telegram-bot-api/README.md

122 lines
3.1 KiB
Markdown
Raw Normal View History

# Golang bindings for the Telegram Bot API
2015-06-25 07:40:42 +02:00
2016-01-04 01:12:03 +01:00
[![GoDoc](https://godoc.org/github.com/go-telegram-bot-api/telegram-bot-api?status.svg)](http://godoc.org/github.com/go-telegram-bot-api/telegram-bot-api)
[![Travis](https://travis-ci.org/go-telegram-bot-api/telegram-bot-api.svg)](https://travis-ci.org/go-telegram-bot-api/telegram-bot-api)
2015-06-26 08:20:29 +02:00
2015-06-26 05:49:24 +02:00
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.
2015-06-26 09:18:55 +02:00
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](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
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"
2017-12-29 08:26:54 +01:00
"github.com/go-telegram-bot-api/telegram-bot-api"
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 {
2016-05-22 17:16:28 +02:00
if update.Message == nil {
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
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"
2017-12-29 08:26:54 +01:00
"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)
2017-12-29 08:26:54 +01:00
_, err = bot.Request(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()
2018-03-26 19:22:16 +02:00
2018-01-07 19:10:50 +01:00
if err != nil {
log.Fatal(err)
}
2018-03-26 19:22:16 +02:00
2018-01-07 19:10:50 +01:00
if info.LastErrorDate != 0 {
2018-03-26 19:22:16 +02:00
log.Printf("failed to set webhook: %s", info.LastErrorMessage)
2018-01-07 19:10:50 +01:00
}
2018-03-26 19:22:16 +02: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 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.
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
2017-12-29 08:26:54 +01:00
Now that [Let's Encrypt](https://letsencrypt.org) is available, you may
wish to generate your free TLS certificate there.