telegram-bot-api/README.md

190 lines
5.1 KiB
Markdown
Raw Normal View History

# Golang bindings for the Telegram Bot API
2015-06-25 07:40:42 +02:00
2021-11-08 20:47:43 +01:00
[![Go Reference](https://pkg.go.dev/badge/github.com/go-telegram-bot-api/telegram-bot-api/v5.svg)](https://pkg.go.dev/github.com/go-telegram-bot-api/telegram-bot-api/v5)
[![Test](https://github.com/go-telegram-bot-api/telegram-bot-api/actions/workflows/test.yml/badge.svg)](https://github.com/go-telegram-bot-api/telegram-bot-api/actions/workflows/test.yml)
2015-06-26 08:20:29 +02:00
All methods are fairly self-explanatory, and reading the [godoc](http://godoc.org/github.com/go-telegram-bot-api/telegram-bot-api) 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](https://telegram.me/go_telegram_bot_api) if
you want to ask questions or discuss development.
2016-01-04 01:12:03 +01:00
2015-06-26 09:18:55 +02:00
## Example
First, ensure the library is installed and up to date by running
2021-11-08 20:47:43 +01:00
`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.
2015-06-26 09:18:55 +02:00
```go
package main
import (
"log"
2021-11-08 20:47:43 +01:00
tgbotapi "github.com/go-telegram-bot-api/telegram-bot-api/v5"
2015-06-26 09:18:55 +02:00
)
func main() {
bot, err := tgbotapi.NewBotAPI("MyAwesomeBotToken")
2015-11-21 15:31:59 +01:00
if err != nil {
log.Panic(err)
}
2015-06-26 09:18:55 +02:00
2015-11-21 15:31:59 +01:00
bot.Debug = true
2015-06-26 09:18:55 +02:00
2015-11-21 15:31:59 +01:00
log.Printf("Authorized on account %s", bot.Self.UserName)
2015-06-26 09:18:55 +02:00
2015-11-21 15:31:59 +01:00
u := tgbotapi.NewUpdate(0)
u.Timeout = 60
2015-06-26 09:18:55 +02:00
2015-11-21 15:31:59 +01:00
updates, err := bot.GetUpdatesChan(u)
2015-06-26 09:18:55 +02:00
2015-11-21 15:31:59 +01:00
for update := range updates {
2018-10-08 09:25:09 +02:00
if update.Message == nil { // ignore any non-Message Updates
2016-05-22 17:16:28 +02:00
continue
}
2015-11-21 15:31:59 +01:00
log.Printf("[%s] %s", update.Message.From.UserName, update.Message.Text)
2015-06-26 09:18:55 +02:00
2015-11-21 15:31:59 +01:00
msg := tgbotapi.NewMessage(update.Message.Chat.ID, update.Message.Text)
msg.ReplyToMessageID = update.Message.MessageID
2015-06-26 09:18:55 +02:00
2015-11-21 15:31:59 +01:00
bot.Send(msg)
}
2015-06-26 09:18:55 +02:00
}
```
2015-09-07 20:17:38 +02:00
2021-11-08 20:47:43 +01:00
There are more examples on the [site](https://go-telegram-bot-api.dev/)
with detailed information on how to do many kinds of things.
2018-10-08 09:25:09 +02:00
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.
2015-09-07 20:17:38 +02:00
```go
package main
import (
"log"
"net/http"
"github.com/go-telegram-bot-api/telegram-bot-api"
2015-09-07 20:17:38 +02:00
)
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"))
2015-09-07 20:17:38 +02:00
if err != nil {
log.Fatal(err)
}
2018-01-07 19:10:50 +01:00
info, err := bot.GetWebhookInfo()
if err != nil {
log.Fatal(err)
}
if info.LastErrorDate != 0 {
2018-10-08 09:25:09 +02:00
log.Printf("Telegram callback failed: %s", info.LastErrorMessage)
2018-01-07 19:10:50 +01:00
}
updates := bot.ListenForWebhook("/" + bot.Token)
2015-09-07 20:17:38 +02:00
go http.ListenAndServeTLS("0.0.0.0:8443", "cert.pem", "key.pem", nil)
2015-11-21 15:31:59 +01:00
for update := range updates {
2015-09-07 20:17:38 +02:00
log.Printf("%+v\n", update)
}
}
```
If you need to publish your bot on AWS Lambda(or something like it) and AWS API Gateway,
you can use such example:
In this code used AWS Lambda Go net/http server adapter [algnhsa](https://github.com/akrylysov/algnhsa)
```go
package main
import (
"github.com/akrylysov/algnhsa"
"github.com/go-telegram-bot-api/telegram-bot-api"
"log"
"net/http"
)
func answer(w http.ResponseWriter, r *http.Request) {
bot, err := tgbotapi.NewBotAPI("MyAwesomeBotToken")
if err != nil {
log.Fatal(err)
}
bot.Debug = true
updates := bot.ListenForWebhookRespReqFormat(w, r)
for update := range updates {
if update.Message == nil {
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
_, err := bot.Send(msg)
if err != nil {
log.Printf("Error send message: %s | Error: %s", msg.Text, err.Error())
}
}
}
func setWebhook(_ http.ResponseWriter, _ *http.Request) {
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.NewWebhook("https://your_api_gateway_address.com/"+bot.Token))
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)
}
}
func main() {
http.HandleFunc("/set_webhook", setWebhook)
http.HandleFunc("/MyAwesomeBotToken", answer)
algnhsa.ListenAndServe(http.DefaultServeMux, nil)
}
```
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.
2015-09-07 20:17:38 +02:00
2015-11-21 12:50:11 +01:00
openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -days 3560 -subj "//O=Org\CN=Test" -nodes
2018-10-08 09:25:09 +02:00
Now that [Let's Encrypt](https://letsencrypt.org) is available,
you may wish to generate your free TLS certificate there.