gotgbot

func (*BaseBotClient) FileURL ¶

func (bot *BaseBotClient) FileURL(token string, tgFilePath string, opts *RequestOpts) string

func (*BaseBotClient) GetAPIURL ¶

func (bot *BaseBotClient) GetAPIURL(opts *RequestOpts) string

GetAPIURL returns the currently used API endpoint.

func (*BaseBotClient) RequestWithContext ¶

func (bot *BaseBotClient) RequestWithContext(ctx context.Context, token string, method string, params map[string]string, data map[string]NamedReader, opts *RequestOpts) (json.RawMessage, error)

RequestWithContext allows sending a POST request to the telegram bot API with an existing context.

• ctx: the timeout contexts to be used.
• method: the telegram API method to call.
• params: map of parameters to be sending to the telegram API. eg: chat_id, user_id, etc.
• data: map of any files to be sending to the telegram API.
• opts: request opts to use. Note: Timeout opts are ignored when used in RequestWithContext. Timeout handling is the responsibility of the caller/context owner.

func (*BaseBotClient) TimeoutContext ¶

func (bot *BaseBotClient) TimeoutContext(opts *RequestOpts) (context.Context, context.CancelFunc)

TimeoutContext returns the appropriate context for the current settings.

func (*Bot) AddStickerToSet ¶

func (bot *Bot) AddStickerToSet(userId int64, name string, sticker InputSticker, opts *AddStickerToSetOpts) (bool, error)

