TelegramBot4s

Telegram Bot API Wrapper for Scala

100% idiomatic Scala wrapper for the Telegram Bot API. The full API is supported, inline queries, callbacks, editing, markups, sending files, chat actions... strongly-typed (no JSON stuff/strings), fully asynchronous (ont top of Akka), and transparently camelCased.

I encourage users to report any bug or broken functionality, I'll do my best to give proper support in a reasonable time frame.

As SBT dependency from Jitpack

  scalaVersion := "2.11.7"
  
  resolvers += "jitpack" at "https://jitpack.io"

  libraryDependencies += "com.github.mukel" %% "telegrambot4s" % "v1.2.2"

Make sure to specify Scala version in your build file, inserting a line like the first one, or you'll get by default a 2.10 Scala version for which this repository does not work.

You can also pull any branch or release from Jitpack, check it out.

About TOKEN safety

Please DO NOT SHARE TOKENS in any form.

In order to avoid unintentional TOKEN sharing, a simple but efficient method is to store a separate file UNTRACKED, OUTSIDE THE REPO!!! e.g. "bot.token" and spawn your bot as follows:

object SafeBot extends TelegramBot with Polling with Commands {
  def token = Source.fromFile("./bot.token").getLines().next
  on("/hello") { implicit msg => _ =>
    reply("My token is SAFE!")
  }
}

SafeBot.run()

Webhooks vs Polling

Both methods are fully supported. Polling is by far the easiest method, and can be used locally without any additional requirements. Polling has been radically improved, it doesn't flood the server and it's very fast. Using webhooks requires a server (it won't work on your laptop). Self-signed certificates are supported, but you must issue the certificates yourself.

Bonus (or how to turn a spare phone into a Telegram Bot)

Beside the usual ways, I've managed to run FlunkeyBot successfully on a Raspberry Pi 2, and most notably on an old Android (4.1.2) phone with a broken screen.

Contributors

Contributions are highly appreciated, documentation improvements/corrections, idiomatic Scala, bug reports, even feature requests. Creating a bot, is also a contribution, I'll add a link to your bot here anytime.

• Andrey Romanov
• Dmitry Kurinskiy
• ex0ns
• Kirill Lastovirya
• Maxim Cherkasov
• hamidr
• Onilton Maciel

Usage

Just add import info.mukel.telegrambot4s._, api._, methods._, models._, Implicits._ and you are good to go.

Running the examples

Create a token file in the token subdirectory

mkdir tokens
cd tokens
echo token_from_telegram_that_looks_like_this_aghgoah:aghoahg >
menial_bot.token

Get into the test console in sbt

sbt
[info] Loading project definition from /home/jmerelo/Code/forks/telegrambot4s/project
[info] Set current project to telegrambot4s (in build file:/home/jmerelo/Code/forks/telegrambot4s/)
> test:console
[info] Compiling 10 Scala sources to /home/jmerelo/Code/forks/telegrambot4s/target/scala-2.11/test-classes...
[info] Starting scala interpreter...
[info] 
Welcome to Scala 2.11.8 (Java HotSpot(TM) 64-Bit Server VM, Java 1.8.0_101).
Type in expressions for evaluation. Or try :help.

scala> import info.mukel.telegrambot4s.examples._
import info.mukel.telegrambot4s.examples._

scala> RandomBot.run()

(Change RandomBot to whatever bot you find interesting)

Let me Google that for you!

object LmgtfyBot extends TelegramBot with Polling with Commands {
  def token = "TOKEN"
  on("/lmgtfy") { implicit msg => args =>
    reply(
      "http://lmgtfy.com/?q=" + URLEncoder.encode(args mkString " ", "UTF-8"),
      disableWebPagePreview = true
    )
  }
}

LmgtfyBot.run()

Google TTS

object TextToSpeechBot extends TelegramBot with Polling with Commands with ChatActions {
  def token = "TOKEN"
  val ttsApiBase = "http://translate.google.com/translate_tts?ie=UTF-8&client=tw-ob&tl=en-us&q="
  on("/speak") { implicit msg => args =>
    val text = args mkString " "
    val url = ttsApiBase + URLEncoder.encode(text, "UTF-8")
    for {
      response <- Http().singleRequest(HttpRequest(uri = Uri(url)))
      if response.status.isSuccess()
      bytes <-  Unmarshal(response).to[ByteString]
    } /* do */ {
      uploadingAudio // hint the user
      val voiceMp3 = InputFile.FromByteString("voice.mp3", bytes)
      api.request(SendVoice(msg.sender, voiceMp3))
    }
  }
}

TextToSpeechBot.run()

Using webhooks

object WebhookBot extends TelegramBot with Webhook {
  def token = "TOKEN"
  def port = 8443
  def webhookUrl = "https://ed88ff73.ngrok.io"

  def toL337(s: String) = s.map("aegiost".zip("4361057").toMap.withDefault(identity))

  override def handleMessage(message: Message): Unit = {
    for (text <- message.text)
      api.request(SendMessage(message.sender, toL337(text)))
  }
}

WebhookBot.run()

Check out the sample bots for more functionality.