Golang bindings for the Telegram Bot API
Go to file
temamagic 4b88e970a1 feat: add is premium user status 2022-06-20 05:12:56 +03:00
.github/workflows Update Go version, fix duplicate runs. 2020-11-05 13:48:39 -05:00
docs Remove WIP label from docs. 2021-12-03 21:28:24 -05:00
tests Added VideoNote support 2017-05-22 02:34:12 +04:30
.gitignore Initial work on improving docs. 2020-07-26 17:22:16 -05:00
LICENSE.txt add license 2015-06-26 21:53:55 -05:00
README.md Fix setting webhook in README. 2022-01-02 21:48:12 -05:00
book.toml Initial work on improving docs. 2020-07-26 17:22:16 -05:00
bot.go Fix ListenForWebhook closing chan after request. 2021-12-07 21:30:04 -05:00
bot_test.go Remove deprecated methods, other small fixes. 2021-12-03 21:16:31 -05:00
configs.go Add ProtectContent field, spoiler type comment. 2022-01-02 22:00:12 -05:00
go.mod Update docs. 2021-11-08 14:47:43 -05:00
go.sum Add support for uploading multiple files. 2020-07-25 19:29:40 -05:00
helpers.go Remove deprecated methods, other small fixes. 2021-12-03 21:16:31 -05:00
helpers_test.go Create interface for file data. 2021-08-20 15:31:52 -04:00
log.go A number of small improvements. 2018-10-08 02:25:09 -05:00
params.go Fix typos and grammar issues in comments 2021-11-08 17:29:10 -05:00
params_test.go Updates for Bot API 4.4 and 4.5. 2020-01-06 01:44:13 -06:00
passport.go Fix typos and grammar issues in comments 2021-11-08 17:29:10 -05:00
types.go feat: add is premium user status 2022-06-20 05:12:56 +03:00
types_test.go Updates for Bot API 5.5. 2021-12-07 10:08:41 -05:00

README.md

Golang bindings for the Telegram Bot API

Go Reference Test

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.

There are more tutorials and high-level information on the website, go-telegram-bot-api.dev.

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/v5.

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

package main

import (
	"log"

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

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 := bot.GetUpdatesChan(u)

	for update := range updates {
		if update.Message != nil { // If we got a message
			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 (
	"log"
	"net/http"

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

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)

	wh, _ := tgbotapi.NewWebhookWithCert("https://www.example.com:8443/"+bot.Token, "cert.pem")

	_, err = bot.Request(wh)
	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 certificate, 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.