telegram-bot-api/helper_methods.go

1157 lines
31 KiB
Go
Raw Normal View History

package tgbotapi
import (
2022-07-03 01:37:12 +02:00
"crypto/hmac"
"crypto/sha256"
"encoding/hex"
"errors"
"fmt"
"net/url"
2022-07-03 01:37:12 +02:00
"sort"
"strings"
)
// NewMessage creates a new Message.
2015-06-26 08:10:53 +02:00
//
// chatID is where to send it, text is the message text.
2016-03-24 19:22:40 +01:00
func NewMessage(chatID int64, text string) MessageConfig {
return MessageConfig{
BaseChat: BaseChat{
2024-01-05 21:05:00 +01:00
ChatConfig: ChatConfig{
ChatID: chatID,
},
},
Text: text,
LinkPreviewOptions: LinkPreviewOptions{
IsDisabled: false,
},
}
}
// NewDeleteMessage creates a request to delete a message.
func NewDeleteMessage(chatID int64, messageID int) DeleteMessageConfig {
return DeleteMessageConfig{
2024-01-05 21:05:00 +01:00
BaseChatMessage: BaseChatMessage{
ChatConfig: ChatConfig{
ChatID: chatID,
},
MessageID: messageID,
},
}
}
// NewDeleteMessages creates a request to delete multiple messages. The messages have to be
// in the same chat. Provide the message ids as an array of integers
func NewDeleteMessages(chatID int64, messageIDs []int) DeleteMessagesConfig {
return DeleteMessagesConfig{
BaseChatMessages: BaseChatMessages{
ChatConfig: ChatConfig{
ChatID: chatID,
},
MessageIDs: messageIDs,
},
}
}
2016-04-22 17:03:00 +02:00
// NewMessageToChannel creates a new Message that is sent to a channel
// by username.
//
2020-11-06 05:29:48 +01:00
// username is the username of the channel, text is the message text,
// and the username should be in the form of `@username`.
2016-04-22 17:03:00 +02:00
func NewMessageToChannel(username string, text string) MessageConfig {
return MessageConfig{
BaseChat: BaseChat{
2024-01-05 21:05:00 +01:00
ChatConfig: ChatConfig{
ChannelUsername: username,
}},
2016-04-22 17:03:00 +02:00
Text: text,
}
}
// NewForward creates a new forward.
2015-06-26 08:10:53 +02:00
//
// chatID is where to send it, fromChatID is the source chat,
// and messageID is the ID of the original message.
2016-03-24 19:22:40 +01:00
func NewForward(chatID int64, fromChatID int64, messageID int) ForwardConfig {
return ForwardConfig{
2024-01-05 21:05:00 +01:00
BaseChat: BaseChat{ChatConfig: ChatConfig{ChatID: chatID}},
FromChat: ChatConfig{ChatID: fromChatID},
MessageID: messageID,
}
}
2020-11-06 18:36:00 +01:00
// NewCopyMessage creates a new copy message.
//
// chatID is where to send it, fromChatID is the source chat,
// and messageID is the ID of the original message.
func NewCopyMessage(chatID int64, fromChatID int64, messageID int) CopyMessageConfig {
return CopyMessageConfig{
2024-01-05 21:05:00 +01:00
BaseChat: BaseChat{ChatConfig: ChatConfig{ChatID: chatID}},
FromChat: ChatConfig{ChatID: fromChatID},
MessageID: messageID,
2020-11-06 18:36:00 +01:00
}
}
// NewPhoto creates a new sendPhoto request.
2015-06-26 08:10:53 +02:00
//
// chatID is where to send it, file is a string path to the file,
// FileReader, or FileBytes.
//
// Note that you must send animated GIFs as a document.
2021-08-20 21:31:52 +02:00
func NewPhoto(chatID int64, file RequestFileData) PhotoConfig {
return PhotoConfig{
BaseFile: BaseFile{
2024-01-05 21:05:00 +01:00
BaseChat: BaseChat{ChatConfig: ChatConfig{ChatID: chatID}},
File: file,
},
}
}
// NewPhotoToChannel creates a new photo uploader to send a photo to a channel.
2015-06-26 08:10:53 +02:00
//
// Note that you must send animated GIFs as a document.
2021-08-20 21:31:52 +02:00
func NewPhotoToChannel(username string, file RequestFileData) PhotoConfig {
return PhotoConfig{
BaseFile: BaseFile{
2024-01-05 21:05:00 +01:00
BaseChat: BaseChat{ChatConfig: ChatConfig{ChannelUsername: username}},
File: file,
},
}
}
// NewAudio creates a new sendAudio request.
2021-08-20 21:31:52 +02:00
func NewAudio(chatID int64, file RequestFileData) AudioConfig {
return AudioConfig{
BaseFile: BaseFile{
2024-01-05 21:05:00 +01:00
BaseChat: BaseChat{ChatConfig: ChatConfig{ChatID: chatID}},
File: file,
},
}
}
// NewDocument creates a new sendDocument request.
2021-08-20 21:31:52 +02:00
func NewDocument(chatID int64, file RequestFileData) DocumentConfig {
return DocumentConfig{
BaseFile: BaseFile{
2024-01-05 21:05:00 +01:00
BaseChat: BaseChat{ChatConfig: ChatConfig{ChatID: chatID}},
File: file,
},
}
}
// NewSticker creates a new sendSticker request.
2021-08-20 21:31:52 +02:00
func NewSticker(chatID int64, file RequestFileData) StickerConfig {
return StickerConfig{
BaseFile: BaseFile{
2024-01-05 21:05:00 +01:00
BaseChat: BaseChat{ChatConfig: ChatConfig{ChatID: chatID}},
File: file,
},
}
}
2023-07-04 21:21:43 +02:00
// NewCustomEmojiStickerSetThumbnal creates a new setCustomEmojiStickerSetThumbnal request
func NewCustomEmojiStickerSetThumbnal(name, customEmojiID string) SetCustomEmojiStickerSetThumbnailConfig {
return SetCustomEmojiStickerSetThumbnailConfig{
2023-07-04 21:21:43 +02:00
Name: name,
CustomEmojiID: customEmojiID,
}
}
// NewStickerSetTitle creates a new setStickerSetTitle request
func NewStickerSetTitle(name, title string) SetStickerSetTitleConfig {
return SetStickerSetTitleConfig{
Name: name,
Title: title,
}
}
// NewDeleteStickerSet creates a new deleteStickerSet request
func NewDeleteStickerSet(name, title string) DeleteStickerSetConfig {
return DeleteStickerSetConfig{
Name: name,
}
}
// NewVideo creates a new sendVideo request.
2021-08-20 21:31:52 +02:00
func NewVideo(chatID int64, file RequestFileData) VideoConfig {
return VideoConfig{
BaseFile: BaseFile{
2024-01-05 21:05:00 +01:00
BaseChat: BaseChat{ChatConfig: ChatConfig{ChatID: chatID}},
File: file,
},
}
}
// NewAnimation creates a new sendAnimation request.
2021-08-20 21:31:52 +02:00
func NewAnimation(chatID int64, file RequestFileData) AnimationConfig {
2018-09-06 14:44:42 +02:00
return AnimationConfig{
BaseFile: BaseFile{
2024-01-05 21:05:00 +01:00
BaseChat: BaseChat{ChatConfig: ChatConfig{ChatID: chatID}},
File: file,
2018-09-06 14:44:42 +02:00
},
}
}
// NewVideoNote creates a new sendVideoNote request.
2017-05-22 00:04:12 +02:00
//
// chatID is where to send it, file is a string path to the file,
// FileReader, or FileBytes.
2021-08-20 21:31:52 +02:00
func NewVideoNote(chatID int64, length int, file RequestFileData) VideoNoteConfig {
2017-05-22 00:04:12 +02:00
return VideoNoteConfig{
BaseFile: BaseFile{
2024-01-05 21:05:00 +01:00
BaseChat: BaseChat{ChatConfig: ChatConfig{ChatID: chatID}},
File: file,
2017-05-22 00:04:12 +02:00
},
Length: length,
}
}
// NewVoice creates a new sendVoice request.
2021-08-20 21:31:52 +02:00
func NewVoice(chatID int64, file RequestFileData) VoiceConfig {
2015-08-18 03:40:42 +02:00
return VoiceConfig{
BaseFile: BaseFile{
2024-01-05 21:05:00 +01:00
BaseChat: BaseChat{ChatConfig: ChatConfig{ChatID: chatID}},
File: file,
},
2015-08-18 03:40:42 +02:00
}
}
// NewMediaGroup creates a new media group. Files should be an array of
// two to ten InputMediaPhoto or InputMediaVideo.
func NewMediaGroup(chatID int64, files []interface{}) MediaGroupConfig {
return MediaGroupConfig{
2022-11-06 00:32:26 +01:00
BaseChat: BaseChat{
2024-01-05 21:05:00 +01:00
ChatConfig: ChatConfig{ChatID: chatID},
2022-11-06 00:32:26 +01:00
},
2023-07-04 21:21:43 +02:00
Media: files,
}
}
// NewInputMediaPhoto creates a new InputMediaPhoto.
2021-08-20 21:31:52 +02:00
func NewInputMediaPhoto(media RequestFileData) InputMediaPhoto {
return InputMediaPhoto{
BaseInputMedia{
Type: "photo",
Media: media,
},
}
}
// NewInputMediaVideo creates a new InputMediaVideo.
2021-08-20 21:31:52 +02:00
func NewInputMediaVideo(media RequestFileData) InputMediaVideo {
return InputMediaVideo{
BaseInputMedia: BaseInputMedia{
Type: "video",
Media: media,
},
}
}
// NewInputMediaAnimation creates a new InputMediaAnimation.
2021-08-20 21:31:52 +02:00
func NewInputMediaAnimation(media RequestFileData) InputMediaAnimation {
return InputMediaAnimation{
BaseInputMedia: BaseInputMedia{
Type: "animation",
Media: media,
},
}
}
// NewInputMediaAudio creates a new InputMediaAudio.
2021-08-20 21:31:52 +02:00
func NewInputMediaAudio(media RequestFileData) InputMediaAudio {
return InputMediaAudio{
BaseInputMedia: BaseInputMedia{
Type: "audio",
Media: media,
},
}
}
// NewInputMediaDocument creates a new InputMediaDocument.
2021-08-20 21:31:52 +02:00
func NewInputMediaDocument(media RequestFileData) InputMediaDocument {
return InputMediaDocument{
BaseInputMedia: BaseInputMedia{
Type: "document",
Media: media,
},
}
}
// NewContact allows you to send a shared contact.
func NewContact(chatID int64, phoneNumber, firstName string) ContactConfig {
return ContactConfig{
BaseChat: BaseChat{
2024-01-05 21:05:00 +01:00
ChatConfig: ChatConfig{ChatID: chatID},
},
PhoneNumber: phoneNumber,
FirstName: firstName,
}
}
// NewLocation shares your location.
2015-06-26 08:10:53 +02:00
//
// chatID is where to send it, latitude and longitude are coordinates.
2016-03-24 19:22:40 +01:00
func NewLocation(chatID int64, latitude float64, longitude float64) LocationConfig {
return LocationConfig{
BaseChat: BaseChat{
2024-01-05 21:05:00 +01:00
ChatConfig: ChatConfig{ChatID: chatID},
},
Latitude: latitude,
Longitude: longitude,
}
}
// NewVenue allows you to send a venue and its location.
func NewVenue(chatID int64, title, address string, latitude, longitude float64) VenueConfig {
return VenueConfig{
BaseChat: BaseChat{
2024-01-05 21:05:00 +01:00
ChatConfig: ChatConfig{ChatID: chatID},
},
Title: title,
Address: address,
2015-11-20 16:30:50 +01:00
Latitude: latitude,
Longitude: longitude,
}
}
// NewChatAction sets a chat action.
2015-06-26 08:10:53 +02:00
// Actions last for 5 seconds, or until your next action.
//
// chatID is where to send it, action should be set via Chat constants.
2016-03-24 19:22:40 +01:00
func NewChatAction(chatID int64, action string) ChatActionConfig {
return ChatActionConfig{
2024-01-05 21:05:00 +01:00
BaseChat: BaseChat{ChatConfig: ChatConfig{ChatID: chatID}},
2015-11-20 15:31:01 +01:00
Action: action,
}
}
// NewUserProfilePhotos gets user profile photos.
2015-06-26 08:10:53 +02:00
//
// userID is the ID of the user you wish to get profile photos from.
2021-03-09 18:38:15 +01:00
func NewUserProfilePhotos(userID int64) UserProfilePhotosConfig {
return UserProfilePhotosConfig{
UserID: userID,
Offset: 0,
Limit: 0,
}
}
// NewUpdate gets updates since the last Offset.
2015-06-26 08:10:53 +02:00
//
// offset is the last Update ID to include.
// You likely want to set this to the last Update ID plus 1.
func NewUpdate(offset int) UpdateConfig {
return UpdateConfig{
Offset: offset,
Limit: 0,
Timeout: 0,
}
}
// NewWebhook creates a new webhook.
2015-06-26 08:10:53 +02:00
//
// link is the url parsable link you wish to get the updates.
func NewWebhook(link string) (WebhookConfig, error) {
u, err := url.Parse(link)
if err != nil {
return WebhookConfig{}, err
}
return WebhookConfig{
2015-11-21 12:26:39 +01:00
URL: u,
}, nil
}
// NewWebhookWithCert creates a new webhook with a certificate.
//
// link is the url you wish to get webhooks,
// file contains a string to a file, FileReader, or FileBytes.
2021-08-20 21:31:52 +02:00
func NewWebhookWithCert(link string, file RequestFileData) (WebhookConfig, error) {
u, err := url.Parse(link)
if err != nil {
return WebhookConfig{}, err
}
return WebhookConfig{
URL: u,
Certificate: file,
}, nil
}
// NewInlineQueryResultArticle creates a new inline query article.
func NewInlineQueryResultArticle(id, title, messageText string) InlineQueryResultArticle {
return InlineQueryResultArticle{
Type: "article",
ID: id,
Title: title,
InputMessageContent: InputTextMessageContent{
Text: messageText,
},
}
}
// NewInlineQueryResultArticleMarkdown creates a new inline query article with Markdown parsing.
func NewInlineQueryResultArticleMarkdown(id, title, messageText string) InlineQueryResultArticle {
return InlineQueryResultArticle{
Type: "article",
ID: id,
Title: title,
InputMessageContent: InputTextMessageContent{
2016-06-02 22:57:39 +02:00
Text: messageText,
ParseMode: "Markdown",
},
}
}
// NewInlineQueryResultArticleMarkdownV2 creates a new inline query article with MarkdownV2 parsing.
func NewInlineQueryResultArticleMarkdownV2(id, title, messageText string) InlineQueryResultArticle {
return InlineQueryResultArticle{
Type: "article",
ID: id,
Title: title,
InputMessageContent: InputTextMessageContent{
Text: messageText,
ParseMode: "MarkdownV2",
},
}
}
// NewInlineQueryResultArticleHTML creates a new inline query article with HTML parsing.
func NewInlineQueryResultArticleHTML(id, title, messageText string) InlineQueryResultArticle {
return InlineQueryResultArticle{
Type: "article",
ID: id,
Title: title,
InputMessageContent: InputTextMessageContent{
2016-06-02 22:57:39 +02:00
Text: messageText,
ParseMode: "HTML",
},
}
}
// NewInlineQueryResultGIF creates a new inline query GIF.
func NewInlineQueryResultGIF(id, url string) InlineQueryResultGIF {
return InlineQueryResultGIF{
Type: "gif",
ID: id,
URL: url,
}
}
// NewInlineQueryResultCachedGIF create a new inline query with cached photo.
func NewInlineQueryResultCachedGIF(id, gifID string) InlineQueryResultCachedGIF {
return InlineQueryResultCachedGIF{
Type: "gif",
ID: id,
GIFID: gifID,
}
}
// NewInlineQueryResultMPEG4GIF creates a new inline query MPEG4 GIF.
func NewInlineQueryResultMPEG4GIF(id, url string) InlineQueryResultMPEG4GIF {
return InlineQueryResultMPEG4GIF{
Type: "mpeg4_gif",
ID: id,
URL: url,
}
}
2020-11-06 05:29:48 +01:00
// NewInlineQueryResultCachedMPEG4GIF create a new inline query with cached MPEG4 GIF.
func NewInlineQueryResultCachedMPEG4GIF(id, MPEG4GIFID string) InlineQueryResultCachedMPEG4GIF {
2020-11-06 05:29:48 +01:00
return InlineQueryResultCachedMPEG4GIF{
Type: "mpeg4_gif",
ID: id,
MPEG4FileID: MPEG4GIFID,
}
}
// NewInlineQueryResultPhoto creates a new inline query photo.
func NewInlineQueryResultPhoto(id, url string) InlineQueryResultPhoto {
return InlineQueryResultPhoto{
Type: "photo",
ID: id,
URL: url,
}
}
// NewInlineQueryResultPhotoWithThumb creates a new inline query photo.
func NewInlineQueryResultPhotoWithThumb(id, url, thumb string) InlineQueryResultPhoto {
return InlineQueryResultPhoto{
Type: "photo",
ID: id,
URL: url,
ThumbURL: thumb,
}
}
// NewInlineQueryResultCachedPhoto create a new inline query with cached photo.
func NewInlineQueryResultCachedPhoto(id, photoID string) InlineQueryResultCachedPhoto {
return InlineQueryResultCachedPhoto{
Type: "photo",
ID: id,
PhotoID: photoID,
}
}
// NewInlineQueryResultVideo creates a new inline query video.
func NewInlineQueryResultVideo(id, url string) InlineQueryResultVideo {
return InlineQueryResultVideo{
Type: "video",
ID: id,
URL: url,
}
}
// NewInlineQueryResultCachedVideo create a new inline query with cached video.
func NewInlineQueryResultCachedVideo(id, videoID, title string) InlineQueryResultCachedVideo {
return InlineQueryResultCachedVideo{
Type: "video",
ID: id,
VideoID: videoID,
Title: title,
}
}
// NewInlineQueryResultCachedSticker create a new inline query with cached sticker.
func NewInlineQueryResultCachedSticker(id, stickerID, title string) InlineQueryResultCachedSticker {
return InlineQueryResultCachedSticker{
Type: "sticker",
ID: id,
StickerID: stickerID,
Title: title,
}
}
// NewInlineQueryResultAudio creates a new inline query audio.
func NewInlineQueryResultAudio(id, url, title string) InlineQueryResultAudio {
return InlineQueryResultAudio{
Type: "audio",
ID: id,
URL: url,
Title: title,
}
}
// NewInlineQueryResultCachedAudio create a new inline query with cached photo.
func NewInlineQueryResultCachedAudio(id, audioID string) InlineQueryResultCachedAudio {
return InlineQueryResultCachedAudio{
Type: "audio",
ID: id,
AudioID: audioID,
}
}
// NewInlineQueryResultVoice creates a new inline query voice.
func NewInlineQueryResultVoice(id, url, title string) InlineQueryResultVoice {
return InlineQueryResultVoice{
Type: "voice",
ID: id,
URL: url,
Title: title,
}
}
// NewInlineQueryResultCachedVoice create a new inline query with cached photo.
func NewInlineQueryResultCachedVoice(id, voiceID, title string) InlineQueryResultCachedVoice {
return InlineQueryResultCachedVoice{
Type: "voice",
ID: id,
VoiceID: voiceID,
Title: title,
}
}
// NewInlineQueryResultDocument creates a new inline query document.
func NewInlineQueryResultDocument(id, url, title, mimeType string) InlineQueryResultDocument {
return InlineQueryResultDocument{
Type: "document",
ID: id,
URL: url,
Title: title,
MimeType: mimeType,
}
}
// NewInlineQueryResultCachedDocument create a new inline query with cached photo.
func NewInlineQueryResultCachedDocument(id, documentID, title string) InlineQueryResultCachedDocument {
return InlineQueryResultCachedDocument{
Type: "document",
ID: id,
DocumentID: documentID,
Title: title,
}
}
// NewInlineQueryResultLocation creates a new inline query location.
func NewInlineQueryResultLocation(id, title string, latitude, longitude float64) InlineQueryResultLocation {
return InlineQueryResultLocation{
Type: "location",
ID: id,
Title: title,
Latitude: latitude,
Longitude: longitude,
}
}
2020-01-06 17:28:13 +01:00
// NewInlineQueryResultVenue creates a new inline query venue.
func NewInlineQueryResultVenue(id, title, address string, latitude, longitude float64) InlineQueryResultVenue {
return InlineQueryResultVenue{
Type: "venue",
ID: id,
Title: title,
Address: address,
Latitude: latitude,
Longitude: longitude,
}
}
// NewEditMessageText allows you to edit the text of a message.
func NewEditMessageText(chatID int64, messageID int, text string) EditMessageTextConfig {
return EditMessageTextConfig{
BaseEdit: BaseEdit{
2024-01-05 21:05:00 +01:00
BaseChatMessage: BaseChatMessage{
ChatConfig: ChatConfig{
ChatID: chatID,
},
MessageID: messageID,
},
},
Text: text,
}
}
2022-10-19 10:58:52 +02:00
// NewEditMessageTextAndMarkup allows you to edit the text and reply markup of a message.
2020-11-06 05:29:48 +01:00
func NewEditMessageTextAndMarkup(chatID int64, messageID int, text string, replyMarkup InlineKeyboardMarkup) EditMessageTextConfig {
return EditMessageTextConfig{
BaseEdit: BaseEdit{
2024-01-05 21:05:00 +01:00
BaseChatMessage: BaseChatMessage{
ChatConfig: ChatConfig{
ChatID: chatID,
},
MessageID: messageID,
},
2020-11-06 05:29:48 +01:00
ReplyMarkup: &replyMarkup,
},
Text: text,
}
}
// NewEditMessageCaption allows you to edit the caption of a message.
func NewEditMessageCaption(chatID int64, messageID int, caption string) EditMessageCaptionConfig {
return EditMessageCaptionConfig{
BaseEdit: BaseEdit{
2024-01-05 21:05:00 +01:00
BaseChatMessage: BaseChatMessage{
ChatConfig: ChatConfig{
ChatID: chatID,
},
MessageID: messageID,
},
},
Caption: caption,
}
}
// NewEditMessageReplyMarkup allows you to edit the inline
// keyboard markup.
func NewEditMessageReplyMarkup(chatID int64, messageID int, replyMarkup InlineKeyboardMarkup) EditMessageReplyMarkupConfig {
return EditMessageReplyMarkupConfig{
BaseEdit: BaseEdit{
2024-01-05 21:05:00 +01:00
BaseChatMessage: BaseChatMessage{
ChatConfig: ChatConfig{
ChatID: chatID,
},
MessageID: messageID,
},
2016-04-19 09:19:36 +02:00
ReplyMarkup: &replyMarkup,
},
}
}
// NewRemoveKeyboard hides the keyboard, with the option for being selective
// or hiding for everyone.
func NewRemoveKeyboard(selective bool) ReplyKeyboardRemove {
return ReplyKeyboardRemove{
RemoveKeyboard: true,
Selective: selective,
}
}
// NewKeyboardButton creates a regular keyboard button.
func NewKeyboardButton(text string) KeyboardButton {
return KeyboardButton{
Text: text,
}
}
// NewKeyboardButtonWebApp creates a keyboard button with text
// which goes to a WebApp.
func NewKeyboardButtonWebApp(text string, webapp WebAppInfo) KeyboardButton {
return KeyboardButton{
Text: text,
WebApp: &webapp,
}
}
// NewKeyboardButtonContact creates a keyboard button that requests
// user contact information upon click.
func NewKeyboardButtonContact(text string) KeyboardButton {
return KeyboardButton{
Text: text,
RequestContact: true,
}
}
// NewKeyboardButtonLocation creates a keyboard button that requests
// user location information upon click.
func NewKeyboardButtonLocation(text string) KeyboardButton {
return KeyboardButton{
Text: text,
RequestLocation: true,
}
}
// NewKeyboardButtonRow creates a row of keyboard buttons.
func NewKeyboardButtonRow(buttons ...KeyboardButton) []KeyboardButton {
var row []KeyboardButton
2016-04-21 09:40:12 +02:00
row = append(row, buttons...)
return row
}
// NewReplyKeyboard creates a new regular keyboard with sane defaults.
func NewReplyKeyboard(rows ...[]KeyboardButton) ReplyKeyboardMarkup {
var keyboard [][]KeyboardButton
2016-04-21 09:40:12 +02:00
keyboard = append(keyboard, rows...)
return ReplyKeyboardMarkup{
ResizeKeyboard: true,
Keyboard: keyboard,
}
}
// NewOneTimeReplyKeyboard creates a new one time keyboard.
func NewOneTimeReplyKeyboard(rows ...[]KeyboardButton) ReplyKeyboardMarkup {
2020-07-21 21:20:12 +02:00
markup := NewReplyKeyboard(rows...)
markup.OneTimeKeyboard = true
return markup
}
// NewInlineKeyboardButtonData creates an inline keyboard button with text
// and data for a callback.
func NewInlineKeyboardButtonData(text, data string) InlineKeyboardButton {
return InlineKeyboardButton{
Text: text,
CallbackData: &data,
}
}
// NewInlineKeyboardButtonWebApp creates an inline keyboard button with text
// which goes to a WebApp.
func NewInlineKeyboardButtonWebApp(text string, webapp WebAppInfo) InlineKeyboardButton {
return InlineKeyboardButton{
Text: text,
WebApp: &webapp,
}
}
2023-07-05 10:23:14 +02:00
// NewInlineKeyboardButtonSwitchInlineQueryChoosenChat creates an inline keyboard button with text
// which goes to a SwitchInlineQueryChosenChat.
func NewInlineKeyboardButtonSwitchInlineQueryChoosenChat(text string, switchInlineQueryChosenChat SwitchInlineQueryChosenChat) InlineKeyboardButton {
return InlineKeyboardButton{
Text: text,
SwitchInlineQueryChosenChat: &switchInlineQueryChosenChat,
}
}
// NewInlineKeyboardButtonLoginURL creates an inline keyboard button with text
// which goes to a LoginURL.
2021-03-11 04:07:51 +01:00
func NewInlineKeyboardButtonLoginURL(text string, loginURL LoginURL) InlineKeyboardButton {
return InlineKeyboardButton{
Text: text,
2021-03-11 04:07:51 +01:00
LoginURL: &loginURL,
}
}
2021-03-11 04:01:47 +01:00
// NewInlineKeyboardButtonURL creates an inline keyboard button with text
// which goes to a URL.
func NewInlineKeyboardButtonURL(text, url string) InlineKeyboardButton {
return InlineKeyboardButton{
Text: text,
URL: &url,
}
}
// NewInlineKeyboardButtonSwitch creates an inline keyboard button with
// text which allows the user to switch to a chat or return to a chat.
func NewInlineKeyboardButtonSwitch(text, sw string) InlineKeyboardButton {
return InlineKeyboardButton{
Text: text,
SwitchInlineQuery: &sw,
}
}
// NewInlineKeyboardRow creates an inline keyboard row with buttons.
func NewInlineKeyboardRow(buttons ...InlineKeyboardButton) []InlineKeyboardButton {
var row []InlineKeyboardButton
2016-04-21 09:40:12 +02:00
row = append(row, buttons...)
return row
}
// NewInlineKeyboardMarkup creates a new inline keyboard.
func NewInlineKeyboardMarkup(rows ...[]InlineKeyboardButton) InlineKeyboardMarkup {
var keyboard [][]InlineKeyboardButton
2016-04-21 09:40:12 +02:00
keyboard = append(keyboard, rows...)
return InlineKeyboardMarkup{
InlineKeyboard: keyboard,
}
}
2016-04-14 23:30:41 +02:00
// NewCallback creates a new callback message.
func NewCallback(id, text string) CallbackConfig {
return CallbackConfig{
CallbackQueryID: id,
Text: text,
ShowAlert: false,
}
}
// NewCallbackWithAlert creates a new callback message that alerts
// the user.
func NewCallbackWithAlert(id, text string) CallbackConfig {
return CallbackConfig{
CallbackQueryID: id,
Text: text,
ShowAlert: true,
}
}
2017-06-02 22:18:42 +02:00
2018-01-09 04:51:17 +01:00
// NewInvoice creates a new Invoice request to the user.
2018-10-09 06:32:34 +02:00
func NewInvoice(chatID int64, title, description, payload, providerToken, startParameter, currency string, prices []LabeledPrice) InvoiceConfig {
2017-06-02 22:18:42 +02:00
return InvoiceConfig{
2024-01-05 21:05:00 +01:00
BaseChat: BaseChat{
ChatConfig: ChatConfig{ChatID: chatID},
},
2017-06-03 08:59:40 +02:00
Title: title,
Description: description,
Payload: payload,
ProviderToken: providerToken,
StartParameter: startParameter,
Currency: currency,
Prices: prices}
2017-06-02 22:18:42 +02:00
}
2018-03-05 16:04:37 +01:00
// NewChatTitle allows you to update the title of a chat.
func NewChatTitle(chatID int64, title string) SetChatTitleConfig {
return SetChatTitleConfig{
2024-01-05 21:05:00 +01:00
ChatConfig: ChatConfig{
ChatID: chatID,
},
Title: title,
}
}
// NewChatDescription allows you to update the description of a chat.
func NewChatDescription(chatID int64, description string) SetChatDescriptionConfig {
return SetChatDescriptionConfig{
2024-01-05 21:05:00 +01:00
ChatConfig: ChatConfig{
ChatID: chatID,
},
Description: description,
}
}
2024-01-07 08:37:27 +01:00
func NewPinChatMessage(chatID int64, messageID int, disableNotification bool) PinChatMessageConfig {
return PinChatMessageConfig{
BaseChatMessage: BaseChatMessage{
ChatConfig: ChatConfig{
ChatID: chatID,
},
MessageID: messageID,
},
DisableNotification: disableNotification,
}
}
func NewUnpinChatMessage(chatID int64, messageID int) UnpinChatMessageConfig {
return UnpinChatMessageConfig{
BaseChatMessage: BaseChatMessage{
ChatConfig: ChatConfig{
ChatID: chatID,
},
MessageID: messageID,
},
}
}
func NewGetChatMember(chatID, userID int64) GetChatMemberConfig {
return GetChatMemberConfig{
ChatConfigWithUser: ChatConfigWithUser{
ChatConfig: ChatConfig{
ChatID: chatID,
},
UserID: userID,
},
}
}
func NewChatMember(chatID, userID int64) ChatMemberConfig {
return ChatMemberConfig{
ChatConfig: ChatConfig{
ChatID: chatID,
},
UserID: userID,
}
}
// NewChatPhoto allows you to update the photo for a chat.
2021-08-20 21:31:52 +02:00
func NewChatPhoto(chatID int64, photo RequestFileData) SetChatPhotoConfig {
return SetChatPhotoConfig{
BaseFile: BaseFile{
BaseChat: BaseChat{
2024-01-05 21:05:00 +01:00
ChatConfig: ChatConfig{ChatID: chatID},
},
File: photo,
},
}
}
// NewDeleteChatPhoto allows you to delete the photo for a chat.
2021-08-20 21:31:52 +02:00
func NewDeleteChatPhoto(chatID int64) DeleteChatPhotoConfig {
return DeleteChatPhotoConfig{
2024-01-05 21:05:00 +01:00
ChatConfig: ChatConfig{
ChatID: chatID,
},
}
}
// NewPoll allows you to create a new poll.
func NewPoll(chatID int64, question string, options ...string) SendPollConfig {
return SendPollConfig{
BaseChat: BaseChat{
2024-01-05 21:05:00 +01:00
ChatConfig: ChatConfig{ChatID: chatID},
},
2020-01-25 04:42:19 +01:00
Question: question,
Options: options,
IsAnonymous: true, // This is Telegram's default.
}
}
// NewStopPoll allows you to stop a poll.
func NewStopPoll(chatID int64, messageID int) StopPollConfig {
return StopPollConfig{
BaseEdit{
2024-01-05 21:05:00 +01:00
BaseChatMessage: BaseChatMessage{
ChatConfig: ChatConfig{
ChatID: chatID,
},
MessageID: messageID,
},
},
}
}
2020-03-30 22:35:53 +02:00
2020-07-21 21:04:01 +02:00
// NewDice allows you to send a random dice roll.
func NewDice(chatID int64) DiceConfig {
return DiceConfig{
BaseChat: BaseChat{
2024-01-05 21:05:00 +01:00
ChatConfig: ChatConfig{ChatID: chatID},
2020-07-21 21:04:01 +02:00
},
}
}
// NewDiceWithEmoji allows you to send a random roll of one of many types.
//
// Emoji may be 🎲 (1-6), 🎯 (1-6), or 🏀 (1-5).
func NewDiceWithEmoji(chatID int64, emoji string) DiceConfig {
2020-03-30 22:35:53 +02:00
return DiceConfig{
2020-04-24 20:18:26 +02:00
BaseChat: BaseChat{
2024-01-05 21:05:00 +01:00
ChatConfig: ChatConfig{ChatID: chatID},
2020-03-30 22:35:53 +02:00
},
2020-07-21 21:04:01 +02:00
Emoji: emoji,
2020-03-30 22:35:53 +02:00
}
}
2021-06-27 21:15:09 +02:00
// NewBotCommandScopeDefault represents the default scope of bot commands.
func NewBotCommandScopeDefault() BotCommandScope {
return BotCommandScope{Type: "default"}
}
// NewBotCommandScopeAllPrivateChats represents the scope of bot commands,
// covering all private chats.
func NewBotCommandScopeAllPrivateChats() BotCommandScope {
return BotCommandScope{Type: "all_private_chats"}
}
// NewBotCommandScopeAllGroupChats represents the scope of bot commands,
// covering all group and supergroup chats.
func NewBotCommandScopeAllGroupChats() BotCommandScope {
return BotCommandScope{Type: "all_group_chats"}
}
// NewBotCommandScopeAllChatAdministrators represents the scope of bot commands,
// covering all group and supergroup chat administrators.
func NewBotCommandScopeAllChatAdministrators() BotCommandScope {
return BotCommandScope{Type: "all_chat_administrators"}
}
// NewBotCommandScopeChat represents the scope of bot commands, covering a
// specific chat.
func NewBotCommandScopeChat(chatID int64) BotCommandScope {
return BotCommandScope{
Type: "chat",
ChatID: chatID,
}
}
// NewBotCommandScopeChatAdministrators represents the scope of bot commands,
// covering all administrators of a specific group or supergroup chat.
func NewBotCommandScopeChatAdministrators(chatID int64) BotCommandScope {
return BotCommandScope{
Type: "chat_administrators",
ChatID: chatID,
}
}
// NewBotCommandScopeChatMember represents the scope of bot commands, covering a
// specific member of a group or supergroup chat.
func NewBotCommandScopeChatMember(chatID, userID int64) BotCommandScope {
return BotCommandScope{
Type: "chat_member",
ChatID: chatID,
UserID: userID,
}
}
2023-07-04 21:21:43 +02:00
// NewSetMyDescription allows you to change the bot's description, which is shown in the chat with the bot if the chat is empty.
func NewSetMyDescription(description, languageCode string) SetMyDescriptionConfig {
return SetMyDescriptionConfig{
Description: description,
LanguageCode: languageCode,
}
}
// NewGetMyDescription returns the current bot description for the given user language
func NewGetMyDescription(languageCode string) GetMyDescriptionConfig {
return GetMyDescriptionConfig{
LanguageCode: languageCode,
}
}
// NewSetMyShortDescription allows you change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot.
func NewSetMyShortDescription(shortDescription, languageCode string) SetMyShortDescriptionConfig {
return SetMyShortDescriptionConfig{
ShortDescription: shortDescription,
LanguageCode: languageCode,
}
}
// NewGetMyShortDescription returns the current bot short description for the given user language.
func NewGetMyShortDescription(languageCode string) GetMyShortDescriptionConfig {
return GetMyShortDescriptionConfig{
LanguageCode: languageCode,
}
}
2023-07-05 10:23:14 +02:00
// NewGetMyName get the current bot name for the given user language
func NewGetMyName(languageCode string) GetMyNameConfig {
return GetMyNameConfig{
LanguageCode: languageCode,
}
}
// NewSetMyName change the bot's name
func NewSetMyName(languageCode, name string) SetMyNameConfig {
return SetMyNameConfig{
Name: name,
LanguageCode: languageCode,
}
}
2021-06-27 21:15:09 +02:00
// NewGetMyCommandsWithScope allows you to set the registered commands for a
// given scope.
func NewGetMyCommandsWithScope(scope BotCommandScope) GetMyCommandsConfig {
return GetMyCommandsConfig{Scope: &scope}
}
// NewGetMyCommandsWithScopeAndLanguage allows you to set the registered
// commands for a given scope and language code.
func NewGetMyCommandsWithScopeAndLanguage(scope BotCommandScope, languageCode string) GetMyCommandsConfig {
return GetMyCommandsConfig{Scope: &scope, LanguageCode: languageCode}
}
2020-03-30 22:35:53 +02:00
// NewSetMyCommands allows you to set the registered commands.
func NewSetMyCommands(commands ...BotCommand) SetMyCommandsConfig {
2021-06-27 21:15:09 +02:00
return SetMyCommandsConfig{Commands: commands}
}
// NewSetMyCommandsWithScope allows you to set the registered commands for a given scope.
2021-06-27 21:15:09 +02:00
func NewSetMyCommandsWithScope(scope BotCommandScope, commands ...BotCommand) SetMyCommandsConfig {
return SetMyCommandsConfig{Commands: commands, Scope: &scope}
}
// NewSetMyCommandsWithScopeAndLanguage allows you to set the registered commands for a given scope
2021-06-27 21:15:09 +02:00
// and language code.
func NewSetMyCommandsWithScopeAndLanguage(scope BotCommandScope, languageCode string, commands ...BotCommand) SetMyCommandsConfig {
return SetMyCommandsConfig{Commands: commands, Scope: &scope, LanguageCode: languageCode}
}
// NewDeleteMyCommands allows you to delete the registered commands.
func NewDeleteMyCommands() DeleteMyCommandsConfig {
return DeleteMyCommandsConfig{}
}
// NewDeleteMyCommandsWithScope allows you to delete the registered commands for a given
2021-06-27 21:15:09 +02:00
// scope.
func NewDeleteMyCommandsWithScope(scope BotCommandScope) DeleteMyCommandsConfig {
return DeleteMyCommandsConfig{Scope: &scope}
}
// NewDeleteMyCommandsWithScopeAndLanguage allows you to delete the registered commands for a given
2021-06-27 21:15:09 +02:00
// scope and language code.
func NewDeleteMyCommandsWithScopeAndLanguage(scope BotCommandScope, languageCode string) DeleteMyCommandsConfig {
return DeleteMyCommandsConfig{Scope: &scope, LanguageCode: languageCode}
2020-03-30 22:35:53 +02:00
}
2022-07-03 01:37:12 +02:00
// ValidateWebAppData validate data received via the Web App
// https://core.telegram.org/bots/webapps#validating-data-received-via-the-web-app
func ValidateWebAppData(token, telegramInitData string) (bool, error) {
initData, err := url.ParseQuery(telegramInitData)
if err != nil {
return false, fmt.Errorf("error parsing data %w", err)
}
dataCheckString := make([]string, 0, len(initData))
for k, v := range initData {
if k == "hash" {
continue
}
if len(v) > 0 {
dataCheckString = append(dataCheckString, fmt.Sprintf("%s=%s", k, v[0]))
}
}
sort.Strings(dataCheckString)
secret := hmac.New(sha256.New, []byte("WebAppData"))
secret.Write([]byte(token))
hHash := hmac.New(sha256.New, secret.Sum(nil))
hHash.Write([]byte(strings.Join(dataCheckString, "\n")))
hash := hex.EncodeToString(hHash.Sum(nil))
if initData.Get("hash") != hash {
return false, errors.New("hash not equal")
}
return true, nil
}