telegram-bot-api/README.md

129 lines
3.8 KiB
Markdown
Raw Normal View History

2024-01-15 11:29:03 +01:00
> # Usage
> If you want to use this fork in the project that imports the original repo, the easiest way is to:
> - `git submodule add git@github.com:OvyFlash/telegram-bot-api.git telegram-bot-api`
> - `go mod edit --replace github.com/go-telegram-bot-api/telegram-bot-api/v5=./telegram-bot-api/`
> - `go mod tidy`
> And you're ready to go.
> Notice, that there have been several breaking changes since the telegram bot API v5 was released, so you might need to update your application.
2015-06-25 07:40:42 +02:00
2024-01-15 11:29:03 +01:00
# Golang bindings for the Telegram Bot API
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
2021-12-04 03:22:53 +01:00
All methods are fairly self-explanatory, and reading the [godoc](https://pkg.go.dev/github.com/go-telegram-bot-api/telegram-bot-api/v5) page should
explain everything. If something isn't clear, open an issue or submit
a pull request.
2021-12-04 03:22:53 +01:00
There are more tutorials and high-level information on the website, [go-telegram-bot-api.dev](https://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](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
2021-12-04 03:22:53 +01:00
updates := bot.GetUpdatesChan(u)
2015-06-26 09:18:55 +02:00
2015-11-21 15:31:59 +01:00
for update := range updates {
2021-12-04 03:22:53 +01:00
if update.Message != nil { // If we got a message
log.Printf("[%s] %s", update.Message.From.UserName, update.Message.Text)
2016-05-22 17:16:28 +02:00
2021-12-04 03:22:53 +01:00
msg := tgbotapi.NewMessage(update.Message.Chat.ID, update.Message.Text)
msg.ReplyParameters.MessageID = update.Message.MessageID
2015-06-26 09:18:55 +02:00
2021-12-04 03:22:53 +01:00
bot.Send(msg)
}
2015-11-21 15:31:59 +01:00
}
2015-06-26 09:18:55 +02:00
}
```
2015-09-07 20:17:38 +02:00
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"
2021-12-04 03:22:53 +01:00
"github.com/go-telegram-bot-api/telegram-bot-api/v5"
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)
2022-01-03 03:48:12 +01:00
wh, _ := tgbotapi.NewWebhookWithCert("https://www.example.com:8443/"+bot.Token, "cert.pem")
2021-12-04 03:22:53 +01:00
2022-01-03 03:48:12 +01:00
_, err = bot.Request(wh)
2015-09-07 20:17:38 +02:00
if err != nil {
log.Fatal(err)
}
2021-12-04 03:22:53 +01:00
2018-01-07 19:10:50 +01:00
info, err := bot.GetWebhookInfo()
if err != nil {
log.Fatal(err)
}
2021-12-04 03:22:53 +01:00
2018-01-07 19:10:50 +01:00
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
}
2021-12-04 03:22:53 +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, 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.