Golang bindings for the Telegram Bot API
Go to file
Henner 5f5f94047c Rewrite message command methods to use entities
Since the Telegram-API considers "/foo-bar" to be a command entity
"/foo", we had choose a behaviour for the
CommandArguments() method.
The specification (https://core.telegram.org/bots#commands) mandates a
space after the command name, so we decided to skip the first character
following the command entity.
However, Telegram clients render "/foo-bar" as if "/foo" was the command
and "-bar" additional text, so this alternative should be remembered.
2017-10-07 17:15:51 +02:00
tests Added VideoNote support 2017-05-22 02:34:12 +04:30
.gitignore Tests improved 2015-11-20 19:43:56 +03:00
.travis.yml Test refactored 2015-11-21 15:34:30 +03:00
LICENSE.txt add license 2015-06-26 21:53:55 -05:00
README.md Add new chat methods for Bot API 2.1. 2016-05-22 10:16:28 -05:00
bot.go Add PinChatMessage and UnpinChatMessage methods 2017-08-05 12:29:06 +03:00
bot_test.go Create own supergroup with test already created bot and give it admin rights 2017-08-05 13:50:44 +03:00
configs.go Add PinChatMessage and UnpinChatMessage methods 2017-08-05 12:29:06 +03:00
helpers.go Fixes and comments 2017-06-03 13:59:40 +07:00
helpers_test.go Add NewInlineQueryResultPhotoWithThumb for #54. 2016-07-26 13:44:48 -05:00
types.go Rewrite message command methods to use entities 2017-10-07 17:15:51 +02:00
types_test.go feat(types): add language code to user struct 2017-05-22 12:40:04 +04:30

README.md

Golang bindings for the Telegram Bot API

GoDoc Travis

All methods have been added, and all features should be available. If you want a feature that hasn't been added yet or something is broken, open an issue and I'll see what I can do.

All methods are fairly self explanatory, and reading the godoc page should explain everything. If something isn't clear, open an issue or submit a pull request.

The scope of this project is just to provide a wrapper around the API without any additional features. There are other projects for creating something with plugins and command handlers without having to design all that yourself.

Use github.com/go-telegram-bot-api/telegram-bot-api for the latest version, or use gopkg.in/telegram-bot-api.v4 for the stable build.

Join the development group if you want to ask questions or discuss development.

Example

This is a very simple bot that just displays any gotten updates, then replies it to that chat.

package main

import (
	"log"
	"gopkg.in/telegram-bot-api.v4"
)

func main() {
	bot, err := tgbotapi.NewBotAPI("MyAwesomeBotToken")
	if err != nil {
		log.Panic(err)
	}

	bot.Debug = true

	log.Printf("Authorized on account %s", bot.Self.UserName)

	u := tgbotapi.NewUpdate(0)
	u.Timeout = 60

	updates, err := bot.GetUpdatesChan(u)

	for update := range updates {
		if update.Message == nil {
			continue
		}

		log.Printf("[%s] %s", update.Message.From.UserName, update.Message.Text)

		msg := tgbotapi.NewMessage(update.Message.Chat.ID, update.Message.Text)
		msg.ReplyToMessageID = update.Message.MessageID

		bot.Send(msg)
	}
}

If you need to use webhooks (if you wish to run on Google App Engine), you may use a slightly different method.

package main

import (
	"gopkg.in/telegram-bot-api.v4"
	"log"
	"net/http"
)

func main() {
	bot, err := tgbotapi.NewBotAPI("MyAwesomeBotToken")
	if err != nil {
		log.Fatal(err)
	}

	bot.Debug = true

	log.Printf("Authorized on account %s", bot.Self.UserName)

	_, err = bot.SetWebhook(tgbotapi.NewWebhookWithCert("https://www.google.com:8443/"+bot.Token, "cert.pem"))
	if err != nil {
		log.Fatal(err)
	}

	updates := bot.ListenForWebhook("/" + bot.Token)
	go http.ListenAndServeTLS("0.0.0.0:8443", "cert.pem", "key.pem", nil)

	for update := range updates {
		log.Printf("%+v\n", update)
	}
}

If you need, you may generate a self signed certficate, as this requires HTTPS / TLS. The above example tells Telegram that this is your certificate and that it should be trusted, even though it is not properly signed.

openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -days 3560 -subj "//O=Org\CN=Test" -nodes

Now that Let's Encrypt has entered public beta, you may wish to generate your free TLS certificate there.