Type-safe library for work with Telegram Bot API
Go to file
renovate[bot] 9d4d2f89e6
Update dependency gradle to v8.7
2024-03-22 18:25:04 +00:00
.github add apiCheck step to ci/cd 2024-03-16 10:20:12 +06:00
docs update docs remote url 2023-10-25 14:58:05 +06:00
gradle Update dependency gradle to v8.7 2024-03-22 18:25:04 +00:00
readmes add exceptions handling readme 2022-01-11 21:22:10 +06:00
resources Add files via upload 2023-02-24 15:30:36 +06:00
tgbotapi fix of build 2023-04-04 00:21:59 +06:00
tgbotapi.api StickerSetName now is value class 2024-03-16 23:07:55 +06:00
tgbotapi.behaviour_builder PollId now is value class 2024-03-16 22:53:01 +06:00
tgbotapi.behaviour_builder.fsm cratch fix of build fails 2023-11-25 17:54:40 +06:00
tgbotapi.core extract different ids into external files 2024-03-16 23:09:01 +06:00
tgbotapi.ksp add api validator 2024-03-16 10:17:33 +06:00
tgbotapi.utils StickerSetName now is value class 2024-03-16 23:07:55 +06:00
tgbotapi.webapps RawChatId as value class 2024-03-16 22:40:42 +06:00
.gitignore update gitignore and dokka version 2021-12-30 11:55:12 +06:00
.travis.yml update travis config 2020-10-22 19:19:55 +06:00
CHANGELOG.md small notice about breaking changes in 11.0.0 2024-03-18 13:54:34 +06:00
CONTRIBUTING.md Create CONTRIBUTING.md 2020-10-02 13:10:01 +06:00
LICENSE Update LICENSE 2020-02-19 22:29:53 +06:00
README.md fixes in changelog and readme 2024-02-17 01:53:00 +06:00
TelegramBotAPI.drawio packages update 2021-10-18 15:20:25 +06:00
_config.yml Set theme jekyll-theme-cayman 2020-01-06 22:44:23 +06:00
build.gradle add api validator 2024-03-16 10:17:33 +06:00
changelog_info_retriever update changelog parser 2020-10-04 17:43:25 +06:00
extensions.gradle start to use more unified way of scripts organization 2022-06-29 13:47:21 +06:00
gradle.properties start 11.0.0 2024-03-16 19:22:49 +06:00
gradlew Update dependency gradle to v8.7 2024-03-22 18:25:04 +00:00
gradlew.bat Update dependency gradle to v8.7 2024-03-22 18:25:04 +00:00
mppJsProject.gradle start to use more unified way of scripts organization 2022-06-29 13:47:21 +06:00
mppProjectWithSerialization.gradle update dependencies and gradle wrapper 2023-11-04 21:13:14 +06:00
publish.gradle replace gitea packages with nexus 2023-12-10 13:37:35 +06:00
publish.kpsb replace gitea packages with nexus 2023-12-10 13:37:35 +06:00
renovate.json Add renovate.json 2020-08-12 20:21:10 +00:00
settings.gradle update kdocs 2023-03-04 21:18:50 +06:00

README.md

TelegramBotAPI Maven Central Supported version

Docs KDocs Mini tutorial
Useful repos Create bot Examples
Misc Awesome Kotlin Badge Small survey
Platforms JVM Js
Experimental Platforms Linux x64 MinGW x64

Hello! This is a set of libraries for working with Telegram Bot API.

Examples

There are several things you need to do to launch examples below:

  • Add mavenCentral() to your project repositories
  • Add dependency implementation "dev.inmo:tgbotapi:$tgbotapi_version"
    • Replace tgbotapi_version with exact version (see last one in the table above) or put variable with this name in project
    • Alternative variant for maven here

More including instructions available here. Other configuration examples:

Most common example

suspend fun main() {
  val bot = telegramBot(TOKEN)

  bot.buildBehaviourWithLongPolling {
    println(getMe())
  
    onCommand("start") {
      reply(it, "Hi:)")
    }
  }.join()
}

In this example you will see information about this bot at the moment of starting and answer with Hi:) every time it gets message /start

Handling only last messages

suspend fun main() {
  val bot = telegramBot(TOKEN)

  val flowsUpdatesFilter = FlowsUpdatesFilter()
  bot.buildBehaviour(flowUpdatesFilter = flowsUpdatesFilter) {
    println(getMe())
  
    onCommand("start") {
      reply(it, "Hi:)")
    }

    retrieveAccumulatedUpdates(this).join()
  }
}

The main difference with the previous example is that bot will get only last updates (accumulated before bot launch and maybe some updates it got after launch)

Build a little bit more complex behaviour

suspend fun main() {
  val bot = telegramBot(TOKEN)

  bot.buildBehaviourWithLongPolling {
    println(getMe())

    val nameReplyMarkup = ReplyKeyboardMarkup(
      matrix {
        row {
          +SimpleKeyboardButton("nope")
        }
      }
    )
    onCommand("start") {
      val photo = waitPhoto(
        SendTextMessage(it.chat.id, "Send me your photo please")
      ).first()

      val name = waitText(
        SendTextMessage(
          it.chat.id,
          "Send me your name or choose \"nope\"",
          replyMarkup = nameReplyMarkup
        )
      ).first().text.takeIf { it != "nope" }

      sendPhoto(
        it.chat,
        photo.mediaCollection,
        entities = buildEntities {
          if (name != null) regular(name) // may be collapsed up to name ?.let(::regular)
        }
      )
    }
  }.join()
}

More examples

You may find examples in this project. Besides, you are always welcome in our docs and chat.