Golang bindings for the Telegram Bot API
Go to file
Syfaro 9d2d117c0e Merge branch 'master' into develop 2018-10-08 14:00:38 -05: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 go1.4 from travis configuration 2018-08-27 22:44:02 +02:00
LICENSE.txt add license 2015-06-26 21:53:55 -05:00
README.md Merge master into develop. 2018-10-08 03:13:50 -05:00
bot.go Merge branch 'master' into develop 2018-10-08 14:00:38 -05:00
bot_test.go Merge master into develop. 2018-10-08 03:13:50 -05:00
configs.go Merge master into develop. 2018-10-08 03:13:50 -05:00
helpers.go Merge master into develop. 2018-10-08 03:13:50 -05:00
helpers_test.go Fix backwards compatibility for Live Location. 2017-12-29 13:00:02 -06:00
log.go A number of small improvements. 2018-10-08 02:25:09 -05:00
passport.go Revert "Remove a broken check for GetUpdatesChan." 2018-10-08 13:58:50 -05:00
types.go Merge master into develop. 2018-10-08 03:13:50 -05:00
types_test.go More various small code quality improvements. 2018-03-26 12:39:07 -05: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 differen 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.Request(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.