Golang bindings for the Telegram Bot API
Find a file
Ilja Lapkovskis 19e9a06795
Merge pull request #5 from eli-l/develop
Bump up the module version to v7
2024-01-20 18:40:24 +02:00
.github/workflows Do not run unit tests on PR. 2024-01-20 18:27:53 +02:00
docs Fix typos in comments 2022-10-19 11:58:52 +03:00
tests Add set message reaction helpers. 2024-01-20 18:17:17 +02:00
.env Move sensitive credentials to the secrets 2024-01-19 17:40:39 +02:00
.gitignore Add .env to .gitignore 2024-01-19 17:47:53 +02:00
book.toml Initial work on improving docs. 2020-07-26 17:22:16 -05:00
bot.go Add set message reaction helpers. 2024-01-20 18:17:17 +02:00
bot_mock_test.go WIP: Separate test. Refactor a bunch of it. 2024-01-18 22:45:49 +02:00
bot_test.go Cleanup unit tests. 2024-01-19 19:48:07 +02:00
configs.go Start implementing 7.0 Bot API changes 2024-01-05 22:05:00 +02:00
example_bot.go Separate tests. Finish integration test refactoring 2024-01-20 16:29:08 +02:00
go.mod Bump up the module version to v7 2024-01-20 18:39:31 +02:00
go.sum WIP: Separate test. Refactor a bunch of it. 2024-01-18 22:45:49 +02:00
helper_methods.go Add set message reaction helpers. 2024-01-20 18:17:17 +02:00
helper_structs.go Start implementing 7.0 Bot API changes 2024-01-05 22:05:00 +02:00
helpers_test.go BOT API 6.7 implementation 2023-07-05 11:23:14 +03:00
LICENSE.txt add license 2015-06-26 21:53:55 -05:00
log.go A number of small improvements. 2018-10-08 02:25:09 -05:00
mockgen.go WIP: Separate test. Refactor a bunch of it. 2024-01-18 22:45:49 +02:00
params.go Start implementing 7.0 Bot API changes 2024-01-05 22:05:00 +02: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
README.md Fix setting webhook in README. 2022-01-02 21:48:12 -05:00
types.go Fix UserIsBot and UserIsPremium fields in KeyboardButtonRequestUsers struct 2024-01-09 01:09:38 +02:00
types_test.go Start implementing 7.0 Bot API changes 2024-01-05 22:05:00 +02:00

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.