1# Golang bindings for the Telegram Bot API
 2
 3[![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)
 4[![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)
 5
 6All methods are fairly self explanatory, and reading the [godoc](http://godoc.org/github.com/go-telegram-bot-api/telegram-bot-api) page should
 7explain everything. If something isn't clear, open an issue or submit
 8a pull request.
 9
10The scope of this project is just to provide a wrapper around the API
11without any additional features. There are other projects for creating
12something with plugins and command handlers without having to design
13all that yourself.
14
15Join [the development group](https://telegram.me/go_telegram_bot_api) if
16you want to ask questions or discuss development.
17
18## Example
19
20First, ensure the library is installed and up to date by running
21`go get -u github.com/go-telegram-bot-api/telegram-bot-api/v5`.
22
23This is a very simple bot that just displays any gotten updates,
24then replies it to that chat.
25
26```go
27package main
28
29import (
30	"log"
31
32	tgbotapi "github.com/go-telegram-bot-api/telegram-bot-api/v5"
33)
34
35func main() {
36	bot, err := tgbotapi.NewBotAPI("MyAwesomeBotToken")
37	if err != nil {
38		log.Panic(err)
39	}
40
41	bot.Debug = true
42
43	log.Printf("Authorized on account %s", bot.Self.UserName)
44
45	u := tgbotapi.NewUpdate(0)
46	u.Timeout = 60
47
48	updates, err := bot.GetUpdatesChan(u)
49
50	for update := range updates {
51		if update.Message == nil { // ignore any non-Message Updates
52			continue
53		}
54
55		log.Printf("[%s] %s", update.Message.From.UserName, update.Message.Text)
56
57		msg := tgbotapi.NewMessage(update.Message.Chat.ID, update.Message.Text)
58		msg.ReplyToMessageID = update.Message.MessageID
59
60		bot.Send(msg)
61	}
62}
63```
64
65There are more examples on the [site](https://go-telegram-bot-api.dev/)
66with detailed information on how to do many different kinds of things.
67It's a great place to get started on using keyboards, commands, or other
68kinds of reply markup.