Golang bindings for the Telegram Bot API
Go to file
Erik Pellizzon 7d4ae712ae
Added empty string error return in docs
2020-11-06 22:07:29 +01:00
tests Added VideoNote support 2017-05-22 02:34:12 +04:30
.gitignore Passport Updates (#1) 2018-09-04 10:52:52 -07:00
.travis.yml Remove old Go versions from Travis. 2020-07-22 04:33:50 -05:00
LICENSE.txt add license 2015-06-26 21:53:55 -05:00
README.md README: link to godoc 2019-10-25 11:47:24 +08:00
bot.go Added empty string error return in docs 2020-11-06 22:07:29 +01:00
bot_test.go Temporarily fix MediaGroup test (Imgur -> GitHub) 2020-10-19 17:00:31 -04:00
configs.go Add params from develop branch, config for poll 2020-10-20 06:52:08 +03:00
go.mod Go mod was added 2019-10-08 12:25:37 +03:00
go.sum Go mod was added 2019-10-08 12:25:37 +03:00
helpers.go Merge branch 'master' of https://github.com/go-telegram-bot-api/telegram-bot-api into wehook-validation 2020-07-21 12:06:24 +03:00
helpers_test.go feat: add sendDice configs 2020-07-21 10:25:30 +03:00
log.go A number of small improvements. 2018-10-08 02:25:09 -05:00
params.go Add params from develop branch, config for poll 2020-10-20 06:52:08 +03:00
passport.go Fix capitalization in doc. 2018-10-08 14:45:45 -05:00
types.go Add message documentation 2020-10-19 00:09:50 +03:00
types_test.go Add type helpers to message entities. 2019-01-10 15:39:47 +03:00

README.md

Golang bindings for the Telegram Bot API

GoDoc Travis

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.

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

Example

First, ensure the library is installed and up to date by running go get -u github.com/go-telegram-bot-api/telegram-bot-api.

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

package main

import (
	"log"

	"github.com/go-telegram-bot-api/telegram-bot-api"
)

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 { // ignore any non-Message Updates
			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)
	}
}

There are more examples on the wiki with detailed information on how to do many different kinds of things. It's a great place to get started on using keyboards, commands, or other kinds of reply markup.

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 (
	"log"
	"net/http"

	"github.com/go-telegram-bot-api/telegram-bot-api"
)

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)
	}
	info, err := bot.GetWebhookInfo()
	if err != nil {
		log.Fatal(err)
	}
	if info.LastErrorDate != 0 {
		log.Printf("Telegram callback failed: %s", info.LastErrorMessage)
	}
	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 is available, you may wish to generate your free TLS certificate there.