No Description

Syfaro 4126fa6112 Merge pull request #565 from crashiura/validate-web-app 2 years ago
.github e6e2a9f3ef Update Go version, fix duplicate runs. 4 years ago
docs fd903f8182 Fix typos in comments 2 years ago
tests ecc60d21b7 Added VideoNote support 7 years ago
.gitignore 5be25266b5 Initial work on improving docs. 4 years ago
LICENSE.txt 7b9b7856fc add license 9 years ago
README.md 60c16b6773 Fix setting webhook in README. 2 years ago
book.toml 5be25266b5 Initial work on improving docs. 4 years ago
bot.go 2fa77043ad Merge pull request #538 from fbbdev/patch-1 2 years ago
bot_test.go 2cc6dc2458 Remove deprecated ioutil functions 2 years ago
configs.go fd903f8182 Fix typos in comments 2 years ago
go.mod 2a2f7c5083 Update docs. 3 years ago
go.sum ce4fc988c9 Add support for uploading multiple files. 4 years ago
helpers.go 4126fa6112 Merge pull request #565 from crashiura/validate-web-app 2 years ago
helpers_test.go 189292093b validate web app hash 2 years ago
log.go b6441c36ee A number of small improvements. 6 years ago
params.go 77aa442a43 Fix typos and grammar issues in comments 3 years ago
params_test.go 5ce2767dad Updates for Bot API 4.4 and 4.5. 4 years ago
passport.go 77aa442a43 Fix typos and grammar issues in comments 3 years ago
types.go 99503a7118 Merge pull request #560 from temamagic/premium-update 2 years ago
types_test.go 10a9f2650f Implement Bot API 6.0 changes. 2 years ago

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.