telegram-bot-api/README.md

91 lines
2.5 KiB
Markdown
Raw Normal View History

# Golang bindings for the Telegram Bot API
2015-06-25 07:40:42 +02:00
[![GoDoc](https://godoc.org/github.com/Syfaro/telegram-bot-api?status.svg)](http://godoc.org/github.com/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.
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-06-27 04:46:06 +02:00
"github.com/Syfaro/telegram-bot-api"
2015-06-26 09:18:55 +02:00
)
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
2015-07-31 19:44:37 +02:00
err = bot.UpdatesChan(u)
if err != nil {
log.Panic(err)
}
2015-06-26 09:18:55 +02:00
2015-07-31 19:44:37 +02:00
for update := range bot.Updates {
2015-06-26 09:18:55 +02:00
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.SendMessage(msg)
}
}
```
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 (
"github.com/Syfaro/telegram-bot-api"
"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"))
if err != nil {
log.Fatal(err)
}
bot.ListenForWebhook()
go http.ListenAndServeTLS("0.0.0.0:8443", "cert.pem", "key.pem", nil)
for update := range bot.Updates {
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.
openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -days 3560 -subj -nodes