No Description

Syfaro 37aef71deb Fix codecov badge to be for correct branch. 2 years ago
.github c8f7564819 Playing around with local-only tests. 2 years ago
docs 0d342c8d5a Remove WIP label from docs. 2 years ago
tests c8f7564819 Playing around with local-only tests. 2 years ago
.gitignore 5be25266b5 Initial work on improving docs. 4 years ago
LICENSE.txt 7b9b7856fc add license 9 years ago
README.md 37aef71deb Fix codecov badge to be for correct branch. 2 years ago
book.toml 5be25266b5 Initial work on improving docs. 4 years ago
bot.go 1eba0e83a1 Fixes, more coverage, and correct assert usage. 2 years ago
bot_test.go 1eba0e83a1 Fixes, more coverage, and correct assert usage. 2 years ago
configs.go 1eba0e83a1 Fixes, more coverage, and correct assert usage. 2 years ago
go.mod c8f7564819 Playing around with local-only tests. 2 years ago
go.sum c8f7564819 Playing around with local-only tests. 2 years ago
helpers.go 24489300ee Remove deprecated methods, other small fixes. 2 years ago
helpers_test.go c8f7564819 Playing around with local-only tests. 2 years ago
log.go b6441c36ee A number of small improvements. 6 years ago
params.go c8f7564819 Playing around with local-only tests. 2 years ago
params_test.go c8f7564819 Playing around with local-only tests. 2 years ago
passport.go 77aa442a43 Fix typos and grammar issues in comments 3 years ago
types.go 1eba0e83a1 Fixes, more coverage, and correct assert usage. 2 years ago
types_test.go 1eba0e83a1 Fixes, more coverage, and correct assert usage. 2 years ago

README.md

Golang bindings for the Telegram Bot API

Go Reference Test codecov

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.google.com:8443/"+bot.Token, "cert.pem")

	_, err = bot.SetWebhook(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.