1
0
mirror of https://github.com/InsanusMokrassar/TelegramBotAPI.git synced 2024-05-30 06:25:14 +00:00
Type-safe library for work with Telegram Bot API
Go to file
2022-07-10 00:04:36 +06:00
.github update github building yml 2022-03-24 16:49:08 +06:00
docs complete rewriting on libs.versions.toml 2022-06-29 14:23:45 +06:00
gradle update microutils 2022-07-09 23:52:16 +06:00
readmes add exceptions handling readme 2022-01-11 21:22:10 +06:00
resources packages update 2021-10-18 15:20:25 +06:00
tgbotapi complete rewriting on libs.versions.toml 2022-06-29 14:23:45 +06:00
tgbotapi.api complete rewriting on libs.versions.toml 2022-06-29 14:23:45 +06:00
tgbotapi.behaviour_builder complete rewriting on libs.versions.toml 2022-06-29 14:23:45 +06:00
tgbotapi.behaviour_builder.fsm complete rewriting on libs.versions.toml 2022-06-29 14:23:45 +06:00
tgbotapi.core fixes 2022-07-09 23:45:24 +06:00
tgbotapi.utils ChatJoinRequest#inviteLink fix 2022-07-09 23:09:52 +06:00
tgbotapi.webapps complete rewriting on libs.versions.toml 2022-06-29 14:23:45 +06:00
_config.yml Set theme jekyll-theme-cayman 2020-01-06 22:44:23 +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
build.gradle Update build.gradle 2022-07-10 00:04:36 +06:00
changelog_info_retriever update changelog parser 2020-10-04 17:43:25 +06:00
CHANGELOG.md update microutils 2022-07-09 23:52:16 +06:00
CONTRIBUTING.md Create CONTRIBUTING.md 2020-10-02 13:10:01 +06:00
extensions.gradle start to use more unified way of scripts organization 2022-06-29 13:47:21 +06:00
gradle.properties start 2.1.3 2022-07-09 22:37:58 +06:00
gradlew init 2018-12-26 16:21:52 +08:00
gradlew.bat init 2018-12-26 16:21:52 +08:00
LICENSE Update LICENSE 2020-02-19 22:29:53 +06:00
mppJsProject.gradle start to use more unified way of scripts organization 2022-06-29 13:47:21 +06:00
mppProjectWithSerialization.gradle complete rewriting on libs.versions.toml 2022-06-29 14:23:45 +06:00
publish.gradle publication scripts update 2022-03-22 16:26:18 +06:00
publish.kpsb publication scripts update 2022-03-22 16:26:18 +06:00
README.md add mention about 6.1 telegram bot api support 2022-06-21 18:58:01 +06:00
renovate.json Add renovate.json 2020-08-12 20:21:10 +00:00
settings.gradle webapps 2022-04-21 14:49:52 +06:00
TelegramBotAPI.drawio packages update 2021-10-18 15:20:25 +06:00

TelegramBotAPI Maven Central Supported version

Awesome Kotlin Badge Build Status Small survey Chat in Telegram
Create bot Examples KDocs Mini tutorial

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 wiki and chat.