// Package tgbotapi has functions and types used for interacting with // the Telegram Bot API. package tgbotapi import ( "bytes" "encoding/json" "errors" "fmt" "github.com/technoweenie/multipartstreamer" "io/ioutil" "log" "net/http" "net/url" "os" "strconv" "strings" "time" ) // BotAPI allows you to interact with the Telegram Bot API. type BotAPI struct { Token string `json:"token"` Debug bool `json:"debug"` Self User `json:"-"` Client *http.Client `json:"-"` } // NewBotAPI creates a new BotAPI instance. // // It requires a token, provided by @BotFather on Telegram. func NewBotAPI(token string) (*BotAPI, error) { return NewBotAPIWithClient(token, &http.Client{}) } // NewBotAPIWithClient creates a new BotAPI instance // and allows you to pass a http.Client. // // It requires a token, provided by @BotFather on Telegram. func NewBotAPIWithClient(token string, client *http.Client) (*BotAPI, error) { bot := &BotAPI{ Token: token, Client: client, } self, err := bot.GetMe() if err != nil { return &BotAPI{}, err } bot.Self = self return bot, nil } // MakeRequest makes a request to a specific endpoint with our token. func (bot *BotAPI) MakeRequest(endpoint string, params url.Values) (APIResponse, error) { method := fmt.Sprintf(APIEndpoint, bot.Token, endpoint) resp, err := bot.Client.PostForm(method, params) if err != nil { return APIResponse{}, err } defer resp.Body.Close() if resp.StatusCode == http.StatusForbidden { return APIResponse{}, errors.New(ErrAPIForbidden) } bytes, err := ioutil.ReadAll(resp.Body) if err != nil { return APIResponse{}, err } if bot.Debug { log.Println(endpoint, string(bytes)) } var apiResp APIResponse json.Unmarshal(bytes, &apiResp) if !apiResp.Ok { return APIResponse{}, errors.New(apiResp.Description) } return apiResp, nil } // makeMessageRequest makes a request to a method that returns a Message. func (bot *BotAPI) makeMessageRequest(endpoint string, params url.Values) (Message, error) { resp, err := bot.MakeRequest(endpoint, params) if err != nil { return Message{}, err } var message Message json.Unmarshal(resp.Result, &message) bot.debugLog(endpoint, params, message) return message, nil } // UploadFile makes a request to the API with a file. // // Requires the parameter to hold the file not be in the params. // File should be a string to a file path, a FileBytes struct, // or a FileReader struct. // // Note that if your FileReader has a size set to -1, it will read // the file into memory to calculate a size. func (bot *BotAPI) UploadFile(endpoint string, params map[string]string, fieldname string, file interface{}) (APIResponse, error) { ms := multipartstreamer.New() ms.WriteFields(params) switch f := file.(type) { case string: fileHandle, err := os.Open(f) if err != nil { return APIResponse{}, err } defer fileHandle.Close() fi, err := os.Stat(f) if err != nil { return APIResponse{}, err } ms.WriteReader(fieldname, fileHandle.Name(), fi.Size(), fileHandle) case FileBytes: buf := bytes.NewBuffer(f.Bytes) ms.WriteReader(fieldname, f.Name, int64(len(f.Bytes)), buf) case FileReader: if f.Size != -1 { ms.WriteReader(fieldname, f.Name, f.Size, f.Reader) break } data, err := ioutil.ReadAll(f.Reader) if err != nil { return APIResponse{}, err } buf := bytes.NewBuffer(data) ms.WriteReader(fieldname, f.Name, int64(len(data)), buf) default: return APIResponse{}, errors.New(ErrBadFileType) } method := fmt.Sprintf(APIEndpoint, bot.Token, endpoint) req, err := http.NewRequest("POST", method, nil) if err != nil { return APIResponse{}, err } ms.SetupRequest(req) res, err := bot.Client.Do(req) if err != nil { return APIResponse{}, err } defer res.Body.Close() bytes, err := ioutil.ReadAll(res.Body) if err != nil { return APIResponse{}, err } if bot.Debug { log.Println(string(bytes)) } var apiResp APIResponse json.Unmarshal(bytes, &apiResp) if !apiResp.Ok { return APIResponse{}, errors.New(apiResp.Description) } return apiResp, nil } // GetFileDirectURL returns direct URL to file // // It requires the FileID. func (bot *BotAPI) GetFileDirectURL(fileID string) (string, error) { file, err := bot.GetFile(FileConfig{fileID}) if err != nil { return "", err } return file.Link(bot.Token), nil } // GetMe fetches the currently authenticated bot. // // This method is called upon creation to validate the token, // and so you may get this data from BotAPI.Self without the need for // another request. func (bot *BotAPI) GetMe() (User, error) { resp, err := bot.MakeRequest("getMe", nil) if err != nil { return User{}, err } var user User json.Unmarshal(resp.Result, &user) bot.debugLog("getMe", nil, user) return user, nil } // IsMessageToMe returns true if message directed to this bot. // // It requires the Message. func (bot *BotAPI) IsMessageToMe(message Message) bool { return strings.Contains(message.Text, "@"+bot.Self.UserName) } // Send will send a Chattable item to Telegram. // // It requires the Chattable to send. func (bot *BotAPI) Send(c Chattable) (Message, error) { switch c.(type) { case Fileable: return bot.sendFile(c.(Fileable)) default: return bot.sendChattable(c) } } // debugLog checks if the bot is currently running in debug mode, and if // so will display information about the request and response in the // debug log. func (bot *BotAPI) debugLog(context string, v url.Values, message interface{}) { if bot.Debug { log.Printf("%s req : %+v\n", context, v) log.Printf("%s resp: %+v\n", context, message) } } // sendExisting will send a Message with an existing file to Telegram. func (bot *BotAPI) sendExisting(method string, config Fileable) (Message, error) { v, err := config.values() if err != nil { return Message{}, err } message, err := bot.makeMessageRequest(method, v) if err != nil { return Message{}, err } return message, nil } // uploadAndSend will send a Message with a new file to Telegram. func (bot *BotAPI) uploadAndSend(method string, config Fileable) (Message, error) { params, err := config.params() if err != nil { return Message{}, err } file := config.getFile() resp, err := bot.UploadFile(method, params, config.name(), file) if err != nil { return Message{}, err } var message Message json.Unmarshal(resp.Result, &message) bot.debugLog(method, nil, message) return message, nil } // sendFile determines if the file is using an existing file or uploading // a new file, then sends it as needed. func (bot *BotAPI) sendFile(config Fileable) (Message, error) { if config.useExistingFile() { return bot.sendExisting(config.method(), config) } return bot.uploadAndSend(config.method(), config) } // sendChattable sends a Chattable. func (bot *BotAPI) sendChattable(config Chattable) (Message, error) { v, err := config.values() if err != nil { return Message{}, err } message, err := bot.makeMessageRequest(config.method(), v) if err != nil { return Message{}, err } return message, nil } // GetUserProfilePhotos gets a user's profile photos. // // It requires UserID. // Offset and Limit are optional. func (bot *BotAPI) GetUserProfilePhotos(config UserProfilePhotosConfig) (UserProfilePhotos, error) { v := url.Values{} v.Add("user_id", strconv.Itoa(config.UserID)) if config.Offset != 0 { v.Add("offset", strconv.Itoa(config.Offset)) } if config.Limit != 0 { v.Add("limit", strconv.Itoa(config.Limit)) } resp, err := bot.MakeRequest("getUserProfilePhotos", v) if err != nil { return UserProfilePhotos{}, err } var profilePhotos UserProfilePhotos json.Unmarshal(resp.Result, &profilePhotos) bot.debugLog("GetUserProfilePhoto", v, profilePhotos) return profilePhotos, nil } // GetFile returns a File which can download a file from Telegram. // // Requires FileID. func (bot *BotAPI) GetFile(config FileConfig) (File, error) { v := url.Values{} v.Add("file_id", config.FileID) resp, err := bot.MakeRequest("getFile", v) if err != nil { return File{}, err } var file File json.Unmarshal(resp.Result, &file) bot.debugLog("GetFile", v, file) return file, nil } // GetUpdates fetches updates. // If a WebHook is set, this will not return any data! // // Offset, Limit, and Timeout are optional. // To avoid stale items, set Offset to one higher than the previous item. // Set Timeout to a large number to reduce requests so you can get updates // instantly instead of having to wait between requests. func (bot *BotAPI) GetUpdates(config UpdateConfig) ([]Update, error) { v := url.Values{} if config.Offset > 0 { v.Add("offset", strconv.Itoa(config.Offset)) } if config.Limit > 0 { v.Add("limit", strconv.Itoa(config.Limit)) } if config.Timeout > 0 { v.Add("timeout", strconv.Itoa(config.Timeout)) } resp, err := bot.MakeRequest("getUpdates", v) if err != nil { return []Update{}, err } var updates []Update json.Unmarshal(resp.Result, &updates) bot.debugLog("getUpdates", v, updates) return updates, nil } // RemoveWebhook unsets the webhook. func (bot *BotAPI) RemoveWebhook() (APIResponse, error) { return bot.MakeRequest("setWebhook", url.Values{}) } // SetWebhook sets a webhook. // // If this is set, GetUpdates will not get any data! // // If you do not have a legitmate TLS certificate, you need to include // your self signed certificate with the config. func (bot *BotAPI) SetWebhook(config WebhookConfig) (APIResponse, error) { if config.Certificate == nil { v := url.Values{} v.Add("url", config.URL.String()) return bot.MakeRequest("setWebhook", v) } params := make(map[string]string) params["url"] = config.URL.String() resp, err := bot.UploadFile("setWebhook", params, "certificate", config.Certificate) if err != nil { return APIResponse{}, err } var apiResp APIResponse json.Unmarshal(resp.Result, &apiResp) if bot.Debug { log.Printf("setWebhook resp: %+v\n", apiResp) } return apiResp, nil } // GetUpdatesChan starts and returns a channel for getting updates. func (bot *BotAPI) GetUpdatesChan(config UpdateConfig) (<-chan Update, error) { updatesChan := make(chan Update, 100) go func() { for { updates, err := bot.GetUpdates(config) if err != nil { log.Println(err) log.Println("Failed to get updates, retrying in 3 seconds...") time.Sleep(time.Second * 3) continue } for _, update := range updates { if update.UpdateID >= config.Offset { config.Offset = update.UpdateID + 1 updatesChan <- update } } } }() return updatesChan, nil } // ListenForWebhook registers a http handler for a webhook. func (bot *BotAPI) ListenForWebhook(pattern string) <-chan Update { updatesChan := make(chan Update, 100) http.HandleFunc(pattern, func(w http.ResponseWriter, r *http.Request) { bytes, _ := ioutil.ReadAll(r.Body) var update Update json.Unmarshal(bytes, &update) updatesChan <- update }) return updatesChan } // AnswerInlineQuery sends a response to an inline query. // // Note that you must respond to an inline query within 30 seconds. func (bot *BotAPI) AnswerInlineQuery(config InlineConfig) (APIResponse, error) { v := url.Values{} v.Add("inline_query_id", config.InlineQueryID) v.Add("cache_time", strconv.Itoa(config.CacheTime)) v.Add("is_personal", strconv.FormatBool(config.IsPersonal)) v.Add("next_offset", config.NextOffset) data, err := json.Marshal(config.Results) if err != nil { return APIResponse{}, err } v.Add("results", string(data)) v.Add("switch_pm_text", config.SwitchPMText) v.Add("switch_pm_parameter", config.SwitchPMParameter) bot.debugLog("answerInlineQuery", v, nil) return bot.MakeRequest("answerInlineQuery", v) } // AnswerCallbackQuery sends a response to an inline query callback. func (bot *BotAPI) AnswerCallbackQuery(config CallbackConfig) (APIResponse, error) { v := url.Values{} v.Add("callback_query_id", config.CallbackQueryID) v.Add("text", config.Text) v.Add("show_alert", strconv.FormatBool(config.ShowAlert)) bot.debugLog("answerCallbackQuery", v, nil) return bot.MakeRequest("answerCallbackQuery", v) } // KickChatMember kicks a user from a chat. Note that this only will work // in supergroups, and requires the bot to be an admin. Also note they // will be unable to rejoin until they are unbanned. func (bot *BotAPI) KickChatMember(config ChatMemberConfig) (APIResponse, error) { v := url.Values{} if config.SuperGroupUsername == "" { v.Add("chat_id", strconv.FormatInt(config.ChatID, 10)) } else { v.Add("chat_id", config.SuperGroupUsername) } v.Add("user_id", strconv.Itoa(config.UserID)) bot.debugLog("kickChatMember", v, nil) return bot.MakeRequest("kickChatMember", v) } // UnbanChatMember unbans a user from a chat. Note that this only will work // in supergroups, and requires the bot to be an admin. func (bot *BotAPI) UnbanChatMember(config ChatMemberConfig) (APIResponse, error) { v := url.Values{} if config.SuperGroupUsername == "" { v.Add("chat_id", strconv.FormatInt(config.ChatID, 10)) } else { v.Add("chat_id", config.SuperGroupUsername) } v.Add("user_id", strconv.Itoa(config.UserID)) bot.debugLog("unbanChatMember", v, nil) return bot.MakeRequest("unbanChatMember", v) }