Golang bindings for the Telegram Bot API
Go to file
Syfaro a274ce7a9f remove a useless test, add test for IsSuperGroup 2015-12-09 20:13:31 -06:00
tests Fixes, tests improved 2015-11-21 14:22:08 +03:00
.gitignore Tests improved 2015-11-20 19:43:56 +03:00
.travis.yml Test refactored 2015-11-21 15:34:30 +03:00
LICENSE.txt add license 2015-06-26 21:53:55 -05:00
README.md Mention Let's Encrypt in README, instead of generating own certs 2015-12-09 20:07:13 -06:00
bot.go Lint issues fixed 2015-11-21 19:43:24 +03:00
bot_test.go Package path changed before merge 2015-11-22 02:40:39 +03:00
configs.go Remove ReplyMarkup interface from MessageConfig, fixes #30 2015-11-25 09:08:03 -06:00
helpers.go removeWebhook method added. 2015-11-21 14:26:39 +03:00
types.go update Message struct for new fields, add IsSuperGroup to Chat struct 2015-12-09 20:08:37 -06:00
types_test.go remove a useless test, add test for IsSuperGroup 2015-12-09 20:13:31 -06:00

README.md

Golang bindings for the Telegram Bot API

GoDoc Travis

All methods have been added, and all features should be available. If you want a feature that hasn't been added yet or something is broken, open an issue and I'll see what I can do.

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.

Note to previous users, there was just a large change that broke some methods. The main changes are that all the Send* functions have been replaced with a single Send, and UpdatesChan was renamed GetUpdatesChan and returns (chan, err) instead of storing the chan in Updates.

Example

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

package main

import (
	"log"
	"github.com/Syfaro/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 {
		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 for some reason (such as running on Google App Engine), you may use a slightly different method.

package main

import (
	"github.com/Syfaro/telegram-bot-api"
	"log"
	"net/http"
)

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)
	}

	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 has entered public beta, you may wish to generate your free TLS certificate there.