AddStickerToSet (https://core.telegram.org/bots/api#addstickertoset)

Use this method to add a new sticker to a set created by the bot. The format of the added sticker must match the format of the other stickers in the set. Emoji sticker sets can have up to 200 stickers. Animated and video sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.

• userId (type int64): User identifier of sticker set owner
• name (type string): Sticker set name
• sticker (type InputSticker): A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set isn't changed.
• opts (type AddStickerToSetOpts): All optional parameters.

func (*Bot) AnswerCallbackQuery ¶

func (bot *Bot) AnswerCallbackQuery(callbackQueryId string, opts *AnswerCallbackQueryOpts) (bool, error)

AnswerCallbackQuery (https://core.telegram.org/bots/api#answercallbackquery)

Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.

• callbackQueryId (type string): Unique identifier for the query to be answered
• opts (type AnswerCallbackQueryOpts): All optional parameters.

func (*Bot) AnswerInlineQuery ¶

func (bot *Bot) AnswerInlineQuery(inlineQueryId string, results []InlineQueryResult, opts *AnswerInlineQueryOpts) (bool, error)

AnswerInlineQuery (https://core.telegram.org/bots/api#answerinlinequery)

Use this method to send answers to an inline query. On success, True is returned. No more than 50 results per query are allowed.

• inlineQueryId (type string): Unique identifier for the answered query
• results (type []InlineQueryResult): A JSON-serialized array of results for the inline query
• opts (type AnswerInlineQueryOpts): All optional parameters.

func (*Bot) AnswerPreCheckoutQuery ¶

func (bot *Bot) AnswerPreCheckoutQuery(preCheckoutQueryId string, ok bool, opts *AnswerPreCheckoutQueryOpts) (bool, error)

AnswerPreCheckoutQuery (https://core.telegram.org/bots/api#answerprecheckoutquery)

Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.

• preCheckoutQueryId (type string): Unique identifier for the query to be answered
• ok (type bool): Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems.
• opts (type AnswerPreCheckoutQueryOpts): All optional parameters.

func (*Bot) AnswerShippingQuery ¶

func (bot *Bot) AnswerShippingQuery(shippingQueryId string, ok bool, opts *AnswerShippingQueryOpts) (bool, error)

AnswerShippingQuery (https://core.telegram.org/bots/api#answershippingquery)

If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.

• shippingQueryId (type string): Unique identifier for the query to be answered
• ok (type bool): Pass True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible)
• opts (type AnswerShippingQueryOpts): All optional parameters.

func (*Bot) AnswerWebAppQuery ¶

func (bot *Bot) AnswerWebAppQuery(webAppQueryId string, result InlineQueryResult, opts *AnswerWebAppQueryOpts) (*SentWebAppMessage, error)

AnswerWebAppQuery (https://core.telegram.org/bots/api#answerwebappquery)

Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned.

• webAppQueryId (type string): Unique identifier for the query to be answered
• result (type InlineQueryResult): A JSON-serialized object describing the message to be sent
• opts (type AnswerWebAppQueryOpts): All optional parameters.

func (*Bot) ApproveChatJoinRequest ¶

func (bot *Bot) ApproveChatJoinRequest(chatId int64, userId int64, opts *ApproveChatJoinRequestOpts) (bool, error)

ApproveChatJoinRequest (https://core.telegram.org/bots/api#approvechatjoinrequest)

Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• userId (type int64): Unique identifier of the target user
• opts (type ApproveChatJoinRequestOpts): All optional parameters.

func (*Bot) BanChatMember ¶

func (bot *Bot) BanChatMember(chatId int64, userId int64, opts *BanChatMemberOpts) (bool, error)

BanChatMember (https://core.telegram.org/bots/api#banchatmember)

Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

• chatId (type int64): Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername)
• userId (type int64): Unique identifier of the target user
• opts (type BanChatMemberOpts): All optional parameters.

func (*Bot) BanChatSenderChat ¶

func (bot *Bot) BanChatSenderChat(chatId int64, senderChatId int64, opts *BanChatSenderChatOpts) (bool, error)

BanChatSenderChat (https://core.telegram.org/bots/api#banchatsenderchat)

Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• senderChatId (type int64): Unique identifier of the target sender chat
• opts (type BanChatSenderChatOpts): All optional parameters.

func (*Bot) Close ¶

func (bot *Bot) Close(opts *CloseOpts) (bool, error)

Close (https://core.telegram.org/bots/api#close)

Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.

• opts (type CloseOpts): All optional parameters.

func (*Bot) CloseForumTopic ¶

func (bot *Bot) CloseForumTopic(chatId int64, messageThreadId int64, opts *CloseForumTopicOpts) (bool, error)

CloseForumTopic (https://core.telegram.org/bots/api#closeforumtopic)

Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
• messageThreadId (type int64): Unique identifier for the target message thread of the forum topic
• opts (type CloseForumTopicOpts): All optional parameters.

func (*Bot) CloseGeneralForumTopic ¶

func (bot *Bot) CloseGeneralForumTopic(chatId int64, opts *CloseGeneralForumTopicOpts) (bool, error)

CloseGeneralForumTopic (https://core.telegram.org/bots/api#closegeneralforumtopic)

Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
• opts (type CloseGeneralForumTopicOpts): All optional parameters.

func (*Bot) CopyMessage ¶

func (bot *Bot) CopyMessage(chatId int64, fromChatId int64, messageId int64, opts *CopyMessageOpts) (*MessageId, error)

CopyMessage (https://core.telegram.org/bots/api#copymessage)

Use this method to copy messages of any kind. Service messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• fromChatId (type int64): Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)
• messageId (type int64): Message identifier in the chat specified in from_chat_id
• opts (type CopyMessageOpts): All optional parameters.

func (*Bot) CopyMessages ¶

func (bot *Bot) CopyMessages(chatId int64, fromChatId int64, messageIds []int64, opts *CopyMessagesOpts) ([]MessageId, error)

CopyMessages (https://core.telegram.org/bots/api#copymessages)

Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• fromChatId (type int64): Unique identifier for the chat where the original messages were sent (or channel username in the format @channelusername)
• messageIds (type []int64): Identifiers of 1-100 messages in the chat from_chat_id to copy. The identifiers must be specified in a strictly increasing order.
• opts (type CopyMessagesOpts): All optional parameters.

func (*Bot) CreateChatInviteLink ¶

func (bot *Bot) CreateChatInviteLink(chatId int64, opts *CreateChatInviteLinkOpts) (*ChatInviteLink, error)

CreateChatInviteLink (https://core.telegram.org/bots/api#createchatinvitelink)

Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• opts (type CreateChatInviteLinkOpts): All optional parameters.

func (*Bot) CreateForumTopic ¶

func (bot *Bot) CreateForumTopic(chatId int64, name string, opts *CreateForumTopicOpts) (*ForumTopic, error)

CreateForumTopic (https://core.telegram.org/bots/api#createforumtopic)

Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns information about the created topic as a ForumTopic object.

• chatId (type int64): Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
• name (type string): Topic name, 1-128 characters
• opts (type CreateForumTopicOpts): All optional parameters.

func (*Bot) CreateInvoiceLink ¶

func (bot *Bot) CreateInvoiceLink(title string, description string, payload string, providerToken string, currency string, prices []LabeledPrice, opts *CreateInvoiceLinkOpts) (string, error)

CreateInvoiceLink (https://core.telegram.org/bots/api#createinvoicelink)

Use this method to create a link for an invoice. Returns the created invoice link as String on success.

• title (type string): Product name, 1-32 characters
• description (type string): Product description, 1-255 characters
• payload (type string): Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.
• providerToken (type string): Payment provider token, obtained via BotFather
• currency (type string): Three-letter ISO 4217 currency code, see more on currencies
• prices (type []LabeledPrice): Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)
• opts (type CreateInvoiceLinkOpts): All optional parameters.

func (*Bot) CreateNewStickerSet ¶

func (bot *Bot) CreateNewStickerSet(userId int64, name string, title string, stickers []InputSticker, stickerFormat string, opts *CreateNewStickerSetOpts) (bool, error)

CreateNewStickerSet (https://core.telegram.org/bots/api#createnewstickerset)

Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. Returns True on success.

• userId (type int64): User identifier of created sticker set owner
• name (type string): Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only English letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in "_by_<bot_username>". <bot_username> is case insensitive. 1-64 characters.
• title (type string): Sticker set title, 1-64 characters
• stickers (type []InputSticker): A JSON-serialized list of 1-50 initial stickers to be added to the sticker set
• stickerFormat (type string): Format of stickers in the set, must be one of "static", "animated", "video"
• opts (type CreateNewStickerSetOpts): All optional parameters.

func (*Bot) DeclineChatJoinRequest ¶

func (bot *Bot) DeclineChatJoinRequest(chatId int64, userId int64, opts *DeclineChatJoinRequestOpts) (bool, error)

DeclineChatJoinRequest (https://core.telegram.org/bots/api#declinechatjoinrequest)

Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• userId (type int64): Unique identifier of the target user
• opts (type DeclineChatJoinRequestOpts): All optional parameters.

func (*Bot) DeleteChatPhoto ¶

func (bot *Bot) DeleteChatPhoto(chatId int64, opts *DeleteChatPhotoOpts) (bool, error)

DeleteChatPhoto (https://core.telegram.org/bots/api#deletechatphoto)

Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• opts (type DeleteChatPhotoOpts): All optional parameters.

func (*Bot) DeleteChatStickerSet ¶

func (bot *Bot) DeleteChatStickerSet(chatId int64, opts *DeleteChatStickerSetOpts) (bool, error)

DeleteChatStickerSet (https://core.telegram.org/bots/api#deletechatstickerset)

Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
• opts (type DeleteChatStickerSetOpts): All optional parameters.

func (*Bot) DeleteForumTopic ¶

func (bot *Bot) DeleteForumTopic(chatId int64, messageThreadId int64, opts *DeleteForumTopicOpts) (bool, error)

DeleteForumTopic (https://core.telegram.org/bots/api#deleteforumtopic)

Use this method to delete a forum topic along with all its messages in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
• messageThreadId (type int64): Unique identifier for the target message thread of the forum topic
• opts (type DeleteForumTopicOpts): All optional parameters.

func (*Bot) DeleteMessage ¶

func (bot *Bot) DeleteMessage(chatId int64, messageId int64, opts *DeleteMessageOpts) (bool, error)

DeleteMessage (https://core.telegram.org/bots/api#deletemessage)

Use this method to delete a message, including service messages, with the following limitations:

• A message can only be deleted if it was sent less than 48 hours ago.
• Service messages about a supergroup, channel, or forum topic creation can't be deleted.
• A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.
• Bots can delete outgoing messages in private chats, groups, and supergroups.
• Bots can delete incoming messages in private chats.
• Bots granted can_post_messages permissions can delete outgoing messages in channels.
• If the bot is an administrator of a group, it can delete any message there.
• If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any message there.

Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• messageId (type int64): Identifier of the message to delete
• opts (type DeleteMessageOpts): All optional parameters.

func (*Bot) DeleteMessages ¶

func (bot *Bot) DeleteMessages(chatId int64, messageIds []int64, opts *DeleteMessagesOpts) (bool, error)

DeleteMessages (https://core.telegram.org/bots/api#deletemessages)

Use this method to delete multiple messages simultaneously. If some of the specified messages can't be found, they are skipped. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• messageIds (type []int64): Identifiers of 1-100 messages to delete. See deleteMessage for limitations on which messages can be deleted
• opts (type DeleteMessagesOpts): All optional parameters.

func (*Bot) DeleteMyCommands ¶

func (bot *Bot) DeleteMyCommands(opts *DeleteMyCommandsOpts) (bool, error)

DeleteMyCommands (https://core.telegram.org/bots/api#deletemycommands)

Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.

• opts (type DeleteMyCommandsOpts): All optional parameters.

func (*Bot) DeleteStickerFromSet ¶

func (bot *Bot) DeleteStickerFromSet(sticker string, opts *DeleteStickerFromSetOpts) (bool, error)

DeleteStickerFromSet (https://core.telegram.org/bots/api#deletestickerfromset)

Use this method to delete a sticker from a set created by the bot. Returns True on success.

• sticker (type string): File identifier of the sticker
• opts (type DeleteStickerFromSetOpts): All optional parameters.

func (*Bot) DeleteStickerSet ¶

func (bot *Bot) DeleteStickerSet(name string, opts *DeleteStickerSetOpts) (bool, error)

DeleteStickerSet (https://core.telegram.org/bots/api#deletestickerset)

Use this method to delete a sticker set that was created by the bot. Returns True on success.

• name (type string): Sticker set name
• opts (type DeleteStickerSetOpts): All optional parameters.

func (*Bot) DeleteWebhook ¶

func (bot *Bot) DeleteWebhook(opts *DeleteWebhookOpts) (bool, error)

DeleteWebhook (https://core.telegram.org/bots/api#deletewebhook)

Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success.

• opts (type DeleteWebhookOpts): All optional parameters.

func (*Bot) EditChatInviteLink ¶

func (bot *Bot) EditChatInviteLink(chatId int64, inviteLink string, opts *EditChatInviteLinkOpts) (*ChatInviteLink, error)

EditChatInviteLink (https://core.telegram.org/bots/api#editchatinvitelink)

Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• inviteLink (type string): The invite link to edit
• opts (type EditChatInviteLinkOpts): All optional parameters.

func (*Bot) EditForumTopic ¶

func (bot *Bot) EditForumTopic(chatId int64, messageThreadId int64, opts *EditForumTopicOpts) (bool, error)

EditForumTopic (https://core.telegram.org/bots/api#editforumtopic)

Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
• messageThreadId (type int64): Unique identifier for the target message thread of the forum topic
• opts (type EditForumTopicOpts): All optional parameters.

func (*Bot) EditGeneralForumTopic ¶

func (bot *Bot) EditGeneralForumTopic(chatId int64, name string, opts *EditGeneralForumTopicOpts) (bool, error)

EditGeneralForumTopic (https://core.telegram.org/bots/api#editgeneralforumtopic)

Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
• name (type string): New topic name, 1-128 characters
• opts (type EditGeneralForumTopicOpts): All optional parameters.

func (*Bot) EditMessageCaption ¶

func (bot *Bot) EditMessageCaption(opts *EditMessageCaptionOpts) (*Message, bool, error)

EditMessageCaption (https://core.telegram.org/bots/api#editmessagecaption)

Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

• opts (type EditMessageCaptionOpts): All optional parameters.

func (*Bot) EditMessageLiveLocation ¶

func (bot *Bot) EditMessageLiveLocation(latitude float64, longitude float64, opts *EditMessageLiveLocationOpts) (*Message, bool, error)

EditMessageLiveLocation (https://core.telegram.org/bots/api#editmessagelivelocation)

Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

• latitude (type float64): Latitude of new location
• longitude (type float64): Longitude of new location
• opts (type EditMessageLiveLocationOpts): All optional parameters.

func (*Bot) EditMessageMedia ¶

func (bot *Bot) EditMessageMedia(media InputMedia, opts *EditMessageMediaOpts) (*Message, bool, error)

EditMessageMedia (https://core.telegram.org/bots/api#editmessagemedia)

Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

• media (type InputMedia): A JSON-serialized object for a new media content of the message
• opts (type EditMessageMediaOpts): All optional parameters.

func (*Bot) EditMessageReplyMarkup ¶

func (bot *Bot) EditMessageReplyMarkup(opts *EditMessageReplyMarkupOpts) (*Message, bool, error)

EditMessageReplyMarkup (https://core.telegram.org/bots/api#editmessagereplymarkup)

Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

• opts (type EditMessageReplyMarkupOpts): All optional parameters.

func (*Bot) EditMessageText ¶

func (bot *Bot) EditMessageText(text string, opts *EditMessageTextOpts) (*Message, bool, error)

EditMessageText (https://core.telegram.org/bots/api#editmessagetext)

Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

• text (type string): New text of the message, 1-4096 characters after entities parsing
• opts (type EditMessageTextOpts): All optional parameters.

func (*Bot) ExportChatInviteLink ¶

func (bot *Bot) ExportChatInviteLink(chatId int64, opts *ExportChatInviteLinkOpts) (string, error)

ExportChatInviteLink (https://core.telegram.org/bots/api#exportchatinvitelink)

Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• opts (type ExportChatInviteLinkOpts): All optional parameters.

func (*Bot) ForwardMessage ¶

func (bot *Bot) ForwardMessage(chatId int64, fromChatId int64, messageId int64, opts *ForwardMessageOpts) (*Message, error)

ForwardMessage (https://core.telegram.org/bots/api#forwardmessage)

Use this method to forward messages of any kind. Service messages and messages with protected content can't be forwarded. On success, the sent Message is returned.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• fromChatId (type int64): Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)
• messageId (type int64): Message identifier in the chat specified in from_chat_id
• opts (type ForwardMessageOpts): All optional parameters.

func (*Bot) ForwardMessages ¶

func (bot *Bot) ForwardMessages(chatId int64, fromChatId int64, messageIds []int64, opts *ForwardMessagesOpts) ([]MessageId, error)

ForwardMessages (https://core.telegram.org/bots/api#forwardmessages)

Use this method to forward multiple messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content can't be forwarded. Album grouping is kept for forwarded messages. On success, an array of MessageId of the sent messages is returned.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• fromChatId (type int64): Unique identifier for the chat where the original messages were sent (or channel username in the format @channelusername)
• messageIds (type []int64): Identifiers of 1-100 messages in the chat from_chat_id to forward. The identifiers must be specified in a strictly increasing order.
• opts (type ForwardMessagesOpts): All optional parameters.

func (*Bot) GetChat ¶

func (bot *Bot) GetChat(chatId int64, opts *GetChatOpts) (*Chat, error)

GetChat (https://core.telegram.org/bots/api#getchat)

Use this method to get up to date information about the chat. Returns a Chat object on success.

• chatId (type int64): Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)
• opts (type GetChatOpts): All optional parameters.

func (*Bot) GetChatAdministrators ¶

func (bot *Bot) GetChatAdministrators(chatId int64, opts *GetChatAdministratorsOpts) ([]ChatMember, error)

GetChatAdministrators (https://core.telegram.org/bots/api#getchatadministrators)

Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of ChatMember objects.

• chatId (type int64): Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)
• opts (type GetChatAdministratorsOpts): All optional parameters.

func (*Bot) GetChatMember ¶

func (bot *Bot) GetChatMember(chatId int64, userId int64, opts *GetChatMemberOpts) (ChatMember, error)

GetChatMember (https://core.telegram.org/bots/api#getchatmember)

Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a ChatMember object on success.

• chatId (type int64): Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)
• userId (type int64): Unique identifier of the target user
• opts (type GetChatMemberOpts): All optional parameters.

func (*Bot) GetChatMemberCount ¶

func (bot *Bot) GetChatMemberCount(chatId int64, opts *GetChatMemberCountOpts) (int64, error)

GetChatMemberCount (https://core.telegram.org/bots/api#getchatmembercount)

Use this method to get the number of members in a chat. Returns Int on success.

• chatId (type int64): Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)
• opts (type GetChatMemberCountOpts): All optional parameters.

func (*Bot) GetChatMenuButton ¶

func (bot *Bot) GetChatMenuButton(opts *GetChatMenuButtonOpts) (MenuButton, error)

GetChatMenuButton (https://core.telegram.org/bots/api#getchatmenubutton)

Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns MenuButton on success.

• opts (type GetChatMenuButtonOpts): All optional parameters.

func (*Bot) GetCustomEmojiStickers ¶

func (bot *Bot) GetCustomEmojiStickers(customEmojiIds []string, opts *GetCustomEmojiStickersOpts) ([]Sticker, error)

GetCustomEmojiStickers (https://core.telegram.org/bots/api#getcustomemojistickers)

Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.

• customEmojiIds (type []string): List of custom emoji identifiers. At most 200 custom emoji identifiers can be specified.
• opts (type GetCustomEmojiStickersOpts): All optional parameters.

func (*Bot) GetFile ¶

func (bot *Bot) GetFile(fileId string, opts *GetFileOpts) (*File, error)

GetFile (https://core.telegram.org/bots/api#getfile)

Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile again. Note: This function may not preserve the original file name and MIME type. You should save the file's MIME type and name (if available) when the File object is received.

• fileId (type string): File identifier to get information about
• opts (type GetFileOpts): All optional parameters.

func (*Bot) GetForumTopicIconStickers ¶

func (bot *Bot) GetForumTopicIconStickers(opts *GetForumTopicIconStickersOpts) ([]Sticker, error)

GetForumTopicIconStickers (https://core.telegram.org/bots/api#getforumtopiciconstickers)

Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of Sticker objects.

• opts (type GetForumTopicIconStickersOpts): All optional parameters.

func (*Bot) GetGameHighScores ¶

func (bot *Bot) GetGameHighScores(userId int64, opts *GetGameHighScoresOpts) ([]GameHighScore, error)

GetGameHighScores (https://core.telegram.org/bots/api#getgamehighscores)

Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. Returns an Array of GameHighScore objects.

• userId (type int64): Target user id
• opts (type GetGameHighScoresOpts): All optional parameters.

func (*Bot) GetMe ¶

func (bot *Bot) GetMe(opts *GetMeOpts) (*User, error)

GetMe (https://core.telegram.org/bots/api#getme)

A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a User object.

• opts (type GetMeOpts): All optional parameters.

func (*Bot) GetMyCommands ¶

func (bot *Bot) GetMyCommands(opts *GetMyCommandsOpts) ([]BotCommand, error)

GetMyCommands (https://core.telegram.org/bots/api#getmycommands)

Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned.

• opts (type GetMyCommandsOpts): All optional parameters.

func (*Bot) GetMyDefaultAdministratorRights ¶

func (bot *Bot) GetMyDefaultAdministratorRights(opts *GetMyDefaultAdministratorRightsOpts) (*ChatAdministratorRights, error)

GetMyDefaultAdministratorRights (https://core.telegram.org/bots/api#getmydefaultadministratorrights)

Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.

• opts (type GetMyDefaultAdministratorRightsOpts): All optional parameters.

func (*Bot) GetMyDescription ¶

func (bot *Bot) GetMyDescription(opts *GetMyDescriptionOpts) (*BotDescription, error)

GetMyDescription (https://core.telegram.org/bots/api#getmydescription)

Use this method to get the current bot description for the given user language. Returns BotDescription on success.

• opts (type GetMyDescriptionOpts): All optional parameters.

func (*Bot) GetMyName ¶

func (bot *Bot) GetMyName(opts *GetMyNameOpts) (*BotName, error)

GetMyName (https://core.telegram.org/bots/api#getmyname)

Use this method to get the current bot name for the given user language. Returns BotName on success.

• opts (type GetMyNameOpts): All optional parameters.

func (*Bot) GetMyShortDescription ¶

func (bot *Bot) GetMyShortDescription(opts *GetMyShortDescriptionOpts) (*BotShortDescription, error)

GetMyShortDescription (https://core.telegram.org/bots/api#getmyshortdescription)

Use this method to get the current bot short description for the given user language. Returns BotShortDescription on success.

• opts (type GetMyShortDescriptionOpts): All optional parameters.

func (*Bot) GetStickerSet ¶

func (bot *Bot) GetStickerSet(name string, opts *GetStickerSetOpts) (*StickerSet, error)

GetStickerSet (https://core.telegram.org/bots/api#getstickerset)

Use this method to get a sticker set. On success, a StickerSet object is returned.

• name (type string): Name of the sticker set
• opts (type GetStickerSetOpts): All optional parameters.

func (*Bot) GetUpdates ¶

func (bot *Bot) GetUpdates(opts *GetUpdatesOpts) ([]Update, error)

GetUpdates (https://core.telegram.org/bots/api#getupdates)

Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.

• opts (type GetUpdatesOpts): All optional parameters.

func (*Bot) GetUserChatBoosts ¶

func (bot *Bot) GetUserChatBoosts(chatId int64, userId int64, opts *GetUserChatBoostsOpts) (*UserChatBoosts, error)

GetUserChatBoosts (https://core.telegram.org/bots/api#getuserchatboosts)

Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a UserChatBoosts object.

• chatId (type int64): Unique identifier for the chat or username of the channel (in the format @channelusername)
• userId (type int64): Unique identifier of the target user
• opts (type GetUserChatBoostsOpts): All optional parameters.

func (*Bot) GetUserProfilePhotos ¶

func (bot *Bot) GetUserProfilePhotos(userId int64, opts *GetUserProfilePhotosOpts) (*UserProfilePhotos, error)

GetUserProfilePhotos (https://core.telegram.org/bots/api#getuserprofilephotos)

Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.

• userId (type int64): Unique identifier of the target user
• opts (type GetUserProfilePhotosOpts): All optional parameters.

func (*Bot) GetWebhookInfo ¶

func (bot *Bot) GetWebhookInfo(opts *GetWebhookInfoOpts) (*WebhookInfo, error)

GetWebhookInfo (https://core.telegram.org/bots/api#getwebhookinfo)

Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.

• opts (type GetWebhookInfoOpts): All optional parameters.

func (*Bot) HideGeneralForumTopic ¶

func (bot *Bot) HideGeneralForumTopic(chatId int64, opts *HideGeneralForumTopicOpts) (bool, error)

HideGeneralForumTopic (https://core.telegram.org/bots/api#hidegeneralforumtopic)

Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
• opts (type HideGeneralForumTopicOpts): All optional parameters.

func (*Bot) LeaveChat ¶

func (bot *Bot) LeaveChat(chatId int64, opts *LeaveChatOpts) (bool, error)

LeaveChat (https://core.telegram.org/bots/api#leavechat)

Use this method for your bot to leave a group, supergroup or channel. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)
• opts (type LeaveChatOpts): All optional parameters.

func (*Bot) LogOut ¶

func (bot *Bot) LogOut(opts *LogOutOpts) (bool, error)

LogOut (https://core.telegram.org/bots/api#logout)

Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.

• opts (type LogOutOpts): All optional parameters.

func (*Bot) PinChatMessage ¶

func (bot *Bot) PinChatMessage(chatId int64, messageId int64, opts *PinChatMessageOpts) (bool, error)

PinChatMessage (https://core.telegram.org/bots/api#pinchatmessage)

Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• messageId (type int64): Identifier of a message to pin
• opts (type PinChatMessageOpts): All optional parameters.

func (*Bot) PromoteChatMember ¶

func (bot *Bot) PromoteChatMember(chatId int64, userId int64, opts *PromoteChatMemberOpts) (bool, error)

PromoteChatMember (https://core.telegram.org/bots/api#promotechatmember)

Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• userId (type int64): Unique identifier of the target user
• opts (type PromoteChatMemberOpts): All optional parameters.

func (*Bot) ReopenForumTopic ¶

func (bot *Bot) ReopenForumTopic(chatId int64, messageThreadId int64, opts *ReopenForumTopicOpts) (bool, error)

ReopenForumTopic (https://core.telegram.org/bots/api#reopenforumtopic)

Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
• messageThreadId (type int64): Unique identifier for the target message thread of the forum topic
• opts (type ReopenForumTopicOpts): All optional parameters.

func (*Bot) ReopenGeneralForumTopic ¶

func (bot *Bot) ReopenGeneralForumTopic(chatId int64, opts *ReopenGeneralForumTopicOpts) (bool, error)

ReopenGeneralForumTopic (https://core.telegram.org/bots/api#reopengeneralforumtopic)

Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
• opts (type ReopenGeneralForumTopicOpts): All optional parameters.

func (*Bot) Request ¶

func (bot *Bot) Request(method string, params map[string]string, data map[string]NamedReader, opts *RequestOpts) (json.RawMessage, error)

func (*Bot) RestrictChatMember ¶

func (bot *Bot) RestrictChatMember(chatId int64, userId int64, permissions ChatPermissions, opts *RestrictChatMemberOpts) (bool, error)

RestrictChatMember (https://core.telegram.org/bots/api#restrictchatmember)

Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
• userId (type int64): Unique identifier of the target user
• permissions (type ChatPermissions): A JSON-serialized object for new user permissions
• opts (type RestrictChatMemberOpts): All optional parameters.

func (*Bot) RevokeChatInviteLink ¶

func (bot *Bot) RevokeChatInviteLink(chatId int64, inviteLink string, opts *RevokeChatInviteLinkOpts) (*ChatInviteLink, error)

RevokeChatInviteLink (https://core.telegram.org/bots/api#revokechatinvitelink)

Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object.

• chatId (type int64): Unique identifier of the target chat or username of the target channel (in the format @channelusername)
• inviteLink (type string): The invite link to revoke
• opts (type RevokeChatInviteLinkOpts): All optional parameters.

func (*Bot) SendAnimation ¶

func (bot *Bot) SendAnimation(chatId int64, animation InputFile, opts *SendAnimationOpts) (*Message, error)

SendAnimation (https://core.telegram.org/bots/api#sendanimation)

Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• animation (type InputFile): Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. More information on Sending Files: https://core.telegram.org/bots/api#sending-files
• opts (type SendAnimationOpts): All optional parameters.

func (*Bot) SendAudio ¶

func (bot *Bot) SendAudio(chatId int64, audio InputFile, opts *SendAudioOpts) (*Message, error)

SendAudio (https://core.telegram.org/bots/api#sendaudio)

Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future. For sending voice messages, use the sendVoice method instead.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• audio (type InputFile): Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files: https://core.telegram.org/bots/api#sending-files
• opts (type SendAudioOpts): All optional parameters.

func (*Bot) SendChatAction ¶

func (bot *Bot) SendChatAction(chatId int64, action string, opts *SendChatActionOpts) (bool, error)

SendChatAction (https://core.telegram.org/bots/api#sendchataction)

Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success. We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• action (type string): Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes.
• opts (type SendChatActionOpts): All optional parameters.

func (*Bot) SendContact ¶

func (bot *Bot) SendContact(chatId int64, phoneNumber string, firstName string, opts *SendContactOpts) (*Message, error)

SendContact (https://core.telegram.org/bots/api#sendcontact)

Use this method to send phone contacts. On success, the sent Message is returned.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• phoneNumber (type string): Contact's phone number
• firstName (type string): Contact's first name
• opts (type SendContactOpts): All optional parameters.

func (*Bot) SendDice ¶

func (bot *Bot) SendDice(chatId int64, opts *SendDiceOpts) (*Message, error)

SendDice (https://core.telegram.org/bots/api#senddice)

Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• opts (type SendDiceOpts): All optional parameters.

func (*Bot) SendDocument ¶

func (bot *Bot) SendDocument(chatId int64, document InputFile, opts *SendDocumentOpts) (*Message, error)

SendDocument (https://core.telegram.org/bots/api#senddocument)

Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• document (type InputFile): File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files: https://core.telegram.org/bots/api#sending-files
• opts (type SendDocumentOpts): All optional parameters.

func (*Bot) SendGame ¶

func (bot *Bot) SendGame(chatId int64, gameShortName string, opts *SendGameOpts) (*Message, error)

SendGame (https://core.telegram.org/bots/api#sendgame)

Use this method to send a game. On success, the sent Message is returned.

• chatId (type int64): Unique identifier for the target chat
• gameShortName (type string): Short name of the game, serves as the unique identifier for the game. Set up your games via @BotFather.
• opts (type SendGameOpts): All optional parameters.

func (*Bot) SendInvoice ¶

func (bot *Bot) SendInvoice(chatId int64, title string, description string, payload string, providerToken string, currency string, prices []LabeledPrice, opts *SendInvoiceOpts) (*Message, error)

SendInvoice (https://core.telegram.org/bots/api#sendinvoice)

Use this method to send invoices. On success, the sent Message is returned.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• title (type string): Product name, 1-32 characters
• description (type string): Product description, 1-255 characters
• payload (type string): Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.
• providerToken (type string): Payment provider token, obtained via @BotFather
• currency (type string): Three-letter ISO 4217 currency code, see more on currencies
• prices (type []LabeledPrice): Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)
• opts (type SendInvoiceOpts): All optional parameters.

func (*Bot) SendLocation ¶

func (bot *Bot) SendLocation(chatId int64, latitude float64, longitude float64, opts *SendLocationOpts) (*Message, error)

SendLocation (https://core.telegram.org/bots/api#sendlocation)

Use this method to send point on the map. On success, the sent Message is returned.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• latitude (type float64): Latitude of the location
• longitude (type float64): Longitude of the location
• opts (type SendLocationOpts): All optional parameters.

func (*Bot) SendMediaGroup ¶

func (bot *Bot) SendMediaGroup(chatId int64, media []InputMedia, opts *SendMediaGroupOpts) ([]Message, error)

SendMediaGroup (https://core.telegram.org/bots/api#sendmediagroup)

Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• media (type []InputMedia): A JSON-serialized array describing messages to be sent, must include 2-10 items
• opts (type SendMediaGroupOpts): All optional parameters.

func (*Bot) SendMessage ¶

func (bot *Bot) SendMessage(chatId int64, text string, opts *SendMessageOpts) (*Message, error)

SendMessage (https://core.telegram.org/bots/api#sendmessage)

Use this method to send text messages. On success, the sent Message is returned.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• text (type string): Text of the message to be sent, 1-4096 characters after entities parsing
• opts (type SendMessageOpts): All optional parameters.

func (*Bot) SendPhoto ¶

func (bot *Bot) SendPhoto(chatId int64, photo InputFile, opts *SendPhotoOpts) (*Message, error)

SendPhoto (https://core.telegram.org/bots/api#sendphoto)

Use this method to send photos. On success, the sent Message is returned.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• photo (type InputFile): Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. More information on Sending Files: https://core.telegram.org/bots/api#sending-files
• opts (type SendPhotoOpts): All optional parameters.

func (*Bot) SendPoll ¶

func (bot *Bot) SendPoll(chatId int64, question string, options []string, opts *SendPollOpts) (*Message, error)

SendPoll (https://core.telegram.org/bots/api#sendpoll)

Use this method to send a native poll. On success, the sent Message is returned.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• question (type string): Poll question, 1-300 characters
• options (type []string): A JSON-serialized list of answer options, 2-10 strings 1-100 characters each
• opts (type SendPollOpts): All optional parameters.

func (*Bot) SendSticker ¶

func (bot *Bot) SendSticker(chatId int64, sticker InputFile, opts *SendStickerOpts) (*Message, error)

SendSticker (https://core.telegram.org/bots/api#sendsticker)

Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent Message is returned.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• sticker (type InputFile): Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP sticker from the Internet, or upload a new .WEBP or .TGS sticker using multipart/form-data. More information on Sending Files: https://core.telegram.org/bots/api#sending-files. Video stickers can only be sent by a file_id. Animated stickers can't be sent via an HTTP URL.
• opts (type SendStickerOpts): All optional parameters.

func (*Bot) SendVenue ¶

func (bot *Bot) SendVenue(chatId int64, latitude float64, longitude float64, title string, address string, opts *SendVenueOpts) (*Message, error)

SendVenue (https://core.telegram.org/bots/api#sendvenue)

Use this method to send information about a venue. On success, the sent Message is returned.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• latitude (type float64): Latitude of the venue
• longitude (type float64): Longitude of the venue
• title (type string): Name of the venue
• address (type string): Address of the venue
• opts (type SendVenueOpts): All optional parameters.

func (*Bot) SendVideo ¶

func (bot *Bot) SendVideo(chatId int64, video InputFile, opts *SendVideoOpts) (*Message, error)

SendVideo (https://core.telegram.org/bots/api#sendvideo)

Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• video (type InputFile): Video to send. Pass a file_id as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data. More information on Sending Files: https://core.telegram.org/bots/api#sending-files
• opts (type SendVideoOpts): All optional parameters.

func (*Bot) SendVideoNote ¶

func (bot *Bot) SendVideoNote(chatId int64, videoNote InputFile, opts *SendVideoNoteOpts) (*Message, error)

SendVideoNote (https://core.telegram.org/bots/api#sendvideonote)

As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• videoNote (type InputFile): Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files: https://core.telegram.org/bots/api#sending-files. Sending video notes by a URL is currently unsupported
• opts (type SendVideoNoteOpts): All optional parameters.

func (*Bot) SendVoice ¶

func (bot *Bot) SendVoice(chatId int64, voice InputFile, opts *SendVoiceOpts) (*Message, error)

SendVoice (https://core.telegram.org/bots/api#sendvoice)

Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• voice (type InputFile): Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files: https://core.telegram.org/bots/api#sending-files
• opts (type SendVoiceOpts): All optional parameters.

func (*Bot) SetChatAdministratorCustomTitle ¶

func (bot *Bot) SetChatAdministratorCustomTitle(chatId int64, userId int64, customTitle string, opts *SetChatAdministratorCustomTitleOpts) (bool, error)

SetChatAdministratorCustomTitle (https://core.telegram.org/bots/api#setchatadministratorcustomtitle)

Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
• userId (type int64): Unique identifier of the target user
• customTitle (type string): New custom title for the administrator; 0-16 characters, emoji are not allowed
• opts (type SetChatAdministratorCustomTitleOpts): All optional parameters.

func (*Bot) SetChatDescription ¶

func (bot *Bot) SetChatDescription(chatId int64, opts *SetChatDescriptionOpts) (bool, error)

SetChatDescription (https://core.telegram.org/bots/api#setchatdescription)

Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• opts (type SetChatDescriptionOpts): All optional parameters.

func (*Bot) SetChatMenuButton ¶

func (bot *Bot) SetChatMenuButton(opts *SetChatMenuButtonOpts) (bool, error)

SetChatMenuButton (https://core.telegram.org/bots/api#setchatmenubutton)

Use this method to change the bot's menu button in a private chat, or the default menu button. Returns True on success.

• opts (type SetChatMenuButtonOpts): All optional parameters.

func (*Bot) SetChatPermissions ¶

func (bot *Bot) SetChatPermissions(chatId int64, permissions ChatPermissions, opts *SetChatPermissionsOpts) (bool, error)

SetChatPermissions (https://core.telegram.org/bots/api#setchatpermissions)

Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
• permissions (type ChatPermissions): A JSON-serialized object for new default chat permissions
• opts (type SetChatPermissionsOpts): All optional parameters.

func (*Bot) SetChatPhoto ¶

func (bot *Bot) SetChatPhoto(chatId int64, photo InputFile, opts *SetChatPhotoOpts) (bool, error)

SetChatPhoto (https://core.telegram.org/bots/api#setchatphoto)

Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• photo (type InputFile): New chat photo, uploaded using multipart/form-data
• opts (type SetChatPhotoOpts): All optional parameters.

func (*Bot) SetChatStickerSet ¶

func (bot *Bot) SetChatStickerSet(chatId int64, stickerSetName string, opts *SetChatStickerSetOpts) (bool, error)

SetChatStickerSet (https://core.telegram.org/bots/api#setchatstickerset)

Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
• stickerSetName (type string): Name of the sticker set to be set as the group sticker set
• opts (type SetChatStickerSetOpts): All optional parameters.

func (*Bot) SetChatTitle ¶

func (bot *Bot) SetChatTitle(chatId int64, title string, opts *SetChatTitleOpts) (bool, error)

SetChatTitle (https://core.telegram.org/bots/api#setchattitle)

Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• title (type string): New chat title, 1-128 characters
• opts (type SetChatTitleOpts): All optional parameters.

func (*Bot) SetCustomEmojiStickerSetThumbnail ¶

func (bot *Bot) SetCustomEmojiStickerSetThumbnail(name string, opts *SetCustomEmojiStickerSetThumbnailOpts) (bool, error)

SetCustomEmojiStickerSetThumbnail (https://core.telegram.org/bots/api#setcustomemojistickersetthumbnail)

Use this method to set the thumbnail of a custom emoji sticker set. Returns True on success.

• name (type string): Sticker set name
• opts (type SetCustomEmojiStickerSetThumbnailOpts): All optional parameters.

func (*Bot) SetGameScore ¶

func (bot *Bot) SetGameScore(userId int64, score int64, opts *SetGameScoreOpts) (*Message, bool, error)

SetGameScore (https://core.telegram.org/bots/api#setgamescore)

Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.

• userId (type int64): User identifier
• score (type int64): New score, must be non-negative
• opts (type SetGameScoreOpts): All optional parameters.

func (*Bot) SetMessageReaction ¶

func (bot *Bot) SetMessageReaction(chatId int64, messageId int64, opts *SetMessageReactionOpts) (bool, error)

SetMessageReaction (https://core.telegram.org/bots/api#setmessagereaction)

Use this method to change the chosen reactions on a message. Service messages can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• messageId (type int64): Identifier of the target message. If the message belongs to a media group, the reaction is set to the first non-deleted message in the group instead.
• opts (type SetMessageReactionOpts): All optional parameters.

func (*Bot) SetMyCommands ¶

func (bot *Bot) SetMyCommands(commands []BotCommand, opts *SetMyCommandsOpts) (bool, error)

SetMyCommands (https://core.telegram.org/bots/api#setmycommands)

Use this method to change the list of the bot's commands. See this manual for more details about bot commands. Returns True on success.

• commands (type []BotCommand): A JSON-serialized list of bot commands to be set as the list of the bot's commands. At most 100 commands can be specified.
• opts (type SetMyCommandsOpts): All optional parameters.

func (*Bot) SetMyDefaultAdministratorRights ¶

func (bot *Bot) SetMyDefaultAdministratorRights(opts *SetMyDefaultAdministratorRightsOpts) (bool, error)

SetMyDefaultAdministratorRights (https://core.telegram.org/bots/api#setmydefaultadministratorrights)

Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are free to modify the list before adding the bot. Returns True on success.

• opts (type SetMyDefaultAdministratorRightsOpts): All optional parameters.

func (*Bot) SetMyDescription ¶

func (bot *Bot) SetMyDescription(opts *SetMyDescriptionOpts) (bool, error)

SetMyDescription (https://core.telegram.org/bots/api#setmydescription)

Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. Returns True on success.

• opts (type SetMyDescriptionOpts): All optional parameters.

func (*Bot) SetMyName ¶

func (bot *Bot) SetMyName(opts *SetMyNameOpts) (bool, error)

SetMyName (https://core.telegram.org/bots/api#setmyname)

Use this method to change the bot's name. Returns True on success.

• opts (type SetMyNameOpts): All optional parameters.

func (*Bot) SetMyShortDescription ¶

func (bot *Bot) SetMyShortDescription(opts *SetMyShortDescriptionOpts) (bool, error)

SetMyShortDescription (https://core.telegram.org/bots/api#setmyshortdescription)

Use this method to 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. Returns True on success.

• opts (type SetMyShortDescriptionOpts): All optional parameters.

func (*Bot) SetPassportDataErrors ¶

func (bot *Bot) SetPassportDataErrors(userId int64, errors []PassportElementError, opts *SetPassportDataErrorsOpts) (bool, error)

SetPassportDataErrors (https://core.telegram.org/bots/api#setpassportdataerrors)

Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success. Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.

• userId (type int64): User identifier
• errors (type []PassportElementError): A JSON-serialized array describing the errors
• opts (type SetPassportDataErrorsOpts): All optional parameters.

func (*Bot) SetStickerEmojiList ¶

func (bot *Bot) SetStickerEmojiList(sticker string, emojiList []string, opts *SetStickerEmojiListOpts) (bool, error)

SetStickerEmojiList (https://core.telegram.org/bots/api#setstickeremojilist)

Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.

• sticker (type string): File identifier of the sticker
• emojiList (type []string): A JSON-serialized list of 1-20 emoji associated with the sticker
• opts (type SetStickerEmojiListOpts): All optional parameters.

func (*Bot) SetStickerKeywords ¶

func (bot *Bot) SetStickerKeywords(sticker string, opts *SetStickerKeywordsOpts) (bool, error)

SetStickerKeywords (https://core.telegram.org/bots/api#setstickerkeywords)

Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.

• sticker (type string): File identifier of the sticker
• opts (type SetStickerKeywordsOpts): All optional parameters.

func (*Bot) SetStickerMaskPosition ¶

func (bot *Bot) SetStickerMaskPosition(sticker string, opts *SetStickerMaskPositionOpts) (bool, error)

SetStickerMaskPosition (https://core.telegram.org/bots/api#setstickermaskposition)

Use this method to change the mask position of a mask sticker. The sticker must belong to a sticker set that was created by the bot. Returns True on success.

• sticker (type string): File identifier of the sticker
• opts (type SetStickerMaskPositionOpts): All optional parameters.

func (*Bot) SetStickerPositionInSet ¶

func (bot *Bot) SetStickerPositionInSet(sticker string, position int64, opts *SetStickerPositionInSetOpts) (bool, error)

SetStickerPositionInSet (https://core.telegram.org/bots/api#setstickerpositioninset)

Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.

• sticker (type string): File identifier of the sticker
• position (type int64): New sticker position in the set, zero-based
• opts (type SetStickerPositionInSetOpts): All optional parameters.

func (*Bot) SetStickerSetThumbnail ¶

func (bot *Bot) SetStickerSetThumbnail(name string, userId int64, opts *SetStickerSetThumbnailOpts) (bool, error)

SetStickerSetThumbnail (https://core.telegram.org/bots/api#setstickersetthumbnail)

Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns True on success.

• name (type string): Sticker set name
• userId (type int64): User identifier of the sticker set owner
• opts (type SetStickerSetThumbnailOpts): All optional parameters.

func (*Bot) SetStickerSetTitle ¶

func (bot *Bot) SetStickerSetTitle(name string, title string, opts *SetStickerSetTitleOpts) (bool, error)

SetStickerSetTitle (https://core.telegram.org/bots/api#setstickersettitle)

Use this method to set the title of a created sticker set. Returns True on success.

• name (type string): Sticker set name
• title (type string): Sticker set title, 1-64 characters
• opts (type SetStickerSetTitleOpts): All optional parameters.

func (*Bot) SetWebhook ¶

func (bot *Bot) SetWebhook(url string, opts *SetWebhookOpts) (bool, error)

SetWebhook (https://core.telegram.org/bots/api#setwebhook)

Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success. If you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header "X-Telegram-Bot-Api-Secret-Token" with the secret token as content.

• url (type string): HTTPS URL to send updates to. Use an empty string to remove webhook integration
• opts (type SetWebhookOpts): All optional parameters.

func (*Bot) StopMessageLiveLocation ¶

func (bot *Bot) StopMessageLiveLocation(opts *StopMessageLiveLocationOpts) (*Message, bool, error)

StopMessageLiveLocation (https://core.telegram.org/bots/api#stopmessagelivelocation)

Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.

• opts (type StopMessageLiveLocationOpts): All optional parameters.

func (*Bot) StopPoll ¶

func (bot *Bot) StopPoll(chatId int64, messageId int64, opts *StopPollOpts) (*Poll, error)

StopPoll (https://core.telegram.org/bots/api#stoppoll)

Use this method to stop a poll which was sent by the bot. On success, the stopped Poll is returned.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• messageId (type int64): Identifier of the original message with the poll
• opts (type StopPollOpts): All optional parameters.

func (*Bot) UnbanChatMember ¶

func (bot *Bot) UnbanChatMember(chatId int64, userId int64, opts *UnbanChatMemberOpts) (bool, error)

UnbanChatMember (https://core.telegram.org/bots/api#unbanchatmember)

Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success.

• chatId (type int64): Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername)
• userId (type int64): Unique identifier of the target user
• opts (type UnbanChatMemberOpts): All optional parameters.

func (*Bot) UnbanChatSenderChat ¶

func (bot *Bot) UnbanChatSenderChat(chatId int64, senderChatId int64, opts *UnbanChatSenderChatOpts) (bool, error)

UnbanChatSenderChat (https://core.telegram.org/bots/api#unbanchatsenderchat)

Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• senderChatId (type int64): Unique identifier of the target sender chat
• opts (type UnbanChatSenderChatOpts): All optional parameters.

func (*Bot) UnhideGeneralForumTopic ¶

func (bot *Bot) UnhideGeneralForumTopic(chatId int64, opts *UnhideGeneralForumTopicOpts) (bool, error)

UnhideGeneralForumTopic (https://core.telegram.org/bots/api#unhidegeneralforumtopic)

Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
• opts (type UnhideGeneralForumTopicOpts): All optional parameters.

func (*Bot) UnpinAllChatMessages ¶

func (bot *Bot) UnpinAllChatMessages(chatId int64, opts *UnpinAllChatMessagesOpts) (bool, error)

UnpinAllChatMessages (https://core.telegram.org/bots/api#unpinallchatmessages)

Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• opts (type UnpinAllChatMessagesOpts): All optional parameters.

func (*Bot) UnpinAllForumTopicMessages ¶

func (bot *Bot) UnpinAllForumTopicMessages(chatId int64, messageThreadId int64, opts *UnpinAllForumTopicMessagesOpts) (bool, error)

UnpinAllForumTopicMessages (https://core.telegram.org/bots/api#unpinallforumtopicmessages)

Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
• messageThreadId (type int64): Unique identifier for the target message thread of the forum topic
• opts (type UnpinAllForumTopicMessagesOpts): All optional parameters.

func (*Bot) UnpinAllGeneralForumTopicMessages ¶

func (bot *Bot) UnpinAllGeneralForumTopicMessages(chatId int64, opts *UnpinAllGeneralForumTopicMessagesOpts) (bool, error)

UnpinAllGeneralForumTopicMessages (https://core.telegram.org/bots/api#unpinallgeneralforumtopicmessages)

Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
• opts (type UnpinAllGeneralForumTopicMessagesOpts): All optional parameters.

func (*Bot) UnpinChatMessage ¶

func (bot *Bot) UnpinChatMessage(chatId int64, opts *UnpinChatMessageOpts) (bool, error)

UnpinChatMessage (https://core.telegram.org/bots/api#unpinchatmessage)

Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.

• chatId (type int64): Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• opts (type UnpinChatMessageOpts): All optional parameters.

func (*Bot) UploadStickerFile ¶

func (bot *Bot) UploadStickerFile(userId int64, sticker InputFile, stickerFormat string, opts *UploadStickerFileOpts) (*File, error)

UploadStickerFile (https://core.telegram.org/bots/api#uploadstickerfile)

Use this method to upload a file with a sticker for later use in the createNewStickerSet and addStickerToSet methods (the file can be used multiple times). Returns the uploaded File on success.

• userId (type int64): User identifier of sticker file owner
• sticker (type InputFile): A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format. See https://core.telegram.org/stickers for technical requirements. More information on Sending Files: https://core.telegram.org/bots/api#sending-files
• stickerFormat (type string): Format of the sticker, must be one of "static", "animated", "video"
• opts (type UploadStickerFileOpts): All optional parameters.

func (BotCommandScopeAllChatAdministrators) GetType ¶

func (v BotCommandScopeAllChatAdministrators) GetType() string

GetType is a helper method to easily access the common fields of an interface.

func (BotCommandScopeAllChatAdministrators) MarshalJSON ¶

func (v BotCommandScopeAllChatAdministrators) MarshalJSON() ([]byte, error)

MarshalJSON is a custom JSON marshaller to allow for enforcing the Type value.

func (BotCommandScopeAllChatAdministrators) MergeBotCommandScope ¶

func (v BotCommandScopeAllChatAdministrators) MergeBotCommandScope() MergedBotCommandScope

MergeBotCommandScope returns a MergedBotCommandScope struct to simplify working with types in a non-generic world.

func (BotCommandScopeAllGroupChats) GetType ¶

func (v BotCommandScopeAllGroupChats) GetType() string

GetType is a helper method to easily access the common fields of an interface.

func (BotCommandScopeAllGroupChats) MarshalJSON ¶

func (v BotCommandScopeAllGroupChats) MarshalJSON() ([]byte, error)

MarshalJSON is a custom JSON marshaller to allow for enforcing the Type value.

func (BotCommandScopeAllGroupChats) MergeBotCommandScope ¶

func (v BotCommandScopeAllGroupChats) MergeBotCommandScope() MergedBotCommandScope

MergeBotCommandScope returns a MergedBotCommandScope struct to simplify working with types in a non-generic world.

func (BotCommandScopeAllPrivateChats) GetType ¶

func (v BotCommandScopeAllPrivateChats) GetType() string

GetType is a helper method to easily access the common fields of an interface.

func (BotCommandScopeAllPrivateChats) MarshalJSON ¶

func (v BotCommandScopeAllPrivateChats) MarshalJSON() ([]byte, error)

MarshalJSON is a custom JSON marshaller to allow for enforcing the Type value.

func (BotCommandScopeAllPrivateChats) MergeBotCommandScope ¶

func (v BotCommandScopeAllPrivateChats) MergeBotCommandScope() MergedBotCommandScope

MergeBotCommandScope returns a MergedBotCommandScope struct to simplify working with types in a non-generic world.

func (BotCommandScopeChat) GetType ¶

func (v BotCommandScopeChat) GetType() string

GetType is a helper method to easily access the common fields of an interface.

func (BotCommandScopeChat) MarshalJSON ¶

func (v BotCommandScopeChat) MarshalJSON() ([]byte, error)

MarshalJSON is a custom JSON marshaller to allow for enforcing the Type value.

func (BotCommandScopeChat) MergeBotCommandScope ¶

func (v BotCommandScopeChat) MergeBotCommandScope() MergedBotCommandScope

MergeBotCommandScope returns a MergedBotCommandScope struct to simplify working with types in a non-generic world.

func (BotCommandScopeChatAdministrators) GetType ¶

func (v BotCommandScopeChatAdministrators) GetType() string

GetType is a helper method to easily access the common fields of an interface.

func (BotCommandScopeChatAdministrators) MarshalJSON ¶

func (v BotCommandScopeChatAdministrators) MarshalJSON() ([]byte, error)

MarshalJSON is a custom JSON marshaller to allow for enforcing the Type value.

func (BotCommandScopeChatAdministrators) MergeBotCommandScope ¶

func (v BotCommandScopeChatAdministrators) MergeBotCommandScope() MergedBotCommandScope

MergeBotCommandScope returns a MergedBotCommandScope struct to simplify working with types in a non-generic world.

func (BotCommandScopeChatMember) GetType ¶

func (v BotCommandScopeChatMember) GetType() string

GetType is a helper method to easily access the common fields of an interface.

func (BotCommandScopeChatMember) MarshalJSON ¶

func (v BotCommandScopeChatMember) MarshalJSON() ([]byte, error)

MarshalJSON is a custom JSON marshaller to allow for enforcing the Type value.

func (BotCommandScopeChatMember) MergeBotCommandScope ¶

func (v BotCommandScopeChatMember) MergeBotCommandScope() MergedBotCommandScope

MergeBotCommandScope returns a MergedBotCommandScope struct to simplify working with types in a non-generic world.

func (BotCommandScopeDefault) GetType ¶

func (v BotCommandScopeDefault) GetType() string

GetType is a helper method to easily access the common fields of an interface.

func (BotCommandScopeDefault) MarshalJSON ¶

func (v BotCommandScopeDefault) MarshalJSON() ([]byte, error)

MarshalJSON is a custom JSON marshaller to allow for enforcing the Type value.

func (BotCommandScopeDefault) MergeBotCommandScope ¶

func (v BotCommandScopeDefault) MergeBotCommandScope() MergedBotCommandScope

MergeBotCommandScope returns a MergedBotCommandScope struct to simplify working with types in a non-generic world.

func (CallbackQuery) Answer ¶

func (cq CallbackQuery) Answer(b *Bot, opts *AnswerCallbackQueryOpts) (bool, error)

Answer Helper method for Bot.AnswerCallbackQuery.

func (*CallbackQuery) UnmarshalJSON ¶

func (v *CallbackQuery) UnmarshalJSON(b []byte) error

UnmarshalJSON is a custom JSON unmarshaller to use the helpers which allow for unmarshalling structs into interfaces.

func (Chat) ApproveJoinRequest ¶

func (c Chat) ApproveJoinRequest(b *Bot, userId int64, opts *ApproveChatJoinRequestOpts) (bool, error)

ApproveJoinRequest Helper method for Bot.ApproveChatJoinRequest.

func (Chat) BanMember ¶

func (c Chat) BanMember(b *Bot, userId int64, opts *BanChatMemberOpts) (bool, error)

BanMember Helper method for Bot.BanChatMember.

func (Chat) BanSenderChat ¶

func (c Chat) BanSenderChat(b *Bot, senderChatId int64, opts *BanChatSenderChatOpts) (bool, error)

BanSenderChat Helper method for Bot.BanChatSenderChat.

func (Chat) CreateInviteLink ¶

func (c Chat) CreateInviteLink(b *Bot, opts *CreateChatInviteLinkOpts) (*ChatInviteLink, error)

CreateInviteLink Helper method for Bot.CreateChatInviteLink.

func (Chat) DeclineJoinRequest ¶

func (c Chat) DeclineJoinRequest(b *Bot, userId int64, opts *DeclineChatJoinRequestOpts) (bool, error)

DeclineJoinRequest Helper method for Bot.DeclineChatJoinRequest.

func (Chat) DeletePhoto ¶

func (c Chat) DeletePhoto(b *Bot, opts *DeleteChatPhotoOpts) (bool, error)

DeletePhoto Helper method for Bot.DeleteChatPhoto.

func (Chat) DeleteStickerSet ¶

func (c Chat) DeleteStickerSet(b *Bot, opts *DeleteChatStickerSetOpts) (bool, error)

DeleteStickerSet Helper method for Bot.DeleteChatStickerSet.

func (Chat) EditInviteLink ¶

func (c Chat) EditInviteLink(b *Bot, inviteLink string, opts *EditChatInviteLinkOpts) (*ChatInviteLink, error)

EditInviteLink Helper method for Bot.EditChatInviteLink.

func (Chat) ExportInviteLink ¶

func (c Chat) ExportInviteLink(b *Bot, opts *ExportChatInviteLinkOpts) (string, error)

ExportInviteLink Helper method for Bot.ExportChatInviteLink.

func (Chat) Get ¶

func (c Chat) Get(b *Bot, opts *GetChatOpts) (*Chat, error)

Get Helper method for Bot.GetChat.

func (Chat) GetAdministrators ¶

func (c Chat) GetAdministrators(b *Bot, opts *GetChatAdministratorsOpts) ([]ChatMember, error)

GetAdministrators Helper method for Bot.GetChatAdministrators.

func (Chat) GetMember ¶

func (c Chat) GetMember(b *Bot, userId int64, opts *GetChatMemberOpts) (ChatMember, error)

GetMember Helper method for Bot.GetChatMember.

func (Chat) GetMemberCount ¶

func (c Chat) GetMemberCount(b *Bot, opts *GetChatMemberCountOpts) (int64, error)

GetMemberCount Helper method for Bot.GetChatMemberCount.

func (Chat) GetMenuButton ¶

func (c Chat) GetMenuButton(b *Bot, opts *GetChatMenuButtonOpts) (MenuButton, error)

GetMenuButton Helper method for Bot.GetChatMenuButton.

func (Chat) GetUserBoosts ¶

func (c Chat) GetUserBoosts(b *Bot, userId int64, opts *GetUserChatBoostsOpts) (*UserChatBoosts, error)

GetUserBoosts Helper method for Bot.GetUserChatBoosts.

func (Chat) Leave ¶

func (c Chat) Leave(b *Bot, opts *LeaveChatOpts) (bool, error)

Leave Helper method for Bot.LeaveChat.

func (Chat) PinMessage ¶

func (c Chat) PinMessage(b *Bot, messageId int64, opts *PinChatMessageOpts) (bool, error)

PinMessage Helper method for Bot.PinChatMessage.

func (Chat) Promote ¶

func (c Chat) Promote(b *Bot, userId int64, opts *PromoteChatMemberOpts) (bool, error)

Promote is a helper function to easily call Bot.PromoteChatMember in a chat.

func (Chat) PromoteMember ¶

func (c Chat) PromoteMember(b *Bot, userId int64, opts *PromoteChatMemberOpts) (bool, error)

PromoteMember Helper method for Bot.PromoteChatMember.

func (Chat) RestrictMember ¶

func (c Chat) RestrictMember(b *Bot, userId int64, permissions ChatPermissions, opts *RestrictChatMemberOpts) (bool, error)

RestrictMember Helper method for Bot.RestrictChatMember.

func (Chat) RevokeInviteLink ¶

func (c Chat) RevokeInviteLink(b *Bot, inviteLink string, opts *RevokeChatInviteLinkOpts) (*ChatInviteLink, error)

RevokeInviteLink Helper method for Bot.RevokeChatInviteLink.

func (Chat) SendAction ¶

func (c Chat) SendAction(b *Bot, action string, opts *SendChatActionOpts) (bool, error)

SendAction Helper method for Bot.SendChatAction.

func (Chat) SendMessage ¶

func (c Chat) SendMessage(b *Bot, text string, opts *SendMessageOpts) (*Message, error)

SendMessage is a helper function to easily call Bot.SendMessage in a chat.

func (Chat) SetAdministratorCustomTitle ¶

func (c Chat) SetAdministratorCustomTitle(b *Bot, userId int64, customTitle string, opts *SetChatAdministratorCustomTitleOpts) (bool, error)

SetAdministratorCustomTitle Helper method for Bot.SetChatAdministratorCustomTitle.

func (Chat) SetDescription ¶

func (c Chat) SetDescription(b *Bot, opts *SetChatDescriptionOpts) (bool, error)

SetDescription Helper method for Bot.SetChatDescription.

func (Chat) SetMenuButton ¶

func (c Chat) SetMenuButton(b *Bot, opts *SetChatMenuButtonOpts) (bool, error)

SetMenuButton Helper method for Bot.SetChatMenuButton.

func (Chat) SetPermissions ¶

func (c Chat) SetPermissions(b *Bot, permissions ChatPermissions, opts *SetChatPermissionsOpts) (bool, error)

SetPermissions Helper method for Bot.SetChatPermissions.

func (Chat) SetPhoto ¶

func (c Chat) SetPhoto(b *Bot, photo InputFile, opts *SetChatPhotoOpts) (bool, error)

SetPhoto Helper method for Bot.SetChatPhoto.

func (Chat) SetStickerSet ¶

func (c Chat) SetStickerSet(b *Bot, stickerSetName string, opts *SetChatStickerSetOpts) (bool, error)

SetStickerSet Helper method for Bot.SetChatStickerSet.

func (Chat) SetTitle ¶

func (c Chat) SetTitle(b *Bot, title string, opts *SetChatTitleOpts) (bool, error)

SetTitle Helper method for Bot.SetChatTitle.

func (Chat) Unban ¶

func (c Chat) Unban(b *Bot, userId int64, opts *UnbanChatMemberOpts) (bool, error)

Unban is a helper function to easily call Bot.UnbanChatMember in a chat.

func (Chat) UnbanMember ¶

func (c Chat) UnbanMember(b *Bot, userId int64, opts *UnbanChatMemberOpts) (bool, error)

UnbanMember Helper method for Bot.UnbanChatMember.

func (Chat) UnbanSenderChat ¶

func (c Chat) UnbanSenderChat(b *Bot, senderChatId int64, opts *UnbanChatSenderChatOpts) (bool, error)

UnbanSenderChat Helper method for Bot.UnbanChatSenderChat.

func (*Chat) UnmarshalJSON ¶

func (v *Chat) UnmarshalJSON(b []byte) error

UnmarshalJSON is a custom JSON unmarshaller to use the helpers which allow for unmarshalling structs into interfaces.

func (Chat) UnpinAllMessages ¶

func (c Chat) UnpinAllMessages(b *Bot, opts *UnpinAllChatMessagesOpts) (bool, error)

UnpinAllMessages Helper method for Bot.UnpinAllChatMessages.

func (Chat) UnpinMessage ¶

func (c Chat) UnpinMessage(b *Bot, opts *UnpinChatMessageOpts) (bool, error)

UnpinMessage Helper method for Bot.UnpinChatMessage.

func (*ChatBoost) UnmarshalJSON ¶

func (v *ChatBoost) UnmarshalJSON(b []byte) error

UnmarshalJSON is a custom JSON unmarshaller to use the helpers which allow for unmarshalling structs into interfaces.

func (*ChatBoostRemoved) UnmarshalJSON ¶

func (v *ChatBoostRemoved) UnmarshalJSON(b []byte) error

UnmarshalJSON is a custom JSON unmarshaller to use the helpers which allow for unmarshalling structs into interfaces.

func (ChatBoostSourceGiftCode) GetSource ¶

func (v ChatBoostSourceGiftCode) GetSource() string

GetSource is a helper method to easily access the common fields of an interface.

func (ChatBoostSourceGiftCode) MarshalJSON ¶

func (v ChatBoostSourceGiftCode) MarshalJSON() ([]byte, error)

MarshalJSON is a custom JSON marshaller to allow for enforcing the Source value.

func (ChatBoostSourceGiftCode) MergeChatBoostSource ¶

func (v ChatBoostSourceGiftCode) MergeChatBoostSource() MergedChatBoostSource

MergeChatBoostSource returns a MergedChatBoostSource struct to simplify working with types in a non-generic world.

func (ChatBoostSourceGiveaway) GetSource ¶

func (v ChatBoostSourceGiveaway) GetSource() string

GetSource is a helper method to easily access the common fields of an interface.

func (ChatBoostSourceGiveaway) MarshalJSON ¶

func (v ChatBoostSourceGiveaway) MarshalJSON() ([]byte, error)

MarshalJSON is a custom JSON marshaller to allow for enforcing the Source value.

func (ChatBoostSourceGiveaway) MergeChatBoostSource ¶

func (v ChatBoostSourceGiveaway) MergeChatBoostSource() MergedChatBoostSource

MergeChatBoostSource returns a MergedChatBoostSource struct to simplify working with types in a non-generic world.

func (ChatBoostSourcePremium) GetSource ¶

func (v ChatBoostSourcePremium) GetSource() string

GetSource is a helper method to easily access the common fields of an interface.

func (ChatBoostSourcePremium) MarshalJSON ¶

func (v ChatBoostSourcePremium) MarshalJSON() ([]byte, error)

MarshalJSON is a custom JSON marshaller to allow for enforcing the Source value.

func (ChatBoostSourcePremium) MergeChatBoostSource ¶

func (v ChatBoostSourcePremium) MergeChatBoostSource() MergedChatBoostSource

MergeChatBoostSource returns a MergedChatBoostSource struct to simplify working with types in a non-generic world.

func (ChatMemberAdministrator) GetStatus ¶

func (v ChatMemberAdministrator) GetStatus() string

GetStatus is a helper method to easily access the common fields of an interface.

func (ChatMemberAdministrator) GetUser ¶

func (v ChatMemberAdministrator) GetUser() User

GetUser is a helper method to easily access the common fields of an interface.

func (ChatMemberAdministrator) MarshalJSON ¶

func (v ChatMemberAdministrator) MarshalJSON() ([]byte, error)

MarshalJSON is a custom JSON marshaller to allow for enforcing the Status value.

func (ChatMemberAdministrator) MergeChatMember ¶

func (v ChatMemberAdministrator) MergeChatMember() MergedChatMember

MergeChatMember returns a MergedChatMember struct to simplify working with types in a non-generic world.

func (ChatMemberBanned) GetStatus ¶

func (v ChatMemberBanned) GetStatus() string

GetStatus is a helper method to easily access the common fields of an interface.

func (ChatMemberBanned) GetUser ¶

func (v ChatMemberBanned) GetUser() User

GetUser is a helper method to easily access the common fields of an interface.

func (ChatMemberBanned) MarshalJSON ¶

func (v ChatMemberBanned) MarshalJSON() ([]byte, error)

MarshalJSON is a custom JSON marshaller to allow for enforcing the Status value.

func (ChatMemberBanned) MergeChatMember ¶

func (v ChatMemberBanned) MergeChatMember() MergedChatMember

MergeChatMember returns a MergedChatMember struct to simplify working with types in a non-generic world.

func (ChatMemberLeft) GetStatus ¶

func (v ChatMemberLeft) GetStatus() string

GetStatus is a helper method to easily access the common fields of an interface.

func (ChatMemberLeft) GetUser ¶

func (v ChatMemberLeft) GetUser() User

GetUser is a helper method to easily access the common fields of an interface.

func (ChatMemberLeft) MarshalJSON ¶

func (v ChatMemberLeft) MarshalJSON() ([]byte, error)

MarshalJSON is a custom JSON marshaller to allow for enforcing the Status value.

func (ChatMemberLeft) MergeChatMember ¶

func (v ChatMemberLeft) MergeChatMember() MergedChatMember

MergeChatMember returns a MergedChatMember struct to simplify working with types in a non-generic world.

func (ChatMemberMember) GetStatus ¶

func (v ChatMemberMember) GetStatus() string

GetStatus is a helper method to easily access the common fields of an interface.

func (ChatMemberMember) GetUser ¶

func (v ChatMemberMember) GetUser() User

GetUser is a helper method to easily access the common fields of an interface.

func (ChatMemberMember) MarshalJSON ¶

func (v ChatMemberMember) MarshalJSON() ([]byte, error)

MarshalJSON is a custom JSON marshaller to allow for enforcing the Status value.

func (ChatMemberMember) MergeChatMember ¶

func (v ChatMemberMember) MergeChatMember() MergedChatMember

MergeChatMember returns a MergedChatMember struct to simplify working with types in a non-generic world.

func (ChatMemberOwner) GetStatus ¶

func (v ChatMemberOwner) GetStatus() string

GetStatus is a helper method to easily access the common fields of an interface.

func (ChatMemberOwner) GetUser ¶

func (v ChatMemberOwner) GetUser() User

GetUser is a helper method to easily access the common fields of an interface.

func (ChatMemberOwner) MarshalJSON ¶

func (v ChatMemberOwner) MarshalJSON() ([]byte, error)

MarshalJSON is a custom JSON marshaller to allow for enforcing the Status value.

func (ChatMemberOwner) MergeChatMember ¶

func (v ChatMemberOwner) MergeChatMember() MergedChatMember

MergeChatMember returns a MergedChatMember struct to simplify working with types in a non-generic world.

func (ChatMemberRestricted) GetStatus ¶

func (v ChatMemberRestricted) GetStatus() string

GetStatus is a helper method to easily access the common fields of an interface.

func (ChatMemberRestricted) GetUser ¶

func (v ChatMemberRestricted) GetUser() User

GetUser is a helper method to easily access the common fields of an interface.

func (ChatMemberRestricted) MarshalJSON ¶

func (v ChatMemberRestricted) MarshalJSON() ([]byte, error)

MarshalJSON is a custom JSON marshaller to allow for enforcing the Status value.

func (ChatMemberRestricted) MergeChatMember ¶

func (v ChatMemberRestricted) MergeChatMember() MergedChatMember

MergeChatMember returns a MergedChatMember struct to simplify working with types in a non-generic world.

func (*ChatMemberUpdated) UnmarshalJSON ¶

func (v *ChatMemberUpdated) UnmarshalJSON(b []byte) error

UnmarshalJSON is a custom JSON unmarshaller to use the helpers which allow for unmarshalling structs into interfaces.

func (*ExternalReplyInfo) UnmarshalJSON ¶

func (v *ExternalReplyInfo) UnmarshalJSON(b []byte) error

UnmarshalJSON is a custom JSON unmarshaller to use the helpers which allow for unmarshalling structs into interfaces.

func (File) URL ¶

func (f File) URL(b *Bot, opts *RequestOpts) string

URL gets the URL the file can be downloaded from.