telegram-bot-api/README.md

95 lines
3.1 KiB
Markdown
Raw Normal View History

# Golang bindings for the Telegram Bot API
2015-06-25 07:40:42 +02:00
2015-11-22 00:40:39 +01:00
[![GoDoc](https://godoc.org/github.com/Syfaro/telegram-bot-api?status.svg)](http://godoc.org/github.com/Syfaro/telegram-bot-api)
[![Travis](https://travis-ci.org/Syfaro/telegram-bot-api.svg)](https://travis-ci.org/Syfaro/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.
2015-06-26 08:22:36 +02:00
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.
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`.
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.
```go
package main
import (
"log"
2015-11-22 00:40:39 +01:00
"github.com/Syfaro/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 {
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 for some reason (such as running on Google App Engine), you may use a slightly different method.
```go
package main
import (
2015-11-22 00:40:39 +01:00
"github.com/Syfaro/telegram-bot-api"
2015-09-07 20:17:38 +02:00
"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"))
2015-09-07 20:17:38 +02:00
if err != nil {
log.Fatal(err)
}
2015-11-21 15:31:59 +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)
}
}
```
2015-12-13 18:38:09 +01:00
For quickly send text message you can use BotAPI method `QuickSend(chatID, "your message")`
2015-09-07 20:17:38 +02:00
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-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
Now that [Let's Encrypt](https://letsencrypt.org) has entered public beta, you may wish to generate your free TLS certificate there.