lukaszraczylo/go-telegram
1
0
Fork 0
mirror of https://github.com/lukaszraczylo/go-telegram.git synced 2026-06-05 22:43:59 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
go-telegram/docs/reference/api.md
T
github-actions[bot] f5250197b7 chore(api): regenerate from Telegram Bot API v10.0 (#3) 
Co-authored-by: lukaszraczylo <2182556+lukaszraczylo@users.noreply.github.com>
2026-05-20 23:15:44 +01:00

850 KiB
Raw Permalink Blame History

api

import "github.com/lukaszraczylo/go-telegram/api"

Package api contains the Telegram Bot API types and method wrappers. Most of the package is generated by cmd/genapi from internal/spec/api.json; this file holds the runtime types that are intentionally hand-coded.

InputFile carries either a local upload (Reader+Filename) or a reference to a previously-uploaded file (file_id) / URL Telegram can fetch. It is not a pure JSON type, so the codegen skips it (see runtimeTypes in cmd/genapi/emitter.go).

ResponseParameters mirrors client.ResponseParameters so callers importing only `api` can access retry_after and migrate_to_chat_id without pulling in the client package.

Package api contains the Telegram Bot API object types and method wrappers, generated from the live documentation by cmd/genapi.

Index

func AddStickerToSet

func AddStickerToSet(ctx context.Context, b *client.Bot, p *AddStickerToSetParams) (bool, error)

AddStickerToSet calls the addStickerToSet Telegram Bot API method.

Use this method to add a new sticker to a set created by the bot. Emoji sticker sets can have up to 200 stickers. Other sticker sets can have up to 120 stickers. Returns True on success.

func AnswerCallbackQuery

func AnswerCallbackQuery(ctx context.Context, b *client.Bot, p *AnswerCallbackQueryParams) (bool, error)

AnswerCallbackQuery calls the answerCallbackQuery Telegram Bot API method.

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. Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via @BotFather and accept the terms. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.

func AnswerInlineQuery

func AnswerInlineQuery(ctx context.Context, b *client.Bot, p *AnswerInlineQueryParams) (bool, error)

AnswerInlineQuery calls the answerInlineQuery Telegram Bot API method.

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

func AnswerPreCheckoutQuery

func AnswerPreCheckoutQuery(ctx context.Context, b *client.Bot, p *AnswerPreCheckoutQueryParams) (bool, error)

AnswerPreCheckoutQuery calls the answerPreCheckoutQuery Telegram Bot API method.

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.

func AnswerShippingQuery

func AnswerShippingQuery(ctx context.Context, b *client.Bot, p *AnswerShippingQueryParams) (bool, error)

AnswerShippingQuery calls the answerShippingQuery Telegram Bot API method.

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.

func ApproveChatJoinRequest

func ApproveChatJoinRequest(ctx context.Context, b *client.Bot, p *ApproveChatJoinRequestParams) (bool, error)

ApproveChatJoinRequest calls the approveChatJoinRequest Telegram Bot API method.

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.

func ApproveSuggestedPost

func ApproveSuggestedPost(ctx context.Context, b *client.Bot, p *ApproveSuggestedPostParams) (bool, error)

ApproveSuggestedPost calls the approveSuggestedPost Telegram Bot API method.

Use this method to approve a suggested post in a direct messages chat. The bot must have the 'can_post_messages' administrator right in the corresponding channel chat. Returns True on success.

func BanChatMember

func BanChatMember(ctx context.Context, b *client.Bot, p *BanChatMemberParams) (bool, error)

BanChatMember calls the banChatMember Telegram Bot API method.

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.

func BanChatSenderChat

func BanChatSenderChat(ctx context.Context, b *client.Bot, p *BanChatSenderChatParams) (bool, error)

BanChatSenderChat calls the banChatSenderChat Telegram Bot API method.

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.

func Close

func Close(ctx context.Context, b *client.Bot, p *CloseParams) (bool, error)

Close calls the close Telegram Bot API method.

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.

func CloseForumTopic

func CloseForumTopic(ctx context.Context, b *client.Bot, p *CloseForumTopicParams) (bool, error)

CloseForumTopic calls the closeForumTopic Telegram Bot API method.

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.

func CloseGeneralForumTopic

func CloseGeneralForumTopic(ctx context.Context, b *client.Bot, p *CloseGeneralForumTopicParams) (bool, error)

CloseGeneralForumTopic calls the closeGeneralForumTopic Telegram Bot API method.

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.

func ConvertGiftToStars

func ConvertGiftToStars(ctx context.Context, b *client.Bot, p *ConvertGiftToStarsParams) (bool, error)

ConvertGiftToStars calls the convertGiftToStars Telegram Bot API method.

Converts a given regular gift to Telegram Stars. Requires the can_convert_gifts_to_stars business bot right. Returns True on success.

func CreateInvoiceLink

func CreateInvoiceLink(ctx context.Context, b *client.Bot, p *CreateInvoiceLinkParams) (string, error)

CreateInvoiceLink calls the createInvoiceLink Telegram Bot API method.

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

func CreateNewStickerSet

func CreateNewStickerSet(ctx context.Context, b *client.Bot, p *CreateNewStickerSetParams) (bool, error)

CreateNewStickerSet calls the createNewStickerSet Telegram Bot API method.

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.

func DeclineChatJoinRequest

func DeclineChatJoinRequest(ctx context.Context, b *client.Bot, p *DeclineChatJoinRequestParams) (bool, error)

DeclineChatJoinRequest calls the declineChatJoinRequest Telegram Bot API method.

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.

func DeclineSuggestedPost

func DeclineSuggestedPost(ctx context.Context, b *client.Bot, p *DeclineSuggestedPostParams) (bool, error)

DeclineSuggestedPost calls the declineSuggestedPost Telegram Bot API method.

Use this method to decline a suggested post in a direct messages chat. The bot must have the 'can_manage_direct_messages' administrator right in the corresponding channel chat. Returns True on success.

func DeleteAllMessageReactions

func DeleteAllMessageReactions(ctx context.Context, b *client.Bot, p *DeleteAllMessageReactionsParams) (bool, error)

DeleteAllMessageReactions calls the deleteAllMessageReactions Telegram Bot API method.

Use this method to remove up to 10000 recent reactions in a group or a supergroup chat added by a given user or chat. The bot must have the 'can_delete_messages' administrator right in the chat. Returns True on success.

func DeleteBusinessMessages

func DeleteBusinessMessages(ctx context.Context, b *client.Bot, p *DeleteBusinessMessagesParams) (bool, error)

DeleteBusinessMessages calls the deleteBusinessMessages Telegram Bot API method.

Delete messages on behalf of a business account. Requires the can_delete_sent_messages business bot right to delete messages sent by the bot itself, or the can_delete_all_messages business bot right to delete any message. Returns True on success.

func DeleteChatPhoto

func DeleteChatPhoto(ctx context.Context, b *client.Bot, p *DeleteChatPhotoParams) (bool, error)

DeleteChatPhoto calls the deleteChatPhoto Telegram Bot API method.

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.

func DeleteChatStickerSet

func DeleteChatStickerSet(ctx context.Context, b *client.Bot, p *DeleteChatStickerSetParams) (bool, error)

DeleteChatStickerSet calls the deleteChatStickerSet Telegram Bot API method.

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.

func DeleteForumTopic

func DeleteForumTopic(ctx context.Context, b *client.Bot, p *DeleteForumTopicParams) (bool, error)

DeleteForumTopic calls the deleteForumTopic Telegram Bot API method.

Use this method to delete a forum topic along with all its messages in a forum supergroup chat or a private chat with a user. In the case of a 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.

func DeleteMessage

func DeleteMessage(ctx context.Context, b *client.Bot, p *DeleteMessageParams) (bool, error)

DeleteMessage calls the deleteMessage Telegram Bot API method.

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 administrator right in a supergroup or a channel, it can delete any message there.- If the bot has can_manage_direct_messages administrator right in a channel, it can delete any message in the corresponding direct messages chat.Returns True on success.

func DeleteMessageReaction

func DeleteMessageReaction(ctx context.Context, b *client.Bot, p *DeleteMessageReactionParams) (bool, error)

DeleteMessageReaction calls the deleteMessageReaction Telegram Bot API method.

Use this method to remove a reaction from a message in a group or a supergroup chat. The bot must have the 'can_delete_messages' administrator right in the chat. Returns True on success.

func DeleteMessages

func DeleteMessages(ctx context.Context, b *client.Bot, p *DeleteMessagesParams) (bool, error)

DeleteMessages calls the deleteMessages Telegram Bot API method.

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.

func DeleteMyCommands

func DeleteMyCommands(ctx context.Context, b *client.Bot, p *DeleteMyCommandsParams) (bool, error)

DeleteMyCommands calls the deleteMyCommands Telegram Bot API method.

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.

func DeleteStickerFromSet

func DeleteStickerFromSet(ctx context.Context, b *client.Bot, p *DeleteStickerFromSetParams) (bool, error)

DeleteStickerFromSet calls the deleteStickerFromSet Telegram Bot API method.

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

func DeleteStickerSet

func DeleteStickerSet(ctx context.Context, b *client.Bot, p *DeleteStickerSetParams) (bool, error)

DeleteStickerSet calls the deleteStickerSet Telegram Bot API method.

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

func DeleteStory

func DeleteStory(ctx context.Context, b *client.Bot, p *DeleteStoryParams) (bool, error)

DeleteStory calls the deleteStory Telegram Bot API method.

Deletes a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns True on success.

func DeleteWebhook

func DeleteWebhook(ctx context.Context, b *client.Bot, p *DeleteWebhookParams) (bool, error)

DeleteWebhook calls the deleteWebhook Telegram Bot API method.

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

func DownloadFileByPath

func DownloadFileByPath(ctx context.Context, b *client.Bot, filePath string) (io.ReadCloser, error)

DownloadFileByPath fetches a file by its file_path (typically obtained from a prior File response). Useful when the caller already has a *File and wants to skip the GetFile round-trip.

func EditForumTopic

func EditForumTopic(ctx context.Context, b *client.Bot, p *EditForumTopicParams) (bool, error)

EditForumTopic calls the editForumTopic Telegram Bot API method.

Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user. In the case of a 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.

func EditGeneralForumTopic

func EditGeneralForumTopic(ctx context.Context, b *client.Bot, p *EditGeneralForumTopicParams) (bool, error)

EditGeneralForumTopic calls the editGeneralForumTopic Telegram Bot API method.

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 the can_manage_topics administrator rights. Returns True on success.

func EditUserStarSubscription

func EditUserStarSubscription(ctx context.Context, b *client.Bot, p *EditUserStarSubscriptionParams) (bool, error)

EditUserStarSubscription calls the editUserStarSubscription Telegram Bot API method.

Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns True on success.

func ExportChatInviteLink

func ExportChatInviteLink(ctx context.Context, b *client.Bot, p *ExportChatInviteLinkParams) (string, error)

ExportChatInviteLink calls the exportChatInviteLink Telegram Bot API method.

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. Note: Each administrator in a chat generates their own invite links. Bots can't use invite links generated by other administrators. If you want your bot to work with invite links, it will need to generate its own link using exportChatInviteLink or by calling the getChat method. If your bot needs to generate a new primary invite link replacing its previous one, use exportChatInviteLink again.

func GetChatMemberCount

func GetChatMemberCount(ctx context.Context, b *client.Bot, p *GetChatMemberCountParams) (int64, error)

GetChatMemberCount calls the getChatMemberCount Telegram Bot API method.

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

func GetManagedBotToken

func GetManagedBotToken(ctx context.Context, b *client.Bot, p *GetManagedBotTokenParams) (string, error)

GetManagedBotToken calls the getManagedBotToken Telegram Bot API method.

Use this method to get the token of a managed bot. Returns the token as String on success.

func GiftPremiumSubscription

func GiftPremiumSubscription(ctx context.Context, b *client.Bot, p *GiftPremiumSubscriptionParams) (bool, error)

GiftPremiumSubscription calls the giftPremiumSubscription Telegram Bot API method.

Gifts a Telegram Premium subscription to the given user. Returns True on success.

func HideGeneralForumTopic

func HideGeneralForumTopic(ctx context.Context, b *client.Bot, p *HideGeneralForumTopicParams) (bool, error)

HideGeneralForumTopic calls the hideGeneralForumTopic Telegram Bot API method.

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.

func LeaveChat

func LeaveChat(ctx context.Context, b *client.Bot, p *LeaveChatParams) (bool, error)

LeaveChat calls the leaveChat Telegram Bot API method.

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

func LogOut

func LogOut(ctx context.Context, b *client.Bot, p *LogOutParams) (bool, error)

LogOut calls the logOut Telegram Bot API method.

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.

func PinChatMessage

func PinChatMessage(ctx context.Context, b *client.Bot, p *PinChatMessageParams) (bool, error)

PinChatMessage calls the pinChatMessage Telegram Bot API method.

Use this method to add a message to the list of pinned messages in a chat. In private chats and channel direct messages chats, all non-service messages can be pinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to pin messages in groups and channels respectively. Returns True on success.

func PromoteChatMember

func PromoteChatMember(ctx context.Context, b *client.Bot, p *PromoteChatMemberParams) (bool, error)

PromoteChatMember calls the promoteChatMember Telegram Bot API method.

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.

func Ptr

func Ptr[T any](v T) *T

Ptr returns a pointer to v. Useful for optional scalar fields where the wire format must distinguish absent (nil) from an explicit zero value (e.g. DisableNotification: api.Ptr(false) to override the chat default).

For untyped literals, supply the type parameter explicitly:

Limit: api.Ptr[int64](5)

For already-typed values, type inference handles it:

var n int64 = 5
Limit: api.Ptr(n)

func ReadBusinessMessage

func ReadBusinessMessage(ctx context.Context, b *client.Bot, p *ReadBusinessMessageParams) (bool, error)

ReadBusinessMessage calls the readBusinessMessage Telegram Bot API method.

Marks incoming message as read on behalf of a business account. Requires the can_read_messages business bot right. Returns True on success.

func RefundStarPayment

func RefundStarPayment(ctx context.Context, b *client.Bot, p *RefundStarPaymentParams) (bool, error)

RefundStarPayment calls the refundStarPayment Telegram Bot API method.

Refunds a successful payment in Telegram Stars. Returns True on success.

func RemoveBusinessAccountProfilePhoto

func RemoveBusinessAccountProfilePhoto(ctx context.Context, b *client.Bot, p *RemoveBusinessAccountProfilePhotoParams) (bool, error)

RemoveBusinessAccountProfilePhoto calls the removeBusinessAccountProfilePhoto Telegram Bot API method.

Removes the current profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.

func RemoveChatVerification

func RemoveChatVerification(ctx context.Context, b *client.Bot, p *RemoveChatVerificationParams) (bool, error)

RemoveChatVerification calls the removeChatVerification Telegram Bot API method.

Removes verification from a chat that is currently verified on behalf of the organization represented by the bot. Returns True on success.

func RemoveMyProfilePhoto

func RemoveMyProfilePhoto(ctx context.Context, b *client.Bot, p *RemoveMyProfilePhotoParams) (bool, error)

RemoveMyProfilePhoto calls the removeMyProfilePhoto Telegram Bot API method.

Removes the profile photo of the bot. Requires no parameters. Returns True on success.

func RemoveUserVerification

func RemoveUserVerification(ctx context.Context, b *client.Bot, p *RemoveUserVerificationParams) (bool, error)

RemoveUserVerification calls the removeUserVerification Telegram Bot API method.

Removes verification from a user who is currently verified on behalf of the organization represented by the bot. Returns True on success.

func ReopenForumTopic

func ReopenForumTopic(ctx context.Context, b *client.Bot, p *ReopenForumTopicParams) (bool, error)

ReopenForumTopic calls the reopenForumTopic Telegram Bot API method.

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.

func ReopenGeneralForumTopic

func ReopenGeneralForumTopic(ctx context.Context, b *client.Bot, p *ReopenGeneralForumTopicParams) (bool, error)

ReopenGeneralForumTopic calls the reopenGeneralForumTopic Telegram Bot API method.

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.

func ReplaceManagedBotToken

func ReplaceManagedBotToken(ctx context.Context, b *client.Bot, p *ReplaceManagedBotTokenParams) (string, error)

ReplaceManagedBotToken calls the replaceManagedBotToken Telegram Bot API method.

Use this method to revoke the current token of a managed bot and generate a new one. Returns the new token as String on success.

func ReplaceStickerInSet

func ReplaceStickerInSet(ctx context.Context, b *client.Bot, p *ReplaceStickerInSetParams) (bool, error)

ReplaceStickerInSet calls the replaceStickerInSet Telegram Bot API method.

Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling deleteStickerFromSet, then addStickerToSet, then setStickerPositionInSet. Returns True on success.

func RestrictChatMember

func RestrictChatMember(ctx context.Context, b *client.Bot, p *RestrictChatMemberParams) (bool, error)

RestrictChatMember calls the restrictChatMember Telegram Bot API method.

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.

func SendChatAction

func SendChatAction(ctx context.Context, b *client.Bot, p *SendChatActionParams) (bool, error)

SendChatAction calls the sendChatAction Telegram Bot API method.

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. Example: The ImageBot needs some time to process a request and upload the image. Instead of sending a text message along the lines of “Retrieving image, please wait…”, the bot may use sendChatAction with action = upload_photo. The user will see a “sending photo” status for the bot. We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.

func SendGift

func SendGift(ctx context.Context, b *client.Bot, p *SendGiftParams) (bool, error)

SendGift calls the sendGift Telegram Bot API method.

Sends a gift to the given user or channel chat. The gift can't be converted to Telegram Stars by the receiver. Returns True on success.

func SendMessageDraft

func SendMessageDraft(ctx context.Context, b *client.Bot, p *SendMessageDraftParams) (bool, error)

SendMessageDraft calls the sendMessageDraft Telegram Bot API method.

Use this method to stream a partial message to a user while the message is being generated. Note that the streamed draft is ephemeral and acts as a temporary 30-second preview - once the output is finalized, you must call sendMessage with the complete message to persist it in the user's chat. Returns True on success.

func SetBusinessAccountBio

func SetBusinessAccountBio(ctx context.Context, b *client.Bot, p *SetBusinessAccountBioParams) (bool, error)

SetBusinessAccountBio calls the setBusinessAccountBio Telegram Bot API method.

Changes the bio of a managed business account. Requires the can_change_bio business bot right. Returns True on success.

func SetBusinessAccountGiftSettings

func SetBusinessAccountGiftSettings(ctx context.Context, b *client.Bot, p *SetBusinessAccountGiftSettingsParams) (bool, error)

SetBusinessAccountGiftSettings calls the setBusinessAccountGiftSettings Telegram Bot API method.

Changes the privacy settings pertaining to incoming gifts in a managed business account. Requires the can_change_gift_settings business bot right. Returns True on success.

func SetBusinessAccountName

func SetBusinessAccountName(ctx context.Context, b *client.Bot, p *SetBusinessAccountNameParams) (bool, error)

SetBusinessAccountName calls the setBusinessAccountName Telegram Bot API method.

Changes the first and last name of a managed business account. Requires the can_change_name business bot right. Returns True on success.

func SetBusinessAccountProfilePhoto

func SetBusinessAccountProfilePhoto(ctx context.Context, b *client.Bot, p *SetBusinessAccountProfilePhotoParams) (bool, error)

SetBusinessAccountProfilePhoto calls the setBusinessAccountProfilePhoto Telegram Bot API method.

Changes the profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.

func SetBusinessAccountUsername

func SetBusinessAccountUsername(ctx context.Context, b *client.Bot, p *SetBusinessAccountUsernameParams) (bool, error)

SetBusinessAccountUsername calls the setBusinessAccountUsername Telegram Bot API method.

Changes the username of a managed business account. Requires the can_change_username business bot right. Returns True on success.

func SetChatAdministratorCustomTitle

func SetChatAdministratorCustomTitle(ctx context.Context, b *client.Bot, p *SetChatAdministratorCustomTitleParams) (bool, error)

SetChatAdministratorCustomTitle calls the setChatAdministratorCustomTitle Telegram Bot API method.

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

func SetChatDescription

func SetChatDescription(ctx context.Context, b *client.Bot, p *SetChatDescriptionParams) (bool, error)

SetChatDescription calls the setChatDescription Telegram Bot API method.

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.

func SetChatMemberTag

func SetChatMemberTag(ctx context.Context, b *client.Bot, p *SetChatMemberTagParams) (bool, error)

SetChatMemberTag calls the setChatMemberTag Telegram Bot API method.

Use this method to set a tag for a regular member in a group or a supergroup. The bot must be an administrator in the chat for this to work and must have the can_manage_tags administrator right. Returns True on success.

func SetChatMenuButton

func SetChatMenuButton(ctx context.Context, b *client.Bot, p *SetChatMenuButtonParams) (bool, error)

SetChatMenuButton calls the setChatMenuButton Telegram Bot API method.

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

func SetChatPermissions

func SetChatPermissions(ctx context.Context, b *client.Bot, p *SetChatPermissionsParams) (bool, error)

SetChatPermissions calls the setChatPermissions Telegram Bot API method.

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.

func SetChatPhoto

func SetChatPhoto(ctx context.Context, b *client.Bot, p *SetChatPhotoParams) (bool, error)

SetChatPhoto calls the setChatPhoto Telegram Bot API method.

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.

func SetChatStickerSet

func SetChatStickerSet(ctx context.Context, b *client.Bot, p *SetChatStickerSetParams) (bool, error)

SetChatStickerSet calls the setChatStickerSet Telegram Bot API method.

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.

func SetChatTitle

func SetChatTitle(ctx context.Context, b *client.Bot, p *SetChatTitleParams) (bool, error)

SetChatTitle calls the setChatTitle Telegram Bot API method.

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.

func SetCustomEmojiStickerSetThumbnail

func SetCustomEmojiStickerSetThumbnail(ctx context.Context, b *client.Bot, p *SetCustomEmojiStickerSetThumbnailParams) (bool, error)

SetCustomEmojiStickerSetThumbnail calls the setCustomEmojiStickerSetThumbnail Telegram Bot API method.

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

func SetManagedBotAccessSettings

func SetManagedBotAccessSettings(ctx context.Context, b *client.Bot, p *SetManagedBotAccessSettingsParams) (bool, error)

SetManagedBotAccessSettings calls the setManagedBotAccessSettings Telegram Bot API method.

Use this method to change the access settings of a managed bot. Returns True on success.

func SetMessageReaction

func SetMessageReaction(ctx context.Context, b *client.Bot, p *SetMessageReactionParams) (bool, error)

SetMessageReaction calls the setMessageReaction Telegram Bot API method.

Use this method to change the chosen reactions on a message. Service messages of some types 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. Bots can't use paid reactions. Returns True on success.

func SetMyCommands

func SetMyCommands(ctx context.Context, b *client.Bot, p *SetMyCommandsParams) (bool, error)

SetMyCommands calls the setMyCommands Telegram Bot API method.

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.

func SetMyDefaultAdministratorRights

func SetMyDefaultAdministratorRights(ctx context.Context, b *client.Bot, p *SetMyDefaultAdministratorRightsParams) (bool, error)

SetMyDefaultAdministratorRights calls the setMyDefaultAdministratorRights Telegram Bot API method.

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.

func SetMyDescription

func SetMyDescription(ctx context.Context, b *client.Bot, p *SetMyDescriptionParams) (bool, error)

SetMyDescription calls the setMyDescription Telegram Bot API method.

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.

func SetMyName

func SetMyName(ctx context.Context, b *client.Bot, p *SetMyNameParams) (bool, error)

SetMyName calls the setMyName Telegram Bot API method.

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

func SetMyProfilePhoto

func SetMyProfilePhoto(ctx context.Context, b *client.Bot, p *SetMyProfilePhotoParams) (bool, error)

SetMyProfilePhoto calls the setMyProfilePhoto Telegram Bot API method.

Changes the profile photo of the bot. Returns True on success.

func SetMyShortDescription

func SetMyShortDescription(ctx context.Context, b *client.Bot, p *SetMyShortDescriptionParams) (bool, error)

SetMyShortDescription calls the setMyShortDescription Telegram Bot API method.

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.

func SetPassportDataErrors

func SetPassportDataErrors(ctx context.Context, b *client.Bot, p *SetPassportDataErrorsParams) (bool, error)

SetPassportDataErrors calls the setPassportDataErrors Telegram Bot API method.

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.

func SetStickerEmojiList

func SetStickerEmojiList(ctx context.Context, b *client.Bot, p *SetStickerEmojiListParams) (bool, error)

SetStickerEmojiList calls the setStickerEmojiList Telegram Bot API method.

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.

func SetStickerKeywords

func SetStickerKeywords(ctx context.Context, b *client.Bot, p *SetStickerKeywordsParams) (bool, error)

SetStickerKeywords calls the setStickerKeywords Telegram Bot API method.

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.

func SetStickerMaskPosition

func SetStickerMaskPosition(ctx context.Context, b *client.Bot, p *SetStickerMaskPositionParams) (bool, error)

SetStickerMaskPosition calls the setStickerMaskPosition Telegram Bot API method.

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.

func SetStickerPositionInSet

func SetStickerPositionInSet(ctx context.Context, b *client.Bot, p *SetStickerPositionInSetParams) (bool, error)

SetStickerPositionInSet calls the setStickerPositionInSet Telegram Bot API method.

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

func SetStickerSetThumbnail

func SetStickerSetThumbnail(ctx context.Context, b *client.Bot, p *SetStickerSetThumbnailParams) (bool, error)

SetStickerSetThumbnail calls the setStickerSetThumbnail Telegram Bot API method.

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.

func SetStickerSetTitle

func SetStickerSetTitle(ctx context.Context, b *client.Bot, p *SetStickerSetTitleParams) (bool, error)

SetStickerSetTitle calls the setStickerSetTitle Telegram Bot API method.

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

func SetUserEmojiStatus

func SetUserEmojiStatus(ctx context.Context, b *client.Bot, p *SetUserEmojiStatusParams) (bool, error)

SetUserEmojiStatus calls the setUserEmojiStatus Telegram Bot API method.

Changes the emoji status for a given user that previously allowed the bot to manage their emoji status via the Mini App method requestEmojiStatusAccess. Returns True on success.

func SetWebhook

func SetWebhook(ctx context.Context, b *client.Bot, p *SetWebhookParams) (bool, error)

SetWebhook calls the setWebhook Telegram Bot API method.

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 (a request with response HTTP status code different from 2XY), we will repeat the request and 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. Notes1. You will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up.2. To use a self-signed certificate, you need to upload your public key certificate using certificate parameter. Please upload as InputFile, sending a String will not work.3. Ports currently supported for webhooks: 443, 80, 88, 8443. If you're having any trouble setting up webhooks, please check out this amazing guide to webhooks.

func TransferBusinessAccountStars

func TransferBusinessAccountStars(ctx context.Context, b *client.Bot, p *TransferBusinessAccountStarsParams) (bool, error)

TransferBusinessAccountStars calls the transferBusinessAccountStars Telegram Bot API method.

Transfers Telegram Stars from the business account balance to the bot's balance. Requires the can_transfer_stars business bot right. Returns True on success.

func TransferGift

func TransferGift(ctx context.Context, b *client.Bot, p *TransferGiftParams) (bool, error)

TransferGift calls the transferGift Telegram Bot API method.

Transfers an owned unique gift to another user. Requires the can_transfer_and_upgrade_gifts business bot right. Requires can_transfer_stars business bot right if the transfer is paid. Returns True on success.

func UnbanChatMember

func UnbanChatMember(ctx context.Context, b *client.Bot, p *UnbanChatMemberParams) (bool, error)

UnbanChatMember calls the unbanChatMember Telegram Bot API method.

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.

func UnbanChatSenderChat

func UnbanChatSenderChat(ctx context.Context, b *client.Bot, p *UnbanChatSenderChatParams) (bool, error)

UnbanChatSenderChat calls the unbanChatSenderChat Telegram Bot API method.

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.

func UnhideGeneralForumTopic

func UnhideGeneralForumTopic(ctx context.Context, b *client.Bot, p *UnhideGeneralForumTopicParams) (bool, error)

UnhideGeneralForumTopic calls the unhideGeneralForumTopic Telegram Bot API method.

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.

func UnpinAllChatMessages

func UnpinAllChatMessages(ctx context.Context, b *client.Bot, p *UnpinAllChatMessagesParams) (bool, error)

UnpinAllChatMessages calls the unpinAllChatMessages Telegram Bot API method.

Use this method to clear the list of pinned messages in a chat. In private chats and channel direct messages chats, no additional rights are required to unpin all pinned messages. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin all pinned messages in groups and channels respectively. Returns True on success.

func UnpinAllForumTopicMessages

func UnpinAllForumTopicMessages(ctx context.Context, b *client.Bot, p *UnpinAllForumTopicMessagesParams) (bool, error)

UnpinAllForumTopicMessages calls the unpinAllForumTopicMessages Telegram Bot API method.

Use this method to clear the list of pinned messages in a forum topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat 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.

func UnpinAllGeneralForumTopicMessages

func UnpinAllGeneralForumTopicMessages(ctx context.Context, b *client.Bot, p *UnpinAllGeneralForumTopicMessagesParams) (bool, error)

UnpinAllGeneralForumTopicMessages calls the unpinAllGeneralForumTopicMessages Telegram Bot API method.

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.

func UnpinChatMessage

func UnpinChatMessage(ctx context.Context, b *client.Bot, p *UnpinChatMessageParams) (bool, error)

UnpinChatMessage calls the unpinChatMessage Telegram Bot API method.

Use this method to remove a message from the list of pinned messages in a chat. In private chats and channel direct messages chats, all messages can be unpinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin messages in groups and channels respectively. Returns True on success.

func UpgradeGift

func UpgradeGift(ctx context.Context, b *client.Bot, p *UpgradeGiftParams) (bool, error)

UpgradeGift calls the upgradeGift Telegram Bot API method.

Upgrades a given regular gift to a unique gift. Requires the can_transfer_and_upgrade_gifts business bot right. Additionally requires the can_transfer_stars business bot right if the upgrade is paid. Returns True on success.

func VerifyChat

func VerifyChat(ctx context.Context, b *client.Bot, p *VerifyChatParams) (bool, error)

VerifyChat calls the verifyChat Telegram Bot API method.

Verifies a chat on behalf of the organization which is represented by the bot. Returns True on success.

func VerifyUser

func VerifyUser(ctx context.Context, b *client.Bot, p *VerifyUserParams) (bool, error)

VerifyUser calls the verifyUser Telegram Bot API method.

Verifies a user on behalf of the organization which is represented by the bot. Returns True on success.

type AcceptedGiftTypes

This object describes the types of gifts that can be gifted to a user or a chat.

type AcceptedGiftTypes struct {
    // True, if unlimited regular gifts are accepted
    UnlimitedGifts bool `json:"unlimited_gifts"`
    // True, if limited regular gifts are accepted
    LimitedGifts bool `json:"limited_gifts"`
    // True, if unique gifts or gifts that can be upgraded to unique for free are accepted
    UniqueGifts bool `json:"unique_gifts"`
    // True, if a Telegram Premium subscription is accepted
    PremiumSubscription bool `json:"premium_subscription"`
    // True, if transfers of unique gifts from channels are accepted
    GiftsFromChannels bool `json:"gifts_from_channels"`
}

type AddStickerToSetParams

AddStickerToSetParams is the parameter set for AddStickerToSet.

Use this method to add a new sticker to a set created by the bot. Emoji sticker sets can have up to 200 stickers. Other sticker sets can have up to 120 stickers. Returns True on success.

type AddStickerToSetParams struct {
    // User identifier of sticker set owner
    UserID int64 `json:"user_id"`
    // Sticker set name
    Name string `json:"name"`
    // 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.
    Sticker InputSticker `json:"sticker"`
}

type AffiliateInfo

Contains information about the affiliate that received a commission via this transaction.

type AffiliateInfo struct {
    // Optional. The bot or the user that received an affiliate commission if it was received by a bot or a user
    AffiliateUser *User `json:"affiliate_user,omitempty"`
    // Optional. The chat that received an affiliate commission if it was received by a chat
    AffiliateChat *Chat `json:"affiliate_chat,omitempty"`
    // The number of Telegram Stars received by the affiliate for each 1000 Telegram Stars received by the bot from referred users
    CommissionPerMille int64 `json:"commission_per_mille"`
    // Integer amount of Telegram Stars received by the affiliate from the transaction, rounded to 0; can be negative for refunds
    Amount int64 `json:"amount"`
    // Optional. The number of 1/1000000000 shares of Telegram Stars received by the affiliate; from -999999999 to 999999999; can be negative for refunds
    NanostarAmount *int64 `json:"nanostar_amount,omitempty"`
}

type Animation

This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).

type Animation struct {
    // Identifier for this file, which can be used to download or reuse the file
    FileID string `json:"file_id"`
    // Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
    FileUniqueID string `json:"file_unique_id"`
    // Video width as defined by the sender
    Width int64 `json:"width"`
    // Video height as defined by the sender
    Height int64 `json:"height"`
    // Duration of the video in seconds as defined by the sender
    Duration int64 `json:"duration"`
    // Optional. Animation thumbnail as defined by the sender
    Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
    // Optional. Original animation filename as defined by the sender
    FileName string `json:"file_name,omitempty"`
    // Optional. MIME type of the file as defined by the sender
    MimeType string `json:"mime_type,omitempty"`
    // Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
    FileSize *int64 `json:"file_size,omitempty"`
}

type AnswerCallbackQueryParams

AnswerCallbackQueryParams is the parameter set for 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. Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via @BotFather and accept the terms. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.

type AnswerCallbackQueryParams struct {
    // Unique identifier for the query to be answered
    CallbackQueryID string `json:"callback_query_id"`
    // Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters.
    Text string `json:"text,omitempty"`
    // If True, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false.
    ShowAlert *bool `json:"show_alert,omitempty"`
    // URL that will be opened by the user's client. If you have created a Game and accepted the conditions via @BotFather, specify the URL that opens your game - note that this will only work if the query comes from a callback_game button.Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.
    URL string `json:"url,omitempty"`
    // The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0.
    CacheTime *int64 `json:"cache_time,omitempty"`
}

type AnswerGuestQueryParams

AnswerGuestQueryParams is the parameter set for AnswerGuestQuery.

Use this method to reply to a received guest message. On success, a SentGuestMessage object is returned.

type AnswerGuestQueryParams struct {
    // Unique identifier for the query to be answered
    GuestQueryID string `json:"guest_query_id"`
    // A JSON-serialized object describing the message to be sent
    Result InlineQueryResult `json:"result"`
}

type AnswerInlineQueryParams

AnswerInlineQueryParams is the parameter set for 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.

type AnswerInlineQueryParams struct {
    // Unique identifier for the answered query
    InlineQueryID string `json:"inline_query_id"`
    // A JSON-serialized array of results for the inline query
    Results []InlineQueryResult `json:"results"`
    // The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300.
    CacheTime *int64 `json:"cache_time,omitempty"`
    // Pass True if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query.
    IsPersonal *bool `json:"is_personal,omitempty"`
    // Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don't support pagination. Offset length can't exceed 64 bytes.
    NextOffset string `json:"next_offset,omitempty"`
    // A JSON-serialized object describing a button to be shown above inline query results
    Button *InlineQueryResultsButton `json:"button,omitempty"`
}

type AnswerPreCheckoutQueryParams

AnswerPreCheckoutQueryParams is the parameter set for 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.

type AnswerPreCheckoutQueryParams struct {
    // Unique identifier for the query to be answered
    PreCheckoutQueryID string `json:"pre_checkout_query_id"`
    // 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.
    Ok  bool `json:"ok"`
    // Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user.
    ErrorMessage string `json:"error_message,omitempty"`
}

type AnswerShippingQueryParams

AnswerShippingQueryParams is the parameter set for 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.

type AnswerShippingQueryParams struct {
    // Unique identifier for the query to be answered
    ShippingQueryID string `json:"shipping_query_id"`
    // 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)
    Ok  bool `json:"ok"`
    // Required if ok is True. A JSON-serialized array of available shipping options.
    ShippingOptions []ShippingOption `json:"shipping_options,omitempty"`
    // Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. “Sorry, delivery to your desired address is unavailable”). Telegram will display this message to the user.
    ErrorMessage string `json:"error_message,omitempty"`
}

type AnswerWebAppQueryParams

AnswerWebAppQueryParams is the parameter set for 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.

type AnswerWebAppQueryParams struct {
    // Unique identifier for the query to be answered
    WebAppQueryID string `json:"web_app_query_id"`
    // A JSON-serialized object describing the message to be sent
    Result InlineQueryResult `json:"result"`
}

type ApproveChatJoinRequestParams

ApproveChatJoinRequestParams is the parameter set for 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.

type ApproveChatJoinRequestParams struct {
    // Unique identifier for the target chat or username of the target channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier of the target user
    UserID int64 `json:"user_id"`
}

type ApproveSuggestedPostParams

ApproveSuggestedPostParams is the parameter set for ApproveSuggestedPost.

Use this method to approve a suggested post in a direct messages chat. The bot must have the 'can_post_messages' administrator right in the corresponding channel chat. Returns True on success.

type ApproveSuggestedPostParams struct {
    // Unique identifier for the target direct messages chat
    ChatID int64 `json:"chat_id"`
    // Identifier of a suggested post message to approve
    MessageID int64 `json:"message_id"`
    // Point in time (Unix timestamp) when the post is expected to be published; omit if the date has already been specified when the suggested post was created. If specified, then the date must be not more than 2678400 seconds (30 days) in the future.
    SendDate *int64 `json:"send_date,omitempty"`
}

type Audio

This object represents an audio file to be treated as music by the Telegram clients.

type Audio struct {
    // Identifier for this file, which can be used to download or reuse the file
    FileID string `json:"file_id"`
    // Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
    FileUniqueID string `json:"file_unique_id"`
    // Duration of the audio in seconds as defined by the sender
    Duration int64 `json:"duration"`
    // Optional. Performer of the audio as defined by the sender or by audio tags
    Performer string `json:"performer,omitempty"`
    // Optional. Title of the audio as defined by the sender or by audio tags
    Title string `json:"title,omitempty"`
    // Optional. Original filename as defined by the sender
    FileName string `json:"file_name,omitempty"`
    // Optional. MIME type of the file as defined by the sender
    MimeType string `json:"mime_type,omitempty"`
    // Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
    FileSize *int64 `json:"file_size,omitempty"`
    // Optional. Thumbnail of the album cover to which the music file belongs
    Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
}

type BackgroundFill

BackgroundFill is a union type. The following concrete variants implement it:

  • BackgroundFillSolid
  • BackgroundFillGradient
  • BackgroundFillFreeformGradient

This object describes the way a background is filled based on the selected colors. Currently, it can be one of

type BackgroundFill interface {
    // contains filtered or unexported methods
}

func UnmarshalBackgroundFill

func UnmarshalBackgroundFill(data []byte) (BackgroundFill, error)

UnmarshalBackgroundFill decodes a BackgroundFill from JSON by inspecting the "type" field and dispatching to the correct concrete type.

type BackgroundFillFreeformGradient

The background is a freeform gradient that rotates after every message in the chat.

type BackgroundFillFreeformGradient struct {
    // Type of the background fill, always “freeform_gradient”
    Type BackgroundFillType `json:"type"`
    // A list of the 3 or 4 base colors that are used to generate the freeform gradient in the RGB24 format
    Colors []int64 `json:"colors"`
}

func (*BackgroundFillFreeformGradient) MarshalJSON

func (v *BackgroundFillFreeformGradient) MarshalJSON() ([]byte, error)

MarshalJSON encodes BackgroundFillFreeformGradient with the discriminator field "type" forced to "freeform_gradient". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type BackgroundFillGradient

The background is a gradient fill.

type BackgroundFillGradient struct {
    // Type of the background fill, always “gradient”
    Type BackgroundFillType `json:"type"`
    // Top color of the gradient in the RGB24 format
    TopColor int64 `json:"top_color"`
    // Bottom color of the gradient in the RGB24 format
    BottomColor int64 `json:"bottom_color"`
    // Clockwise rotation angle of the background fill in degrees; 0-359
    RotationAngle int64 `json:"rotation_angle"`
}

func (*BackgroundFillGradient) MarshalJSON

func (v *BackgroundFillGradient) MarshalJSON() ([]byte, error)

MarshalJSON encodes BackgroundFillGradient with the discriminator field "type" forced to "gradient". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type BackgroundFillSolid

The background is filled using the selected color.

type BackgroundFillSolid struct {
    // Type of the background fill, always “solid”
    Type BackgroundFillType `json:"type"`
    // The color of the background fill in the RGB24 format
    Color int64 `json:"color"`
}

func (*BackgroundFillSolid) MarshalJSON

func (v *BackgroundFillSolid) MarshalJSON() ([]byte, error)

MarshalJSON encodes BackgroundFillSolid with the discriminator field "type" forced to "solid". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type BackgroundFillType

type BackgroundFillType string


const (
    BackgroundFillTypeSolid            BackgroundFillType = "solid"
    BackgroundFillTypeGradient         BackgroundFillType = "gradient"
    BackgroundFillTypeFreeformGradient BackgroundFillType = "freeform_gradient"
)

type BackgroundType

BackgroundType is a union type. The following concrete variants implement it:

  • BackgroundTypeFill
  • BackgroundTypeWallpaper
  • BackgroundTypePattern
  • BackgroundTypeChatTheme

This object describes the type of a background. Currently, it can be one of

type BackgroundType interface {
    // contains filtered or unexported methods
}

func UnmarshalBackgroundType

func UnmarshalBackgroundType(data []byte) (BackgroundType, error)

UnmarshalBackgroundType decodes a BackgroundType from JSON by inspecting the "type" field and dispatching to the correct concrete type.

type BackgroundTypeChatTheme

The background is taken directly from a built-in chat theme.

type BackgroundTypeChatTheme struct {
    // Type of the background, always “chat_theme”
    Type BackgroundTypeKind `json:"type"`
    // Name of the chat theme, which is usually an emoji
    ThemeName string `json:"theme_name"`
}

func (*BackgroundTypeChatTheme) MarshalJSON

func (v *BackgroundTypeChatTheme) MarshalJSON() ([]byte, error)

MarshalJSON encodes BackgroundTypeChatTheme with the discriminator field "type" forced to "chat_theme". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type BackgroundTypeFill

The background is automatically filled based on the selected colors.

type BackgroundTypeFill struct {
    // Type of the background, always “fill”
    Type BackgroundTypeKind `json:"type"`
    // The background fill
    Fill BackgroundFill `json:"fill"`
    // Dimming of the background in dark themes, as a percentage; 0-100
    DarkThemeDimming int64 `json:"dark_theme_dimming"`
}

func (*BackgroundTypeFill) MarshalJSON

func (v *BackgroundTypeFill) MarshalJSON() ([]byte, error)

MarshalJSON encodes BackgroundTypeFill with the discriminator field "type" forced to "fill". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

func (*BackgroundTypeFill) UnmarshalJSON

func (m *BackgroundTypeFill) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes BackgroundTypeFill by dispatching union-typed fields (Fill) through their concrete UnmarshalXxx helpers.

type BackgroundTypeKind

type BackgroundTypeKind string


const (
    BackgroundTypeKindFill      BackgroundTypeKind = "fill"
    BackgroundTypeKindWallpaper BackgroundTypeKind = "wallpaper"
    BackgroundTypeKindPattern   BackgroundTypeKind = "pattern"
    BackgroundTypeKindChatTheme BackgroundTypeKind = "chat_theme"
)

type BackgroundTypePattern

The background is a .PNG or .TGV (gzipped subset of SVG with MIME type “application/x-tgwallpattern”) pattern to be combined with the background fill chosen by the user.

type BackgroundTypePattern struct {
    // Type of the background, always “pattern”
    Type BackgroundTypeKind `json:"type"`
    // Document with the pattern
    Document Document `json:"document"`
    // The background fill that is combined with the pattern
    Fill BackgroundFill `json:"fill"`
    // Intensity of the pattern when it is shown above the filled background; 0-100
    Intensity int64 `json:"intensity"`
    // Optional. True, if the background fill must be applied only to the pattern itself. All other pixels are black in this case. For dark themes only.
    IsInverted *bool `json:"is_inverted,omitempty"`
    // Optional. True, if the background moves slightly when the device is tilted
    IsMoving *bool `json:"is_moving,omitempty"`
}

func (*BackgroundTypePattern) MarshalJSON

func (v *BackgroundTypePattern) MarshalJSON() ([]byte, error)

MarshalJSON encodes BackgroundTypePattern with the discriminator field "type" forced to "pattern". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

func (*BackgroundTypePattern) UnmarshalJSON

func (m *BackgroundTypePattern) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes BackgroundTypePattern by dispatching union-typed fields (Fill) through their concrete UnmarshalXxx helpers.

type BackgroundTypeWallpaper

The background is a wallpaper in the JPEG format.

type BackgroundTypeWallpaper struct {
    // Type of the background, always “wallpaper”
    Type BackgroundTypeKind `json:"type"`
    // Document with the wallpaper
    Document Document `json:"document"`
    // Dimming of the background in dark themes, as a percentage; 0-100
    DarkThemeDimming int64 `json:"dark_theme_dimming"`
    // Optional. True, if the wallpaper is downscaled to fit in a 450x450 square and then box-blurred with radius 12
    IsBlurred *bool `json:"is_blurred,omitempty"`
    // Optional. True, if the background moves slightly when the device is tilted
    IsMoving *bool `json:"is_moving,omitempty"`
}

func (*BackgroundTypeWallpaper) MarshalJSON

func (v *BackgroundTypeWallpaper) MarshalJSON() ([]byte, error)

MarshalJSON encodes BackgroundTypeWallpaper with the discriminator field "type" forced to "wallpaper". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type BanChatMemberParams

BanChatMemberParams is the parameter set for 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.

type BanChatMemberParams struct {
    // Unique identifier for the target group or username of the target supergroup or channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier of the target user
    UserID int64 `json:"user_id"`
    // Date when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.
    UntilDate *int64 `json:"until_date,omitempty"`
    // Pass True to delete all messages from the chat for the user that is being removed. If False, the user will be able to see messages in the group that were sent before the user was removed. Always True for supergroups and channels.
    RevokeMessages *bool `json:"revoke_messages,omitempty"`
}

type BanChatSenderChatParams

BanChatSenderChatParams is the parameter set for 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.

type BanChatSenderChatParams struct {
    // Unique identifier for the target chat or username of the target channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier of the target sender chat
    SenderChatID int64 `json:"sender_chat_id"`
}

type Birthdate

Describes the birthdate of a user.

type Birthdate struct {
    // Day of the user's birth; 1-31
    Day int64 `json:"day"`
    // Month of the user's birth; 1-12
    Month int64 `json:"month"`
    // Optional. Year of the user's birth
    Year *int64 `json:"year,omitempty"`
}

type BotAccessSettings

This object describes the access settings of a bot.

type BotAccessSettings struct {
    // True, if only selected users can access the bot. The bot's owner can always access it.
    IsAccessRestricted bool `json:"is_access_restricted"`
    // Optional. The list of other users who have access to the bot if the access is restricted
    AddedUsers []User `json:"added_users,omitempty"`
}

func GetManagedBotAccessSettings

func GetManagedBotAccessSettings(ctx context.Context, b *client.Bot, p *GetManagedBotAccessSettingsParams) (*BotAccessSettings, error)

GetManagedBotAccessSettings calls the getManagedBotAccessSettings Telegram Bot API method.

Use this method to get the access settings of a managed bot. Returns a BotAccessSettings object on success.

type BotCommand

This object represents a bot command.

type BotCommand struct {
    // Text of the command; 1-32 characters. Can contain only lowercase English letters, digits and underscores.
    Command string `json:"command"`
    // Description of the command; 1-256 characters
    Description string `json:"description"`
}

func GetMyCommands

func GetMyCommands(ctx context.Context, b *client.Bot, p *GetMyCommandsParams) ([]BotCommand, error)

GetMyCommands calls the getMyCommands Telegram Bot API method.

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.

type BotCommandScope

BotCommandScope is a union type. The following concrete variants implement it:

  • BotCommandScopeDefault
  • BotCommandScopeAllPrivateChats
  • BotCommandScopeAllGroupChats
  • BotCommandScopeAllChatAdministrators
  • BotCommandScopeChat
  • BotCommandScopeChatAdministrators
  • BotCommandScopeChatMember

This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported:

type BotCommandScope interface {
    // contains filtered or unexported methods
}

type BotCommandScopeAllChatAdministrators

Represents the scope of bot commands, covering all group and supergroup chat administrators.

type BotCommandScopeAllChatAdministrators struct {
    // Scope type, must be all_chat_administrators
    Type BotCommandScopeType `json:"type"`
}

func (*BotCommandScopeAllChatAdministrators) MarshalJSON

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

MarshalJSON encodes BotCommandScopeAllChatAdministrators with the discriminator field "type" forced to "all_chat_administrators". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type BotCommandScopeAllGroupChats

Represents the scope of bot commands, covering all group and supergroup chats.

type BotCommandScopeAllGroupChats struct {
    // Scope type, must be all_group_chats
    Type BotCommandScopeType `json:"type"`
}

func (*BotCommandScopeAllGroupChats) MarshalJSON

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

MarshalJSON encodes BotCommandScopeAllGroupChats with the discriminator field "type" forced to "all_group_chats". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type BotCommandScopeAllPrivateChats

Represents the scope of bot commands, covering all private chats.

type BotCommandScopeAllPrivateChats struct {
    // Scope type, must be all_private_chats
    Type BotCommandScopeType `json:"type"`
}

func (*BotCommandScopeAllPrivateChats) MarshalJSON

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

MarshalJSON encodes BotCommandScopeAllPrivateChats with the discriminator field "type" forced to "all_private_chats". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type BotCommandScopeChat

Represents the scope of bot commands, covering a specific chat.

type BotCommandScopeChat struct {
    // Scope type, must be chat
    Type BotCommandScopeType `json:"type"`
    // Unique identifier for the target chat or username of the target supergroup in the format @username. Channel direct messages chats and channel chats aren't supported.
    ChatID ChatID `json:"chat_id"`
}

func (*BotCommandScopeChat) MarshalJSON

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

MarshalJSON encodes BotCommandScopeChat with the discriminator field "type" forced to "chat". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type BotCommandScopeChatAdministrators

Represents the scope of bot commands, covering all administrators of a specific group or supergroup chat.

type BotCommandScopeChatAdministrators struct {
    // Scope type, must be chat_administrators
    Type BotCommandScopeType `json:"type"`
    // Unique identifier for the target chat or username of the target supergroup in the format @username. Channel direct messages chats and channel chats aren't supported.
    ChatID ChatID `json:"chat_id"`
}

func (*BotCommandScopeChatAdministrators) MarshalJSON

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

MarshalJSON encodes BotCommandScopeChatAdministrators with the discriminator field "type" forced to "chat_administrators". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type BotCommandScopeChatMember

Represents the scope of bot commands, covering a specific member of a group or supergroup chat.

type BotCommandScopeChatMember struct {
    // Scope type, must be chat_member
    Type BotCommandScopeType `json:"type"`
    // Unique identifier for the target chat or username of the target supergroup in the format @username. Channel direct messages chats and channel chats aren't supported.
    ChatID ChatID `json:"chat_id"`
    // Unique identifier of the target user
    UserID int64 `json:"user_id"`
}

func (*BotCommandScopeChatMember) MarshalJSON

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

MarshalJSON encodes BotCommandScopeChatMember with the discriminator field "type" forced to "chat_member". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type BotCommandScopeDefault

Represents the default scope of bot commands. Default commands are used if no commands with a narrower scope are specified for the user.

type BotCommandScopeDefault struct {
    // Scope type, must be default
    Type BotCommandScopeType `json:"type"`
}

func (*BotCommandScopeDefault) MarshalJSON

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

MarshalJSON encodes BotCommandScopeDefault with the discriminator field "type" forced to "default". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type BotCommandScopeType

type BotCommandScopeType string


const (
    BotCommandScopeTypeDefault               BotCommandScopeType = "default"
    BotCommandScopeTypeAllPrivateChats       BotCommandScopeType = "all_private_chats"
    BotCommandScopeTypeAllGroupChats         BotCommandScopeType = "all_group_chats"
    BotCommandScopeTypeAllChatAdministrators BotCommandScopeType = "all_chat_administrators"
    BotCommandScopeTypeChat                  BotCommandScopeType = "chat"
    BotCommandScopeTypeChatAdministrators    BotCommandScopeType = "chat_administrators"
    BotCommandScopeTypeChatMember            BotCommandScopeType = "chat_member"
)

type BotDescription

This object represents the bot's description.

type BotDescription struct {
    // The bot's description
    Description string `json:"description"`
}

func GetMyDescription

func GetMyDescription(ctx context.Context, b *client.Bot, p *GetMyDescriptionParams) (*BotDescription, error)

GetMyDescription calls the getMyDescription Telegram Bot API method.

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

type BotName

This object represents the bot's name.

type BotName struct {
    // The bot's name
    Name string `json:"name"`
}

func GetMyName

func GetMyName(ctx context.Context, b *client.Bot, p *GetMyNameParams) (*BotName, error)

GetMyName calls the getMyName Telegram Bot API method.

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

type BotShortDescription

This object represents the bot's short description.

type BotShortDescription struct {
    // The bot's short description
    ShortDescription string `json:"short_description"`
}

func GetMyShortDescription

func GetMyShortDescription(ctx context.Context, b *client.Bot, p *GetMyShortDescriptionParams) (*BotShortDescription, error)

GetMyShortDescription calls the getMyShortDescription Telegram Bot API method.

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

type BusinessBotRights

Represents the rights of a business bot.

type BusinessBotRights struct {
    // Optional. True, if the bot can send and edit messages in the private chats that had incoming messages in the last 24 hours
    CanReply *bool `json:"can_reply,omitempty"`
    // Optional. True, if the bot can mark incoming private messages as read
    CanReadMessages *bool `json:"can_read_messages,omitempty"`
    // Optional. True, if the bot can delete messages sent by the bot
    CanDeleteSentMessages *bool `json:"can_delete_sent_messages,omitempty"`
    // Optional. True, if the bot can delete all private messages in managed chats
    CanDeleteAllMessages *bool `json:"can_delete_all_messages,omitempty"`
    // Optional. True, if the bot can edit the first and last name of the business account
    CanEditName *bool `json:"can_edit_name,omitempty"`
    // Optional. True, if the bot can edit the bio of the business account
    CanEditBio *bool `json:"can_edit_bio,omitempty"`
    // Optional. True, if the bot can edit the profile photo of the business account
    CanEditProfilePhoto *bool `json:"can_edit_profile_photo,omitempty"`
    // Optional. True, if the bot can edit the username of the business account
    CanEditUsername *bool `json:"can_edit_username,omitempty"`
    // Optional. True, if the bot can change the privacy settings pertaining to gifts for the business account
    CanChangeGiftSettings *bool `json:"can_change_gift_settings,omitempty"`
    // Optional. True, if the bot can view gifts and the amount of Telegram Stars owned by the business account
    CanViewGiftsAndStars *bool `json:"can_view_gifts_and_stars,omitempty"`
    // Optional. True, if the bot can convert regular gifts owned by the business account to Telegram Stars
    CanConvertGiftsToStars *bool `json:"can_convert_gifts_to_stars,omitempty"`
    // Optional. True, if the bot can transfer and upgrade gifts owned by the business account
    CanTransferAndUpgradeGifts *bool `json:"can_transfer_and_upgrade_gifts,omitempty"`
    // Optional. True, if the bot can transfer Telegram Stars received by the business account to its own account, or use them to upgrade and transfer gifts
    CanTransferStars *bool `json:"can_transfer_stars,omitempty"`
    // Optional. True, if the bot can post, edit and delete stories on behalf of the business account
    CanManageStories *bool `json:"can_manage_stories,omitempty"`
}

type BusinessConnection

Describes the connection of the bot with a business account.

type BusinessConnection struct {
    // Unique identifier of the business connection
    ID  string `json:"id"`
    // Business account user that created the business connection
    User User `json:"user"`
    // Identifier of a private chat with the user who created the business connection. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.
    UserChatID int64 `json:"user_chat_id"`
    // Date the connection was established in Unix time
    Date int64 `json:"date"`
    // Optional. Rights of the business bot
    Rights *BusinessBotRights `json:"rights,omitempty"`
    // True, if the connection is active
    IsEnabled bool `json:"is_enabled"`
}

func GetBusinessConnection

func GetBusinessConnection(ctx context.Context, b *client.Bot, p *GetBusinessConnectionParams) (*BusinessConnection, error)

GetBusinessConnection calls the getBusinessConnection Telegram Bot API method.

Use this method to get information about the connection of the bot with a business account. Returns a BusinessConnection object on success.

type BusinessIntro

Contains information about the start page settings of a Telegram Business account.

type BusinessIntro struct {
    // Optional. Title text of the business intro
    Title string `json:"title,omitempty"`
    // Optional. Message text of the business intro
    Message string `json:"message,omitempty"`
    // Optional. Sticker of the business intro
    Sticker *Sticker `json:"sticker,omitempty"`
}

type BusinessLocation

Contains information about the location of a Telegram Business account.

type BusinessLocation struct {
    // Address of the business
    Address string `json:"address"`
    // Optional. Location of the business
    Location *Location `json:"location,omitempty"`
}

type BusinessMessagesDeleted

This object is received when messages are deleted from a connected business account.

type BusinessMessagesDeleted struct {
    // Unique identifier of the business connection
    BusinessConnectionID string `json:"business_connection_id"`
    // Information about a chat in the business account. The bot may not have access to the chat or the corresponding user.
    Chat Chat `json:"chat"`
    // The list of identifiers of deleted messages in the chat of the business account
    MessageIds []int64 `json:"message_ids"`
}

type BusinessOpeningHours

Describes the opening hours of a business.

type BusinessOpeningHours struct {
    // Unique name of the time zone for which the opening hours are defined
    TimeZoneName string `json:"time_zone_name"`
    // List of time intervals describing business opening hours
    OpeningHours []BusinessOpeningHoursInterval `json:"opening_hours"`
}

type BusinessOpeningHoursInterval

Describes an interval of time during which a business is open.

type BusinessOpeningHoursInterval struct {
    // The minute's sequence number in a week, starting on Monday, marking the start of the time interval during which the business is open; 0 - 7 * 24 * 60
    OpeningMinute int64 `json:"opening_minute"`
    // The minute's sequence number in a week, starting on Monday, marking the end of the time interval during which the business is open; 0 - 8 * 24 * 60
    ClosingMinute int64 `json:"closing_minute"`
}

type CallbackGame

A placeholder, currently holds no information. Use BotFather to set up your game.

type CallbackGame struct {
}

type CallbackQuery

This object represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field message will be present. If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present. NOTE: After the user presses a callback button, Telegram clients will display a progress bar until you call answerCallbackQuery. It is, therefore, necessary to react by calling answerCallbackQuery even if no notification to the user is needed (e.g., without specifying any of the optional parameters).

type CallbackQuery struct {
    // Unique identifier for this query
    ID  string `json:"id"`
    // Sender
    From User `json:"from"`
    // Optional. Message sent by the bot with the callback button that originated the query
    Message MaybeInaccessibleMessage `json:"message,omitempty"`
    // Optional. Identifier of the message sent via the bot in inline mode, that originated the query
    InlineMessageID string `json:"inline_message_id,omitempty"`
    // Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games.
    ChatInstance string `json:"chat_instance"`
    // Optional. Data associated with the callback button. Be aware that the message originated the query can contain no callback buttons with this data.
    Data string `json:"data,omitempty"`
    // Optional. Short name of a Game to be returned, serves as the unique identifier for the game
    GameShortName string `json:"game_short_name,omitempty"`
}

func (*CallbackQuery) UnmarshalJSON

func (m *CallbackQuery) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes CallbackQuery by dispatching union-typed fields (Message) through their concrete UnmarshalXxx helpers.

type Chat

This object represents a chat.

type Chat struct {
    // Unique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.
    ID  int64 `json:"id"`
    // Type of the chat, can be either “private”, “group”, “supergroup” or “channel”
    Type ChatType `json:"type"`
    // Optional. Title, for supergroups, channels and group chats
    Title string `json:"title,omitempty"`
    // Optional. Username, for private chats, supergroups and channels if available
    Username string `json:"username,omitempty"`
    // Optional. First name of the other party in a private chat
    FirstName string `json:"first_name,omitempty"`
    // Optional. Last name of the other party in a private chat
    LastName string `json:"last_name,omitempty"`
    // Optional. True, if the supergroup chat is a forum (has topics enabled)
    IsForum *bool `json:"is_forum,omitempty"`
    // Optional. True, if the chat is the direct messages chat of a channel
    IsDirectMessages *bool `json:"is_direct_messages,omitempty"`
}

type ChatAdministratorRights

Represents the rights of an administrator in a chat.

type ChatAdministratorRights struct {
    // True, if the user's presence in the chat is hidden
    IsAnonymous bool `json:"is_anonymous"`
    // True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.
    CanManageChat bool `json:"can_manage_chat"`
    // True, if the administrator can delete messages of other users
    CanDeleteMessages bool `json:"can_delete_messages"`
    // True, if the administrator can manage video chats
    CanManageVideoChats bool `json:"can_manage_video_chats"`
    // True, if the administrator can restrict, ban or unban chat members, or access supergroup statistics
    CanRestrictMembers bool `json:"can_restrict_members"`
    // True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user)
    CanPromoteMembers bool `json:"can_promote_members"`
    // True, if the user is allowed to change the chat title, photo and other settings
    CanChangeInfo bool `json:"can_change_info"`
    // True, if the user is allowed to invite new users to the chat
    CanInviteUsers bool `json:"can_invite_users"`
    // True, if the administrator can post stories to the chat
    CanPostStories bool `json:"can_post_stories"`
    // True, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive
    CanEditStories bool `json:"can_edit_stories"`
    // True, if the administrator can delete stories posted by other users
    CanDeleteStories bool `json:"can_delete_stories"`
    // Optional. True, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only
    CanPostMessages *bool `json:"can_post_messages,omitempty"`
    // Optional. True, if the administrator can edit messages of other users and can pin messages; for channels only
    CanEditMessages *bool `json:"can_edit_messages,omitempty"`
    // Optional. True, if the user is allowed to pin messages; for groups and supergroups only
    CanPinMessages *bool `json:"can_pin_messages,omitempty"`
    // Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only
    CanManageTopics *bool `json:"can_manage_topics,omitempty"`
    // Optional. True, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only
    CanManageDirectMessages *bool `json:"can_manage_direct_messages,omitempty"`
    // Optional. True, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can_pin_messages.
    CanManageTags *bool `json:"can_manage_tags,omitempty"`
}

func GetMyDefaultAdministratorRights

func GetMyDefaultAdministratorRights(ctx context.Context, b *client.Bot, p *GetMyDefaultAdministratorRightsParams) (*ChatAdministratorRights, error)

GetMyDefaultAdministratorRights calls the getMyDefaultAdministratorRights Telegram Bot API method.

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

type ChatBackground

This object represents a chat background.

type ChatBackground struct {
    // Type of the background
    Type BackgroundType `json:"type"`
}

func (*ChatBackground) UnmarshalJSON

func (m *ChatBackground) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes ChatBackground by dispatching union-typed fields (Type) through their concrete UnmarshalXxx helpers.

type ChatBoost

This object contains information about a chat boost.

type ChatBoost struct {
    // Unique identifier of the boost
    BoostID string `json:"boost_id"`
    // Point in time (Unix timestamp) when the chat was boosted
    AddDate int64 `json:"add_date"`
    // Point in time (Unix timestamp) when the boost will automatically expire, unless the booster's Telegram Premium subscription is prolonged
    ExpirationDate int64 `json:"expiration_date"`
    // Source of the added boost
    Source ChatBoostSource `json:"source"`
}

func (*ChatBoost) UnmarshalJSON

func (m *ChatBoost) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes ChatBoost by dispatching union-typed fields (Source) through their concrete UnmarshalXxx helpers.

type ChatBoostAdded

This object represents a service message about a user boosting a chat.

type ChatBoostAdded struct {
    // Number of boosts added by the user
    BoostCount int64 `json:"boost_count"`
}

type ChatBoostRemoved

This object represents a boost removed from a chat.

type ChatBoostRemoved struct {
    // Chat which was boosted
    Chat Chat `json:"chat"`
    // Unique identifier of the boost
    BoostID string `json:"boost_id"`
    // Point in time (Unix timestamp) when the boost was removed
    RemoveDate int64 `json:"remove_date"`
    // Source of the removed boost
    Source ChatBoostSource `json:"source"`
}

func (*ChatBoostRemoved) UnmarshalJSON

func (m *ChatBoostRemoved) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes ChatBoostRemoved by dispatching union-typed fields (Source) through their concrete UnmarshalXxx helpers.

type ChatBoostSource

ChatBoostSource is a union type. The following concrete variants implement it:

  • ChatBoostSourcePremium
  • ChatBoostSourceGiftCode
  • ChatBoostSourceGiveaway

This object describes the source of a chat boost. It can be one of

type ChatBoostSource interface {
    // contains filtered or unexported methods
}

func UnmarshalChatBoostSource

func UnmarshalChatBoostSource(data []byte) (ChatBoostSource, error)

UnmarshalChatBoostSource decodes a ChatBoostSource from JSON by inspecting the "source" field and dispatching to the correct concrete type.

type ChatBoostSourceGiftCode

The boost was obtained by the creation of Telegram Premium gift codes to boost a chat. Each such code boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription.

type ChatBoostSourceGiftCode struct {
    // Source of the boost, always “gift_code”
    Source ChatBoostSourceKind `json:"source"`
    // User for which the gift code was created
    User User `json:"user"`
}

func (*ChatBoostSourceGiftCode) MarshalJSON

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

MarshalJSON encodes ChatBoostSourceGiftCode with the discriminator field "source" forced to "gift_code". The hardcoded value frees callers from setting Source by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type ChatBoostSourceGiveaway

The boost was obtained by the creation of a Telegram Premium or a Telegram Star giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription for Telegram Premium giveaways and prize_star_count / 500 times for one year for Telegram Star giveaways.

type ChatBoostSourceGiveaway struct {
    // Source of the boost, always “giveaway”
    Source ChatBoostSourceKind `json:"source"`
    // Identifier of a message in the chat with the giveaway; the message could have been deleted already. May be 0 if the message isn't sent yet.
    GiveawayMessageID int64 `json:"giveaway_message_id"`
    // Optional. User that won the prize in the giveaway if any; for Telegram Premium giveaways only
    User *User `json:"user,omitempty"`
    // Optional. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only
    PrizeStarCount *int64 `json:"prize_star_count,omitempty"`
    // Optional. True, if the giveaway was completed, but there was no user to win the prize
    IsUnclaimed *bool `json:"is_unclaimed,omitempty"`
}

func (*ChatBoostSourceGiveaway) MarshalJSON

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

MarshalJSON encodes ChatBoostSourceGiveaway with the discriminator field "source" forced to "giveaway". The hardcoded value frees callers from setting Source by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type ChatBoostSourceKind

type ChatBoostSourceKind string


const (
    ChatBoostSourceKindPremium  ChatBoostSourceKind = "premium"
    ChatBoostSourceKindGiftCode ChatBoostSourceKind = "gift_code"
    ChatBoostSourceKindGiveaway ChatBoostSourceKind = "giveaway"
)

type ChatBoostSourcePremium

The boost was obtained by subscribing to Telegram Premium or by gifting a Telegram Premium subscription to another user.

type ChatBoostSourcePremium struct {
    // Source of the boost, always “premium”
    Source ChatBoostSourceKind `json:"source"`
    // User that boosted the chat
    User User `json:"user"`
}

func (*ChatBoostSourcePremium) MarshalJSON

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

MarshalJSON encodes ChatBoostSourcePremium with the discriminator field "source" forced to "premium". The hardcoded value frees callers from setting Source by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type ChatBoostUpdated

This object represents a boost added to a chat or changed.

type ChatBoostUpdated struct {
    // Chat which was boosted
    Chat Chat `json:"chat"`
    // Information about the chat boost
    Boost ChatBoost `json:"boost"`
}

type ChatFullInfo

This object contains full information about a chat.

type ChatFullInfo struct {
    // Unique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.
    ID  int64 `json:"id"`
    // Type of the chat, can be either “private”, “group”, “supergroup” or “channel”
    Type ChatType `json:"type"`
    // Optional. Title, for supergroups, channels and group chats
    Title string `json:"title,omitempty"`
    // Optional. Username, for private chats, supergroups and channels if available
    Username string `json:"username,omitempty"`
    // Optional. First name of the other party in a private chat
    FirstName string `json:"first_name,omitempty"`
    // Optional. Last name of the other party in a private chat
    LastName string `json:"last_name,omitempty"`
    // Optional. True, if the supergroup chat is a forum (has topics enabled)
    IsForum *bool `json:"is_forum,omitempty"`
    // Optional. True, if the chat is the direct messages chat of a channel
    IsDirectMessages *bool `json:"is_direct_messages,omitempty"`
    // Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See accent colors for more details.
    AccentColorID int64 `json:"accent_color_id"`
    // The maximum number of reactions that can be set on a message in the chat
    MaxReactionCount int64 `json:"max_reaction_count"`
    // Optional. Chat photo
    Photo *ChatPhoto `json:"photo,omitempty"`
    // Optional. If non-empty, the list of all active chat usernames; for private chats, supergroups and channels
    ActiveUsernames []string `json:"active_usernames,omitempty"`
    // Optional. For private chats, the date of birth of the user
    Birthdate *Birthdate `json:"birthdate,omitempty"`
    // Optional. For private chats with business accounts, the intro of the business
    BusinessIntro *BusinessIntro `json:"business_intro,omitempty"`
    // Optional. For private chats with business accounts, the location of the business
    BusinessLocation *BusinessLocation `json:"business_location,omitempty"`
    // Optional. For private chats with business accounts, the opening hours of the business
    BusinessOpeningHours *BusinessOpeningHours `json:"business_opening_hours,omitempty"`
    // Optional. For private chats, the personal channel of the user
    PersonalChat *Chat `json:"personal_chat,omitempty"`
    // Optional. Information about the corresponding channel chat; for direct messages chats only
    ParentChat *Chat `json:"parent_chat,omitempty"`
    // Optional. List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed.
    AvailableReactions []ReactionType `json:"available_reactions,omitempty"`
    // Optional. Custom emoji identifier of the emoji chosen by the chat for the reply header and link preview background
    BackgroundCustomEmojiID string `json:"background_custom_emoji_id,omitempty"`
    // Optional. Identifier of the accent color for the chat's profile background. See profile accent colors for more details.
    ProfileAccentColorID *int64 `json:"profile_accent_color_id,omitempty"`
    // Optional. Custom emoji identifier of the emoji chosen by the chat for its profile background
    ProfileBackgroundCustomEmojiID string `json:"profile_background_custom_emoji_id,omitempty"`
    // Optional. Custom emoji identifier of the emoji status of the chat or the other party in a private chat
    EmojiStatusCustomEmojiID string `json:"emoji_status_custom_emoji_id,omitempty"`
    // Optional. Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any
    EmojiStatusExpirationDate *int64 `json:"emoji_status_expiration_date,omitempty"`
    // Optional. Bio of the other party in a private chat
    Bio string `json:"bio,omitempty"`
    // Optional. True, if privacy settings of the other party in the private chat allows to use tg://user?id=<user_id> links only in chats with the user
    HasPrivateForwards *bool `json:"has_private_forwards,omitempty"`
    // Optional. True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat
    HasRestrictedVoiceAndVideoMessages *bool `json:"has_restricted_voice_and_video_messages,omitempty"`
    // Optional. True, if users need to join the supergroup before they can send messages
    JoinToSendMessages *bool `json:"join_to_send_messages,omitempty"`
    // Optional. True, if all users directly joining the supergroup without using an invite link need to be approved by supergroup administrators
    JoinByRequest *bool `json:"join_by_request,omitempty"`
    // Optional. Description, for groups, supergroups and channel chats
    Description string `json:"description,omitempty"`
    // Optional. Primary invite link, for groups, supergroups and channel chats
    InviteLink string `json:"invite_link,omitempty"`
    // Optional. The most recent pinned message (by sending date)
    PinnedMessage *Message `json:"pinned_message,omitempty"`
    // Optional. Default chat member permissions, for groups and supergroups
    Permissions *ChatPermissions `json:"permissions,omitempty"`
    // Information about types of gifts that are accepted by the chat or by the corresponding user for private chats
    AcceptedGiftTypes AcceptedGiftTypes `json:"accepted_gift_types"`
    // Optional. True, if paid media messages can be sent or forwarded to the channel chat. The field is available only for channel chats.
    CanSendPaidMedia *bool `json:"can_send_paid_media,omitempty"`
    // Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds
    SlowModeDelay *int64 `json:"slow_mode_delay,omitempty"`
    // Optional. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions
    UnrestrictBoostCount *int64 `json:"unrestrict_boost_count,omitempty"`
    // Optional. The time after which all messages sent to the chat will be automatically deleted; in seconds
    MessageAutoDeleteTime *int64 `json:"message_auto_delete_time,omitempty"`
    // Optional. True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators.
    HasAggressiveAntiSpamEnabled *bool `json:"has_aggressive_anti_spam_enabled,omitempty"`
    // Optional. True, if non-administrators can only get the list of bots and administrators in the chat
    HasHiddenMembers *bool `json:"has_hidden_members,omitempty"`
    // Optional. True, if messages from the chat can't be forwarded to other chats
    HasProtectedContent *bool `json:"has_protected_content,omitempty"`
    // Optional. True, if new chat members will have access to old messages; available only to chat administrators
    HasVisibleHistory *bool `json:"has_visible_history,omitempty"`
    // Optional. For supergroups, name of the group sticker set
    StickerSetName string `json:"sticker_set_name,omitempty"`
    // Optional. True, if the bot can change the group sticker set
    CanSetStickerSet *bool `json:"can_set_sticker_set,omitempty"`
    // Optional. For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group.
    CustomEmojiStickerSetName string `json:"custom_emoji_sticker_set_name,omitempty"`
    // Optional. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier.
    LinkedChatID *int64 `json:"linked_chat_id,omitempty"`
    // Optional. For supergroups, the location to which the supergroup is connected
    Location *ChatLocation `json:"location,omitempty"`
    // Optional. For private chats, the rating of the user if any
    Rating *UserRating `json:"rating,omitempty"`
    // Optional. For private chats, the first audio added to the profile of the user
    FirstProfileAudio *Audio `json:"first_profile_audio,omitempty"`
    // Optional. The color scheme based on a unique gift that must be used for the chat's name, message replies and link previews
    UniqueGiftColors *UniqueGiftColors `json:"unique_gift_colors,omitempty"`
    // Optional. The number of Telegram Stars a general user has to pay to send a message to the chat
    PaidMessageStarCount *int64 `json:"paid_message_star_count,omitempty"`
}

func GetChat

func GetChat(ctx context.Context, b *client.Bot, p *GetChatParams) (*ChatFullInfo, error)

GetChat calls the getChat Telegram Bot API method.

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

func (*ChatFullInfo) UnmarshalJSON

func (m *ChatFullInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes ChatFullInfo by dispatching union-typed fields (AvailableReactions) through their concrete UnmarshalXxx helpers.

type ChatID

ChatID identifies a chat by either numeric id or "@username". The Telegram Bot API spells the same field as either an integer or a string; ChatID preserves both forms with explicit constructors and a custom MarshalJSON so callers never see `any` at the source level.

type ChatID struct {
    // contains filtered or unexported fields
}

func ChatIDFromInt

func ChatIDFromInt(id int64) ChatID

ChatIDFromInt builds a ChatID for a numeric chat identifier (e.g. -1001234567890).

func ChatIDFromUsername

func ChatIDFromUsername(name string) ChatID

ChatIDFromUsername builds a ChatID for a public chat (e.g. "@channel"). The leading "@" is required by Telegram for usernames.

func (ChatID) IsZero

func (c ChatID) IsZero() bool

IsZero reports whether c carries no value.

func (ChatID) MarshalJSON

func (c ChatID) MarshalJSON() ([]byte, error)

MarshalJSON emits either a JSON number (integer form) or a JSON string (@username form). Empty values marshal as "null".

func (ChatID) String

func (c ChatID) String() string

String returns the wire form (decimal integer or "@name") for use in multipart bodies.

func (*ChatID) UnmarshalJSON

func (c *ChatID) UnmarshalJSON(data []byte) error

UnmarshalJSON accepts either a JSON number or a JSON string.

type ChatInviteLink

Represents an invite link for a chat.

type ChatInviteLink struct {
    // The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with “…”.
    InviteLink string `json:"invite_link"`
    // Creator of the link
    Creator User `json:"creator"`
    // True, if users joining the chat via the link need to be approved by chat administrators
    CreatesJoinRequest bool `json:"creates_join_request"`
    // True, if the link is primary
    IsPrimary bool `json:"is_primary"`
    // True, if the link is revoked
    IsRevoked bool `json:"is_revoked"`
    // Optional. Invite link name
    Name string `json:"name,omitempty"`
    // Optional. Point in time (Unix timestamp) when the link will expire or has been expired
    ExpireDate *int64 `json:"expire_date,omitempty"`
    // Optional. The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999
    MemberLimit *int64 `json:"member_limit,omitempty"`
    // Optional. Number of pending join requests created using this link
    PendingJoinRequestCount *int64 `json:"pending_join_request_count,omitempty"`
    // Optional. The number of seconds the subscription will be active for before the next payment
    SubscriptionPeriod *int64 `json:"subscription_period,omitempty"`
    // Optional. The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat using the link
    SubscriptionPrice *int64 `json:"subscription_price,omitempty"`
}

func CreateChatInviteLink

func CreateChatInviteLink(ctx context.Context, b *client.Bot, p *CreateChatInviteLinkParams) (*ChatInviteLink, error)

CreateChatInviteLink calls the createChatInviteLink Telegram Bot API method.

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.

func CreateChatSubscriptionInviteLink

func CreateChatSubscriptionInviteLink(ctx context.Context, b *client.Bot, p *CreateChatSubscriptionInviteLinkParams) (*ChatInviteLink, error)

CreateChatSubscriptionInviteLink calls the createChatSubscriptionInviteLink Telegram Bot API method.

Use this method to create a subscription invite link for a channel chat. The bot must have the can_invite_users administrator rights. The link can be edited using the method editChatSubscriptionInviteLink or revoked using the method revokeChatInviteLink. Returns the new invite link as a ChatInviteLink object.

func EditChatInviteLink

func EditChatInviteLink(ctx context.Context, b *client.Bot, p *EditChatInviteLinkParams) (*ChatInviteLink, error)

EditChatInviteLink calls the editChatInviteLink Telegram Bot API method.

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.

func EditChatSubscriptionInviteLink

func EditChatSubscriptionInviteLink(ctx context.Context, b *client.Bot, p *EditChatSubscriptionInviteLinkParams) (*ChatInviteLink, error)

EditChatSubscriptionInviteLink calls the editChatSubscriptionInviteLink Telegram Bot API method.

Use this method to edit a subscription invite link created by the bot. The bot must have the can_invite_users administrator rights. Returns the edited invite link as a ChatInviteLink object.

func RevokeChatInviteLink

func RevokeChatInviteLink(ctx context.Context, b *client.Bot, p *RevokeChatInviteLinkParams) (*ChatInviteLink, error)

RevokeChatInviteLink calls the revokeChatInviteLink Telegram Bot API method.

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.

type ChatJoinRequest

Represents a join request sent to a chat.

type ChatJoinRequest struct {
    // Chat to which the request was sent
    Chat Chat `json:"chat"`
    // User that sent the join request
    From User `json:"from"`
    // Identifier of a private chat with the user who sent the join request. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot can use this identifier for 5 minutes to send messages until the join request is processed, assuming no other administrator contacted the user.
    UserChatID int64 `json:"user_chat_id"`
    // Date the request was sent in Unix time
    Date int64 `json:"date"`
    // Optional. Bio of the user
    Bio string `json:"bio,omitempty"`
    // Optional. Chat invite link that was used by the user to send the join request
    InviteLink *ChatInviteLink `json:"invite_link,omitempty"`
}

type ChatLocation

Represents a location to which a chat is connected.

type ChatLocation struct {
    // The location to which the supergroup is connected. Can't be a live location.
    Location Location `json:"location"`
    // Location address; 1-64 characters, as defined by the chat owner
    Address string `json:"address"`
}

type ChatMember

ChatMember is a union type. The following concrete variants implement it:

  • ChatMemberOwner
  • ChatMemberAdministrator
  • ChatMemberMember
  • ChatMemberRestricted
  • ChatMemberLeft
  • ChatMemberBanned

This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported:

type ChatMember interface {
    // contains filtered or unexported methods
}

func GetChatAdministrators

func GetChatAdministrators(ctx context.Context, b *client.Bot, p *GetChatAdministratorsParams) ([]ChatMember, error)

GetChatAdministrators calls the getChatAdministrators Telegram Bot API method.

Use this method to get a list of administrators in a chat. Returns an Array of ChatMember objects.

func GetChatMember

func GetChatMember(ctx context.Context, b *client.Bot, p *GetChatMemberParams) (ChatMember, error)

GetChatMember calls the getChatMember Telegram Bot API method.

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.

func UnmarshalChatMember

func UnmarshalChatMember(data []byte) (ChatMember, error)

UnmarshalChatMember decodes a ChatMember from JSON by inspecting the "status" field and dispatching to the correct concrete type.

type ChatMemberAdministrator

Represents a chat member that has some additional privileges.

type ChatMemberAdministrator struct {
    // The member's status in the chat, always “administrator”
    Status ChatMemberStatus `json:"status"`
    // Information about the user
    User User `json:"user"`
    // True, if the bot is allowed to edit administrator privileges of that user
    CanBeEdited bool `json:"can_be_edited"`
    // True, if the user's presence in the chat is hidden
    IsAnonymous bool `json:"is_anonymous"`
    // True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.
    CanManageChat bool `json:"can_manage_chat"`
    // True, if the administrator can delete messages of other users
    CanDeleteMessages bool `json:"can_delete_messages"`
    // True, if the administrator can manage video chats
    CanManageVideoChats bool `json:"can_manage_video_chats"`
    // True, if the administrator can restrict, ban or unban chat members, or access supergroup statistics
    CanRestrictMembers bool `json:"can_restrict_members"`
    // True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user)
    CanPromoteMembers bool `json:"can_promote_members"`
    // True, if the user is allowed to change the chat title, photo and other settings
    CanChangeInfo bool `json:"can_change_info"`
    // True, if the user is allowed to invite new users to the chat
    CanInviteUsers bool `json:"can_invite_users"`
    // True, if the administrator can post stories to the chat
    CanPostStories bool `json:"can_post_stories"`
    // True, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive
    CanEditStories bool `json:"can_edit_stories"`
    // True, if the administrator can delete stories posted by other users
    CanDeleteStories bool `json:"can_delete_stories"`
    // Optional. True, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only
    CanPostMessages *bool `json:"can_post_messages,omitempty"`
    // Optional. True, if the administrator can edit messages of other users and can pin messages; for channels only
    CanEditMessages *bool `json:"can_edit_messages,omitempty"`
    // Optional. True, if the user is allowed to pin messages; for groups and supergroups only
    CanPinMessages *bool `json:"can_pin_messages,omitempty"`
    // Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only
    CanManageTopics *bool `json:"can_manage_topics,omitempty"`
    // Optional. True, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only
    CanManageDirectMessages *bool `json:"can_manage_direct_messages,omitempty"`
    // Optional. True, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can_pin_messages.
    CanManageTags *bool `json:"can_manage_tags,omitempty"`
    // Optional. Custom title for this user
    CustomTitle string `json:"custom_title,omitempty"`
}

func (*ChatMemberAdministrator) MarshalJSON

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

MarshalJSON encodes ChatMemberAdministrator with the discriminator field "status" forced to "administrator". The hardcoded value frees callers from setting Status by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type ChatMemberBanned

Represents a chat member that was banned in the chat and can't return to the chat or view chat messages.

type ChatMemberBanned struct {
    // The member's status in the chat, always “kicked”
    Status ChatMemberStatus `json:"status"`
    // Information about the user
    User User `json:"user"`
    // Date when restrictions will be lifted for this user; Unix time. If 0, then the user is banned forever.
    UntilDate int64 `json:"until_date"`
}

func (*ChatMemberBanned) MarshalJSON

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

MarshalJSON encodes ChatMemberBanned with the discriminator field "status" forced to "kicked". The hardcoded value frees callers from setting Status by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type ChatMemberLeft

Represents a chat member that isn't currently a member of the chat, but may join it themselves.

type ChatMemberLeft struct {
    // The member's status in the chat, always “left”
    Status ChatMemberStatus `json:"status"`
    // Information about the user
    User User `json:"user"`
}

func (*ChatMemberLeft) MarshalJSON

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

MarshalJSON encodes ChatMemberLeft with the discriminator field "status" forced to "left". The hardcoded value frees callers from setting Status by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type ChatMemberMember

Represents a chat member that has no additional privileges or restrictions.

type ChatMemberMember struct {
    // The member's status in the chat, always “member”
    Status ChatMemberStatus `json:"status"`
    // Optional. Tag of the member
    Tag string `json:"tag,omitempty"`
    // Information about the user
    User User `json:"user"`
    // Optional. Date when the user's subscription will expire; Unix time
    UntilDate *int64 `json:"until_date,omitempty"`
}

func (*ChatMemberMember) MarshalJSON

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

MarshalJSON encodes ChatMemberMember with the discriminator field "status" forced to "member". The hardcoded value frees callers from setting Status by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type ChatMemberOwner

Represents a chat member that owns the chat and has all administrator privileges.

type ChatMemberOwner struct {
    // The member's status in the chat, always “creator”
    Status ChatMemberStatus `json:"status"`
    // Information about the user
    User User `json:"user"`
    // True, if the user's presence in the chat is hidden
    IsAnonymous bool `json:"is_anonymous"`
    // Optional. Custom title for this user
    CustomTitle string `json:"custom_title,omitempty"`
}

func (*ChatMemberOwner) MarshalJSON

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

MarshalJSON encodes ChatMemberOwner with the discriminator field "status" forced to "creator". The hardcoded value frees callers from setting Status by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type ChatMemberRestricted

Represents a chat member that is under certain restrictions in the chat. Supergroups only.

type ChatMemberRestricted struct {
    // The member's status in the chat, always “restricted”
    Status ChatMemberStatus `json:"status"`
    // Optional. Tag of the member
    Tag string `json:"tag,omitempty"`
    // Information about the user
    User User `json:"user"`
    // True, if the user is a member of the chat at the moment of the request
    IsMember bool `json:"is_member"`
    // True, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues
    CanSendMessages bool `json:"can_send_messages"`
    // True, if the user is allowed to send audios
    CanSendAudios bool `json:"can_send_audios"`
    // True, if the user is allowed to send documents
    CanSendDocuments bool `json:"can_send_documents"`
    // True, if the user is allowed to send photos
    CanSendPhotos bool `json:"can_send_photos"`
    // True, if the user is allowed to send videos
    CanSendVideos bool `json:"can_send_videos"`
    // True, if the user is allowed to send video notes
    CanSendVideoNotes bool `json:"can_send_video_notes"`
    // True, if the user is allowed to send voice notes
    CanSendVoiceNotes bool `json:"can_send_voice_notes"`
    // True, if the user is allowed to send polls and checklists
    CanSendPolls bool `json:"can_send_polls"`
    // True, if the user is allowed to send animations, games, stickers and use inline bots
    CanSendOtherMessages bool `json:"can_send_other_messages"`
    // True, if the user is allowed to add web page previews to their messages
    CanAddWebPagePreviews bool `json:"can_add_web_page_previews"`
    // True, if the user is allowed to react to messages
    CanReactToMessages bool `json:"can_react_to_messages"`
    // True, if the user is allowed to edit their own tag
    CanEditTag bool `json:"can_edit_tag"`
    // True, if the user is allowed to change the chat title, photo and other settings
    CanChangeInfo bool `json:"can_change_info"`
    // True, if the user is allowed to invite new users to the chat
    CanInviteUsers bool `json:"can_invite_users"`
    // True, if the user is allowed to pin messages
    CanPinMessages bool `json:"can_pin_messages"`
    // True, if the user is allowed to create forum topics
    CanManageTopics bool `json:"can_manage_topics"`
    // Date when restrictions will be lifted for this user; Unix time. If 0, then the user is restricted forever.
    UntilDate int64 `json:"until_date"`
}

func (*ChatMemberRestricted) MarshalJSON

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

MarshalJSON encodes ChatMemberRestricted with the discriminator field "status" forced to "restricted". The hardcoded value frees callers from setting Status by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type ChatMemberStatus

type ChatMemberStatus string


const (
    ChatMemberStatusCreator       ChatMemberStatus = "creator"
    ChatMemberStatusAdministrator ChatMemberStatus = "administrator"
    ChatMemberStatusMember        ChatMemberStatus = "member"
    ChatMemberStatusRestricted    ChatMemberStatus = "restricted"
    ChatMemberStatusLeft          ChatMemberStatus = "left"
    ChatMemberStatusKicked        ChatMemberStatus = "kicked"
)

type ChatMemberUpdated

This object represents changes in the status of a chat member.

type ChatMemberUpdated struct {
    // Chat the user belongs to
    Chat Chat `json:"chat"`
    // Performer of the action, which resulted in the change
    From User `json:"from"`
    // Date the change was done in Unix time
    Date int64 `json:"date"`
    // Previous information about the chat member
    OldChatMember ChatMember `json:"old_chat_member"`
    // New information about the chat member
    NewChatMember ChatMember `json:"new_chat_member"`
    // Optional. Chat invite link, which was used by the user to join the chat; for joining by invite link events only
    InviteLink *ChatInviteLink `json:"invite_link,omitempty"`
    // Optional. True, if the user joined the chat after sending a direct join request without using an invite link and being approved by an administrator
    ViaJoinRequest *bool `json:"via_join_request,omitempty"`
    // Optional. True, if the user joined the chat via a chat folder invite link
    ViaChatFolderInviteLink *bool `json:"via_chat_folder_invite_link,omitempty"`
}

func (*ChatMemberUpdated) UnmarshalJSON

func (m *ChatMemberUpdated) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes ChatMemberUpdated by dispatching union-typed fields (OldChatMember, NewChatMember) through their concrete UnmarshalXxx helpers.

type ChatOwnerChanged

Describes a service message about an ownership change in the chat.

type ChatOwnerChanged struct {
    // The new owner of the chat
    NewOwner User `json:"new_owner"`
}

type ChatOwnerLeft

Describes a service message about the chat owner leaving the chat.

type ChatOwnerLeft struct {
    // Optional. The user who will become the new owner of the chat if the previous owner does not return to the chat
    NewOwner *User `json:"new_owner,omitempty"`
}

type ChatPermissions

Describes actions that a non-administrator user is allowed to take in a chat.

type ChatPermissions struct {
    // Optional. True, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues
    CanSendMessages *bool `json:"can_send_messages,omitempty"`
    // Optional. True, if the user is allowed to send audios
    CanSendAudios *bool `json:"can_send_audios,omitempty"`
    // Optional. True, if the user is allowed to send documents
    CanSendDocuments *bool `json:"can_send_documents,omitempty"`
    // Optional. True, if the user is allowed to send photos
    CanSendPhotos *bool `json:"can_send_photos,omitempty"`
    // Optional. True, if the user is allowed to send videos
    CanSendVideos *bool `json:"can_send_videos,omitempty"`
    // Optional. True, if the user is allowed to send video notes
    CanSendVideoNotes *bool `json:"can_send_video_notes,omitempty"`
    // Optional. True, if the user is allowed to send voice notes
    CanSendVoiceNotes *bool `json:"can_send_voice_notes,omitempty"`
    // Optional. True, if the user is allowed to send polls and checklists
    CanSendPolls *bool `json:"can_send_polls,omitempty"`
    // Optional. True, if the user is allowed to send animations, games, stickers and use inline bots
    CanSendOtherMessages *bool `json:"can_send_other_messages,omitempty"`
    // Optional. True, if the user is allowed to add web page previews to their messages
    CanAddWebPagePreviews *bool `json:"can_add_web_page_previews,omitempty"`
    // Optional. True, if the user is allowed to react to messages. If omitted, defaults to the value of can_send_messages.
    CanReactToMessages *bool `json:"can_react_to_messages,omitempty"`
    // Optional. True, if the user is allowed to edit their own tag. If omitted, defaults to the value of can_pin_messages.
    CanEditTag *bool `json:"can_edit_tag,omitempty"`
    // Optional. True, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups.
    CanChangeInfo *bool `json:"can_change_info,omitempty"`
    // Optional. True, if the user is allowed to invite new users to the chat
    CanInviteUsers *bool `json:"can_invite_users,omitempty"`
    // Optional. True, if the user is allowed to pin messages. Ignored in public supergroups.
    CanPinMessages *bool `json:"can_pin_messages,omitempty"`
    // Optional. True, if the user is allowed to create forum topics. If omitted defaults to the value of can_pin_messages.
    CanManageTopics *bool `json:"can_manage_topics,omitempty"`
}

type ChatPhoto

This object represents a chat photo.

type ChatPhoto struct {
    // File identifier of small (160x160) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed.
    SmallFileID string `json:"small_file_id"`
    // Unique file identifier of small (160x160) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
    SmallFileUniqueID string `json:"small_file_unique_id"`
    // File identifier of big (640x640) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed.
    BigFileID string `json:"big_file_id"`
    // Unique file identifier of big (640x640) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
    BigFileUniqueID string `json:"big_file_unique_id"`
}

type ChatShared

This object contains information about a chat that was shared with the bot using a KeyboardButtonRequestChat button.

type ChatShared struct {
    // Identifier of the request
    RequestID int64 `json:"request_id"`
    // Identifier of the shared chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot may not have access to the chat and could be unable to use this identifier, unless the chat is already known to the bot by some other means.
    ChatID int64 `json:"chat_id"`
    // Optional. Title of the chat, if the title was requested by the bot
    Title string `json:"title,omitempty"`
    // Optional. Username of the chat, if the username was requested by the bot and available
    Username string `json:"username,omitempty"`
    // Optional. Available sizes of the chat photo, if the photo was requested by the bot
    Photo []PhotoSize `json:"photo,omitempty"`
}

type ChatType

type ChatType string


const (
    ChatTypePrivate    ChatType = "private"
    ChatTypeGroup      ChatType = "group"
    ChatTypeSupergroup ChatType = "supergroup"
    ChatTypeChannel    ChatType = "channel"
)

type Checklist

Describes a checklist.

type Checklist struct {
    // Title of the checklist
    Title string `json:"title"`
    // Optional. Special entities that appear in the checklist title
    TitleEntities []MessageEntity `json:"title_entities,omitempty"`
    // List of tasks in the checklist
    Tasks []ChecklistTask `json:"tasks"`
    // Optional. True, if users other than the creator of the list can add tasks to the list
    OthersCanAddTasks *bool `json:"others_can_add_tasks,omitempty"`
    // Optional. True, if users other than the creator of the list can mark tasks as done or not done
    OthersCanMarkTasksAsDone *bool `json:"others_can_mark_tasks_as_done,omitempty"`
}

type ChecklistTask

Describes a task in a checklist.

type ChecklistTask struct {
    // Unique identifier of the task
    ID  int64 `json:"id"`
    // Text of the task
    Text string `json:"text"`
    // Optional. Special entities that appear in the task text
    TextEntities []MessageEntity `json:"text_entities,omitempty"`
    // Optional. User that completed the task; omitted if the task wasn't completed by a user
    CompletedByUser *User `json:"completed_by_user,omitempty"`
    // Optional. Chat that completed the task; omitted if the task wasn't completed by a chat
    CompletedByChat *Chat `json:"completed_by_chat,omitempty"`
    // Optional. Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't completed
    CompletionDate *int64 `json:"completion_date,omitempty"`
}

type ChecklistTasksAdded

Describes a service message about tasks added to a checklist.

type ChecklistTasksAdded struct {
    // Optional. Message containing the checklist to which the tasks were added. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.
    ChecklistMessage *Message `json:"checklist_message,omitempty"`
    // List of tasks added to the checklist
    Tasks []ChecklistTask `json:"tasks"`
}

type ChecklistTasksDone

Describes a service message about checklist tasks marked as done or not done.

type ChecklistTasksDone struct {
    // Optional. Message containing the checklist whose tasks were marked as done or not done. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.
    ChecklistMessage *Message `json:"checklist_message,omitempty"`
    // Optional. Identifiers of the tasks that were marked as done
    MarkedAsDoneTaskIds []int64 `json:"marked_as_done_task_ids,omitempty"`
    // Optional. Identifiers of the tasks that were marked as not done
    MarkedAsNotDoneTaskIds []int64 `json:"marked_as_not_done_task_ids,omitempty"`
}

type ChosenInlineResult

Represents a result of an inline query that was chosen by the user and sent to their chat partner. Note: It is necessary to enable inline feedback via @BotFather in order to receive these objects in updates.

type ChosenInlineResult struct {
    // The unique identifier for the result that was chosen
    ResultID string `json:"result_id"`
    // The user that chose the result
    From User `json:"from"`
    // Optional. Sender location, only for bots that require user location
    Location *Location `json:"location,omitempty"`
    // Optional. Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message. Will be also received in callback queries and can be used to edit the message.
    InlineMessageID string `json:"inline_message_id,omitempty"`
    // The query that was used to obtain the result
    Query string `json:"query"`
}

type CloseForumTopicParams

CloseForumTopicParams is the parameter set for 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.

type CloseForumTopicParams struct {
    // Unique identifier for the target chat or username of the target supergroup in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message thread of the forum topic
    MessageThreadID int64 `json:"message_thread_id"`
}

type CloseGeneralForumTopicParams

CloseGeneralForumTopicParams is the parameter set for 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.

type CloseGeneralForumTopicParams struct {
    // Unique identifier for the target chat or username of the target supergroup in the format @username
    ChatID ChatID `json:"chat_id"`
}

type CloseParams

CloseParams is the parameter set for 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.

type CloseParams struct {
}

type Contact

This object represents a phone contact.

type Contact struct {
    // Contact's phone number
    PhoneNumber string `json:"phone_number"`
    // Contact's first name
    FirstName string `json:"first_name"`
    // Optional. Contact's last name
    LastName string `json:"last_name,omitempty"`
    // Optional. Contact's user identifier in Telegram. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.
    UserID *int64 `json:"user_id,omitempty"`
    // Optional. Additional data about the contact in the form of a vCard
    Vcard string `json:"vcard,omitempty"`
}

type ConvertGiftToStarsParams

ConvertGiftToStarsParams is the parameter set for ConvertGiftToStars.

Converts a given regular gift to Telegram Stars. Requires the can_convert_gifts_to_stars business bot right. Returns True on success.

type ConvertGiftToStarsParams struct {
    // Unique identifier of the business connection
    BusinessConnectionID string `json:"business_connection_id"`
    // Unique identifier of the regular gift that should be converted to Telegram Stars
    OwnedGiftID string `json:"owned_gift_id"`
}

type CopyMessageParams

CopyMessageParams is the parameter set for CopyMessage.

Use this method to copy messages of any kind. Service messages, paid media 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.

type CopyMessageParams struct {
    // Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
    MessageThreadID *int64 `json:"message_thread_id,omitempty"`
    // Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
    DirectMessagesTopicID *int64 `json:"direct_messages_topic_id,omitempty"`
    // Unique identifier for the chat where the original message was sent (or username of the target bot, supergroup or channel in the format @username)
    FromChatID ChatID `json:"from_chat_id"`
    // Message identifier in the chat specified in from_chat_id
    MessageID int64 `json:"message_id"`
    // New start timestamp for the copied video in the message
    VideoStartTimestamp *int64 `json:"video_start_timestamp,omitempty"`
    // New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept.
    Caption string `json:"caption,omitempty"`
    // Mode for parsing entities in the new caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Pass True, if the caption must be shown above the message media. Ignored if a new caption isn't specified.
    ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
    // Sends the message silently. Users will receive a notification with no sound.
    DisableNotification *bool `json:"disable_notification,omitempty"`
    // Protects the contents of the sent message from forwarding and saving
    ProtectContent *bool `json:"protect_content,omitempty"`
    // Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
    AllowPaidBroadcast *bool `json:"allow_paid_broadcast,omitempty"`
    // Unique identifier of the message effect to be added to the message; only available when copying to private chats
    MessageEffectID string `json:"message_effect_id,omitempty"`
    // A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
    SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
    // Description of the message to reply to
    ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
    // Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
    ReplyMarkup any `json:"reply_markup,omitempty"`
}

type CopyMessagesParams

CopyMessagesParams is the parameter set for 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, paid media 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.

type CopyMessagesParams struct {
    // Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
    MessageThreadID *int64 `json:"message_thread_id,omitempty"`
    // Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat
    DirectMessagesTopicID *int64 `json:"direct_messages_topic_id,omitempty"`
    // Unique identifier for the chat where the original messages were sent (or username of the target bot, supergroup or channel in the format @username)
    FromChatID ChatID `json:"from_chat_id"`
    // A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to copy. The identifiers must be specified in a strictly increasing order.
    MessageIds []int64 `json:"message_ids"`
    // Sends the messages silently. Users will receive a notification with no sound.
    DisableNotification *bool `json:"disable_notification,omitempty"`
    // Protects the contents of the sent messages from forwarding and saving
    ProtectContent *bool `json:"protect_content,omitempty"`
    // Pass True to copy the messages without their captions
    RemoveCaption *bool `json:"remove_caption,omitempty"`
}

type CopyTextButton

This object represents an inline keyboard button that copies specified text to the clipboard.

type CopyTextButton struct {
    // The text to be copied to the clipboard; 1-256 characters
    Text string `json:"text"`
}

type CreateChatInviteLinkParams

CreateChatInviteLinkParams is the parameter set for 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.

type CreateChatInviteLinkParams struct {
    // Unique identifier for the target chat or username of the target channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Invite link name; 0-32 characters
    Name string `json:"name,omitempty"`
    // Point in time (Unix timestamp) when the link will expire
    ExpireDate *int64 `json:"expire_date,omitempty"`
    // The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999
    MemberLimit *int64 `json:"member_limit,omitempty"`
    // True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified.
    CreatesJoinRequest *bool `json:"creates_join_request,omitempty"`
}

type CreateChatSubscriptionInviteLinkParams

CreateChatSubscriptionInviteLinkParams is the parameter set for CreateChatSubscriptionInviteLink.

Use this method to create a subscription invite link for a channel chat. The bot must have the can_invite_users administrator rights. The link can be edited using the method editChatSubscriptionInviteLink or revoked using the method revokeChatInviteLink. Returns the new invite link as a ChatInviteLink object.

type CreateChatSubscriptionInviteLinkParams struct {
    // Unique identifier for the target channel chat or username of the target channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Invite link name; 0-32 characters
    Name string `json:"name,omitempty"`
    // The number of seconds the subscription will be active for before the next payment. Currently, it must always be 2592000 (30 days).
    SubscriptionPeriod int64 `json:"subscription_period"`
    // The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat; 1-10000
    SubscriptionPrice int64 `json:"subscription_price"`
}

type CreateForumTopicParams

CreateForumTopicParams is the parameter set for CreateForumTopic.

Use this method to create a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator right. Returns information about the created topic as a ForumTopic object.

type CreateForumTopicParams struct {
    // Unique identifier for the target chat or username of the target supergroup in the format @username
    ChatID ChatID `json:"chat_id"`
    // Topic name, 1-128 characters
    Name string `json:"name"`
    // Color of the topic icon in RGB format. Currently, must be one of 7322096 (0x6FB9F0), 16766590 (0xFFD67E), 13338331 (0xCB86DB), 9367192 (0x8EEE98), 16749490 (0xFF93B2), or 16478047 (0xFB6F5F).
    IconColor *int64 `json:"icon_color,omitempty"`
    // Unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers.
    IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
}

type CreateInvoiceLinkParams

CreateInvoiceLinkParams is the parameter set for CreateInvoiceLink.

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

type CreateInvoiceLinkParams struct {
    // Unique identifier of the business connection on behalf of which the link will be created. For payments in Telegram Stars only.
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Product name, 1-32 characters
    Title string `json:"title"`
    // Product description, 1-255 characters
    Description string `json:"description"`
    // Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.
    Payload string `json:"payload"`
    // Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.
    ProviderToken string `json:"provider_token,omitempty"`
    // Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars.
    Currency string `json:"currency"`
    // Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars.
    Prices []LabeledPrice `json:"prices"`
    // The number of seconds the subscription will be active for before the next payment. The currency must be set to “XTR” (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 10000 Telegram Stars.
    SubscriptionPeriod *int64 `json:"subscription_period,omitempty"`
    // The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars.
    MaxTipAmount *int64 `json:"max_tip_amount,omitempty"`
    // A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.
    SuggestedTipAmounts []int64 `json:"suggested_tip_amounts,omitempty"`
    // JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.
    ProviderData string `json:"provider_data,omitempty"`
    // URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.
    PhotoURL string `json:"photo_url,omitempty"`
    // Photo size in bytes
    PhotoSize *int64 `json:"photo_size,omitempty"`
    // Photo width
    PhotoWidth *int64 `json:"photo_width,omitempty"`
    // Photo height
    PhotoHeight *int64 `json:"photo_height,omitempty"`
    // Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars.
    NeedName *bool `json:"need_name,omitempty"`
    // Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars.
    NeedPhoneNumber *bool `json:"need_phone_number,omitempty"`
    // Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars.
    NeedEmail *bool `json:"need_email,omitempty"`
    // Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars.
    NeedShippingAddress *bool `json:"need_shipping_address,omitempty"`
    // Pass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars.
    SendPhoneNumberToProvider *bool `json:"send_phone_number_to_provider,omitempty"`
    // Pass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars.
    SendEmailToProvider *bool `json:"send_email_to_provider,omitempty"`
    // Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars.
    IsFlexible *bool `json:"is_flexible,omitempty"`
}

type CreateNewStickerSetParams

CreateNewStickerSetParams is the parameter set for 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.

type CreateNewStickerSetParams struct {
    // User identifier of created sticker set owner
    UserID int64 `json:"user_id"`
    // 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.
    Name string `json:"name"`
    // Sticker set title, 1-64 characters
    Title string `json:"title"`
    // A JSON-serialized list of 1-50 initial stickers to be added to the sticker set
    Stickers []InputSticker `json:"stickers"`
    // Type of stickers in the set, pass “regular”, “mask”, or “custom_emoji”. By default, a regular sticker set is created.
    StickerType string `json:"sticker_type,omitempty"`
    // Pass True if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only
    NeedsRepainting *bool `json:"needs_repainting,omitempty"`
}

type DeclineChatJoinRequestParams

DeclineChatJoinRequestParams is the parameter set for 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.

type DeclineChatJoinRequestParams struct {
    // Unique identifier for the target chat or username of the target channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier of the target user
    UserID int64 `json:"user_id"`
}

type DeclineSuggestedPostParams

DeclineSuggestedPostParams is the parameter set for DeclineSuggestedPost.

Use this method to decline a suggested post in a direct messages chat. The bot must have the 'can_manage_direct_messages' administrator right in the corresponding channel chat. Returns True on success.

type DeclineSuggestedPostParams struct {
    // Unique identifier for the target direct messages chat
    ChatID int64 `json:"chat_id"`
    // Identifier of a suggested post message to decline
    MessageID int64 `json:"message_id"`
    // Comment for the creator of the suggested post; 0-128 characters
    Comment string `json:"comment,omitempty"`
}

type DeleteAllMessageReactionsParams

DeleteAllMessageReactionsParams is the parameter set for DeleteAllMessageReactions.

Use this method to remove up to 10000 recent reactions in a group or a supergroup chat added by a given user or chat. The bot must have the 'can_delete_messages' administrator right in the chat. Returns True on success.

type DeleteAllMessageReactionsParams struct {
    // Unique identifier for the target chat or username of the target supergroup in the format @username
    ChatID ChatID `json:"chat_id"`
    // Identifier of the user whose reactions will be removed, if the reactions were added by a user
    UserID *int64 `json:"user_id,omitempty"`
    // Identifier of the chat whose reactions will be removed, if the reactions were added by a chat
    ActorChatID *int64 `json:"actor_chat_id,omitempty"`
}

type DeleteBusinessMessagesParams

DeleteBusinessMessagesParams is the parameter set for DeleteBusinessMessages.

Delete messages on behalf of a business account. Requires the can_delete_sent_messages business bot right to delete messages sent by the bot itself, or the can_delete_all_messages business bot right to delete any message. Returns True on success.

type DeleteBusinessMessagesParams struct {
    // Unique identifier of the business connection on behalf of which to delete the messages
    BusinessConnectionID string `json:"business_connection_id"`
    // A JSON-serialized list of 1-100 identifiers of messages to delete. All messages must be from the same chat. See deleteMessage for limitations on which messages can be deleted.
    MessageIds []int64 `json:"message_ids"`
}

type DeleteChatPhotoParams

DeleteChatPhotoParams is the parameter set for 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.

type DeleteChatPhotoParams struct {
    // Unique identifier for the target chat or username of the target channel in the format @username
    ChatID ChatID `json:"chat_id"`
}

type DeleteChatStickerSetParams

DeleteChatStickerSetParams is the parameter set for 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.

type DeleteChatStickerSetParams struct {
    // Unique identifier for the target chat or username of the target supergroup in the format @username
    ChatID ChatID `json:"chat_id"`
}

type DeleteForumTopicParams

DeleteForumTopicParams is the parameter set for DeleteForumTopic.

Use this method to delete a forum topic along with all its messages in a forum supergroup chat or a private chat with a user. In the case of a 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.

type DeleteForumTopicParams struct {
    // Unique identifier for the target chat or username of the target supergroup in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message thread of the forum topic
    MessageThreadID int64 `json:"message_thread_id"`
}

type DeleteMessageParams

DeleteMessageParams is the parameter set for 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 administrator right in a supergroup or a channel, it can delete any message there.- If the bot has can_manage_direct_messages administrator right in a channel, it can delete any message in the corresponding direct messages chat.Returns True on success.

type DeleteMessageParams struct {
    // Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Identifier of the message to delete
    MessageID int64 `json:"message_id"`
}

type DeleteMessageReactionParams

DeleteMessageReactionParams is the parameter set for DeleteMessageReaction.

Use this method to remove a reaction from a message in a group or a supergroup chat. The bot must have the 'can_delete_messages' administrator right in the chat. Returns True on success.

type DeleteMessageReactionParams struct {
    // Unique identifier for the target chat or username of the target supergroup in the format @username
    ChatID ChatID `json:"chat_id"`
    // Identifier of the target message
    MessageID int64 `json:"message_id"`
    // Identifier of the user whose reaction will be removed, if the reaction was added by a user
    UserID *int64 `json:"user_id,omitempty"`
    // Identifier of the chat whose reaction will be removed, if the reaction was added by a chat
    ActorChatID *int64 `json:"actor_chat_id,omitempty"`
}

type DeleteMessagesParams

DeleteMessagesParams is the parameter set for 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.

type DeleteMessagesParams struct {
    // Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // A JSON-serialized list of 1-100 identifiers of messages to delete. See deleteMessage for limitations on which messages can be deleted.
    MessageIds []int64 `json:"message_ids"`
}

type DeleteMyCommandsParams

DeleteMyCommandsParams is the parameter set for 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.

type DeleteMyCommandsParams struct {
    // A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault.
    Scope BotCommandScope `json:"scope,omitempty"`
    // A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands.
    LanguageCode string `json:"language_code,omitempty"`
}

type DeleteStickerFromSetParams

DeleteStickerFromSetParams is the parameter set for DeleteStickerFromSet.

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

type DeleteStickerFromSetParams struct {
    // File identifier of the sticker
    Sticker string `json:"sticker"`
}

type DeleteStickerSetParams

DeleteStickerSetParams is the parameter set for DeleteStickerSet.

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

type DeleteStickerSetParams struct {
    // Sticker set name
    Name string `json:"name"`
}

type DeleteStoryParams

DeleteStoryParams is the parameter set for DeleteStory.

Deletes a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns True on success.

type DeleteStoryParams struct {
    // Unique identifier of the business connection
    BusinessConnectionID string `json:"business_connection_id"`
    // Unique identifier of the story to delete
    StoryID int64 `json:"story_id"`
}

type DeleteWebhookParams

DeleteWebhookParams is the parameter set for DeleteWebhook.

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

type DeleteWebhookParams struct {
    // Pass True to drop all pending updates
    DropPendingUpdates *bool `json:"drop_pending_updates,omitempty"`
}

type Dice

This object represents an animated emoji that displays a random value.

type Dice struct {
    // Emoji on which the dice throw animation is based
    Emoji string `json:"emoji"`
    // Value of the dice, 1-6 for “”, “” and “” base emoji, 1-5 for “” and “” base emoji, 1-64 for “” base emoji
    Value int64 `json:"value"`
}

type DiceEmoji

DiceEmoji is the set of emoji values accepted by sendDice. Telegram's canonical list is "🎲", "🎯", "🏀", "⚽", "🎳", "🎰". The codegen scraper drops these values during regex extraction (multi-byte boundary issues with curly-quoted emoji), so this enum is hand- curated and wired into SendDiceParams.Emoji via the per-field type override in cmd/genapi/emitter.go.

type DiceEmoji string


const (
    DiceEmojiDice        DiceEmoji = "🎲"
    DiceEmojiDart        DiceEmoji = "🎯"
    DiceEmojiBasketball  DiceEmoji = "🏀"
    DiceEmojiFootball    DiceEmoji = "⚽"
    DiceEmojiBowling     DiceEmoji = "🎳"
    DiceEmojiSlotMachine DiceEmoji = "🎰"
)

type DirectMessagePriceChanged

Describes a service message about a change in the price of direct messages sent to a channel chat.

type DirectMessagePriceChanged struct {
    // True, if direct messages are enabled for the channel chat; false otherwise
    AreDirectMessagesEnabled bool `json:"are_direct_messages_enabled"`
    // Optional. The new number of Telegram Stars that must be paid by users for each direct message sent to the channel. Does not apply to users who have been exempted by administrators. Defaults to 0.
    DirectMessageStarCount *int64 `json:"direct_message_star_count,omitempty"`
}

type DirectMessagesTopic

Describes a topic of a direct messages chat.

type DirectMessagesTopic struct {
    // Unique identifier of the topic. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.
    TopicID int64 `json:"topic_id"`
    // Optional. Information about the user that created the topic. Currently, it is always present.
    User *User `json:"user,omitempty"`
}

type Document

This object represents a general file (as opposed to photos, voice messages and audio files).

type Document struct {
    // Identifier for this file, which can be used to download or reuse the file
    FileID string `json:"file_id"`
    // Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
    FileUniqueID string `json:"file_unique_id"`
    // Optional. Document thumbnail as defined by the sender
    Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
    // Optional. Original filename as defined by the sender
    FileName string `json:"file_name,omitempty"`
    // Optional. MIME type of the file as defined by the sender
    MimeType string `json:"mime_type,omitempty"`
    // Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
    FileSize *int64 `json:"file_size,omitempty"`
}

type EditChatInviteLinkParams

EditChatInviteLinkParams is the parameter set for 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.

type EditChatInviteLinkParams struct {
    // Unique identifier for the target chat or username of the target channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // The invite link to edit
    InviteLink string `json:"invite_link"`
    // Invite link name; 0-32 characters
    Name string `json:"name,omitempty"`
    // Point in time (Unix timestamp) when the link will expire
    ExpireDate *int64 `json:"expire_date,omitempty"`
    // The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999
    MemberLimit *int64 `json:"member_limit,omitempty"`
    // True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified.
    CreatesJoinRequest *bool `json:"creates_join_request,omitempty"`
}

type EditChatSubscriptionInviteLinkParams

EditChatSubscriptionInviteLinkParams is the parameter set for EditChatSubscriptionInviteLink.

Use this method to edit a subscription invite link created by the bot. The bot must have the can_invite_users administrator rights. Returns the edited invite link as a ChatInviteLink object.

type EditChatSubscriptionInviteLinkParams struct {
    // Unique identifier for the target chat or username of the target channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // The invite link to edit
    InviteLink string `json:"invite_link"`
    // Invite link name; 0-32 characters
    Name string `json:"name,omitempty"`
}

type EditForumTopicParams

EditForumTopicParams is the parameter set for EditForumTopic.

Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user. In the case of a 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.

type EditForumTopicParams struct {
    // Unique identifier for the target chat or username of the target supergroup in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message thread of the forum topic
    MessageThreadID int64 `json:"message_thread_id"`
    // New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept.
    Name string `json:"name,omitempty"`
    // New unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept.
    IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
}

type EditGeneralForumTopicParams

EditGeneralForumTopicParams is the parameter set for 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 the can_manage_topics administrator rights. Returns True on success.

type EditGeneralForumTopicParams struct {
    // Unique identifier for the target chat or username of the target supergroup in the format @username
    ChatID ChatID `json:"chat_id"`
    // New topic name, 1-128 characters
    Name string `json:"name"`
}

type EditMessageCaptionParams

EditMessageCaptionParams is the parameter set for 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. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

type EditMessageCaptionParams struct {
    // Unique identifier of the business connection on behalf of which the message to be edited was sent
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username.
    ChatID *ChatID `json:"chat_id,omitempty"`
    // Required if inline_message_id is not specified. Identifier of the message to edit.
    MessageID *int64 `json:"message_id,omitempty"`
    // Required if chat_id and message_id are not specified. Identifier of the inline message.
    InlineMessageID string `json:"inline_message_id,omitempty"`
    // New caption of the message, 0-1024 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Mode for parsing entities in the message caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Pass True, if the caption must be shown above the message media. Supported only for animation, photo and video messages.
    ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
    // A JSON-serialized object for an inline keyboard
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

type EditMessageChecklistParams

EditMessageChecklistParams is the parameter set for EditMessageChecklist.

Use this method to edit a checklist on behalf of a connected business account. On success, the edited Message is returned.

type EditMessageChecklistParams struct {
    // Unique identifier of the business connection on behalf of which the message will be sent
    BusinessConnectionID string `json:"business_connection_id"`
    // Unique identifier for the target chat or username of the target bot in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message
    MessageID int64 `json:"message_id"`
    // A JSON-serialized object for the new checklist
    Checklist InputChecklist `json:"checklist"`
    // A JSON-serialized object for the new inline keyboard for the message
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

type EditMessageLiveLocationParams

EditMessageLiveLocationParams is the parameter set for 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.

type EditMessageLiveLocationParams struct {
    // Unique identifier of the business connection on behalf of which the message to be edited was sent
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username.
    ChatID *ChatID `json:"chat_id,omitempty"`
    // Required if inline_message_id is not specified. Identifier of the message to edit.
    MessageID *int64 `json:"message_id,omitempty"`
    // Required if chat_id and message_id are not specified. Identifier of the inline message.
    InlineMessageID string `json:"inline_message_id,omitempty"`
    // Latitude of new location
    Latitude float64 `json:"latitude"`
    // Longitude of new location
    Longitude float64 `json:"longitude"`
    // New period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current live_period by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then live_period remains unchanged.
    LivePeriod *int64 `json:"live_period,omitempty"`
    // The radius of uncertainty for the location, measured in meters; 0-1500
    HorizontalAccuracy *float64 `json:"horizontal_accuracy,omitempty"`
    // Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.
    Heading *int64 `json:"heading,omitempty"`
    // The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.
    ProximityAlertRadius *int64 `json:"proximity_alert_radius,omitempty"`
    // A JSON-serialized object for a new inline keyboard
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

type EditMessageMediaParams

EditMessageMediaParams is the parameter set for EditMessageMedia.

Use this method to edit animation, audio, document, live photo, photo, or video messages, or to add media to text 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, a live 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. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

type EditMessageMediaParams struct {
    // Unique identifier of the business connection on behalf of which the message to be edited was sent
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username.
    ChatID *ChatID `json:"chat_id,omitempty"`
    // Required if inline_message_id is not specified. Identifier of the message to edit.
    MessageID *int64 `json:"message_id,omitempty"`
    // Required if chat_id and message_id are not specified. Identifier of the inline message.
    InlineMessageID string `json:"inline_message_id,omitempty"`
    // A JSON-serialized object for a new media content of the message
    Media InputMedia `json:"media"`
    // A JSON-serialized object for a new inline keyboard
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

func (*EditMessageMediaParams) HasFile

func (p *EditMessageMediaParams) HasFile() bool

HasFile reports whether a multipart upload is required.

func (*EditMessageMediaParams) MultipartFields

func (p *EditMessageMediaParams) MultipartFields() map[string]string

MultipartFields returns the non-file fields used in the multipart body.

func (*EditMessageMediaParams) MultipartFiles

func (p *EditMessageMediaParams) MultipartFiles() []client.MultipartFile

MultipartFiles returns the file parts.

type EditMessageReplyMarkupParams

EditMessageReplyMarkupParams is the parameter set for 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. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

type EditMessageReplyMarkupParams struct {
    // Unique identifier of the business connection on behalf of which the message to be edited was sent
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username.
    ChatID *ChatID `json:"chat_id,omitempty"`
    // Required if inline_message_id is not specified. Identifier of the message to edit.
    MessageID *int64 `json:"message_id,omitempty"`
    // Required if chat_id and message_id are not specified. Identifier of the inline message.
    InlineMessageID string `json:"inline_message_id,omitempty"`
    // A JSON-serialized object for an inline keyboard
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

type EditMessageTextParams

EditMessageTextParams is the parameter set for 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. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

type EditMessageTextParams struct {
    // Unique identifier of the business connection on behalf of which the message to be edited was sent
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username.
    ChatID *ChatID `json:"chat_id,omitempty"`
    // Required if inline_message_id is not specified. Identifier of the message to edit.
    MessageID *int64 `json:"message_id,omitempty"`
    // Required if chat_id and message_id are not specified. Identifier of the inline message.
    InlineMessageID string `json:"inline_message_id,omitempty"`
    // New text of the message, 1-4096 characters after entities parsing
    Text string `json:"text"`
    // Mode for parsing entities in the message text. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode
    Entities []MessageEntity `json:"entities,omitempty"`
    // Link preview generation options for the message
    LinkPreviewOptions *LinkPreviewOptions `json:"link_preview_options,omitempty"`
    // A JSON-serialized object for an inline keyboard
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

type EditStoryParams

EditStoryParams is the parameter set for EditStory.

Edits a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.

type EditStoryParams struct {
    // Unique identifier of the business connection
    BusinessConnectionID string `json:"business_connection_id"`
    // Unique identifier of the story to edit
    StoryID int64 `json:"story_id"`
    // Content of the story
    Content InputStoryContent `json:"content"`
    // Caption of the story, 0-2048 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Mode for parsing entities in the story caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // A JSON-serialized list of clickable areas to be shown on the story
    Areas []StoryArea `json:"areas,omitempty"`
}

type EditUserStarSubscriptionParams

EditUserStarSubscriptionParams is the parameter set for EditUserStarSubscription.

Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns True on success.

type EditUserStarSubscriptionParams struct {
    // Identifier of the user whose subscription will be edited
    UserID int64 `json:"user_id"`
    // Telegram payment identifier for the subscription
    TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`
    // Pass True to cancel extension of the user subscription; the subscription must be active up to the end of the current subscription period. Pass False to allow the user to re-enable a subscription that was previously canceled by the bot.
    IsCanceled bool `json:"is_canceled"`
}

type EncryptedCredentials

Describes data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.

type EncryptedCredentials struct {
    // Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for EncryptedPassportElement decryption and authentication
    Data string `json:"data"`
    // Base64-encoded data hash for data authentication
    Hash string `json:"hash"`
    // Base64-encoded secret, encrypted with the bot's public RSA key, required for data decryption
    Secret string `json:"secret"`
}

type EncryptedPassportElement

Describes documents or other Telegram Passport elements shared with the bot by the user.

type EncryptedPassportElement struct {
    // Element type. One of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”, “phone_number”, “email”.
    Type EncryptedPassportElementType `json:"type"`
    // Optional. Base64-encoded encrypted Telegram Passport element data provided by the user; available only for “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport” and “address” types. Can be decrypted and verified using the accompanying EncryptedCredentials.
    Data string `json:"data,omitempty"`
    // Optional. User's verified phone number; available only for “phone_number” type
    PhoneNumber string `json:"phone_number,omitempty"`
    // Optional. User's verified email address; available only for “email” type
    Email string `json:"email,omitempty"`
    // Optional. Array of encrypted files with documents provided by the user; available only for “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials.
    Files []PassportFile `json:"files,omitempty"`
    // Optional. Encrypted file with the front side of the document, provided by the user; available only for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials.
    FrontSide *PassportFile `json:"front_side,omitempty"`
    // Optional. Encrypted file with the reverse side of the document, provided by the user; available only for “driver_license” and “identity_card”. The file can be decrypted and verified using the accompanying EncryptedCredentials.
    ReverseSide *PassportFile `json:"reverse_side,omitempty"`
    // Optional. Encrypted file with the selfie of the user holding a document, provided by the user; available if requested for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials.
    Selfie *PassportFile `json:"selfie,omitempty"`
    // Optional. Array of encrypted files with translated versions of documents provided by the user; available if requested for “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials.
    Translation []PassportFile `json:"translation,omitempty"`
    // Base64-encoded element hash for using in PassportElementErrorUnspecified
    Hash string `json:"hash"`
}

type EncryptedPassportElementType

type EncryptedPassportElementType string


const (
    EncryptedPassportElementTypePersonalDetails       EncryptedPassportElementType = "personal_details"
    EncryptedPassportElementTypePassport              EncryptedPassportElementType = "passport"
    EncryptedPassportElementTypeDriverLicense         EncryptedPassportElementType = "driver_license"
    EncryptedPassportElementTypeIdentityCard          EncryptedPassportElementType = "identity_card"
    EncryptedPassportElementTypeInternalPassport      EncryptedPassportElementType = "internal_passport"
    EncryptedPassportElementTypeAddress               EncryptedPassportElementType = "address"
    EncryptedPassportElementTypeUtilityBill           EncryptedPassportElementType = "utility_bill"
    EncryptedPassportElementTypeBankStatement         EncryptedPassportElementType = "bank_statement"
    EncryptedPassportElementTypeRentalAgreement       EncryptedPassportElementType = "rental_agreement"
    EncryptedPassportElementTypePassportRegistration  EncryptedPassportElementType = "passport_registration"
    EncryptedPassportElementTypeTemporaryRegistration EncryptedPassportElementType = "temporary_registration"
    EncryptedPassportElementTypePhoneNumber           EncryptedPassportElementType = "phone_number"
    EncryptedPassportElementTypeEmail                 EncryptedPassportElementType = "email"
)

type ExportChatInviteLinkParams

ExportChatInviteLinkParams is the parameter set for 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. Note: Each administrator in a chat generates their own invite links. Bots can't use invite links generated by other administrators. If you want your bot to work with invite links, it will need to generate its own link using exportChatInviteLink or by calling the getChat method. If your bot needs to generate a new primary invite link replacing its previous one, use exportChatInviteLink again.

type ExportChatInviteLinkParams struct {
    // Unique identifier for the target chat or username of the target channel in the format @username
    ChatID ChatID `json:"chat_id"`
}

type ExternalReplyInfo

This object contains information about a message that is being replied to, which may come from another chat or forum topic.

type ExternalReplyInfo struct {
    // Origin of the message replied to by the given message
    Origin MessageOrigin `json:"origin"`
    // Optional. Chat the original message belongs to. Available only if the chat is a supergroup or a channel.
    Chat *Chat `json:"chat,omitempty"`
    // Optional. Unique message identifier inside the original chat. Available only if the original chat is a supergroup or a channel.
    MessageID *int64 `json:"message_id,omitempty"`
    // Optional. Options used for link preview generation for the original message, if it is a text message
    LinkPreviewOptions *LinkPreviewOptions `json:"link_preview_options,omitempty"`
    // Optional. Message is an animation, information about the animation
    Animation *Animation `json:"animation,omitempty"`
    // Optional. Message is an audio file, information about the file
    Audio *Audio `json:"audio,omitempty"`
    // Optional. Message is a general file, information about the file
    Document *Document `json:"document,omitempty"`
    // Optional. Message is a live photo, information about the live photo
    LivePhoto *LivePhoto `json:"live_photo,omitempty"`
    // Optional. Message contains paid media; information about the paid media
    PaidMedia *PaidMediaInfo `json:"paid_media,omitempty"`
    // Optional. Message is a photo, available sizes of the photo
    Photo []PhotoSize `json:"photo,omitempty"`
    // Optional. Message is a sticker, information about the sticker
    Sticker *Sticker `json:"sticker,omitempty"`
    // Optional. Message is a forwarded story
    Story *Story `json:"story,omitempty"`
    // Optional. Message is a video, information about the video
    Video *Video `json:"video,omitempty"`
    // Optional. Message is a video note, information about the video message
    VideoNote *VideoNote `json:"video_note,omitempty"`
    // Optional. Message is a voice message, information about the file
    Voice *Voice `json:"voice,omitempty"`
    // Optional. True, if the message media is covered by a spoiler animation
    HasMediaSpoiler *bool `json:"has_media_spoiler,omitempty"`
    // Optional. Message is a checklist
    Checklist *Checklist `json:"checklist,omitempty"`
    // Optional. Message is a shared contact, information about the contact
    Contact *Contact `json:"contact,omitempty"`
    // Optional. Message is a dice with random value
    Dice *Dice `json:"dice,omitempty"`
    // Optional. Message is a game, information about the game. More about games »
    Game *Game `json:"game,omitempty"`
    // Optional. Message is a scheduled giveaway, information about the giveaway
    Giveaway *Giveaway `json:"giveaway,omitempty"`
    // Optional. A giveaway with public winners was completed
    GiveawayWinners *GiveawayWinners `json:"giveaway_winners,omitempty"`
    // Optional. Message is an invoice for a payment, information about the invoice. More about payments »
    Invoice *Invoice `json:"invoice,omitempty"`
    // Optional. Message is a shared location, information about the location
    Location *Location `json:"location,omitempty"`
    // Optional. Message is a native poll, information about the poll
    Poll *Poll `json:"poll,omitempty"`
    // Optional. Message is a venue, information about the venue
    Venue *Venue `json:"venue,omitempty"`
}

func (*ExternalReplyInfo) UnmarshalJSON

func (m *ExternalReplyInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes ExternalReplyInfo by dispatching union-typed fields (Origin) through their concrete UnmarshalXxx helpers.

type File

This object represents a file ready to be downloaded. The file can be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>. 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. The maximum file size to download is 20 MB

type File struct {
    // Identifier for this file, which can be used to download or reuse the file
    FileID string `json:"file_id"`
    // Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
    FileUniqueID string `json:"file_unique_id"`
    // Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
    FileSize *int64 `json:"file_size,omitempty"`
    // Optional. File path. Use https://api.telegram.org/file/bot<token>/<file_path> to get the file.
    FilePath string `json:"file_path,omitempty"`
}

func DownloadFile

func DownloadFile(ctx context.Context, b *client.Bot, fileID string) (io.ReadCloser, *File, error)

DownloadFile fetches the contents of a Telegram-hosted file given a previously-uploaded file_id. It calls GetFile to resolve the file's download path, then issues an HTTP GET to the file CDN endpoint.

The returned io.ReadCloser must be closed by the caller. The size of the file is reported via *File.FileSize when known.

For files larger than 20 MB, Telegram requires a self-hosted Bot API server (default api.telegram.org has a 20 MB limit on getFile).

func GetFile

func GetFile(ctx context.Context, b *client.Bot, p *GetFileParams) (*File, error)

GetFile calls the getFile Telegram Bot API method.

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.

func UploadStickerFile

func UploadStickerFile(ctx context.Context, b *client.Bot, p *UploadStickerFileParams) (*File, error)

UploadStickerFile calls the uploadStickerFile Telegram Bot API method.

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

type ForceReply

Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode. Not supported in channels and for messages sent on behalf of a user account. Example: A poll bot for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll: The last option is definitely more attractive. And if you use ForceReply in your bot's questions, it will receive the user's answers even if it only receives replies, commands and mentions - without any extra work for the user.

type ForceReply struct {
    // Shows reply interface to the user, as if they manually selected the bot's message and tapped 'Reply'
    ForceReply bool `json:"force_reply"`
    // Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters
    InputFieldPlaceholder string `json:"input_field_placeholder,omitempty"`
    // Optional. Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the original message.
    Selective *bool `json:"selective,omitempty"`
}

type ForumTopic

This object represents a forum topic.

type ForumTopic struct {
    // Unique identifier of the forum topic
    MessageThreadID int64 `json:"message_thread_id"`
    // Name of the topic
    Name string `json:"name"`
    // Color of the topic icon in RGB format
    IconColor int64 `json:"icon_color"`
    // Optional. Unique identifier of the custom emoji shown as the topic icon
    IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
    // Optional. True, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot
    IsNameImplicit *bool `json:"is_name_implicit,omitempty"`
}

func CreateForumTopic

func CreateForumTopic(ctx context.Context, b *client.Bot, p *CreateForumTopicParams) (*ForumTopic, error)

CreateForumTopic calls the createForumTopic Telegram Bot API method.

Use this method to create a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator right. Returns information about the created topic as a ForumTopic object.

type ForumTopicClosed

This object represents a service message about a forum topic closed in the chat. Currently holds no information.

type ForumTopicClosed struct {
}

type ForumTopicCreated

This object represents a service message about a new forum topic created in the chat.

type ForumTopicCreated struct {
    // Name of the topic
    Name string `json:"name"`
    // Color of the topic icon in RGB format
    IconColor int64 `json:"icon_color"`
    // Optional. Unique identifier of the custom emoji shown as the topic icon
    IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
    // Optional. True, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot
    IsNameImplicit *bool `json:"is_name_implicit,omitempty"`
}

type ForumTopicEdited

This object represents a service message about an edited forum topic.

type ForumTopicEdited struct {
    // Optional. New name of the topic, if it was edited
    Name string `json:"name,omitempty"`
    // Optional. New identifier of the custom emoji shown as the topic icon, if it was edited; an empty string if the icon was removed
    IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
}

type ForumTopicReopened

This object represents a service message about a forum topic reopened in the chat. Currently holds no information.

type ForumTopicReopened struct {
}

type ForwardMessageParams

ForwardMessageParams is the parameter set for 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.

type ForwardMessageParams struct {
    // Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
    MessageThreadID *int64 `json:"message_thread_id,omitempty"`
    // Identifier of the direct messages topic to which the message will be forwarded; required if the message is forwarded to a direct messages chat
    DirectMessagesTopicID *int64 `json:"direct_messages_topic_id,omitempty"`
    // Unique identifier for the chat where the original message was sent (or username of the target bot, supergroup or channel in the format @username)
    FromChatID ChatID `json:"from_chat_id"`
    // New start timestamp for the forwarded video in the message
    VideoStartTimestamp *int64 `json:"video_start_timestamp,omitempty"`
    // Sends the message silently. Users will receive a notification with no sound.
    DisableNotification *bool `json:"disable_notification,omitempty"`
    // Protects the contents of the forwarded message from forwarding and saving
    ProtectContent *bool `json:"protect_content,omitempty"`
    // Unique identifier of the message effect to be added to the message; only available when forwarding to private chats
    MessageEffectID string `json:"message_effect_id,omitempty"`
    // A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only
    SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
    // Message identifier in the chat specified in from_chat_id
    MessageID int64 `json:"message_id"`
}

type ForwardMessagesParams

ForwardMessagesParams is the parameter set for 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.

type ForwardMessagesParams struct {
    // Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
    MessageThreadID *int64 `json:"message_thread_id,omitempty"`
    // Identifier of the direct messages topic to which the messages will be forwarded; required if the messages are forwarded to a direct messages chat
    DirectMessagesTopicID *int64 `json:"direct_messages_topic_id,omitempty"`
    // Unique identifier for the chat where the original messages were sent (or username of the target bot, supergroup or channel in the format @username)
    FromChatID ChatID `json:"from_chat_id"`
    // A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to forward. The identifiers must be specified in a strictly increasing order.
    MessageIds []int64 `json:"message_ids"`
    // Sends the messages silently. Users will receive a notification with no sound.
    DisableNotification *bool `json:"disable_notification,omitempty"`
    // Protects the contents of the forwarded messages from forwarding and saving
    ProtectContent *bool `json:"protect_content,omitempty"`
}

type Game

This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.

type Game struct {
    // Title of the game
    Title string `json:"title"`
    // Description of the game
    Description string `json:"description"`
    // Photo that will be displayed in the game message in chats
    Photo []PhotoSize `json:"photo"`
    // Optional. Brief description of the game or high scores included in the game message. Can be automatically edited to include current high scores for the game when the bot calls setGameScore, or manually edited using editMessageText. 0-4096 characters.
    Text string `json:"text,omitempty"`
    // Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc.
    TextEntities []MessageEntity `json:"text_entities,omitempty"`
    // Optional. Animation that will be displayed in the game message in chats. Upload via BotFather.
    Animation *Animation `json:"animation,omitempty"`
}

type GameHighScore

This object represents one row of the high scores table for a game. And that's about all we've got for now.If you've got any questions, please check out our Bot FAQ »

type GameHighScore struct {
    // Position in high score table for the game
    Position int64 `json:"position"`
    // User
    User User `json:"user"`
    // Score
    Score int64 `json:"score"`
}

func GetGameHighScores

func GetGameHighScores(ctx context.Context, b *client.Bot, p *GetGameHighScoresParams) ([]GameHighScore, error)

GetGameHighScores calls the getGameHighScores Telegram Bot API method.

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. This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and their neighbors are not among them. Please note that this behavior is subject to change.

type GeneralForumTopicHidden

This object represents a service message about General forum topic hidden in the chat. Currently holds no information.

type GeneralForumTopicHidden struct {
}

type GeneralForumTopicUnhidden

This object represents a service message about General forum topic unhidden in the chat. Currently holds no information.

type GeneralForumTopicUnhidden struct {
}

type GetAvailableGiftsParams

GetAvailableGiftsParams is the parameter set for GetAvailableGifts.

Returns the list of gifts that can be sent by the bot to users and channel chats. Requires no parameters. Returns a Gifts object.

type GetAvailableGiftsParams struct {
}

type GetBusinessAccountGiftsParams

GetBusinessAccountGiftsParams is the parameter set for GetBusinessAccountGifts.

Returns the gifts received and owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns OwnedGifts on success.

type GetBusinessAccountGiftsParams struct {
    // Unique identifier of the business connection
    BusinessConnectionID string `json:"business_connection_id"`
    // Pass True to exclude gifts that aren't saved to the account's profile page
    ExcludeUnsaved *bool `json:"exclude_unsaved,omitempty"`
    // Pass True to exclude gifts that are saved to the account's profile page
    ExcludeSaved *bool `json:"exclude_saved,omitempty"`
    // Pass True to exclude gifts that can be purchased an unlimited number of times
    ExcludeUnlimited *bool `json:"exclude_unlimited,omitempty"`
    // Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique
    ExcludeLimitedUpgradable *bool `json:"exclude_limited_upgradable,omitempty"`
    // Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique
    ExcludeLimitedNonUpgradable *bool `json:"exclude_limited_non_upgradable,omitempty"`
    // Pass True to exclude unique gifts
    ExcludeUnique *bool `json:"exclude_unique,omitempty"`
    // Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram
    ExcludeFromBlockchain *bool `json:"exclude_from_blockchain,omitempty"`
    // Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.
    SortByPrice *bool `json:"sort_by_price,omitempty"`
    // Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results
    Offset string `json:"offset,omitempty"`
    // The maximum number of gifts to be returned; 1-100. Defaults to 100.
    Limit *int64 `json:"limit,omitempty"`
}

type GetBusinessAccountStarBalanceParams

GetBusinessAccountStarBalanceParams is the parameter set for GetBusinessAccountStarBalance.

Returns the amount of Telegram Stars owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns StarAmount on success.

type GetBusinessAccountStarBalanceParams struct {
    // Unique identifier of the business connection
    BusinessConnectionID string `json:"business_connection_id"`
}

type GetBusinessConnectionParams

GetBusinessConnectionParams is the parameter set for GetBusinessConnection.

Use this method to get information about the connection of the bot with a business account. Returns a BusinessConnection object on success.

type GetBusinessConnectionParams struct {
    // Unique identifier of the business connection
    BusinessConnectionID string `json:"business_connection_id"`
}

type GetChatAdministratorsParams

GetChatAdministratorsParams is the parameter set for GetChatAdministrators.

Use this method to get a list of administrators in a chat. Returns an Array of ChatMember objects.

type GetChatAdministratorsParams struct {
    // Unique identifier for the target chat or username of the target supergroup or channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Pass True to additionally receive all bots that are administrators of the chat. By default, bots other than the current bot are omitted.
    ReturnBots *bool `json:"return_bots,omitempty"`
}

type GetChatGiftsParams

GetChatGiftsParams is the parameter set for GetChatGifts.

Returns the gifts owned by a chat. Returns OwnedGifts on success.

type GetChatGiftsParams struct {
    // Unique identifier for the target chat or username of the target channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Pass True to exclude gifts that aren't saved to the chat's profile page. Always True, unless the bot has the can_post_messages administrator right in the channel.
    ExcludeUnsaved *bool `json:"exclude_unsaved,omitempty"`
    // Pass True to exclude gifts that are saved to the chat's profile page. Always False, unless the bot has the can_post_messages administrator right in the channel.
    ExcludeSaved *bool `json:"exclude_saved,omitempty"`
    // Pass True to exclude gifts that can be purchased an unlimited number of times
    ExcludeUnlimited *bool `json:"exclude_unlimited,omitempty"`
    // Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique
    ExcludeLimitedUpgradable *bool `json:"exclude_limited_upgradable,omitempty"`
    // Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique
    ExcludeLimitedNonUpgradable *bool `json:"exclude_limited_non_upgradable,omitempty"`
    // Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram
    ExcludeFromBlockchain *bool `json:"exclude_from_blockchain,omitempty"`
    // Pass True to exclude unique gifts
    ExcludeUnique *bool `json:"exclude_unique,omitempty"`
    // Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.
    SortByPrice *bool `json:"sort_by_price,omitempty"`
    // Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results
    Offset string `json:"offset,omitempty"`
    // The maximum number of gifts to be returned; 1-100. Defaults to 100.
    Limit *int64 `json:"limit,omitempty"`
}

type GetChatMemberCountParams

GetChatMemberCountParams is the parameter set for GetChatMemberCount.

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

type GetChatMemberCountParams struct {
    // Unique identifier for the target chat or username of the target supergroup or channel in the format @username
    ChatID ChatID `json:"chat_id"`
}

type GetChatMemberParams

GetChatMemberParams is the parameter set for 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.

type GetChatMemberParams struct {
    // Unique identifier for the target chat or username of the target supergroup or channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier of the target user
    UserID int64 `json:"user_id"`
}

type GetChatMenuButtonParams

GetChatMenuButtonParams is the parameter set for 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.

type GetChatMenuButtonParams struct {
    // Unique identifier for the target private chat. If not specified, the bot's default menu button will be returned.
    ChatID *int64 `json:"chat_id,omitempty"`
}

type GetChatParams

GetChatParams is the parameter set for GetChat.

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

type GetChatParams struct {
    // Unique identifier for the target chat or username of the target supergroup or channel in the format @username
    ChatID ChatID `json:"chat_id"`
}

type GetCustomEmojiStickersParams

GetCustomEmojiStickersParams is the parameter set for GetCustomEmojiStickers.

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

type GetCustomEmojiStickersParams struct {
    // A JSON-serialized list of custom emoji identifiers. At most 200 custom emoji identifiers can be specified.
    CustomEmojiIds []string `json:"custom_emoji_ids"`
}

type GetFileParams

GetFileParams is the parameter set for 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.

type GetFileParams struct {
    // File identifier to get information about
    FileID string `json:"file_id"`
}

type GetForumTopicIconStickersParams

GetForumTopicIconStickersParams is the parameter set for 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.

type GetForumTopicIconStickersParams struct {
}

type GetGameHighScoresParams

GetGameHighScoresParams is the parameter set for 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. This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and their neighbors are not among them. Please note that this behavior is subject to change.

type GetGameHighScoresParams struct {
    // Target user id
    UserID int64 `json:"user_id"`
    // Required if inline_message_id is not specified. Unique identifier for the target chat.
    ChatID *int64 `json:"chat_id,omitempty"`
    // Required if inline_message_id is not specified. Identifier of the sent message.
    MessageID *int64 `json:"message_id,omitempty"`
    // Required if chat_id and message_id are not specified. Identifier of the inline message.
    InlineMessageID string `json:"inline_message_id,omitempty"`
}

type GetManagedBotAccessSettingsParams

GetManagedBotAccessSettingsParams is the parameter set for GetManagedBotAccessSettings.

Use this method to get the access settings of a managed bot. Returns a BotAccessSettings object on success.

type GetManagedBotAccessSettingsParams struct {
    // User identifier of the managed bot whose access settings will be returned
    UserID int64 `json:"user_id"`
}

type GetManagedBotTokenParams

GetManagedBotTokenParams is the parameter set for GetManagedBotToken.

Use this method to get the token of a managed bot. Returns the token as String on success.

type GetManagedBotTokenParams struct {
    // User identifier of the managed bot whose token will be returned
    UserID int64 `json:"user_id"`
}

type GetMeParams

GetMeParams is the parameter set for 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.

type GetMeParams struct {
}

type GetMyCommandsParams

GetMyCommandsParams is the parameter set for 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.

type GetMyCommandsParams struct {
    // A JSON-serialized object, describing scope of users. Defaults to BotCommandScopeDefault.
    Scope BotCommandScope `json:"scope,omitempty"`
    // A two-letter ISO 639-1 language code or an empty string
    LanguageCode string `json:"language_code,omitempty"`
}

type GetMyDefaultAdministratorRightsParams

GetMyDefaultAdministratorRightsParams is the parameter set for GetMyDefaultAdministratorRights.

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

type GetMyDefaultAdministratorRightsParams struct {
    // Pass True to get default administrator rights of the bot in channels. Otherwise, default administrator rights of the bot for groups and supergroups will be returned.
    ForChannels *bool `json:"for_channels,omitempty"`
}

type GetMyDescriptionParams

GetMyDescriptionParams is the parameter set for GetMyDescription.

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

type GetMyDescriptionParams struct {
    // A two-letter ISO 639-1 language code or an empty string
    LanguageCode string `json:"language_code,omitempty"`
}

type GetMyNameParams

GetMyNameParams is the parameter set for GetMyName.

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

type GetMyNameParams struct {
    // A two-letter ISO 639-1 language code or an empty string
    LanguageCode string `json:"language_code,omitempty"`
}

type GetMyShortDescriptionParams

GetMyShortDescriptionParams is the parameter set for GetMyShortDescription.

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

type GetMyShortDescriptionParams struct {
    // A two-letter ISO 639-1 language code or an empty string
    LanguageCode string `json:"language_code,omitempty"`
}

type GetMyStarBalanceParams

GetMyStarBalanceParams is the parameter set for GetMyStarBalance.

A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a StarAmount object.

type GetMyStarBalanceParams struct {
}

type GetStarTransactionsParams

GetStarTransactionsParams is the parameter set for GetStarTransactions.

Returns the bot's Telegram Star transactions in chronological order. On success, returns a StarTransactions object.

type GetStarTransactionsParams struct {
    // Number of transactions to skip in the response
    Offset *int64 `json:"offset,omitempty"`
    // The maximum number of transactions to be retrieved. Values between 1-100 are accepted. Defaults to 100.
    Limit *int64 `json:"limit,omitempty"`
}

type GetStickerSetParams

GetStickerSetParams is the parameter set for GetStickerSet.

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

type GetStickerSetParams struct {
    // Name of the sticker set
    Name string `json:"name"`
}

type GetUpdatesParams

GetUpdatesParams is the parameter set for GetUpdates.

Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects. Notes1. This method will not work if an outgoing webhook is set up.2. In order to avoid getting duplicate updates, recalculate offset after each server response.

type GetUpdatesParams struct {
    // Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will be forgotten.
    Offset *int64 `json:"offset,omitempty"`
    // Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100.
    Limit *int64 `json:"limit,omitempty"`
    // Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only.
    Timeout *int64 `json:"timeout,omitempty"`
    // A JSON-serialized list of the update types you want your bot to receive. For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used.Please note that this parameter doesn't affect updates created before the call to getUpdates, so unwanted updates may be received for a short period of time.
    AllowedUpdates []UpdateType `json:"allowed_updates,omitempty"`
}

type GetUserChatBoostsParams

GetUserChatBoostsParams is the parameter set for 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.

type GetUserChatBoostsParams struct {
    // Unique identifier for the chat or username of the channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier of the target user
    UserID int64 `json:"user_id"`
}

type GetUserGiftsParams

GetUserGiftsParams is the parameter set for GetUserGifts.

Returns the gifts owned and hosted by a user. Returns OwnedGifts on success.

type GetUserGiftsParams struct {
    // Unique identifier of the user
    UserID int64 `json:"user_id"`
    // Pass True to exclude gifts that can be purchased an unlimited number of times
    ExcludeUnlimited *bool `json:"exclude_unlimited,omitempty"`
    // Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique
    ExcludeLimitedUpgradable *bool `json:"exclude_limited_upgradable,omitempty"`
    // Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique
    ExcludeLimitedNonUpgradable *bool `json:"exclude_limited_non_upgradable,omitempty"`
    // Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram
    ExcludeFromBlockchain *bool `json:"exclude_from_blockchain,omitempty"`
    // Pass True to exclude unique gifts
    ExcludeUnique *bool `json:"exclude_unique,omitempty"`
    // Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.
    SortByPrice *bool `json:"sort_by_price,omitempty"`
    // Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results
    Offset string `json:"offset,omitempty"`
    // The maximum number of gifts to be returned; 1-100. Defaults to 100.
    Limit *int64 `json:"limit,omitempty"`
}

type GetUserPersonalChatMessagesParams

GetUserPersonalChatMessagesParams is the parameter set for GetUserPersonalChatMessages.

Use this method to get the last messages from the personal chat (i.e., the chat currently added to their profile) of a given user. On success, an array of Message objects is returned.

type GetUserPersonalChatMessagesParams struct {
    // Unique identifier for the target user
    UserID int64 `json:"user_id"`
    // The maximum number of messages to return; 1-20
    Limit int64 `json:"limit"`
}

type GetUserProfileAudiosParams

GetUserProfileAudiosParams is the parameter set for GetUserProfileAudios.

Use this method to get a list of profile audios for a user. Returns a UserProfileAudios object.

type GetUserProfileAudiosParams struct {
    // Unique identifier of the target user
    UserID int64 `json:"user_id"`
    // Sequential number of the first audio to be returned. By default, all audios are returned.
    Offset *int64 `json:"offset,omitempty"`
    // Limits the number of audios to be retrieved. Values between 1-100 are accepted. Defaults to 100.
    Limit *int64 `json:"limit,omitempty"`
}

type GetUserProfilePhotosParams

GetUserProfilePhotosParams is the parameter set for GetUserProfilePhotos.

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

type GetUserProfilePhotosParams struct {
    // Unique identifier of the target user
    UserID int64 `json:"user_id"`
    // Sequential number of the first photo to be returned. By default, all photos are returned.
    Offset *int64 `json:"offset,omitempty"`
    // Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100.
    Limit *int64 `json:"limit,omitempty"`
}

type GetWebhookInfoParams

GetWebhookInfoParams is the parameter set for 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.

type GetWebhookInfoParams struct {
}

type Gift

This object represents a gift that can be sent by the bot.

type Gift struct {
    // Unique identifier of the gift
    ID  string `json:"id"`
    // The sticker that represents the gift
    Sticker Sticker `json:"sticker"`
    // The number of Telegram Stars that must be paid to send the sticker
    StarCount int64 `json:"star_count"`
    // Optional. The number of Telegram Stars that must be paid to upgrade the gift to a unique one
    UpgradeStarCount *int64 `json:"upgrade_star_count,omitempty"`
    // Optional. True, if the gift can only be purchased by Telegram Premium subscribers
    IsPremium *bool `json:"is_premium,omitempty"`
    // Optional. True, if the gift can be used (after being upgraded) to customize a user's appearance
    HasColors *bool `json:"has_colors,omitempty"`
    // Optional. The total number of gifts of this type that can be sent by all users; for limited gifts only
    TotalCount *int64 `json:"total_count,omitempty"`
    // Optional. The number of remaining gifts of this type that can be sent by all users; for limited gifts only
    RemainingCount *int64 `json:"remaining_count,omitempty"`
    // Optional. The total number of gifts of this type that can be sent by the bot; for limited gifts only
    PersonalTotalCount *int64 `json:"personal_total_count,omitempty"`
    // Optional. The number of remaining gifts of this type that can be sent by the bot; for limited gifts only
    PersonalRemainingCount *int64 `json:"personal_remaining_count,omitempty"`
    // Optional. Background of the gift
    Background *GiftBackground `json:"background,omitempty"`
    // Optional. The total number of different unique gifts that can be obtained by upgrading the gift
    UniqueGiftVariantCount *int64 `json:"unique_gift_variant_count,omitempty"`
    // Optional. Information about the chat that published the gift
    PublisherChat *Chat `json:"publisher_chat,omitempty"`
}

type GiftBackground

This object describes the background of a gift.

type GiftBackground struct {
    // Center color of the background in RGB format
    CenterColor int64 `json:"center_color"`
    // Edge color of the background in RGB format
    EdgeColor int64 `json:"edge_color"`
    // Text color of the background in RGB format
    TextColor int64 `json:"text_color"`
}

type GiftInfo

Describes a service message about a regular gift that was sent or received.

type GiftInfo struct {
    // Information about the gift
    Gift Gift `json:"gift"`
    // Optional. Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts
    OwnedGiftID string `json:"owned_gift_id,omitempty"`
    // Optional. Number of Telegram Stars that can be claimed by the receiver by converting the gift; omitted if conversion to Telegram Stars is impossible
    ConvertStarCount *int64 `json:"convert_star_count,omitempty"`
    // Optional. Number of Telegram Stars that were prepaid for the ability to upgrade the gift
    PrepaidUpgradeStarCount *int64 `json:"prepaid_upgrade_star_count,omitempty"`
    // Optional. True, if the gift's upgrade was purchased after the gift was sent
    IsUpgradeSeparate *bool `json:"is_upgrade_separate,omitempty"`
    // Optional. True, if the gift can be upgraded to a unique gift
    CanBeUpgraded *bool `json:"can_be_upgraded,omitempty"`
    // Optional. Text of the message that was added to the gift
    Text string `json:"text,omitempty"`
    // Optional. Special entities that appear in the text
    Entities []MessageEntity `json:"entities,omitempty"`
    // Optional. True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them
    IsPrivate *bool `json:"is_private,omitempty"`
    // Optional. Unique number reserved for this gift when upgraded. See the number field in UniqueGift.
    UniqueGiftNumber *int64 `json:"unique_gift_number,omitempty"`
}

type GiftPremiumSubscriptionParams

GiftPremiumSubscriptionParams is the parameter set for GiftPremiumSubscription.

Gifts a Telegram Premium subscription to the given user. Returns True on success.

type GiftPremiumSubscriptionParams struct {
    // Unique identifier of the target user who will receive a Telegram Premium subscription
    UserID int64 `json:"user_id"`
    // Number of months the Telegram Premium subscription will be active for the user; must be one of 3, 6, or 12
    MonthCount int64 `json:"month_count"`
    // Number of Telegram Stars to pay for the Telegram Premium subscription; must be 1000 for 3 months, 1500 for 6 months, and 2500 for 12 months
    StarCount int64 `json:"star_count"`
    // Text that will be shown along with the service message about the subscription; 0-128 characters
    Text string `json:"text,omitempty"`
    // Mode for parsing entities in the text. See formatting options for more details. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored.
    TextParseMode ParseMode `json:"text_parse_mode,omitempty"`
    // A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of text_parse_mode. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored.
    TextEntities []MessageEntity `json:"text_entities,omitempty"`
}

type Gifts

This object represent a list of gifts.

type Gifts struct {
    // The list of gifts
    Gifts []Gift `json:"gifts"`
}

func GetAvailableGifts

func GetAvailableGifts(ctx context.Context, b *client.Bot, p *GetAvailableGiftsParams) (*Gifts, error)

GetAvailableGifts calls the getAvailableGifts Telegram Bot API method.

Returns the list of gifts that can be sent by the bot to users and channel chats. Requires no parameters. Returns a Gifts object.

type Giveaway

This object represents a message about a scheduled giveaway.

type Giveaway struct {
    // The list of chats which the user must join to participate in the giveaway
    Chats []Chat `json:"chats"`
    // Point in time (Unix timestamp) when winners of the giveaway will be selected
    WinnersSelectionDate int64 `json:"winners_selection_date"`
    // The number of users which are supposed to be selected as winners of the giveaway
    WinnerCount int64 `json:"winner_count"`
    // Optional. True, if only users who join the chats after the giveaway started should be eligible to win
    OnlyNewMembers *bool `json:"only_new_members,omitempty"`
    // Optional. True, if the list of giveaway winners will be visible to everyone
    HasPublicWinners *bool `json:"has_public_winners,omitempty"`
    // Optional. Description of additional giveaway prize
    PrizeDescription string `json:"prize_description,omitempty"`
    // Optional. A list of two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which eligible users for the giveaway must come. If empty, then all users can participate in the giveaway. Users with a phone number that was bought on Fragment can always participate in giveaways.
    CountryCodes []string `json:"country_codes,omitempty"`
    // Optional. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only
    PrizeStarCount *int64 `json:"prize_star_count,omitempty"`
    // Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only
    PremiumSubscriptionMonthCount *int64 `json:"premium_subscription_month_count,omitempty"`
}

type GiveawayCompleted

This object represents a service message about the completion of a giveaway without public winners.

type GiveawayCompleted struct {
    // Number of winners in the giveaway
    WinnerCount int64 `json:"winner_count"`
    // Optional. Number of undistributed prizes
    UnclaimedPrizeCount *int64 `json:"unclaimed_prize_count,omitempty"`
    // Optional. Message with the giveaway that was completed, if it wasn't deleted
    GiveawayMessage *Message `json:"giveaway_message,omitempty"`
    // Optional. True, if the giveaway is a Telegram Star giveaway. Otherwise, currently, the giveaway is a Telegram Premium giveaway.
    IsStarGiveaway *bool `json:"is_star_giveaway,omitempty"`
}

type GiveawayCreated

This object represents a service message about the creation of a scheduled giveaway.

type GiveawayCreated struct {
    // Optional. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only
    PrizeStarCount *int64 `json:"prize_star_count,omitempty"`
}

type GiveawayWinners

This object represents a message about the completion of a giveaway with public winners.

type GiveawayWinners struct {
    // The chat that created the giveaway
    Chat Chat `json:"chat"`
    // Identifier of the message with the giveaway in the chat
    GiveawayMessageID int64 `json:"giveaway_message_id"`
    // Point in time (Unix timestamp) when winners of the giveaway were selected
    WinnersSelectionDate int64 `json:"winners_selection_date"`
    // Total number of winners in the giveaway
    WinnerCount int64 `json:"winner_count"`
    // List of up to 100 winners of the giveaway
    Winners []User `json:"winners"`
    // Optional. The number of other chats the user had to join in order to be eligible for the giveaway
    AdditionalChatCount *int64 `json:"additional_chat_count,omitempty"`
    // Optional. The number of Telegram Stars that were split between giveaway winners; for Telegram Star giveaways only
    PrizeStarCount *int64 `json:"prize_star_count,omitempty"`
    // Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only
    PremiumSubscriptionMonthCount *int64 `json:"premium_subscription_month_count,omitempty"`
    // Optional. Number of undistributed prizes
    UnclaimedPrizeCount *int64 `json:"unclaimed_prize_count,omitempty"`
    // Optional. True, if only users who had joined the chats after the giveaway started were eligible to win
    OnlyNewMembers *bool `json:"only_new_members,omitempty"`
    // Optional. True, if the giveaway was canceled because the payment for it was refunded
    WasRefunded *bool `json:"was_refunded,omitempty"`
    // Optional. Description of additional giveaway prize
    PrizeDescription string `json:"prize_description,omitempty"`
}

type HideGeneralForumTopicParams

HideGeneralForumTopicParams is the parameter set for 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.

type HideGeneralForumTopicParams struct {
    // Unique identifier for the target chat or username of the target supergroup in the format @username
    ChatID ChatID `json:"chat_id"`
}

type InaccessibleMessage

This object describes a message that was deleted or is otherwise inaccessible to the bot.

type InaccessibleMessage struct {
    // Chat the message belonged to
    Chat Chat `json:"chat"`
    // Unique message identifier inside the chat
    MessageID int64 `json:"message_id"`
    // Always 0. The field can be used to differentiate regular and inaccessible messages.
    Date int64 `json:"date"`
}

type InlineKeyboardButton

This object represents one button of an inline keyboard. Exactly one of the fields other than text, icon_custom_emoji_id, and style must be used to specify the type of the button.

type InlineKeyboardButton struct {
    // Label text on the button
    Text string `json:"text"`
    // Optional. Unique identifier of the custom emoji shown before the text of the button. Can only be used by bots that purchased additional usernames on Fragment or in the messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription.
    IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
    // Optional. Style of the button. Must be one of “danger” (red), “success” (green) or “primary” (blue). If omitted, then an app-specific style is used.
    Style KeyboardButtonStyle `json:"style,omitempty"`
    // Optional. HTTP or tg:// URL to be opened when the button is pressed. Links tg://user?id=<user_id> can be used to mention a user by their identifier without using a username, if this is allowed by their privacy settings.
    URL string `json:"url,omitempty"`
    // Optional. Data to be sent in a callback query to the bot when the button is pressed, 1-64 bytes
    CallbackData string `json:"callback_data,omitempty"`
    // Optional. Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. Available only in private chats between a user and the bot. Not supported for messages sent on behalf of a business account.
    WebApp *WebAppInfo `json:"web_app,omitempty"`
    // Optional. An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget.
    LoginURL *LoginUrl `json:"login_url,omitempty"`
    // Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. Not supported for messages sent in channel direct messages chats and on behalf of a business account.
    SwitchInlineQuery string `json:"switch_inline_query,omitempty"`
    // Optional. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent in channel direct messages chats and on behalf of a business account.
    SwitchInlineQueryCurrentChat string `json:"switch_inline_query_current_chat,omitempty"`
    // Optional. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent in channel direct messages chats and on behalf of a business account.
    SwitchInlineQueryChosenChat *SwitchInlineQueryChosenChat `json:"switch_inline_query_chosen_chat,omitempty"`
    // Optional. Description of the button that copies the specified text to the clipboard
    CopyText *CopyTextButton `json:"copy_text,omitempty"`
    // Optional. Description of the game that will be launched when the user presses the button.NOTE: This type of button must always be the first button in the first row.
    CallbackGame *CallbackGame `json:"callback_game,omitempty"`
    // Optional. Specify True, to send a Pay button. Substrings “” and “XTR” in the buttons's text will be replaced with a Telegram Star icon.NOTE: This type of button must always be the first button in the first row and can only be used in invoice messages.
    Pay *bool `json:"pay,omitempty"`
}

type InlineKeyboardMarkup

This object represents an inline keyboard that appears right next to the message it belongs to.

type InlineKeyboardMarkup struct {
    // Array of button rows, each represented by an Array of InlineKeyboardButton objects
    InlineKeyboard [][]InlineKeyboardButton `json:"inline_keyboard"`
}

type InlineQuery

This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.

type InlineQuery struct {
    // Unique identifier for this query
    ID  string `json:"id"`
    // Sender
    From User `json:"from"`
    // Text of the query (up to 256 characters)
    Query string `json:"query"`
    // Offset of the results to be returned, can be controlled by the bot
    Offset string `json:"offset"`
    // Optional. Type of the chat from which the inline query was sent. Can be either “sender” for a private chat with the inline query sender, “private”, “group”, “supergroup”, or “channel”. The chat type should be always known for requests sent from official clients and most third-party clients, unless the request was sent from a secret chat.
    ChatType InlineQueryChatType `json:"chat_type,omitempty"`
    // Optional. Sender location, only for bots that request user location
    Location *Location `json:"location,omitempty"`
}

type InlineQueryChatType

type InlineQueryChatType string


const (
    InlineQueryChatTypeSender     InlineQueryChatType = "sender"
    InlineQueryChatTypePrivate    InlineQueryChatType = "private"
    InlineQueryChatTypeGroup      InlineQueryChatType = "group"
    InlineQueryChatTypeSupergroup InlineQueryChatType = "supergroup"
    InlineQueryChatTypeChannel    InlineQueryChatType = "channel"
)

type InlineQueryResult

InlineQueryResult is a union type. The following concrete variants implement it:

  • InlineQueryResultCachedAudio
  • InlineQueryResultCachedDocument
  • InlineQueryResultCachedGif
  • InlineQueryResultCachedMpeg4Gif
  • InlineQueryResultCachedPhoto
  • InlineQueryResultCachedSticker
  • InlineQueryResultCachedVideo
  • InlineQueryResultCachedVoice
  • InlineQueryResultArticle
  • InlineQueryResultAudio
  • InlineQueryResultContact
  • InlineQueryResultGame
  • InlineQueryResultDocument
  • InlineQueryResultGif
  • InlineQueryResultLocation
  • InlineQueryResultMpeg4Gif
  • InlineQueryResultPhoto
  • InlineQueryResultVenue
  • InlineQueryResultVideo
  • InlineQueryResultVoice

This object represents one result of an inline query. Telegram clients currently support results of the following 20 types: Note: All URLs passed in inline query results will be available to end users and therefore must be assumed to be public.

type InlineQueryResult interface {
    // contains filtered or unexported methods
}

type InlineQueryResultArticle

Represents a link to an article or web page.

type InlineQueryResultArticle struct {
    // Type of the result, must be article
    Type InlineQueryResultType `json:"type"`
    // Unique identifier for this result, 1-64 Bytes
    ID  string `json:"id"`
    // Title of the result
    Title string `json:"title"`
    // Content of the message to be sent
    InputMessageContent InputMessageContent `json:"input_message_content"`
    // Optional. Inline keyboard attached to the message
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
    // Optional. URL of the result
    URL string `json:"url,omitempty"`
    // Optional. Short description of the result
    Description string `json:"description,omitempty"`
    // Optional. Url of the thumbnail for the result
    ThumbnailURL string `json:"thumbnail_url,omitempty"`
    // Optional. Thumbnail width
    ThumbnailWidth *int64 `json:"thumbnail_width,omitempty"`
    // Optional. Thumbnail height
    ThumbnailHeight *int64 `json:"thumbnail_height,omitempty"`
}

func (*InlineQueryResultArticle) MarshalJSON

func (v *InlineQueryResultArticle) MarshalJSON() ([]byte, error)

MarshalJSON encodes InlineQueryResultArticle with the discriminator field "type" forced to "article". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InlineQueryResultAudio

Represents a link to an MP3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.

type InlineQueryResultAudio struct {
    // Type of the result, must be audio
    Type InlineQueryResultType `json:"type"`
    // Unique identifier for this result, 1-64 bytes
    ID  string `json:"id"`
    // A valid URL for the audio file
    AudioURL string `json:"audio_url"`
    // Title
    Title string `json:"title"`
    // Optional. Caption, 0-1024 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Optional. Mode for parsing entities in the audio caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Optional. Performer
    Performer string `json:"performer,omitempty"`
    // Optional. Audio duration in seconds
    AudioDuration *int64 `json:"audio_duration,omitempty"`
    // Optional. Inline keyboard attached to the message
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
    // Optional. Content of the message to be sent instead of the audio
    InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}

func (*InlineQueryResultAudio) MarshalJSON

func (v *InlineQueryResultAudio) MarshalJSON() ([]byte, error)

MarshalJSON encodes InlineQueryResultAudio with the discriminator field "type" forced to "audio". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InlineQueryResultCachedAudio

Represents a link to an MP3 audio file stored on the Telegram servers. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.

type InlineQueryResultCachedAudio struct {
    // Type of the result, must be audio
    Type InlineQueryResultType `json:"type"`
    // Unique identifier for this result, 1-64 bytes
    ID  string `json:"id"`
    // A valid file identifier for the audio file
    AudioFileID string `json:"audio_file_id"`
    // Optional. Caption, 0-1024 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Optional. Mode for parsing entities in the audio caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Optional. Inline keyboard attached to the message
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
    // Optional. Content of the message to be sent instead of the audio
    InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}

func (*InlineQueryResultCachedAudio) MarshalJSON

func (v *InlineQueryResultCachedAudio) MarshalJSON() ([]byte, error)

MarshalJSON encodes InlineQueryResultCachedAudio with the discriminator field "type" forced to "audio". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InlineQueryResultCachedDocument

Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file.

type InlineQueryResultCachedDocument struct {
    // Type of the result, must be document
    Type InlineQueryResultType `json:"type"`
    // Unique identifier for this result, 1-64 bytes
    ID  string `json:"id"`
    // Title for the result
    Title string `json:"title"`
    // A valid file identifier for the file
    DocumentFileID string `json:"document_file_id"`
    // Optional. Short description of the result
    Description string `json:"description,omitempty"`
    // Optional. Caption of the document to be sent, 0-1024 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Optional. Mode for parsing entities in the document caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Optional. Inline keyboard attached to the message
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
    // Optional. Content of the message to be sent instead of the file
    InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}

func (*InlineQueryResultCachedDocument) MarshalJSON

func (v *InlineQueryResultCachedDocument) MarshalJSON() ([]byte, error)

MarshalJSON encodes InlineQueryResultCachedDocument with the discriminator field "type" forced to "document". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InlineQueryResultCachedGif

Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with specified content instead of the animation.

type InlineQueryResultCachedGif struct {
    // Type of the result, must be gif
    Type InlineQueryResultType `json:"type"`
    // Unique identifier for this result, 1-64 bytes
    ID  string `json:"id"`
    // A valid file identifier for the GIF file
    GifFileID string `json:"gif_file_id"`
    // Optional. Title for the result
    Title string `json:"title,omitempty"`
    // Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Optional. Mode for parsing entities in the caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Optional. Pass True, if the caption must be shown above the message media
    ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
    // Optional. Inline keyboard attached to the message
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
    // Optional. Content of the message to be sent instead of the GIF animation
    InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}

func (*InlineQueryResultCachedGif) MarshalJSON

func (v *InlineQueryResultCachedGif) MarshalJSON() ([]byte, error)

MarshalJSON encodes InlineQueryResultCachedGif with the discriminator field "type" forced to "gif". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InlineQueryResultCachedMpeg4Gif

Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By default, this animated MPEG-4 file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.

type InlineQueryResultCachedMpeg4Gif struct {
    // Type of the result, must be mpeg4_gif
    Type InlineQueryResultType `json:"type"`
    // Unique identifier for this result, 1-64 bytes
    ID  string `json:"id"`
    // A valid file identifier for the MPEG4 file
    Mpeg4FileID string `json:"mpeg4_file_id"`
    // Optional. Title for the result
    Title string `json:"title,omitempty"`
    // Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Optional. Mode for parsing entities in the caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Optional. Pass True, if the caption must be shown above the message media
    ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
    // Optional. Inline keyboard attached to the message
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
    // Optional. Content of the message to be sent instead of the video animation
    InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}

func (*InlineQueryResultCachedMpeg4Gif) MarshalJSON

func (v *InlineQueryResultCachedMpeg4Gif) MarshalJSON() ([]byte, error)

MarshalJSON encodes InlineQueryResultCachedMpeg4Gif with the discriminator field "type" forced to "mpeg4_gif". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InlineQueryResultCachedPhoto

Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.

type InlineQueryResultCachedPhoto struct {
    // Type of the result, must be photo
    Type InlineQueryResultType `json:"type"`
    // Unique identifier for this result, 1-64 bytes
    ID  string `json:"id"`
    // A valid file identifier of the photo
    PhotoFileID string `json:"photo_file_id"`
    // Optional. Title for the result
    Title string `json:"title,omitempty"`
    // Optional. Short description of the result
    Description string `json:"description,omitempty"`
    // Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Optional. Mode for parsing entities in the photo caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Optional. Pass True, if the caption must be shown above the message media
    ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
    // Optional. Inline keyboard attached to the message
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
    // Optional. Content of the message to be sent instead of the photo
    InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}

func (*InlineQueryResultCachedPhoto) MarshalJSON

func (v *InlineQueryResultCachedPhoto) MarshalJSON() ([]byte, error)

MarshalJSON encodes InlineQueryResultCachedPhoto with the discriminator field "type" forced to "photo". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InlineQueryResultCachedSticker

Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the sticker.

type InlineQueryResultCachedSticker struct {
    // Type of the result, must be sticker
    Type InlineQueryResultType `json:"type"`
    // Unique identifier for this result, 1-64 bytes
    ID  string `json:"id"`
    // A valid file identifier of the sticker
    StickerFileID string `json:"sticker_file_id"`
    // Optional. Inline keyboard attached to the message
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
    // Optional. Content of the message to be sent instead of the sticker
    InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}

func (*InlineQueryResultCachedSticker) MarshalJSON

func (v *InlineQueryResultCachedSticker) MarshalJSON() ([]byte, error)

MarshalJSON encodes InlineQueryResultCachedSticker with the discriminator field "type" forced to "sticker". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InlineQueryResultCachedVideo

Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.

type InlineQueryResultCachedVideo struct {
    // Type of the result, must be video
    Type InlineQueryResultType `json:"type"`
    // Unique identifier for this result, 1-64 bytes
    ID  string `json:"id"`
    // A valid file identifier for the video file
    VideoFileID string `json:"video_file_id"`
    // Title for the result
    Title string `json:"title"`
    // Optional. Short description of the result
    Description string `json:"description,omitempty"`
    // Optional. Caption of the video to be sent, 0-1024 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Optional. Mode for parsing entities in the video caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Optional. Pass True, if the caption must be shown above the message media
    ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
    // Optional. Inline keyboard attached to the message
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
    // Optional. Content of the message to be sent instead of the video
    InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}

func (*InlineQueryResultCachedVideo) MarshalJSON

func (v *InlineQueryResultCachedVideo) MarshalJSON() ([]byte, error)

MarshalJSON encodes InlineQueryResultCachedVideo with the discriminator field "type" forced to "video". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InlineQueryResultCachedVoice

Represents a link to a voice message stored on the Telegram servers. By default, this voice message will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the voice message.

type InlineQueryResultCachedVoice struct {
    // Type of the result, must be voice
    Type InlineQueryResultType `json:"type"`
    // Unique identifier for this result, 1-64 bytes
    ID  string `json:"id"`
    // A valid file identifier for the voice message
    VoiceFileID string `json:"voice_file_id"`
    // Voice message title
    Title string `json:"title"`
    // Optional. Caption, 0-1024 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Optional. Mode for parsing entities in the voice message caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Optional. Inline keyboard attached to the message
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
    // Optional. Content of the message to be sent instead of the voice message
    InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}

func (*InlineQueryResultCachedVoice) MarshalJSON

func (v *InlineQueryResultCachedVoice) MarshalJSON() ([]byte, error)

MarshalJSON encodes InlineQueryResultCachedVoice with the discriminator field "type" forced to "voice". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InlineQueryResultContact

Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the contact.

type InlineQueryResultContact struct {
    // Type of the result, must be contact
    Type InlineQueryResultType `json:"type"`
    // Unique identifier for this result, 1-64 Bytes
    ID  string `json:"id"`
    // Contact's phone number
    PhoneNumber string `json:"phone_number"`
    // Contact's first name
    FirstName string `json:"first_name"`
    // Optional. Contact's last name
    LastName string `json:"last_name,omitempty"`
    // Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes
    Vcard string `json:"vcard,omitempty"`
    // Optional. Inline keyboard attached to the message
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
    // Optional. Content of the message to be sent instead of the contact
    InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
    // Optional. Url of the thumbnail for the result
    ThumbnailURL string `json:"thumbnail_url,omitempty"`
    // Optional. Thumbnail width
    ThumbnailWidth *int64 `json:"thumbnail_width,omitempty"`
    // Optional. Thumbnail height
    ThumbnailHeight *int64 `json:"thumbnail_height,omitempty"`
}

func (*InlineQueryResultContact) MarshalJSON

func (v *InlineQueryResultContact) MarshalJSON() ([]byte, error)

MarshalJSON encodes InlineQueryResultContact with the discriminator field "type" forced to "contact". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InlineQueryResultDocument

Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file. Currently, only .PDF and .ZIP files can be sent using this method.

type InlineQueryResultDocument struct {
    // Type of the result, must be document
    Type InlineQueryResultType `json:"type"`
    // Unique identifier for this result, 1-64 bytes
    ID  string `json:"id"`
    // Title for the result
    Title string `json:"title"`
    // Optional. Caption of the document to be sent, 0-1024 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Optional. Mode for parsing entities in the document caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // A valid URL for the file
    DocumentURL string `json:"document_url"`
    // MIME type of the content of the file, either “application/pdf” or “application/zip”
    MimeType InlineQueryResultDocumentMimeType `json:"mime_type"`
    // Optional. Short description of the result
    Description string `json:"description,omitempty"`
    // Optional. Inline keyboard attached to the message
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
    // Optional. Content of the message to be sent instead of the file
    InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
    // Optional. URL of the thumbnail (JPEG only) for the file
    ThumbnailURL string `json:"thumbnail_url,omitempty"`
    // Optional. Thumbnail width
    ThumbnailWidth *int64 `json:"thumbnail_width,omitempty"`
    // Optional. Thumbnail height
    ThumbnailHeight *int64 `json:"thumbnail_height,omitempty"`
}

func (*InlineQueryResultDocument) MarshalJSON

func (v *InlineQueryResultDocument) MarshalJSON() ([]byte, error)

MarshalJSON encodes InlineQueryResultDocument with the discriminator field "type" forced to "document". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InlineQueryResultDocumentMimeType

type InlineQueryResultDocumentMimeType string


const (
    InlineQueryResultDocumentMimeTypeApplicationOfPdf InlineQueryResultDocumentMimeType = "application/pdf"
    InlineQueryResultDocumentMimeTypeApplicationOfZip InlineQueryResultDocumentMimeType = "application/zip"
)

type InlineQueryResultGame

Represents a Game.

type InlineQueryResultGame struct {
    // Type of the result, must be game
    Type InlineQueryResultType `json:"type"`
    // Unique identifier for this result, 1-64 bytes
    ID  string `json:"id"`
    // Short name of the game
    GameShortName string `json:"game_short_name"`
    // Optional. Inline keyboard attached to the message
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

func (*InlineQueryResultGame) MarshalJSON

func (v *InlineQueryResultGame) MarshalJSON() ([]byte, error)

MarshalJSON encodes InlineQueryResultGame with the discriminator field "type" forced to "game". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InlineQueryResultGif

Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.

type InlineQueryResultGif struct {
    // Type of the result, must be gif
    Type InlineQueryResultType `json:"type"`
    // Unique identifier for this result, 1-64 bytes
    ID  string `json:"id"`
    // A valid URL for the GIF file
    GifURL string `json:"gif_url"`
    // Optional. Width of the GIF
    GifWidth *int64 `json:"gif_width,omitempty"`
    // Optional. Height of the GIF
    GifHeight *int64 `json:"gif_height,omitempty"`
    // Optional. Duration of the GIF in seconds
    GifDuration *int64 `json:"gif_duration,omitempty"`
    // URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result
    ThumbnailURL string `json:"thumbnail_url"`
    // Optional. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg”.
    ThumbnailMimeType InlineQueryResultGifThumbnailMimeType `json:"thumbnail_mime_type,omitempty"`
    // Optional. Title for the result
    Title string `json:"title,omitempty"`
    // Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Optional. Mode for parsing entities in the caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Optional. Pass True, if the caption must be shown above the message media
    ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
    // Optional. Inline keyboard attached to the message
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
    // Optional. Content of the message to be sent instead of the GIF animation
    InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}

func (*InlineQueryResultGif) MarshalJSON

func (v *InlineQueryResultGif) MarshalJSON() ([]byte, error)

MarshalJSON encodes InlineQueryResultGif with the discriminator field "type" forced to "gif". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InlineQueryResultGifThumbnailMimeType

type InlineQueryResultGifThumbnailMimeType string


const (
    InlineQueryResultGifThumbnailMimeTypeImageOfJpeg InlineQueryResultGifThumbnailMimeType = "image/jpeg"
    InlineQueryResultGifThumbnailMimeTypeImageOfGif  InlineQueryResultGifThumbnailMimeType = "image/gif"
    InlineQueryResultGifThumbnailMimeTypeVideoOfMp4  InlineQueryResultGifThumbnailMimeType = "video/mp4"
)

type InlineQueryResultLocation

Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the location.

type InlineQueryResultLocation struct {
    // Type of the result, must be location
    Type InlineQueryResultType `json:"type"`
    // Unique identifier for this result, 1-64 Bytes
    ID  string `json:"id"`
    // Location latitude in degrees
    Latitude float64 `json:"latitude"`
    // Location longitude in degrees
    Longitude float64 `json:"longitude"`
    // Location title
    Title string `json:"title"`
    // Optional. The radius of uncertainty for the location, measured in meters; 0-1500
    HorizontalAccuracy *float64 `json:"horizontal_accuracy,omitempty"`
    // Optional. Period in seconds during which the location can be updated, must be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely
    LivePeriod *int64 `json:"live_period,omitempty"`
    // Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.
    Heading *int64 `json:"heading,omitempty"`
    // Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.
    ProximityAlertRadius *int64 `json:"proximity_alert_radius,omitempty"`
    // Optional. Inline keyboard attached to the message
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
    // Optional. Content of the message to be sent instead of the location
    InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
    // Optional. Url of the thumbnail for the result
    ThumbnailURL string `json:"thumbnail_url,omitempty"`
    // Optional. Thumbnail width
    ThumbnailWidth *int64 `json:"thumbnail_width,omitempty"`
    // Optional. Thumbnail height
    ThumbnailHeight *int64 `json:"thumbnail_height,omitempty"`
}

func (*InlineQueryResultLocation) MarshalJSON

func (v *InlineQueryResultLocation) MarshalJSON() ([]byte, error)

MarshalJSON encodes InlineQueryResultLocation with the discriminator field "type" forced to "location". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InlineQueryResultMpeg4Gif

Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this animated MPEG-4 file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.

type InlineQueryResultMpeg4Gif struct {
    // Type of the result, must be mpeg4_gif
    Type InlineQueryResultType `json:"type"`
    // Unique identifier for this result, 1-64 bytes
    ID  string `json:"id"`
    // A valid URL for the MPEG4 file
    Mpeg4URL string `json:"mpeg4_url"`
    // Optional. Video width
    Mpeg4Width *int64 `json:"mpeg4_width,omitempty"`
    // Optional. Video height
    Mpeg4Height *int64 `json:"mpeg4_height,omitempty"`
    // Optional. Video duration in seconds
    Mpeg4Duration *int64 `json:"mpeg4_duration,omitempty"`
    // URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result
    ThumbnailURL string `json:"thumbnail_url"`
    // Optional. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg”.
    ThumbnailMimeType InlineQueryResultGifThumbnailMimeType `json:"thumbnail_mime_type,omitempty"`
    // Optional. Title for the result
    Title string `json:"title,omitempty"`
    // Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Optional. Mode for parsing entities in the caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Optional. Pass True, if the caption must be shown above the message media
    ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
    // Optional. Inline keyboard attached to the message
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
    // Optional. Content of the message to be sent instead of the video animation
    InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}

func (*InlineQueryResultMpeg4Gif) MarshalJSON

func (v *InlineQueryResultMpeg4Gif) MarshalJSON() ([]byte, error)

MarshalJSON encodes InlineQueryResultMpeg4Gif with the discriminator field "type" forced to "mpeg4_gif". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InlineQueryResultPhoto

Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.

type InlineQueryResultPhoto struct {
    // Type of the result, must be photo
    Type InlineQueryResultType `json:"type"`
    // Unique identifier for this result, 1-64 bytes
    ID  string `json:"id"`
    // A valid URL of the photo. Photo must be in JPEG format. Photo size must not exceed 5MB.
    PhotoURL string `json:"photo_url"`
    // URL of the thumbnail for the photo
    ThumbnailURL string `json:"thumbnail_url"`
    // Optional. Width of the photo
    PhotoWidth *int64 `json:"photo_width,omitempty"`
    // Optional. Height of the photo
    PhotoHeight *int64 `json:"photo_height,omitempty"`
    // Optional. Title for the result
    Title string `json:"title,omitempty"`
    // Optional. Short description of the result
    Description string `json:"description,omitempty"`
    // Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Optional. Mode for parsing entities in the photo caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Optional. Pass True, if the caption must be shown above the message media
    ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
    // Optional. Inline keyboard attached to the message
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
    // Optional. Content of the message to be sent instead of the photo
    InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}

func (*InlineQueryResultPhoto) MarshalJSON

func (v *InlineQueryResultPhoto) MarshalJSON() ([]byte, error)

MarshalJSON encodes InlineQueryResultPhoto with the discriminator field "type" forced to "photo". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InlineQueryResultType

type InlineQueryResultType string


const (
    InlineQueryResultTypeAudio    InlineQueryResultType = "audio"
    InlineQueryResultTypeDocument InlineQueryResultType = "document"
    InlineQueryResultTypeGif      InlineQueryResultType = "gif"
    InlineQueryResultTypeMpeg4Gif InlineQueryResultType = "mpeg4_gif"
    InlineQueryResultTypePhoto    InlineQueryResultType = "photo"
    InlineQueryResultTypeSticker  InlineQueryResultType = "sticker"
    InlineQueryResultTypeVideo    InlineQueryResultType = "video"
    InlineQueryResultTypeVoice    InlineQueryResultType = "voice"
    InlineQueryResultTypeArticle  InlineQueryResultType = "article"
    InlineQueryResultTypeContact  InlineQueryResultType = "contact"
    InlineQueryResultTypeGame     InlineQueryResultType = "game"
    InlineQueryResultTypeLocation InlineQueryResultType = "location"
    InlineQueryResultTypeVenue    InlineQueryResultType = "venue"
)

type InlineQueryResultVenue

Represents a venue. By default, the venue will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the venue.

type InlineQueryResultVenue struct {
    // Type of the result, must be venue
    Type InlineQueryResultType `json:"type"`
    // Unique identifier for this result, 1-64 Bytes
    ID  string `json:"id"`
    // Latitude of the venue location in degrees
    Latitude float64 `json:"latitude"`
    // Longitude of the venue location in degrees
    Longitude float64 `json:"longitude"`
    // Title of the venue
    Title string `json:"title"`
    // Address of the venue
    Address string `json:"address"`
    // Optional. Foursquare identifier of the venue if known
    FoursquareID string `json:"foursquare_id,omitempty"`
    // Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)
    FoursquareType string `json:"foursquare_type,omitempty"`
    // Optional. Google Places identifier of the venue
    GooglePlaceID string `json:"google_place_id,omitempty"`
    // Optional. Google Places type of the venue. (See supported types.)
    GooglePlaceType string `json:"google_place_type,omitempty"`
    // Optional. Inline keyboard attached to the message
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
    // Optional. Content of the message to be sent instead of the venue
    InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
    // Optional. Url of the thumbnail for the result
    ThumbnailURL string `json:"thumbnail_url,omitempty"`
    // Optional. Thumbnail width
    ThumbnailWidth *int64 `json:"thumbnail_width,omitempty"`
    // Optional. Thumbnail height
    ThumbnailHeight *int64 `json:"thumbnail_height,omitempty"`
}

func (*InlineQueryResultVenue) MarshalJSON

func (v *InlineQueryResultVenue) MarshalJSON() ([]byte, error)

MarshalJSON encodes InlineQueryResultVenue with the discriminator field "type" forced to "venue". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InlineQueryResultVideo

Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video. If an InlineQueryResultVideo message contains an embedded video (e.g., YouTube), you must replace its content using input_message_content.

type InlineQueryResultVideo struct {
    // Type of the result, must be video
    Type InlineQueryResultType `json:"type"`
    // Unique identifier for this result, 1-64 bytes
    ID  string `json:"id"`
    // A valid URL for the embedded video player or video file
    VideoURL string `json:"video_url"`
    // MIME type of the content of the video URL, “text/html” or “video/mp4”
    MimeType string `json:"mime_type"`
    // URL of the thumbnail (JPEG only) for the video
    ThumbnailURL string `json:"thumbnail_url"`
    // Title for the result
    Title string `json:"title"`
    // Optional. Caption of the video to be sent, 0-1024 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Optional. Mode for parsing entities in the video caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Optional. Pass True, if the caption must be shown above the message media
    ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
    // Optional. Video width
    VideoWidth *int64 `json:"video_width,omitempty"`
    // Optional. Video height
    VideoHeight *int64 `json:"video_height,omitempty"`
    // Optional. Video duration in seconds
    VideoDuration *int64 `json:"video_duration,omitempty"`
    // Optional. Short description of the result
    Description string `json:"description,omitempty"`
    // Optional. Inline keyboard attached to the message
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
    // Optional. Content of the message to be sent instead of the video. This field is required if InlineQueryResultVideo is used to send an HTML-page as a result (e.g., a YouTube video).
    InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}

func (*InlineQueryResultVideo) MarshalJSON

func (v *InlineQueryResultVideo) MarshalJSON() ([]byte, error)

MarshalJSON encodes InlineQueryResultVideo with the discriminator field "type" forced to "video". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InlineQueryResultVoice

Represents a link to a voice recording in an .OGG container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the the voice message.

type InlineQueryResultVoice struct {
    // Type of the result, must be voice
    Type InlineQueryResultType `json:"type"`
    // Unique identifier for this result, 1-64 bytes
    ID  string `json:"id"`
    // A valid URL for the voice recording
    VoiceURL string `json:"voice_url"`
    // Recording title
    Title string `json:"title"`
    // Optional. Caption, 0-1024 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Optional. Mode for parsing entities in the voice message caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Optional. Recording duration in seconds
    VoiceDuration *int64 `json:"voice_duration,omitempty"`
    // Optional. Inline keyboard attached to the message
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
    // Optional. Content of the message to be sent instead of the voice recording
    InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}

func (*InlineQueryResultVoice) MarshalJSON

func (v *InlineQueryResultVoice) MarshalJSON() ([]byte, error)

MarshalJSON encodes InlineQueryResultVoice with the discriminator field "type" forced to "voice". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InlineQueryResultsButton

This object represents a button to be shown above inline query results. You must use exactly one of the optional fields.

type InlineQueryResultsButton struct {
    // Label text on the button
    Text string `json:"text"`
    // Optional. Description of the Web App that will be launched when the user presses the button. The Web App will be able to switch back to the inline mode using the method switchInlineQuery inside the Web App.
    WebApp *WebAppInfo `json:"web_app,omitempty"`
    // Optional. Deep-linking parameter for the /start message sent to the bot when a user presses the button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed.Example: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a 'Connect your YouTube account' button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an OAuth link. Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities.
    StartParameter string `json:"start_parameter,omitempty"`
}

type InputChecklist

Describes a checklist to create.

type InputChecklist struct {
    // Title of the checklist; 1-255 characters after entities parsing
    Title string `json:"title"`
    // Optional. Mode for parsing entities in the title. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // Optional. List of special entities that appear in the title, which can be specified instead of parse_mode. Currently, only bold, italic, underline, strikethrough, spoiler, custom_emoji, and date_time entities are allowed.
    TitleEntities []MessageEntity `json:"title_entities,omitempty"`
    // List of 1-30 tasks in the checklist
    Tasks []InputChecklistTask `json:"tasks"`
    // Optional. Pass True if other users can add tasks to the checklist
    OthersCanAddTasks *bool `json:"others_can_add_tasks,omitempty"`
    // Optional. Pass True if other users can mark tasks as done or not done in the checklist
    OthersCanMarkTasksAsDone *bool `json:"others_can_mark_tasks_as_done,omitempty"`
}

type InputChecklistTask

Describes a task to add to a checklist.

type InputChecklistTask struct {
    // Unique identifier of the task; must be positive and unique among all task identifiers currently present in the checklist
    ID  int64 `json:"id"`
    // Text of the task; 1-100 characters after entities parsing
    Text string `json:"text"`
    // Optional. Mode for parsing entities in the text. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // Optional. List of special entities that appear in the text, which can be specified instead of parse_mode. Currently, only bold, italic, underline, strikethrough, spoiler, custom_emoji, and date_time entities are allowed.
    TextEntities []MessageEntity `json:"text_entities,omitempty"`
}

type InputContactMessageContent

Represents the content of a contact message to be sent as the result of an inline query.

type InputContactMessageContent struct {
    // Contact's phone number
    PhoneNumber string `json:"phone_number"`
    // Contact's first name
    FirstName string `json:"first_name"`
    // Optional. Contact's last name
    LastName string `json:"last_name,omitempty"`
    // Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes
    Vcard string `json:"vcard,omitempty"`
}

type InputFile

InputFile carries either a file path (for upload) or a Telegram file_id / URL string (for reuse). When PathOrID names a local file, the request is sent as multipart/form-data; otherwise the value is sent inline.

type InputFile struct {
    // PathOrID is one of: an absolute or relative filesystem path, a
    // previously-uploaded Telegram file_id, or an HTTPS URL Telegram
    // can fetch.
    PathOrID string
    // Reader, when non-nil, is used as the file content (Filename names it).
    Reader io.Reader
    // Filename is the upload filename used when Reader is set.
    Filename string
}

func (*InputFile) IsLocalUpload

func (f *InputFile) IsLocalUpload() bool

IsLocalUpload reports whether this InputFile triggers a multipart upload.

type InputInvoiceMessageContent

Represents the content of an invoice message to be sent as the result of an inline query.

type InputInvoiceMessageContent struct {
    // Product name, 1-32 characters
    Title string `json:"title"`
    // Product description, 1-255 characters
    Description string `json:"description"`
    // Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.
    Payload string `json:"payload"`
    // Optional. Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.
    ProviderToken string `json:"provider_token,omitempty"`
    // Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars.
    Currency string `json:"currency"`
    // Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars.
    Prices []LabeledPrice `json:"prices"`
    // Optional. The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars.
    MaxTipAmount *int64 `json:"max_tip_amount,omitempty"`
    // Optional. A JSON-serialized array of suggested amounts of tip in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.
    SuggestedTipAmounts []int64 `json:"suggested_tip_amounts,omitempty"`
    // Optional. A JSON-serialized object for data about the invoice, which will be shared with the payment provider. A detailed description of the required fields should be provided by the payment provider.
    ProviderData string `json:"provider_data,omitempty"`
    // Optional. URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.
    PhotoURL string `json:"photo_url,omitempty"`
    // Optional. Photo size in bytes
    PhotoSize *int64 `json:"photo_size,omitempty"`
    // Optional. Photo width
    PhotoWidth *int64 `json:"photo_width,omitempty"`
    // Optional. Photo height
    PhotoHeight *int64 `json:"photo_height,omitempty"`
    // Optional. Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars.
    NeedName *bool `json:"need_name,omitempty"`
    // Optional. Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars.
    NeedPhoneNumber *bool `json:"need_phone_number,omitempty"`
    // Optional. Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars.
    NeedEmail *bool `json:"need_email,omitempty"`
    // Optional. Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars.
    NeedShippingAddress *bool `json:"need_shipping_address,omitempty"`
    // Optional. Pass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars.
    SendPhoneNumberToProvider *bool `json:"send_phone_number_to_provider,omitempty"`
    // Optional. Pass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars.
    SendEmailToProvider *bool `json:"send_email_to_provider,omitempty"`
    // Optional. Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars.
    IsFlexible *bool `json:"is_flexible,omitempty"`
}

type InputLocationMessageContent

Represents the content of a location message to be sent as the result of an inline query.

type InputLocationMessageContent struct {
    // Latitude of the location in degrees
    Latitude float64 `json:"latitude"`
    // Longitude of the location in degrees
    Longitude float64 `json:"longitude"`
    // Optional. The radius of uncertainty for the location, measured in meters; 0-1500
    HorizontalAccuracy *float64 `json:"horizontal_accuracy,omitempty"`
    // Optional. Period in seconds during which the location can be updated, must be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely
    LivePeriod *int64 `json:"live_period,omitempty"`
    // Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.
    Heading *int64 `json:"heading,omitempty"`
    // Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.
    ProximityAlertRadius *int64 `json:"proximity_alert_radius,omitempty"`
}

type InputMedia

InputMedia is a union type. The following concrete variants implement it:

  • InputMediaAnimation
  • InputMediaAudio
  • InputMediaDocument
  • InputMediaLivePhoto
  • InputMediaPhoto
  • InputMediaVideo

This object represents the content of a media message to be sent. It should be one of

type InputMedia interface {
    // contains filtered or unexported methods
}

type InputMediaAnimation

Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.

type InputMediaAnimation struct {
    // Type of the result, must be animation
    Type InputMediaType `json:"type"`
    // File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »
    Media string `json:"media"`
    // Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
    Thumbnail string `json:"thumbnail,omitempty"`
    // Optional. Caption of the animation to be sent, 0-1024 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Optional. Mode for parsing entities in the animation caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Optional. Pass True, if the caption must be shown above the message media
    ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
    // Optional. Animation width
    Width *int64 `json:"width,omitempty"`
    // Optional. Animation height
    Height *int64 `json:"height,omitempty"`
    // Optional. Animation duration in seconds
    Duration *int64 `json:"duration,omitempty"`
    // Optional. Pass True if the animation needs to be covered with a spoiler animation
    HasSpoiler *bool `json:"has_spoiler,omitempty"`
}

func (*InputMediaAnimation) MarshalJSON

func (v *InputMediaAnimation) MarshalJSON() ([]byte, error)

MarshalJSON encodes InputMediaAnimation with the discriminator field "type" forced to "animation". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InputMediaAudio

Represents an audio file to be treated as music to be sent.

type InputMediaAudio struct {
    // Type of the result, must be audio
    Type InputMediaType `json:"type"`
    // File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »
    Media string `json:"media"`
    // Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
    Thumbnail string `json:"thumbnail,omitempty"`
    // Optional. Caption of the audio to be sent, 0-1024 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Optional. Mode for parsing entities in the audio caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Optional. Duration of the audio in seconds
    Duration *int64 `json:"duration,omitempty"`
    // Optional. Performer of the audio
    Performer string `json:"performer,omitempty"`
    // Optional. Title of the audio
    Title string `json:"title,omitempty"`
}

func (*InputMediaAudio) MarshalJSON

func (v *InputMediaAudio) MarshalJSON() ([]byte, error)

MarshalJSON encodes InputMediaAudio with the discriminator field "type" forced to "audio". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InputMediaDocument

Represents a general file to be sent.

type InputMediaDocument struct {
    // Type of the result, must be document
    Type InputMediaType `json:"type"`
    // File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »
    Media string `json:"media"`
    // Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
    Thumbnail string `json:"thumbnail,omitempty"`
    // Optional. Caption of the document to be sent, 0-1024 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Optional. Mode for parsing entities in the document caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Optional. Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always True, if the document is sent as part of an album.
    DisableContentTypeDetection *bool `json:"disable_content_type_detection,omitempty"`
}

func (*InputMediaDocument) MarshalJSON

func (v *InputMediaDocument) MarshalJSON() ([]byte, error)

MarshalJSON encodes InputMediaDocument with the discriminator field "type" forced to "document". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InputMediaLivePhoto

Represents a live photo to be sent.

type InputMediaLivePhoto struct {
    // Type of the result, must be live_photo
    Type InputMediaType `json:"type"`
    // Video of the live photo to send. Pass a file_id to send a file that exists on the Telegram servers (recommended) or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files ». Sending live photos by a URL is currently unsupported.
    Media string `json:"media"`
    // The static photo to send. Pass a file_id to send a file that exists on the Telegram servers (recommended) or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files ». Sending live photos by a URL is currently unsupported.
    Photo string `json:"photo"`
    // Optional. Caption of the live photo to be sent, 0-1024 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Optional. Mode for parsing entities in the live photo caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Optional. Pass True, if the caption must be shown above the message media
    ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
    // Optional. Pass True if the live photo needs to be covered with a spoiler animation
    HasSpoiler *bool `json:"has_spoiler,omitempty"`
}

func (*InputMediaLivePhoto) MarshalJSON

func (v *InputMediaLivePhoto) MarshalJSON() ([]byte, error)

MarshalJSON encodes InputMediaLivePhoto with the discriminator field "type" forced to "live_photo". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InputMediaLocation

Represents a location to be sent.

type InputMediaLocation struct {
    // Type of the result, must be location
    Type InputPollOptionMediaType `json:"type"`
    // Latitude of the location
    Latitude float64 `json:"latitude"`
    // Longitude of the location
    Longitude float64 `json:"longitude"`
    // Optional. The radius of uncertainty for the location, measured in meters; 0-1500
    HorizontalAccuracy *float64 `json:"horizontal_accuracy,omitempty"`
}

func (*InputMediaLocation) MarshalJSON

func (v *InputMediaLocation) MarshalJSON() ([]byte, error)

MarshalJSON encodes InputMediaLocation with the discriminator field "type" forced to "location". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InputMediaPhoto

Represents a photo to be sent.

type InputMediaPhoto struct {
    // Type of the result, must be photo
    Type InputMediaType `json:"type"`
    // File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »
    Media string `json:"media"`
    // Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Optional. Mode for parsing entities in the photo caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Optional. Pass True, if the caption must be shown above the message media
    ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
    // Optional. Pass True if the photo needs to be covered with a spoiler animation
    HasSpoiler *bool `json:"has_spoiler,omitempty"`
}

func (*InputMediaPhoto) MarshalJSON

func (v *InputMediaPhoto) MarshalJSON() ([]byte, error)

MarshalJSON encodes InputMediaPhoto with the discriminator field "type" forced to "photo". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InputMediaSticker

Represents a sticker file to be sent.

type InputMediaSticker struct {
    // Type of the result, must be sticker
    Type InputPollOptionMediaType `json:"type"`
    // File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a .WEBP sticker from the Internet, or pass “attach://<file_attach_name>” to upload a new .WEBP, .TGS, or .WEBM sticker using multipart/form-data under <file_attach_name> name. More information on Sending Files »
    Media string `json:"media"`
    // Optional. Emoji associated with the sticker; only for just uploaded stickers
    Emoji string `json:"emoji,omitempty"`
}

func (*InputMediaSticker) MarshalJSON

func (v *InputMediaSticker) MarshalJSON() ([]byte, error)

MarshalJSON encodes InputMediaSticker with the discriminator field "type" forced to "sticker". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InputMediaType

type InputMediaType string


const (
    InputMediaTypeAnimation InputMediaType = "animation"
    InputMediaTypeAudio     InputMediaType = "audio"
    InputMediaTypeDocument  InputMediaType = "document"
    InputMediaTypeLivePhoto InputMediaType = "live_photo"
    InputMediaTypePhoto     InputMediaType = "photo"
    InputMediaTypeVideo     InputMediaType = "video"
)

type InputMediaVenue

Represents a venue to be sent.

type InputMediaVenue struct {
    // Type of the result, must be venue
    Type InputPollOptionMediaType `json:"type"`
    // Latitude of the location
    Latitude float64 `json:"latitude"`
    // Longitude of the location
    Longitude float64 `json:"longitude"`
    // Name of the venue
    Title string `json:"title"`
    // Address of the venue
    Address string `json:"address"`
    // Optional. Foursquare identifier of the venue
    FoursquareID string `json:"foursquare_id,omitempty"`
    // Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)
    FoursquareType string `json:"foursquare_type,omitempty"`
    // Optional. Google Places identifier of the venue
    GooglePlaceID string `json:"google_place_id,omitempty"`
    // Optional. Google Places type of the venue. (See supported types.)
    GooglePlaceType string `json:"google_place_type,omitempty"`
}

func (*InputMediaVenue) MarshalJSON

func (v *InputMediaVenue) MarshalJSON() ([]byte, error)

MarshalJSON encodes InputMediaVenue with the discriminator field "type" forced to "venue". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InputMediaVideo

Represents a video to be sent.

type InputMediaVideo struct {
    // Type of the result, must be video
    Type InputMediaType `json:"type"`
    // File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »
    Media string `json:"media"`
    // Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
    Thumbnail string `json:"thumbnail,omitempty"`
    // Optional. Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »
    Cover string `json:"cover,omitempty"`
    // Optional. Start timestamp for the video in the message
    StartTimestamp *int64 `json:"start_timestamp,omitempty"`
    // Optional. Caption of the video to be sent, 0-1024 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Optional. Mode for parsing entities in the video caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Optional. Pass True, if the caption must be shown above the message media
    ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
    // Optional. Video width
    Width *int64 `json:"width,omitempty"`
    // Optional. Video height
    Height *int64 `json:"height,omitempty"`
    // Optional. Video duration in seconds
    Duration *int64 `json:"duration,omitempty"`
    // Optional. Pass True if the uploaded video is suitable for streaming
    SupportsStreaming *bool `json:"supports_streaming,omitempty"`
    // Optional. Pass True if the video needs to be covered with a spoiler animation
    HasSpoiler *bool `json:"has_spoiler,omitempty"`
}

func (*InputMediaVideo) MarshalJSON

func (v *InputMediaVideo) MarshalJSON() ([]byte, error)

MarshalJSON encodes InputMediaVideo with the discriminator field "type" forced to "video". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InputMessageContent

InputMessageContent is a union type. The following concrete variants implement it:

  • InputTextMessageContent
  • InputLocationMessageContent
  • InputVenueMessageContent
  • InputContactMessageContent
  • InputInvoiceMessageContent

This object represents the content of a message to be sent as a result of an inline query. Telegram clients currently support the following 5 types:

type InputMessageContent interface {
    // contains filtered or unexported methods
}

type InputPaidMedia

InputPaidMedia is a union type. The following concrete variants implement it:

  • InputPaidMediaLivePhoto
  • InputPaidMediaPhoto
  • InputPaidMediaVideo

This object describes the paid media to be sent. Currently, it can be one of

type InputPaidMedia interface {
    // contains filtered or unexported methods
}

type InputPaidMediaLivePhoto

The paid media to send is a live photo.

type InputPaidMediaLivePhoto struct {
    // Type of the media, must be live_photo
    Type InputPaidMediaType `json:"type"`
    // Video of the live photo to send. Pass a file_id to send a file that exists on the Telegram servers (recommended) or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files ». Sending live photos by a URL is currently unsupported.
    Media string `json:"media"`
    // The static photo to send. Pass a file_id to send a file that exists on the Telegram servers (recommended) or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files ». Sending live photos by a URL is currently unsupported.
    Photo string `json:"photo"`
}

func (*InputPaidMediaLivePhoto) MarshalJSON

func (v *InputPaidMediaLivePhoto) MarshalJSON() ([]byte, error)

MarshalJSON encodes InputPaidMediaLivePhoto with the discriminator field "type" forced to "live_photo". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InputPaidMediaPhoto

The paid media to send is a photo.

type InputPaidMediaPhoto struct {
    // Type of the media, must be photo
    Type InputPaidMediaType `json:"type"`
    // File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »
    Media string `json:"media"`
}

func (*InputPaidMediaPhoto) MarshalJSON

func (v *InputPaidMediaPhoto) MarshalJSON() ([]byte, error)

MarshalJSON encodes InputPaidMediaPhoto with the discriminator field "type" forced to "photo". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InputPaidMediaType

type InputPaidMediaType string


const (
    InputPaidMediaTypeLivePhoto InputPaidMediaType = "live_photo"
    InputPaidMediaTypePhoto     InputPaidMediaType = "photo"
    InputPaidMediaTypeVideo     InputPaidMediaType = "video"
)

type InputPaidMediaVideo

The paid media to send is a video.

type InputPaidMediaVideo struct {
    // Type of the media, must be video
    Type InputPaidMediaType `json:"type"`
    // File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »
    Media string `json:"media"`
    // Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
    Thumbnail string `json:"thumbnail,omitempty"`
    // Optional. Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »
    Cover string `json:"cover,omitempty"`
    // Optional. Start timestamp for the video in the message
    StartTimestamp *int64 `json:"start_timestamp,omitempty"`
    // Optional. Video width
    Width *int64 `json:"width,omitempty"`
    // Optional. Video height
    Height *int64 `json:"height,omitempty"`
    // Optional. Video duration in seconds
    Duration *int64 `json:"duration,omitempty"`
    // Optional. Pass True if the uploaded video is suitable for streaming
    SupportsStreaming *bool `json:"supports_streaming,omitempty"`
}

func (*InputPaidMediaVideo) MarshalJSON

func (v *InputPaidMediaVideo) MarshalJSON() ([]byte, error)

MarshalJSON encodes InputPaidMediaVideo with the discriminator field "type" forced to "video". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InputPollMedia

InputPollMedia is a union type. The following concrete variants implement it:

  • InputMediaAnimation
  • InputMediaAudio
  • InputMediaDocument
  • InputMediaLivePhoto
  • InputMediaLocation
  • InputMediaPhoto
  • InputMediaVenue
  • InputMediaVideo

This object represents the content of a poll description or a quiz explanation to be sent. It should be one of

type InputPollMedia interface {
    // contains filtered or unexported methods
}

type InputPollMediaType

type InputPollMediaType string


const (
    InputPollMediaTypeAnimation InputPollMediaType = "animation"
    InputPollMediaTypeAudio     InputPollMediaType = "audio"
    InputPollMediaTypeDocument  InputPollMediaType = "document"
    InputPollMediaTypeLivePhoto InputPollMediaType = "live_photo"
    InputPollMediaTypeLocation  InputPollMediaType = "location"
    InputPollMediaTypePhoto     InputPollMediaType = "photo"
    InputPollMediaTypeVenue     InputPollMediaType = "venue"
    InputPollMediaTypeVideo     InputPollMediaType = "video"
)

type InputPollOption

This object contains information about one answer option in a poll to be sent.

type InputPollOption struct {
    // Option text, 1-100 characters
    Text string `json:"text"`
    // Optional. Mode for parsing entities in the text. See formatting options for more details. Currently, only custom emoji entities are allowed.
    TextParseMode ParseMode `json:"text_parse_mode,omitempty"`
    // Optional. A JSON-serialized list of special entities that appear in the poll option text. It can be specified instead of text_parse_mode.
    TextEntities []MessageEntity `json:"text_entities,omitempty"`
    // Optional. Media added to the poll option
    Media InputPollOptionMedia `json:"media,omitempty"`
}

type InputPollOptionMedia

InputPollOptionMedia is a union type. The following concrete variants implement it:

  • InputMediaAnimation
  • InputMediaLivePhoto
  • InputMediaLocation
  • InputMediaPhoto
  • InputMediaSticker
  • InputMediaVenue
  • InputMediaVideo

This object represents the content of a poll option to be sent. It should be one of

type InputPollOptionMedia interface {
    // contains filtered or unexported methods
}

type InputPollOptionMediaType

type InputPollOptionMediaType string


const (
    InputPollOptionMediaTypeAnimation InputPollOptionMediaType = "animation"
    InputPollOptionMediaTypeLivePhoto InputPollOptionMediaType = "live_photo"
    InputPollOptionMediaTypeLocation  InputPollOptionMediaType = "location"
    InputPollOptionMediaTypePhoto     InputPollOptionMediaType = "photo"
    InputPollOptionMediaTypeSticker   InputPollOptionMediaType = "sticker"
    InputPollOptionMediaTypeVenue     InputPollOptionMediaType = "venue"
    InputPollOptionMediaTypeVideo     InputPollOptionMediaType = "video"
)

type InputProfilePhoto

InputProfilePhoto is a union type. The following concrete variants implement it:

  • InputProfilePhotoStatic
  • InputProfilePhotoAnimated

This object describes a profile photo to set. Currently, it can be one of

type InputProfilePhoto interface {
    // contains filtered or unexported methods
}

type InputProfilePhotoAnimated

An animated profile photo in the MPEG4 format.

type InputProfilePhotoAnimated struct {
    // Type of the profile photo, must be animated
    Type InputProfilePhotoType `json:"type"`
    // The animated profile photo. Profile photos can't be reused and can only be uploaded as a new file, so you can pass “attach://<file_attach_name>” if the photo was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
    Animation string `json:"animation"`
    // Optional. Timestamp in seconds of the frame that will be used as the static profile photo. Defaults to 0.0.
    MainFrameTimestamp *float64 `json:"main_frame_timestamp,omitempty"`
}

func (*InputProfilePhotoAnimated) MarshalJSON

func (v *InputProfilePhotoAnimated) MarshalJSON() ([]byte, error)

MarshalJSON encodes InputProfilePhotoAnimated with the discriminator field "type" forced to "animated". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InputProfilePhotoStatic

A static profile photo in the .JPG format.

type InputProfilePhotoStatic struct {
    // Type of the profile photo, must be static
    Type InputProfilePhotoType `json:"type"`
    // The static profile photo. Profile photos can't be reused and can only be uploaded as a new file, so you can pass “attach://<file_attach_name>” if the photo was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
    Photo string `json:"photo"`
}

func (*InputProfilePhotoStatic) MarshalJSON

func (v *InputProfilePhotoStatic) MarshalJSON() ([]byte, error)

MarshalJSON encodes InputProfilePhotoStatic with the discriminator field "type" forced to "static". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InputProfilePhotoType

type InputProfilePhotoType string


const (
    InputProfilePhotoTypeStatic   InputProfilePhotoType = "static"
    InputProfilePhotoTypeAnimated InputProfilePhotoType = "animated"
)

type InputSticker

This object describes a sticker to be added to a sticker set.

type InputSticker struct {
    // The added sticker. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new file using multipart/form-data under <file_attach_name> name. Animated and video stickers can't be uploaded via HTTP URL. More information on Sending Files »
    Sticker string `json:"sticker"`
    // Format of the added sticker, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, “video” for a .WEBM video
    Format InputStickerFormat `json:"format"`
    // List of 1-20 emoji associated with the sticker
    EmojiList []string `json:"emoji_list"`
    // Optional. Position where the mask should be placed on faces. For “mask” stickers only.
    MaskPosition *MaskPosition `json:"mask_position,omitempty"`
    // Optional. List of 0-20 search keywords for the sticker with total length of up to 64 characters. For “regular” and “custom_emoji” stickers only.
    Keywords []string `json:"keywords,omitempty"`
}

type InputStickerFormat

type InputStickerFormat string


const (
    InputStickerFormatStatic   InputStickerFormat = "static"
    InputStickerFormatAnimated InputStickerFormat = "animated"
    InputStickerFormatVideo    InputStickerFormat = "video"
)

type InputStoryContent

InputStoryContent is a union type. The following concrete variants implement it:

  • InputStoryContentPhoto
  • InputStoryContentVideo

This object describes the content of a story to post. Currently, it can be one of

type InputStoryContent interface {
    // contains filtered or unexported methods
}

type InputStoryContentPhoto

Describes a photo to post as a story.

type InputStoryContentPhoto struct {
    // Type of the content, must be photo
    Type InputStoryContentType `json:"type"`
    // The photo to post as a story. The photo must be of the size 1080x1920 and must not exceed 10 MB. The photo can't be reused and can only be uploaded as a new file, so you can pass “attach://<file_attach_name>” if the photo was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
    Photo string `json:"photo"`
}

func (*InputStoryContentPhoto) MarshalJSON

func (v *InputStoryContentPhoto) MarshalJSON() ([]byte, error)

MarshalJSON encodes InputStoryContentPhoto with the discriminator field "type" forced to "photo". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InputStoryContentType

type InputStoryContentType string


const (
    InputStoryContentTypePhoto InputStoryContentType = "photo"
    InputStoryContentTypeVideo InputStoryContentType = "video"
)

type InputStoryContentVideo

Describes a video to post as a story.

type InputStoryContentVideo struct {
    // Type of the content, must be video
    Type InputStoryContentType `json:"type"`
    // The video to post as a story. The video must be of the size 720x1280, streamable, encoded with H.265 codec, with key frames added each second in the MPEG4 format, and must not exceed 30 MB. The video can't be reused and can only be uploaded as a new file, so you can pass “attach://<file_attach_name>” if the video was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
    Video string `json:"video"`
    // Optional. Precise duration of the video in seconds; 0-60
    Duration *float64 `json:"duration,omitempty"`
    // Optional. Timestamp in seconds of the frame that will be used as the static cover for the story. Defaults to 0.0.
    CoverFrameTimestamp *float64 `json:"cover_frame_timestamp,omitempty"`
    // Optional. Pass True if the video has no sound
    IsAnimation *bool `json:"is_animation,omitempty"`
}

func (*InputStoryContentVideo) MarshalJSON

func (v *InputStoryContentVideo) MarshalJSON() ([]byte, error)

MarshalJSON encodes InputStoryContentVideo with the discriminator field "type" forced to "video". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type InputTextMessageContent

Represents the content of a text message to be sent as the result of an inline query.

type InputTextMessageContent struct {
    // Text of the message to be sent, 1-4096 characters
    MessageText string `json:"message_text"`
    // Optional. Mode for parsing entities in the message text. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // Optional. List of special entities that appear in message text, which can be specified instead of parse_mode
    Entities []MessageEntity `json:"entities,omitempty"`
    // Optional. Link preview generation options for the message
    LinkPreviewOptions *LinkPreviewOptions `json:"link_preview_options,omitempty"`
}

type InputVenueMessageContent

Represents the content of a venue message to be sent as the result of an inline query.

type InputVenueMessageContent struct {
    // Latitude of the venue in degrees
    Latitude float64 `json:"latitude"`
    // Longitude of the venue in degrees
    Longitude float64 `json:"longitude"`
    // Name of the venue
    Title string `json:"title"`
    // Address of the venue
    Address string `json:"address"`
    // Optional. Foursquare identifier of the venue, if known
    FoursquareID string `json:"foursquare_id,omitempty"`
    // Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)
    FoursquareType string `json:"foursquare_type,omitempty"`
    // Optional. Google Places identifier of the venue
    GooglePlaceID string `json:"google_place_id,omitempty"`
    // Optional. Google Places type of the venue. (See supported types.)
    GooglePlaceType string `json:"google_place_type,omitempty"`
}

type Invoice

This object contains basic information about an invoice.

type Invoice struct {
    // Product name
    Title string `json:"title"`
    // Product description
    Description string `json:"description"`
    // Unique bot deep-linking parameter that can be used to generate this invoice
    StartParameter string `json:"start_parameter"`
    // Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars
    Currency string `json:"currency"`
    // Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
    TotalAmount int64 `json:"total_amount"`
}

type KeyboardButton

This object represents one button of the reply keyboard. At most one of the fields other than text, icon_custom_emoji_id, and style must be used to specify the type of the button. For simple text buttons, String can be used instead of this object to specify the button text.

type KeyboardButton struct {
    // Text of the button. If none of the fields other than text, icon_custom_emoji_id, and style are used, it will be sent as a message when the button is pressed.
    Text string `json:"text"`
    // Optional. Unique identifier of the custom emoji shown before the text of the button. Can only be used by bots that purchased additional usernames on Fragment or in the messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription.
    IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
    // Optional. Style of the button. Must be one of “danger” (red), “success” (green) or “primary” (blue). If omitted, then an app-specific style is used.
    Style KeyboardButtonStyle `json:"style,omitempty"`
    // Optional. If specified, pressing the button will open a list of suitable users. Identifiers of selected users will be sent to the bot in a “users_shared” service message. Available in private chats only.
    RequestUsers *KeyboardButtonRequestUsers `json:"request_users,omitempty"`
    // Optional. If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a “chat_shared” service message. Available in private chats only.
    RequestChat *KeyboardButtonRequestChat `json:"request_chat,omitempty"`
    // Optional. If specified, pressing the button will ask the user to create and share a bot that will be managed by the current bot. Available for bots that enabled management of other bots in the @BotFather Mini App. Available in private chats only.
    RequestManagedBot *KeyboardButtonRequestManagedBot `json:"request_managed_bot,omitempty"`
    // Optional. If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only.
    RequestContact *bool `json:"request_contact,omitempty"`
    // Optional. If True, the user's current location will be sent when the button is pressed. Available in private chats only.
    RequestLocation *bool `json:"request_location,omitempty"`
    // Optional. If specified, the user will be asked to create a poll and send it to the bot when the button is pressed. Available in private chats only.
    RequestPoll *KeyboardButtonPollType `json:"request_poll,omitempty"`
    // Optional. If specified, the described Web App will be launched when the button is pressed. The Web App will be able to send a “web_app_data” service message. Available in private chats only.
    WebApp *WebAppInfo `json:"web_app,omitempty"`
}

type KeyboardButtonPollType

This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.

type KeyboardButtonPollType struct {
    // Optional. If quiz is passed, the user will be allowed to create only polls in the quiz mode. If regular is passed, only regular polls will be allowed. Otherwise, the user will be allowed to create a poll of any type.
    Type string `json:"type,omitempty"`
}

type KeyboardButtonRequestChat

This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the chat if appropriate. More about requesting chats ».

type KeyboardButtonRequestChat struct {
    // Signed 32-bit identifier of the request, which will be received back in the ChatShared object. Must be unique within the message.
    RequestID int64 `json:"request_id"`
    // Pass True to request a channel chat, pass False to request a group or a supergroup chat
    ChatIsChannel bool `json:"chat_is_channel"`
    // Optional. Pass True to request a forum supergroup, pass False to request a non-forum chat. If not specified, no additional restrictions are applied.
    ChatIsForum *bool `json:"chat_is_forum,omitempty"`
    // Optional. Pass True to request a supergroup or a channel with a username, pass False to request a chat without a username. If not specified, no additional restrictions are applied.
    ChatHasUsername *bool `json:"chat_has_username,omitempty"`
    // Optional. Pass True to request a chat owned by the user. Otherwise, no additional restrictions are applied.
    ChatIsCreated *bool `json:"chat_is_created,omitempty"`
    // Optional. A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of bot_administrator_rights. If not specified, no additional restrictions are applied.
    UserAdministratorRights *ChatAdministratorRights `json:"user_administrator_rights,omitempty"`
    // Optional. A JSON-serialized object listing the required administrator rights of the bot in the chat. The rights must be a subset of user_administrator_rights. If not specified, no additional restrictions are applied.
    BotAdministratorRights *ChatAdministratorRights `json:"bot_administrator_rights,omitempty"`
    // Optional. Pass True to request a chat with the bot as a member. Otherwise, no additional restrictions are applied.
    BotIsMember *bool `json:"bot_is_member,omitempty"`
    // Optional. Pass True to request the chat's title
    RequestTitle *bool `json:"request_title,omitempty"`
    // Optional. Pass True to request the chat's username
    RequestUsername *bool `json:"request_username,omitempty"`
    // Optional. Pass True to request the chat's photo
    RequestPhoto *bool `json:"request_photo,omitempty"`
}

type KeyboardButtonRequestManagedBot

This object defines the parameters for the creation of a managed bot. Information about the created bot will be shared with the bot using the update managed_bot and a Message with the field managed_bot_created.

type KeyboardButtonRequestManagedBot struct {
    // Signed 32-bit identifier of the request. Must be unique within the message.
    RequestID int64 `json:"request_id"`
    // Optional. Suggested name for the bot
    SuggestedName string `json:"suggested_name,omitempty"`
    // Optional. Suggested username for the bot
    SuggestedUsername string `json:"suggested_username,omitempty"`
}

type KeyboardButtonRequestUsers

This object defines the criteria used to request suitable users. Information about the selected users will be shared with the bot when the corresponding button is pressed. More about requesting users »

type KeyboardButtonRequestUsers struct {
    // Signed 32-bit identifier of the request that will be received back in the UsersShared object. Must be unique within the message.
    RequestID int64 `json:"request_id"`
    // Optional. Pass True to request bots, pass False to request regular users. If not specified, no additional restrictions are applied.
    UserIsBot *bool `json:"user_is_bot,omitempty"`
    // Optional. Pass True to request premium users, pass False to request non-premium users. If not specified, no additional restrictions are applied.
    UserIsPremium *bool `json:"user_is_premium,omitempty"`
    // Optional. The maximum number of users to be selected; 1-10. Defaults to 1.
    MaxQuantity *int64 `json:"max_quantity,omitempty"`
    // Optional. Pass True to request the users' first and last names
    RequestName *bool `json:"request_name,omitempty"`
    // Optional. Pass True to request the users' usernames
    RequestUsername *bool `json:"request_username,omitempty"`
    // Optional. Pass True to request the users' photos
    RequestPhoto *bool `json:"request_photo,omitempty"`
}

type KeyboardButtonStyle

type KeyboardButtonStyle string


const (
    KeyboardButtonStyleDanger  KeyboardButtonStyle = "danger"
    KeyboardButtonStyleSuccess KeyboardButtonStyle = "success"
    KeyboardButtonStylePrimary KeyboardButtonStyle = "primary"
)

type LabeledPrice

This object represents a portion of the price for goods or services.

type LabeledPrice struct {
    // Portion label
    Label string `json:"label"`
    // Price of the product in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
    Amount int64 `json:"amount"`
}

type LeaveChatParams

LeaveChatParams is the parameter set for LeaveChat.

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

type LeaveChatParams struct {
    // Unique identifier for the target chat or username of the target supergroup or channel in the format @username. Channel direct messages chats aren't supported; leave the corresponding channel instead.
    ChatID ChatID `json:"chat_id"`
}

type LinkPreviewOptions

Describes the options used for link preview generation.

type LinkPreviewOptions struct {
    // Optional. True, if the link preview is disabled
    IsDisabled *bool `json:"is_disabled,omitempty"`
    // Optional. URL to use for the link preview. If empty, then the first URL found in the message text will be used.
    URL string `json:"url,omitempty"`
    // Optional. True, if the media in the link preview is supposed to be shrunk; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview
    PreferSmallMedia *bool `json:"prefer_small_media,omitempty"`
    // Optional. True, if the media in the link preview is supposed to be enlarged; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview
    PreferLargeMedia *bool `json:"prefer_large_media,omitempty"`
    // Optional. True, if the link preview must be shown above the message text; otherwise, the link preview will be shown below the message text
    ShowAboveText *bool `json:"show_above_text,omitempty"`
}

type LivePhoto

This object represents a live photo.

type LivePhoto struct {
    // Optional. Available sizes of the corresponding static photo
    Photo []PhotoSize `json:"photo,omitempty"`
    // Identifier for the video file which can be used to download or reuse the file
    FileID string `json:"file_id"`
    // Unique identifier for the video file which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
    FileUniqueID string `json:"file_unique_id"`
    // Video width as defined by the sender
    Width int64 `json:"width"`
    // Video height as defined by the sender
    Height int64 `json:"height"`
    // Duration of the video in seconds as defined by the sender
    Duration int64 `json:"duration"`
    // Optional. MIME type of the file as defined by the sender
    MimeType string `json:"mime_type,omitempty"`
    // Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
    FileSize *int64 `json:"file_size,omitempty"`
}

type Location

This object represents a point on the map.

type Location struct {
    // Latitude as defined by the sender
    Latitude float64 `json:"latitude"`
    // Longitude as defined by the sender
    Longitude float64 `json:"longitude"`
    // Optional. The radius of uncertainty for the location, measured in meters; 0-1500
    HorizontalAccuracy *float64 `json:"horizontal_accuracy,omitempty"`
    // Optional. Time relative to the message sending date, during which the location can be updated; in seconds. For active live locations only.
    LivePeriod *int64 `json:"live_period,omitempty"`
    // Optional. The direction in which user is moving, in degrees; 1-360. For active live locations only.
    Heading *int64 `json:"heading,omitempty"`
    // Optional. The maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only.
    ProximityAlertRadius *int64 `json:"proximity_alert_radius,omitempty"`
}

type LocationAddress

Describes the physical address of a location.

type LocationAddress struct {
    // The two-letter ISO 3166-1 alpha-2 country code of the country where the location is located
    CountryCode string `json:"country_code"`
    // Optional. State of the location
    State string `json:"state,omitempty"`
    // Optional. City of the location
    City string `json:"city,omitempty"`
    // Optional. Street address of the location
    Street string `json:"street,omitempty"`
}

type LogOutParams

LogOutParams is the parameter set for 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.

type LogOutParams struct {
}

type LoginUrl

This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a great replacement for the Telegram Login Widget when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in: Telegram apps support these buttons as of version 5.7. Sample bot: @discussbot

type LoginUrl struct {
    // An HTTPS URL to be opened with user authorization data added to the query string when the button is pressed. If the user refuses to provide authorization data, the original URL without information about the user will be opened. The data added is the same as described in Receiving authorization data.NOTE: You must always check the hash of the received data to verify the authentication and the integrity of the data as described in Checking authorization.
    URL string `json:"url"`
    // Optional. New text of the button in forwarded messages
    ForwardText string `json:"forward_text,omitempty"`
    // Optional. Username of a bot, which will be used for user authorization. See Setting up a bot for more details. If not specified, the current bot's username will be assumed. The url's domain must be the same as the domain linked with the bot. See Linking your domain to the bot for more details.
    BotUsername string `json:"bot_username,omitempty"`
    // Optional. Pass True to request the permission for your bot to send messages to the user
    RequestWriteAccess *bool `json:"request_write_access,omitempty"`
}

type ManagedBotCreated

This object contains information about the bot that was created to be managed by the current bot.

type ManagedBotCreated struct {
    // Information about the bot. The bot's token can be fetched using the method getManagedBotToken.
    Bot User `json:"bot"`
}

type ManagedBotUpdated

This object contains information about the creation, token update, or owner update of a bot that is managed by the current bot.

type ManagedBotUpdated struct {
    // User that created the bot
    User User `json:"user"`
    // Information about the bot. Token of the bot can be fetched using the method getManagedBotToken.
    Bot User `json:"bot"`
}

type MaskPosition

This object describes the position on faces where a mask should be placed by default.

type MaskPosition struct {
    // The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”.
    Point MaskPositionPoint `json:"point"`
    // Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. For example, choosing -1.0 will place mask just to the left of the default mask position.
    XShift float64 `json:"x_shift"`
    // Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. For example, 1.0 will place the mask just below the default mask position.
    YShift float64 `json:"y_shift"`
    // Mask scaling coefficient. For example, 2.0 means double size.
    Scale float64 `json:"scale"`
}

type MaskPositionPoint

type MaskPositionPoint string


const (
    MaskPositionPointForehead MaskPositionPoint = "forehead"
    MaskPositionPointEyes     MaskPositionPoint = "eyes"
    MaskPositionPointMouth    MaskPositionPoint = "mouth"
    MaskPositionPointChin     MaskPositionPoint = "chin"
)

type MaybeInaccessibleMessage

MaybeInaccessibleMessage is a union type. The following concrete variants implement it:

  • Message
  • InaccessibleMessage

This object describes a message that can be inaccessible to the bot. It can be one of

type MaybeInaccessibleMessage interface {
    // contains filtered or unexported methods
}

func UnmarshalMaybeInaccessibleMessage

func UnmarshalMaybeInaccessibleMessage(data []byte) (MaybeInaccessibleMessage, error)

UnmarshalMaybeInaccessibleMessage decodes a JSON object into the correct MaybeInaccessibleMessage variant. Telegram uses the date field as a discriminator: date == 0 indicates InaccessibleMessage; any other value indicates a real Message.

type MeCache

MeCache caches the result of GetMe across calls. Construct one per Bot and call Get to retrieve the cached User on subsequent invocations.

var meCache api.MeCache
me, err := meCache.Get(ctx, bot)

MeCache is safe for concurrent use.

type MeCache struct {
    // contains filtered or unexported fields
}

func (*MeCache) Get

func (c *MeCache) Get(ctx context.Context, b *client.Bot) (*User, error)

Get returns the User from a cached GetMe call. If the cache is empty, it calls GetMe and populates the cache on success.

func (*MeCache) Reset

func (c *MeCache) Reset()

Reset clears the cache. Useful in tests or after the bot's identity is known to have changed (very rare).

type MenuButton

MenuButton is a union type. The following concrete variants implement it:

  • MenuButtonCommands
  • MenuButtonWebApp
  • MenuButtonDefault

This object describes the bot's menu button in a private chat. It should be one of If a menu button other than MenuButtonDefault is set for a private chat, then it is applied in the chat. Otherwise the default menu button is applied. By default, the menu button opens the list of bot commands.

type MenuButton interface {
    // contains filtered or unexported methods
}

func GetChatMenuButton

func GetChatMenuButton(ctx context.Context, b *client.Bot, p *GetChatMenuButtonParams) (MenuButton, error)

GetChatMenuButton calls the getChatMenuButton Telegram Bot API method.

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.

func UnmarshalMenuButton

func UnmarshalMenuButton(data []byte) (MenuButton, error)

UnmarshalMenuButton decodes a MenuButton from JSON by inspecting the "type" field and dispatching to the correct concrete type.

type MenuButtonCommands

Represents a menu button, which opens the bot's list of commands.

type MenuButtonCommands struct {
    // Type of the button, must be commands
    Type MenuButtonType `json:"type"`
}

func (*MenuButtonCommands) MarshalJSON

func (v *MenuButtonCommands) MarshalJSON() ([]byte, error)

MarshalJSON encodes MenuButtonCommands with the discriminator field "type" forced to "commands". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type MenuButtonDefault

Describes that no specific value for the menu button was set.

type MenuButtonDefault struct {
    // Type of the button, must be default
    Type MenuButtonType `json:"type"`
}

func (*MenuButtonDefault) MarshalJSON

func (v *MenuButtonDefault) MarshalJSON() ([]byte, error)

MarshalJSON encodes MenuButtonDefault with the discriminator field "type" forced to "default". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type MenuButtonType

type MenuButtonType string


const (
    MenuButtonTypeCommands MenuButtonType = "commands"
    MenuButtonTypeWebApp   MenuButtonType = "web_app"
    MenuButtonTypeDefault  MenuButtonType = "default"
)

type MenuButtonWebApp

Represents a menu button, which launches a Web App.

type MenuButtonWebApp struct {
    // Type of the button, must be web_app
    Type MenuButtonType `json:"type"`
    // Text on the button
    Text string `json:"text"`
    // Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. Alternatively, a t.me link to a Web App of the bot can be specified in the object instead of the Web App's URL, in which case the Web App will be opened as if the user pressed the link.
    WebApp WebAppInfo `json:"web_app"`
}

func (*MenuButtonWebApp) MarshalJSON

func (v *MenuButtonWebApp) MarshalJSON() ([]byte, error)

MarshalJSON encodes MenuButtonWebApp with the discriminator field "type" forced to "web_app". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type Message

This object represents a message.

type Message struct {
    // Unique message identifier inside this chat. In specific instances (e.g., message containing a video sent to a big chat), the server might automatically schedule a message instead of sending it immediately. In such cases, this field will be 0 and the relevant message will be unusable until it is actually sent.
    MessageID int64 `json:"message_id"`
    // Optional. Unique identifier of a message thread or forum topic to which the message belongs; for supergroups and private chats only
    MessageThreadID *int64 `json:"message_thread_id,omitempty"`
    // Optional. Information about the direct messages chat topic that contains the message
    DirectMessagesTopic *DirectMessagesTopic `json:"direct_messages_topic,omitempty"`
    // Optional. Sender of the message; may be empty for messages sent to channels. For backward compatibility, if the message was sent on behalf of a chat, the field contains a fake sender user in non-channel chats.
    From *User `json:"from,omitempty"`
    // Optional. Sender of the message when sent on behalf of a chat. For example, the supergroup itself for messages sent by its anonymous administrators or a linked channel for messages automatically forwarded to the channel's discussion group. For backward compatibility, if the message was sent on behalf of a chat, the field from contains a fake sender user in non-channel chats.
    SenderChat *Chat `json:"sender_chat,omitempty"`
    // Optional. If the sender of the message boosted the chat, the number of boosts added by the user
    SenderBoostCount *int64 `json:"sender_boost_count,omitempty"`
    // Optional. The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.
    SenderBusinessBot *User `json:"sender_business_bot,omitempty"`
    // Optional. Tag or custom title of the sender of the message; for supergroups only
    SenderTag string `json:"sender_tag,omitempty"`
    // Date the message was sent in Unix time. It is always a positive number, representing a valid date.
    Date int64 `json:"date"`
    // Optional. The unique identifier for the guest query. Use this identifier with the method answerGuestQuery to send a response message. If non-empty, the message belongs to the chat where the guest bot was summoned, which may not coincide with other existing bot chats sharing the same identifier.
    GuestQueryID string `json:"guest_query_id,omitempty"`
    // Optional. Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Chat the message belongs to
    Chat Chat `json:"chat"`
    // Optional. Information about the original message for forwarded messages
    ForwardOrigin MessageOrigin `json:"forward_origin,omitempty"`
    // Optional. True, if the message is sent to a topic in a forum supergroup or a private chat with the bot
    IsTopicMessage *bool `json:"is_topic_message,omitempty"`
    // Optional. True, if the message is a channel post that was automatically forwarded to the connected discussion group
    IsAutomaticForward *bool `json:"is_automatic_forward,omitempty"`
    // Optional. For replies in the same chat and message thread, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.
    ReplyToMessage *Message `json:"reply_to_message,omitempty"`
    // Optional. Information about the message that is being replied to, which may come from another chat or forum topic
    ExternalReply *ExternalReplyInfo `json:"external_reply,omitempty"`
    // Optional. For replies that quote part of the original message, the quoted part of the message
    Quote *TextQuote `json:"quote,omitempty"`
    // Optional. For replies to a story, the original story
    ReplyToStory *Story `json:"reply_to_story,omitempty"`
    // Optional. Identifier of the specific checklist task that is being replied to
    ReplyToChecklistTaskID *int64 `json:"reply_to_checklist_task_id,omitempty"`
    // Optional. Persistent identifier of the specific poll option that is being replied to
    ReplyToPollOptionID string `json:"reply_to_poll_option_id,omitempty"`
    // Optional. Bot through which the message was sent
    ViaBot *User `json:"via_bot,omitempty"`
    // Optional. For a message sent by a guest bot, this is the user whose original message triggered the bot's response
    GuestBotCallerUser *User `json:"guest_bot_caller_user,omitempty"`
    // Optional. For a message sent by a guest bot, this is the chat whose original message triggered the bot's response
    GuestBotCallerChat *Chat `json:"guest_bot_caller_chat,omitempty"`
    // Optional. Date the message was last edited in Unix time
    EditDate *int64 `json:"edit_date,omitempty"`
    // Optional. True, if the message can't be forwarded
    HasProtectedContent *bool `json:"has_protected_content,omitempty"`
    // Optional. True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message
    IsFromOffline *bool `json:"is_from_offline,omitempty"`
    // Optional. True, if the message is a paid post. Note that such posts must not be deleted for 24 hours to receive the payment and can't be edited.
    IsPaidPost *bool `json:"is_paid_post,omitempty"`
    // Optional. The unique identifier inside this chat of a media message group this message belongs to
    MediaGroupID string `json:"media_group_id,omitempty"`
    // Optional. Signature of the post author for messages in channels, or the custom title of an anonymous group administrator
    AuthorSignature string `json:"author_signature,omitempty"`
    // Optional. The number of Telegram Stars that were paid by the sender of the message to send it
    PaidStarCount *int64 `json:"paid_star_count,omitempty"`
    // Optional. For text messages, the actual UTF-8 text of the message
    Text string `json:"text,omitempty"`
    // Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text
    Entities []MessageEntity `json:"entities,omitempty"`
    // Optional. Options used for link preview generation for the message, if it is a text message and link preview options were changed
    LinkPreviewOptions *LinkPreviewOptions `json:"link_preview_options,omitempty"`
    // Optional. Information about suggested post parameters if the message is a suggested post in a channel direct messages chat. If the message is an approved or declined suggested post, then it can't be edited.
    SuggestedPostInfo *SuggestedPostInfo `json:"suggested_post_info,omitempty"`
    // Optional. Unique identifier of the message effect added to the message
    EffectID string `json:"effect_id,omitempty"`
    // Optional. Message is an animation, information about the animation. For backward compatibility, when this field is set, the document field will also be set.
    Animation *Animation `json:"animation,omitempty"`
    // Optional. Message is an audio file, information about the file
    Audio *Audio `json:"audio,omitempty"`
    // Optional. Message is a general file, information about the file
    Document *Document `json:"document,omitempty"`
    // Optional. Message is a live photo, information about the live photo. For backward compatibility, when this field is set, the photo field will also be set.
    LivePhoto *LivePhoto `json:"live_photo,omitempty"`
    // Optional. Message contains paid media; information about the paid media
    PaidMedia *PaidMediaInfo `json:"paid_media,omitempty"`
    // Optional. Message is a photo, available sizes of the photo
    Photo []PhotoSize `json:"photo,omitempty"`
    // Optional. Message is a sticker, information about the sticker
    Sticker *Sticker `json:"sticker,omitempty"`
    // Optional. Message is a forwarded story
    Story *Story `json:"story,omitempty"`
    // Optional. Message is a video, information about the video
    Video *Video `json:"video,omitempty"`
    // Optional. Message is a video note, information about the video message
    VideoNote *VideoNote `json:"video_note,omitempty"`
    // Optional. Message is a voice message, information about the file
    Voice *Voice `json:"voice,omitempty"`
    // Optional. Caption for the animation, audio, document, paid media, photo, video or voice
    Caption string `json:"caption,omitempty"`
    // Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Optional. True, if the caption must be shown above the message media
    ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
    // Optional. True, if the message media is covered by a spoiler animation
    HasMediaSpoiler *bool `json:"has_media_spoiler,omitempty"`
    // Optional. Message is a checklist
    Checklist *Checklist `json:"checklist,omitempty"`
    // Optional. Message is a shared contact, information about the contact
    Contact *Contact `json:"contact,omitempty"`
    // Optional. Message is a dice with random value
    Dice *Dice `json:"dice,omitempty"`
    // Optional. Message is a game, information about the game. More about games »
    Game *Game `json:"game,omitempty"`
    // Optional. Message is a native poll, information about the poll
    Poll *Poll `json:"poll,omitempty"`
    // Optional. Message is a venue, information about the venue. For backward compatibility, when this field is set, the location field will also be set.
    Venue *Venue `json:"venue,omitempty"`
    // Optional. Message is a shared location, information about the location
    Location *Location `json:"location,omitempty"`
    // Optional. New members that were added to the group or supergroup and information about them (the bot itself may be one of these members)
    NewChatMembers []User `json:"new_chat_members,omitempty"`
    // Optional. A member was removed from the group, information about them (this member may be the bot itself)
    LeftChatMember *User `json:"left_chat_member,omitempty"`
    // Optional. Service message: chat owner has left
    ChatOwnerLeft *ChatOwnerLeft `json:"chat_owner_left,omitempty"`
    // Optional. Service message: chat owner has changed
    ChatOwnerChanged *ChatOwnerChanged `json:"chat_owner_changed,omitempty"`
    // Optional. A chat title was changed to this value
    NewChatTitle string `json:"new_chat_title,omitempty"`
    // Optional. A chat photo was change to this value
    NewChatPhoto []PhotoSize `json:"new_chat_photo,omitempty"`
    // Optional. Service message: the chat photo was deleted
    DeleteChatPhoto *bool `json:"delete_chat_photo,omitempty"`
    // Optional. Service message: the group has been created
    GroupChatCreated *bool `json:"group_chat_created,omitempty"`
    // Optional. Service message: the supergroup has been created. This field can't be received in a message coming through updates, because bot can't be a member of a supergroup when it is created. It can only be found in reply_to_message if someone replies to a very first message in a directly created supergroup.
    SupergroupChatCreated *bool `json:"supergroup_chat_created,omitempty"`
    // Optional. Service message: the channel has been created. This field can't be received in a message coming through updates, because bot can't be a member of a channel when it is created. It can only be found in reply_to_message if someone replies to a very first message in a channel.
    ChannelChatCreated *bool `json:"channel_chat_created,omitempty"`
    // Optional. Service message: auto-delete timer settings changed in the chat
    MessageAutoDeleteTimerChanged *MessageAutoDeleteTimerChanged `json:"message_auto_delete_timer_changed,omitempty"`
    // Optional. The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.
    MigrateToChatID *int64 `json:"migrate_to_chat_id,omitempty"`
    // Optional. The supergroup has been migrated from a group with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.
    MigrateFromChatID *int64 `json:"migrate_from_chat_id,omitempty"`
    // Optional. Specified message was pinned. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.
    PinnedMessage MaybeInaccessibleMessage `json:"pinned_message,omitempty"`
    // Optional. Message is an invoice for a payment, information about the invoice. More about payments »
    Invoice *Invoice `json:"invoice,omitempty"`
    // Optional. Message is a service message about a successful payment, information about the payment. More about payments »
    SuccessfulPayment *SuccessfulPayment `json:"successful_payment,omitempty"`
    // Optional. Message is a service message about a refunded payment, information about the payment. More about payments »
    RefundedPayment *RefundedPayment `json:"refunded_payment,omitempty"`
    // Optional. Service message: users were shared with the bot
    UsersShared *UsersShared `json:"users_shared,omitempty"`
    // Optional. Service message: a chat was shared with the bot
    ChatShared *ChatShared `json:"chat_shared,omitempty"`
    // Optional. Service message: a regular gift was sent or received
    Gift *GiftInfo `json:"gift,omitempty"`
    // Optional. Service message: a unique gift was sent or received
    UniqueGift *UniqueGiftInfo `json:"unique_gift,omitempty"`
    // Optional. Service message: upgrade of a gift was purchased after the gift was sent
    GiftUpgradeSent *GiftInfo `json:"gift_upgrade_sent,omitempty"`
    // Optional. The domain name of the website on which the user has logged in. More about Telegram Login »
    ConnectedWebsite string `json:"connected_website,omitempty"`
    // Optional. Service message: the user allowed the bot to write messages after adding it to the attachment or side menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method requestWriteAccess
    WriteAccessAllowed *WriteAccessAllowed `json:"write_access_allowed,omitempty"`
    // Optional. Telegram Passport data
    PassportData *PassportData `json:"passport_data,omitempty"`
    // Optional. Service message. A user in the chat triggered another user's proximity alert while sharing Live Location.
    ProximityAlertTriggered *ProximityAlertTriggered `json:"proximity_alert_triggered,omitempty"`
    // Optional. Service message: user boosted the chat
    BoostAdded *ChatBoostAdded `json:"boost_added,omitempty"`
    // Optional. Service message: chat background set
    ChatBackgroundSet *ChatBackground `json:"chat_background_set,omitempty"`
    // Optional. Service message: some tasks in a checklist were marked as done or not done
    ChecklistTasksDone *ChecklistTasksDone `json:"checklist_tasks_done,omitempty"`
    // Optional. Service message: tasks were added to a checklist
    ChecklistTasksAdded *ChecklistTasksAdded `json:"checklist_tasks_added,omitempty"`
    // Optional. Service message: the price for paid messages in the corresponding direct messages chat of a channel has changed
    DirectMessagePriceChanged *DirectMessagePriceChanged `json:"direct_message_price_changed,omitempty"`
    // Optional. Service message: forum topic created
    ForumTopicCreated *ForumTopicCreated `json:"forum_topic_created,omitempty"`
    // Optional. Service message: forum topic edited
    ForumTopicEdited *ForumTopicEdited `json:"forum_topic_edited,omitempty"`
    // Optional. Service message: forum topic closed
    ForumTopicClosed *ForumTopicClosed `json:"forum_topic_closed,omitempty"`
    // Optional. Service message: forum topic reopened
    ForumTopicReopened *ForumTopicReopened `json:"forum_topic_reopened,omitempty"`
    // Optional. Service message: the 'General' forum topic hidden
    GeneralForumTopicHidden *GeneralForumTopicHidden `json:"general_forum_topic_hidden,omitempty"`
    // Optional. Service message: the 'General' forum topic unhidden
    GeneralForumTopicUnhidden *GeneralForumTopicUnhidden `json:"general_forum_topic_unhidden,omitempty"`
    // Optional. Service message: a scheduled giveaway was created
    GiveawayCreated *GiveawayCreated `json:"giveaway_created,omitempty"`
    // Optional. The message is a scheduled giveaway message
    Giveaway *Giveaway `json:"giveaway,omitempty"`
    // Optional. A giveaway with public winners was completed
    GiveawayWinners *GiveawayWinners `json:"giveaway_winners,omitempty"`
    // Optional. Service message: a giveaway without public winners was completed
    GiveawayCompleted *GiveawayCompleted `json:"giveaway_completed,omitempty"`
    // Optional. Service message: user created a bot that will be managed by the current bot
    ManagedBotCreated *ManagedBotCreated `json:"managed_bot_created,omitempty"`
    // Optional. Service message: the price for paid messages has changed in the chat
    PaidMessagePriceChanged *PaidMessagePriceChanged `json:"paid_message_price_changed,omitempty"`
    // Optional. Service message: answer option was added to a poll
    PollOptionAdded *PollOptionAdded `json:"poll_option_added,omitempty"`
    // Optional. Service message: answer option was deleted from a poll
    PollOptionDeleted *PollOptionDeleted `json:"poll_option_deleted,omitempty"`
    // Optional. Service message: a suggested post was approved
    SuggestedPostApproved *SuggestedPostApproved `json:"suggested_post_approved,omitempty"`
    // Optional. Service message: approval of a suggested post has failed
    SuggestedPostApprovalFailed *SuggestedPostApprovalFailed `json:"suggested_post_approval_failed,omitempty"`
    // Optional. Service message: a suggested post was declined
    SuggestedPostDeclined *SuggestedPostDeclined `json:"suggested_post_declined,omitempty"`
    // Optional. Service message: payment for a suggested post was received
    SuggestedPostPaid *SuggestedPostPaid `json:"suggested_post_paid,omitempty"`
    // Optional. Service message: payment for a suggested post was refunded
    SuggestedPostRefunded *SuggestedPostRefunded `json:"suggested_post_refunded,omitempty"`
    // Optional. Service message: video chat scheduled
    VideoChatScheduled *VideoChatScheduled `json:"video_chat_scheduled,omitempty"`
    // Optional. Service message: video chat started
    VideoChatStarted *VideoChatStarted `json:"video_chat_started,omitempty"`
    // Optional. Service message: video chat ended
    VideoChatEnded *VideoChatEnded `json:"video_chat_ended,omitempty"`
    // Optional. Service message: new participants invited to a video chat
    VideoChatParticipantsInvited *VideoChatParticipantsInvited `json:"video_chat_participants_invited,omitempty"`
    // Optional. Service message: data sent by a Web App
    WebAppData *WebAppData `json:"web_app_data,omitempty"`
    // Optional. Inline keyboard attached to the message. login_url buttons are represented as ordinary url buttons.
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

func EditMessageChecklist

func EditMessageChecklist(ctx context.Context, b *client.Bot, p *EditMessageChecklistParams) (*Message, error)

EditMessageChecklist calls the editMessageChecklist Telegram Bot API method.

Use this method to edit a checklist on behalf of a connected business account. On success, the edited Message is returned.

func ForwardMessage

func ForwardMessage(ctx context.Context, b *client.Bot, p *ForwardMessageParams) (*Message, error)

ForwardMessage calls the forwardMessage Telegram Bot API method.

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.

func GetUserPersonalChatMessages

func GetUserPersonalChatMessages(ctx context.Context, b *client.Bot, p *GetUserPersonalChatMessagesParams) ([]Message, error)

GetUserPersonalChatMessages calls the getUserPersonalChatMessages Telegram Bot API method.

Use this method to get the last messages from the personal chat (i.e., the chat currently added to their profile) of a given user. On success, an array of Message objects is returned.

func SendAnimation

func SendAnimation(ctx context.Context, b *client.Bot, p *SendAnimationParams) (*Message, error)

SendAnimation calls the sendAnimation Telegram Bot API method.

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.

func SendAudio

func SendAudio(ctx context.Context, b *client.Bot, p *SendAudioParams) (*Message, error)

SendAudio calls the sendAudio Telegram Bot API method.

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.

func SendChecklist

func SendChecklist(ctx context.Context, b *client.Bot, p *SendChecklistParams) (*Message, error)

SendChecklist calls the sendChecklist Telegram Bot API method.

Use this method to send a checklist on behalf of a connected business account. On success, the sent Message is returned.

func SendContact

func SendContact(ctx context.Context, b *client.Bot, p *SendContactParams) (*Message, error)

SendContact calls the sendContact Telegram Bot API method.

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

func SendDice

func SendDice(ctx context.Context, b *client.Bot, p *SendDiceParams) (*Message, error)

SendDice calls the sendDice Telegram Bot API method.

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

func SendDocument

func SendDocument(ctx context.Context, b *client.Bot, p *SendDocumentParams) (*Message, error)

SendDocument calls the sendDocument Telegram Bot API method.

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.

func SendGame

func SendGame(ctx context.Context, b *client.Bot, p *SendGameParams) (*Message, error)

SendGame calls the sendGame Telegram Bot API method.

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

func SendInvoice

func SendInvoice(ctx context.Context, b *client.Bot, p *SendInvoiceParams) (*Message, error)

SendInvoice calls the sendInvoice Telegram Bot API method.

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

func SendLivePhoto

func SendLivePhoto(ctx context.Context, b *client.Bot, p *SendLivePhotoParams) (*Message, error)

SendLivePhoto calls the sendLivePhoto Telegram Bot API method.

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

func SendLocation

func SendLocation(ctx context.Context, b *client.Bot, p *SendLocationParams) (*Message, error)

SendLocation calls the sendLocation Telegram Bot API method.

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

func SendMediaGroup

func SendMediaGroup(ctx context.Context, b *client.Bot, p *SendMediaGroupParams) ([]Message, error)

SendMediaGroup calls the sendMediaGroup Telegram Bot API method.

Use this method to send a group of photos, live 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 Message objects that were sent is returned.

func SendMessage

func SendMessage(ctx context.Context, b *client.Bot, p *SendMessageParams) (*Message, error)

SendMessage calls the sendMessage Telegram Bot API method.

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

func SendPaidMedia

func SendPaidMedia(ctx context.Context, b *client.Bot, p *SendPaidMediaParams) (*Message, error)

SendPaidMedia calls the sendPaidMedia Telegram Bot API method.

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

func SendPhoto

func SendPhoto(ctx context.Context, b *client.Bot, p *SendPhotoParams) (*Message, error)

SendPhoto calls the sendPhoto Telegram Bot API method.

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

func SendPoll

func SendPoll(ctx context.Context, b *client.Bot, p *SendPollParams) (*Message, error)

SendPoll calls the sendPoll Telegram Bot API method.

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

func SendSticker

func SendSticker(ctx context.Context, b *client.Bot, p *SendStickerParams) (*Message, error)

SendSticker calls the sendSticker Telegram Bot API method.

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

func SendVenue

func SendVenue(ctx context.Context, b *client.Bot, p *SendVenueParams) (*Message, error)

SendVenue calls the sendVenue Telegram Bot API method.

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

func SendVideo

func SendVideo(ctx context.Context, b *client.Bot, p *SendVideoParams) (*Message, error)

SendVideo calls the sendVideo Telegram Bot API method.

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.

func SendVideoNote

func SendVideoNote(ctx context.Context, b *client.Bot, p *SendVideoNoteParams) (*Message, error)

SendVideoNote calls the sendVideoNote Telegram Bot API method.

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.

func SendVoice

func SendVoice(ctx context.Context, b *client.Bot, p *SendVoiceParams) (*Message, error)

SendVoice calls the sendVoice Telegram Bot API method.

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, or in .MP3 format, or in .M4A format (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.

func (*Message) GetSender

func (m *Message) GetSender() *Sender

GetSender constructs a Sender for a Message. The result is never nil.

func (*Message) UnmarshalJSON

func (m *Message) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes Message by dispatching union-typed fields (ForwardOrigin, PinnedMessage) through their concrete UnmarshalXxx helpers.

type MessageAutoDeleteTimerChanged

This object represents a service message about a change in auto-delete timer settings.

type MessageAutoDeleteTimerChanged struct {
    // New auto-delete time for messages in the chat; in seconds
    MessageAutoDeleteTime int64 `json:"message_auto_delete_time"`
}

type MessageEntity

This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

type MessageEntity struct {
    // Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag or #hashtag@chatusername), “cashtag” ($USD or $USD@chatusername), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “blockquote” (block quotation), “expandable_blockquote” (collapsed-by-default block quotation), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames), “custom_emoji” (for inline custom emoji stickers), or “date_time” (for formatted date and time).
    Type MessageEntityType `json:"type"`
    // Offset in UTF-16 code units to the start of the entity
    Offset int64 `json:"offset"`
    // Length of the entity in UTF-16 code units
    Length int64 `json:"length"`
    // Optional. For “text_link” only, URL that will be opened after user taps on the text
    URL string `json:"url,omitempty"`
    // Optional. For “text_mention” only, the mentioned user
    User *User `json:"user,omitempty"`
    // Optional. For “pre” only, the programming language of the entity text
    Language string `json:"language,omitempty"`
    // Optional. For “custom_emoji” only, unique identifier of the custom emoji. Use getCustomEmojiStickers to get full information about the sticker.
    CustomEmojiID string `json:"custom_emoji_id,omitempty"`
    // Optional. For “date_time” only, the Unix time associated with the entity
    UnixTime *int64 `json:"unix_time,omitempty"`
    // Optional. For “date_time” only, the string that defines the formatting of the date and time. See date-time entity formatting for more details.
    DateTimeFormat string `json:"date_time_format,omitempty"`
}

type MessageEntityType

type MessageEntityType string


const (
    MessageEntityTypeMention              MessageEntityType = "mention"
    MessageEntityTypeHashtag              MessageEntityType = "hashtag"
    MessageEntityTypeCashtag              MessageEntityType = "cashtag"
    MessageEntityTypeBotCommand           MessageEntityType = "bot_command"
    MessageEntityTypeURL                  MessageEntityType = "url"
    MessageEntityTypeEmail                MessageEntityType = "email"
    MessageEntityTypePhoneNumber          MessageEntityType = "phone_number"
    MessageEntityTypeBold                 MessageEntityType = "bold"
    MessageEntityTypeItalic               MessageEntityType = "italic"
    MessageEntityTypeUnderline            MessageEntityType = "underline"
    MessageEntityTypeStrikethrough        MessageEntityType = "strikethrough"
    MessageEntityTypeSpoiler              MessageEntityType = "spoiler"
    MessageEntityTypeBlockquote           MessageEntityType = "blockquote"
    MessageEntityTypeExpandableBlockquote MessageEntityType = "expandable_blockquote"
    MessageEntityTypeCode                 MessageEntityType = "code"
    MessageEntityTypePre                  MessageEntityType = "pre"
    MessageEntityTypeTextLink             MessageEntityType = "text_link"
    MessageEntityTypeTextMention          MessageEntityType = "text_mention"
    MessageEntityTypeCustomEmoji          MessageEntityType = "custom_emoji"
    MessageEntityTypeDateTime             MessageEntityType = "date_time"
)

type MessageId

This object represents a unique message identifier.

type MessageId struct {
    // Unique message identifier. In specific instances (e.g., message containing a video sent to a big chat), the server might automatically schedule a message instead of sending it immediately. In such cases, this field will be 0 and the relevant message will be unusable until it is actually sent.
    MessageID int64 `json:"message_id"`
}

func CopyMessage

func CopyMessage(ctx context.Context, b *client.Bot, p *CopyMessageParams) (*MessageId, error)

CopyMessage calls the copyMessage Telegram Bot API method.

Use this method to copy messages of any kind. Service messages, paid media 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.

func CopyMessages

func CopyMessages(ctx context.Context, b *client.Bot, p *CopyMessagesParams) ([]MessageId, error)

CopyMessages calls the copyMessages Telegram Bot API method.

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, paid media 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.

func ForwardMessages

func ForwardMessages(ctx context.Context, b *client.Bot, p *ForwardMessagesParams) ([]MessageId, error)

ForwardMessages calls the forwardMessages Telegram Bot API method.

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.

type MessageOrBool

MessageOrBool wraps the "Message or True" return shape Telegram uses on edit methods (editMessageText, editMessageCaption, etc.). When the bot edits a regular chat message, Message is non-nil; when it edits an inline message, OK is true.

type MessageOrBool struct {
    Message *Message
    OK      bool
}

func EditMessageCaption

func EditMessageCaption(ctx context.Context, b *client.Bot, p *EditMessageCaptionParams) (*MessageOrBool, error)

EditMessageCaption calls the editMessageCaption Telegram Bot API method.

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. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

func EditMessageLiveLocation

func EditMessageLiveLocation(ctx context.Context, b *client.Bot, p *EditMessageLiveLocationParams) (*MessageOrBool, error)

EditMessageLiveLocation calls the editMessageLiveLocation Telegram Bot API method.

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.

func EditMessageMedia

func EditMessageMedia(ctx context.Context, b *client.Bot, p *EditMessageMediaParams) (*MessageOrBool, error)

EditMessageMedia calls the editMessageMedia Telegram Bot API method.

Use this method to edit animation, audio, document, live photo, photo, or video messages, or to add media to text 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, a live 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. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

func EditMessageReplyMarkup

func EditMessageReplyMarkup(ctx context.Context, b *client.Bot, p *EditMessageReplyMarkupParams) (*MessageOrBool, error)

EditMessageReplyMarkup calls the editMessageReplyMarkup Telegram Bot API method.

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. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

func EditMessageText

func EditMessageText(ctx context.Context, b *client.Bot, p *EditMessageTextParams) (*MessageOrBool, error)

EditMessageText calls the editMessageText Telegram Bot API method.

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. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

func SetGameScore

func SetGameScore(ctx context.Context, b *client.Bot, p *SetGameScoreParams) (*MessageOrBool, error)

SetGameScore calls the setGameScore Telegram Bot API method.

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.

func StopMessageLiveLocation

func StopMessageLiveLocation(ctx context.Context, b *client.Bot, p *StopMessageLiveLocationParams) (*MessageOrBool, error)

StopMessageLiveLocation calls the stopMessageLiveLocation Telegram Bot API method.

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.

func (*MessageOrBool) UnmarshalJSON

func (m *MessageOrBool) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes either {...} into Message or `true`/`false` into OK.

type MessageOrigin

MessageOrigin is a union type. The following concrete variants implement it:

  • MessageOriginUser
  • MessageOriginHiddenUser
  • MessageOriginChat
  • MessageOriginChannel

This object describes the origin of a message. It can be one of

type MessageOrigin interface {
    // contains filtered or unexported methods
}

func UnmarshalMessageOrigin

func UnmarshalMessageOrigin(data []byte) (MessageOrigin, error)

UnmarshalMessageOrigin decodes a MessageOrigin from JSON by inspecting the "type" field and dispatching to the correct concrete type.

type MessageOriginChannel

The message was originally sent to a channel chat.

type MessageOriginChannel struct {
    // Type of the message origin, always “channel”
    Type MessageOriginType `json:"type"`
    // Date the message was sent originally in Unix time
    Date int64 `json:"date"`
    // Channel chat to which the message was originally sent
    Chat Chat `json:"chat"`
    // Unique message identifier inside the chat
    MessageID int64 `json:"message_id"`
    // Optional. Signature of the original post author
    AuthorSignature string `json:"author_signature,omitempty"`
}

func (*MessageOriginChannel) MarshalJSON

func (v *MessageOriginChannel) MarshalJSON() ([]byte, error)

MarshalJSON encodes MessageOriginChannel with the discriminator field "type" forced to "channel". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type MessageOriginChat

The message was originally sent on behalf of a chat to a group chat.

type MessageOriginChat struct {
    // Type of the message origin, always “chat”
    Type MessageOriginType `json:"type"`
    // Date the message was sent originally in Unix time
    Date int64 `json:"date"`
    // Chat that sent the message originally
    SenderChat Chat `json:"sender_chat"`
    // Optional. For messages originally sent by an anonymous chat administrator, original message author signature
    AuthorSignature string `json:"author_signature,omitempty"`
}

func (*MessageOriginChat) MarshalJSON

func (v *MessageOriginChat) MarshalJSON() ([]byte, error)

MarshalJSON encodes MessageOriginChat with the discriminator field "type" forced to "chat". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type MessageOriginHiddenUser

The message was originally sent by an unknown user.

type MessageOriginHiddenUser struct {
    // Type of the message origin, always “hidden_user”
    Type MessageOriginType `json:"type"`
    // Date the message was sent originally in Unix time
    Date int64 `json:"date"`
    // Name of the user that sent the message originally
    SenderUserName string `json:"sender_user_name"`
}

func (*MessageOriginHiddenUser) MarshalJSON

func (v *MessageOriginHiddenUser) MarshalJSON() ([]byte, error)

MarshalJSON encodes MessageOriginHiddenUser with the discriminator field "type" forced to "hidden_user". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type MessageOriginType

type MessageOriginType string


const (
    MessageOriginTypeUser       MessageOriginType = "user"
    MessageOriginTypeHiddenUser MessageOriginType = "hidden_user"
    MessageOriginTypeChat       MessageOriginType = "chat"
    MessageOriginTypeChannel    MessageOriginType = "channel"
)

type MessageOriginUser

The message was originally sent by a known user.

type MessageOriginUser struct {
    // Type of the message origin, always “user”
    Type MessageOriginType `json:"type"`
    // Date the message was sent originally in Unix time
    Date int64 `json:"date"`
    // User that sent the message originally
    SenderUser User `json:"sender_user"`
}

func (*MessageOriginUser) MarshalJSON

func (v *MessageOriginUser) MarshalJSON() ([]byte, error)

MarshalJSON encodes MessageOriginUser with the discriminator field "type" forced to "user". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type MessageReactionCountUpdated

This object represents reaction changes on a message with anonymous reactions.

type MessageReactionCountUpdated struct {
    // The chat containing the message
    Chat Chat `json:"chat"`
    // Unique message identifier inside the chat
    MessageID int64 `json:"message_id"`
    // Date of the change in Unix time
    Date int64 `json:"date"`
    // List of reactions that are present on the message
    Reactions []ReactionCount `json:"reactions"`
}

type MessageReactionUpdated

This object represents a change of a reaction on a message performed by a user.

type MessageReactionUpdated struct {
    // The chat containing the message the user reacted to
    Chat Chat `json:"chat"`
    // Unique identifier of the message inside the chat
    MessageID int64 `json:"message_id"`
    // Optional. The user that changed the reaction, if the user isn't anonymous
    User *User `json:"user,omitempty"`
    // Optional. The chat on behalf of which the reaction was changed, if the user is anonymous
    ActorChat *Chat `json:"actor_chat,omitempty"`
    // Date of the change in Unix time
    Date int64 `json:"date"`
    // Previous list of reaction types that were set by the user
    OldReaction []ReactionType `json:"old_reaction"`
    // New list of reaction types that have been set by the user
    NewReaction []ReactionType `json:"new_reaction"`
}

func (*MessageReactionUpdated) GetSender

func (mru *MessageReactionUpdated) GetSender() *Sender

GetSender constructs a Sender for a MessageReactionUpdated.

func (*MessageReactionUpdated) UnmarshalJSON

func (m *MessageReactionUpdated) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes MessageReactionUpdated by dispatching union-typed fields (OldReaction, NewReaction) through their concrete UnmarshalXxx helpers.

type OrderInfo

This object represents information about an order.

type OrderInfo struct {
    // Optional. User name
    Name string `json:"name,omitempty"`
    // Optional. User's phone number
    PhoneNumber string `json:"phone_number,omitempty"`
    // Optional. User email
    Email string `json:"email,omitempty"`
    // Optional. User shipping address
    ShippingAddress *ShippingAddress `json:"shipping_address,omitempty"`
}

type OwnedGift

OwnedGift is a union type. The following concrete variants implement it:

  • OwnedGiftRegular
  • OwnedGiftUnique

This object describes a gift received and owned by a user or a chat. Currently, it can be one of

type OwnedGift interface {
    // contains filtered or unexported methods
}

func UnmarshalOwnedGift

func UnmarshalOwnedGift(data []byte) (OwnedGift, error)

UnmarshalOwnedGift decodes a OwnedGift from JSON by inspecting the "type" field and dispatching to the correct concrete type.

type OwnedGiftRegular

Describes a regular gift owned by a user or a chat.

type OwnedGiftRegular struct {
    // Type of the gift, always “regular”
    Type OwnedGiftType `json:"type"`
    // Information about the regular gift
    Gift Gift `json:"gift"`
    // Optional. Unique identifier of the gift for the bot; for gifts received on behalf of business accounts only
    OwnedGiftID string `json:"owned_gift_id,omitempty"`
    // Optional. Sender of the gift if it is a known user
    SenderUser *User `json:"sender_user,omitempty"`
    // Date the gift was sent in Unix time
    SendDate int64 `json:"send_date"`
    // Optional. Text of the message that was added to the gift
    Text string `json:"text,omitempty"`
    // Optional. Special entities that appear in the text
    Entities []MessageEntity `json:"entities,omitempty"`
    // Optional. True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them
    IsPrivate *bool `json:"is_private,omitempty"`
    // Optional. True, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only
    IsSaved *bool `json:"is_saved,omitempty"`
    // Optional. True, if the gift can be upgraded to a unique gift; for gifts received on behalf of business accounts only
    CanBeUpgraded *bool `json:"can_be_upgraded,omitempty"`
    // Optional. True, if the gift was refunded and isn't available anymore
    WasRefunded *bool `json:"was_refunded,omitempty"`
    // Optional. Number of Telegram Stars that can be claimed by the receiver instead of the gift; omitted if the gift cannot be converted to Telegram Stars; for gifts received on behalf of business accounts only
    ConvertStarCount *int64 `json:"convert_star_count,omitempty"`
    // Optional. Number of Telegram Stars that were paid for the ability to upgrade the gift
    PrepaidUpgradeStarCount *int64 `json:"prepaid_upgrade_star_count,omitempty"`
    // Optional. True, if the gift's upgrade was purchased after the gift was sent; for gifts received on behalf of business accounts only
    IsUpgradeSeparate *bool `json:"is_upgrade_separate,omitempty"`
    // Optional. Unique number reserved for this gift when upgraded. See the number field in UniqueGift.
    UniqueGiftNumber *int64 `json:"unique_gift_number,omitempty"`
}

func (*OwnedGiftRegular) MarshalJSON

func (v *OwnedGiftRegular) MarshalJSON() ([]byte, error)

MarshalJSON encodes OwnedGiftRegular with the discriminator field "type" forced to "regular". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type OwnedGiftType

type OwnedGiftType string


const (
    OwnedGiftTypeRegular OwnedGiftType = "regular"
    OwnedGiftTypeUnique  OwnedGiftType = "unique"
)

type OwnedGiftUnique

Describes a unique gift received and owned by a user or a chat.

type OwnedGiftUnique struct {
    // Type of the gift, always “unique”
    Type OwnedGiftType `json:"type"`
    // Information about the unique gift
    Gift UniqueGift `json:"gift"`
    // Optional. Unique identifier of the received gift for the bot; for gifts received on behalf of business accounts only
    OwnedGiftID string `json:"owned_gift_id,omitempty"`
    // Optional. Sender of the gift if it is a known user
    SenderUser *User `json:"sender_user,omitempty"`
    // Date the gift was sent in Unix time
    SendDate int64 `json:"send_date"`
    // Optional. True, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only
    IsSaved *bool `json:"is_saved,omitempty"`
    // Optional. True, if the gift can be transferred to another owner; for gifts received on behalf of business accounts only
    CanBeTransferred *bool `json:"can_be_transferred,omitempty"`
    // Optional. Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift
    TransferStarCount *int64 `json:"transfer_star_count,omitempty"`
    // Optional. Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift can be transferred now.
    NextTransferDate *int64 `json:"next_transfer_date,omitempty"`
}

func (*OwnedGiftUnique) MarshalJSON

func (v *OwnedGiftUnique) MarshalJSON() ([]byte, error)

MarshalJSON encodes OwnedGiftUnique with the discriminator field "type" forced to "unique". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type OwnedGifts

Contains the list of gifts received and owned by a user or a chat.

type OwnedGifts struct {
    // The total number of gifts owned by the user or the chat
    TotalCount int64 `json:"total_count"`
    // The list of gifts
    Gifts []OwnedGift `json:"gifts"`
    // Optional. Offset for the next request. If empty, then there are no more results.
    NextOffset string `json:"next_offset,omitempty"`
}

func GetBusinessAccountGifts

func GetBusinessAccountGifts(ctx context.Context, b *client.Bot, p *GetBusinessAccountGiftsParams) (*OwnedGifts, error)

GetBusinessAccountGifts calls the getBusinessAccountGifts Telegram Bot API method.

Returns the gifts received and owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns OwnedGifts on success.

func GetChatGifts

func GetChatGifts(ctx context.Context, b *client.Bot, p *GetChatGiftsParams) (*OwnedGifts, error)

GetChatGifts calls the getChatGifts Telegram Bot API method.

Returns the gifts owned by a chat. Returns OwnedGifts on success.

func GetUserGifts

func GetUserGifts(ctx context.Context, b *client.Bot, p *GetUserGiftsParams) (*OwnedGifts, error)

GetUserGifts calls the getUserGifts Telegram Bot API method.

Returns the gifts owned and hosted by a user. Returns OwnedGifts on success.

func (*OwnedGifts) UnmarshalJSON

func (m *OwnedGifts) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes OwnedGifts by dispatching union-typed fields (Gifts) through their concrete UnmarshalXxx helpers.

type PaidMedia

PaidMedia is a union type. The following concrete variants implement it:

  • PaidMediaLivePhoto
  • PaidMediaPhoto
  • PaidMediaPreview
  • PaidMediaVideo

This object describes paid media. Currently, it can be one of

type PaidMedia interface {
    // contains filtered or unexported methods
}

func UnmarshalPaidMedia

func UnmarshalPaidMedia(data []byte) (PaidMedia, error)

UnmarshalPaidMedia decodes a PaidMedia from JSON by inspecting the "type" field and dispatching to the correct concrete type.

type PaidMediaInfo

Describes the paid media added to a message.

type PaidMediaInfo struct {
    // The number of Telegram Stars that must be paid to buy access to the media
    StarCount int64 `json:"star_count"`
    // Information about the paid media
    PaidMedia []PaidMedia `json:"paid_media"`
}

func (*PaidMediaInfo) UnmarshalJSON

func (m *PaidMediaInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes PaidMediaInfo by dispatching union-typed fields (PaidMedia) through their concrete UnmarshalXxx helpers.

type PaidMediaLivePhoto

The paid media is a live photo.

type PaidMediaLivePhoto struct {
    // Type of the paid media, always “live_photo”
    Type PaidMediaType `json:"type"`
    // The photo
    LivePhoto LivePhoto `json:"live_photo"`
}

func (*PaidMediaLivePhoto) MarshalJSON

func (v *PaidMediaLivePhoto) MarshalJSON() ([]byte, error)

MarshalJSON encodes PaidMediaLivePhoto with the discriminator field "type" forced to "live_photo". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type PaidMediaPhoto

The paid media is a photo.

type PaidMediaPhoto struct {
    // Type of the paid media, always “photo”
    Type PaidMediaType `json:"type"`
    // The photo
    Photo []PhotoSize `json:"photo"`
}

func (*PaidMediaPhoto) MarshalJSON

func (v *PaidMediaPhoto) MarshalJSON() ([]byte, error)

MarshalJSON encodes PaidMediaPhoto with the discriminator field "type" forced to "photo". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type PaidMediaPreview

The paid media isn't available before the payment.

type PaidMediaPreview struct {
    // Type of the paid media, always “preview”
    Type PaidMediaType `json:"type"`
    // Optional. Media width as defined by the sender
    Width *int64 `json:"width,omitempty"`
    // Optional. Media height as defined by the sender
    Height *int64 `json:"height,omitempty"`
    // Optional. Duration of the media in seconds as defined by the sender
    Duration *int64 `json:"duration,omitempty"`
}

func (*PaidMediaPreview) MarshalJSON

func (v *PaidMediaPreview) MarshalJSON() ([]byte, error)

MarshalJSON encodes PaidMediaPreview with the discriminator field "type" forced to "preview". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type PaidMediaPurchased

This object contains information about a paid media purchase.

type PaidMediaPurchased struct {
    // User who purchased the media
    From User `json:"from"`
    // Bot-specified paid media payload
    PaidMediaPayload string `json:"paid_media_payload"`
}

type PaidMediaType

type PaidMediaType string


const (
    PaidMediaTypeLivePhoto PaidMediaType = "live_photo"
    PaidMediaTypePhoto     PaidMediaType = "photo"
    PaidMediaTypePreview   PaidMediaType = "preview"
    PaidMediaTypeVideo     PaidMediaType = "video"
)

type PaidMediaVideo

The paid media is a video.

type PaidMediaVideo struct {
    // Type of the paid media, always “video”
    Type PaidMediaType `json:"type"`
    // The video
    Video Video `json:"video"`
}

func (*PaidMediaVideo) MarshalJSON

func (v *PaidMediaVideo) MarshalJSON() ([]byte, error)

MarshalJSON encodes PaidMediaVideo with the discriminator field "type" forced to "video". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type PaidMessagePriceChanged

Describes a service message about a change in the price of paid messages within a chat.

type PaidMessagePriceChanged struct {
    // The new number of Telegram Stars that must be paid by non-administrator users of the supergroup chat for each sent message
    PaidMessageStarCount int64 `json:"paid_message_star_count"`
}

type ParseMode

type ParseMode string


const (
    ParseModeMarkdown   ParseMode = "Markdown"
    ParseModeMarkdownV2 ParseMode = "MarkdownV2"
    ParseModeHTML       ParseMode = "HTML"
)

type PassportData

Describes Telegram Passport data shared with the bot by the user.

type PassportData struct {
    // Array with information about documents and other Telegram Passport elements that was shared with the bot
    Data []EncryptedPassportElement `json:"data"`
    // Encrypted credentials required to decrypt the data
    Credentials EncryptedCredentials `json:"credentials"`
}

type PassportElementError

PassportElementError is a union type. The following concrete variants implement it:

  • PassportElementErrorDataField
  • PassportElementErrorFrontSide
  • PassportElementErrorReverseSide
  • PassportElementErrorSelfie
  • PassportElementErrorFile
  • PassportElementErrorFiles
  • PassportElementErrorTranslationFile
  • PassportElementErrorTranslationFiles
  • PassportElementErrorUnspecified

This object represents an error in the Telegram Passport element which was submitted that should be resolved by the user. It should be one of:

type PassportElementError interface {
    // contains filtered or unexported methods
}

type PassportElementErrorDataField

Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes.

type PassportElementErrorDataField struct {
    // Error source, must be data
    Source PassportElementErrorSource `json:"source"`
    // The section of the user's Telegram Passport which has the error, one of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”
    Type PassportElementErrorDataFieldType `json:"type"`
    // Name of the data field which has the error
    FieldName string `json:"field_name"`
    // Base64-encoded data hash
    DataHash string `json:"data_hash"`
    // Error message
    Message string `json:"message"`
}

func (*PassportElementErrorDataField) MarshalJSON

func (v *PassportElementErrorDataField) MarshalJSON() ([]byte, error)

MarshalJSON encodes PassportElementErrorDataField with the discriminator field "source" forced to "data". The hardcoded value frees callers from setting Source by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type PassportElementErrorDataFieldType

type PassportElementErrorDataFieldType string


const (
    PassportElementErrorDataFieldTypePersonalDetails  PassportElementErrorDataFieldType = "personal_details"
    PassportElementErrorDataFieldTypePassport         PassportElementErrorDataFieldType = "passport"
    PassportElementErrorDataFieldTypeDriverLicense    PassportElementErrorDataFieldType = "driver_license"
    PassportElementErrorDataFieldTypeIdentityCard     PassportElementErrorDataFieldType = "identity_card"
    PassportElementErrorDataFieldTypeInternalPassport PassportElementErrorDataFieldType = "internal_passport"
    PassportElementErrorDataFieldTypeAddress          PassportElementErrorDataFieldType = "address"
)

type PassportElementErrorFile

Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes.

type PassportElementErrorFile struct {
    // Error source, must be file
    Source PassportElementErrorSource `json:"source"`
    // The section of the user's Telegram Passport which has the issue, one of “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”
    Type PassportElementErrorFileType `json:"type"`
    // Base64-encoded file hash
    FileHash string `json:"file_hash"`
    // Error message
    Message string `json:"message"`
}

func (*PassportElementErrorFile) MarshalJSON

func (v *PassportElementErrorFile) MarshalJSON() ([]byte, error)

MarshalJSON encodes PassportElementErrorFile with the discriminator field "source" forced to "file". The hardcoded value frees callers from setting Source by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type PassportElementErrorFileType

type PassportElementErrorFileType string


const (
    PassportElementErrorFileTypeUtilityBill           PassportElementErrorFileType = "utility_bill"
    PassportElementErrorFileTypeBankStatement         PassportElementErrorFileType = "bank_statement"
    PassportElementErrorFileTypeRentalAgreement       PassportElementErrorFileType = "rental_agreement"
    PassportElementErrorFileTypePassportRegistration  PassportElementErrorFileType = "passport_registration"
    PassportElementErrorFileTypeTemporaryRegistration PassportElementErrorFileType = "temporary_registration"
)

type PassportElementErrorFiles

Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.

type PassportElementErrorFiles struct {
    // Error source, must be files
    Source PassportElementErrorSource `json:"source"`
    // The section of the user's Telegram Passport which has the issue, one of “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”
    Type PassportElementErrorFileType `json:"type"`
    // List of base64-encoded file hashes
    FileHashes []string `json:"file_hashes"`
    // Error message
    Message string `json:"message"`
}

func (*PassportElementErrorFiles) MarshalJSON

func (v *PassportElementErrorFiles) MarshalJSON() ([]byte, error)

MarshalJSON encodes PassportElementErrorFiles with the discriminator field "source" forced to "files". The hardcoded value frees callers from setting Source by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type PassportElementErrorFrontSide

Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes.

type PassportElementErrorFrontSide struct {
    // Error source, must be front_side
    Source PassportElementErrorSource `json:"source"`
    // The section of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”
    Type PassportElementErrorSelfieType `json:"type"`
    // Base64-encoded hash of the file with the front side of the document
    FileHash string `json:"file_hash"`
    // Error message
    Message string `json:"message"`
}

func (*PassportElementErrorFrontSide) MarshalJSON

func (v *PassportElementErrorFrontSide) MarshalJSON() ([]byte, error)

MarshalJSON encodes PassportElementErrorFrontSide with the discriminator field "source" forced to "front_side". The hardcoded value frees callers from setting Source by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type PassportElementErrorReverseSide

Represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes.

type PassportElementErrorReverseSide struct {
    // Error source, must be reverse_side
    Source PassportElementErrorSource `json:"source"`
    // The section of the user's Telegram Passport which has the issue, one of “driver_license”, “identity_card”
    Type PassportElementErrorReverseSideType `json:"type"`
    // Base64-encoded hash of the file with the reverse side of the document
    FileHash string `json:"file_hash"`
    // Error message
    Message string `json:"message"`
}

func (*PassportElementErrorReverseSide) MarshalJSON

func (v *PassportElementErrorReverseSide) MarshalJSON() ([]byte, error)

MarshalJSON encodes PassportElementErrorReverseSide with the discriminator field "source" forced to "reverse_side". The hardcoded value frees callers from setting Source by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type PassportElementErrorReverseSideType

type PassportElementErrorReverseSideType string


const (
    PassportElementErrorReverseSideTypeDriverLicense PassportElementErrorReverseSideType = "driver_license"
    PassportElementErrorReverseSideTypeIdentityCard  PassportElementErrorReverseSideType = "identity_card"
)

type PassportElementErrorSelfie

Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes.

type PassportElementErrorSelfie struct {
    // Error source, must be selfie
    Source PassportElementErrorSource `json:"source"`
    // The section of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”
    Type PassportElementErrorSelfieType `json:"type"`
    // Base64-encoded hash of the file with the selfie
    FileHash string `json:"file_hash"`
    // Error message
    Message string `json:"message"`
}

func (*PassportElementErrorSelfie) MarshalJSON

func (v *PassportElementErrorSelfie) MarshalJSON() ([]byte, error)

MarshalJSON encodes PassportElementErrorSelfie with the discriminator field "source" forced to "selfie". The hardcoded value frees callers from setting Source by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type PassportElementErrorSelfieType

type PassportElementErrorSelfieType string


const (
    PassportElementErrorSelfieTypePassport         PassportElementErrorSelfieType = "passport"
    PassportElementErrorSelfieTypeDriverLicense    PassportElementErrorSelfieType = "driver_license"
    PassportElementErrorSelfieTypeIdentityCard     PassportElementErrorSelfieType = "identity_card"
    PassportElementErrorSelfieTypeInternalPassport PassportElementErrorSelfieType = "internal_passport"
)

type PassportElementErrorSource

type PassportElementErrorSource string


const (
    PassportElementErrorSourceData             PassportElementErrorSource = "data"
    PassportElementErrorSourceFrontSide        PassportElementErrorSource = "front_side"
    PassportElementErrorSourceReverseSide      PassportElementErrorSource = "reverse_side"
    PassportElementErrorSourceSelfie           PassportElementErrorSource = "selfie"
    PassportElementErrorSourceFile             PassportElementErrorSource = "file"
    PassportElementErrorSourceFiles            PassportElementErrorSource = "files"
    PassportElementErrorSourceTranslationFile  PassportElementErrorSource = "translation_file"
    PassportElementErrorSourceTranslationFiles PassportElementErrorSource = "translation_files"
    PassportElementErrorSourceUnspecified      PassportElementErrorSource = "unspecified"
)

type PassportElementErrorTranslationFile

Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes.

type PassportElementErrorTranslationFile struct {
    // Error source, must be translation_file
    Source PassportElementErrorSource `json:"source"`
    // Type of element of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”
    Type PassportElementErrorTranslationFileType `json:"type"`
    // Base64-encoded file hash
    FileHash string `json:"file_hash"`
    // Error message
    Message string `json:"message"`
}

func (*PassportElementErrorTranslationFile) MarshalJSON

func (v *PassportElementErrorTranslationFile) MarshalJSON() ([]byte, error)

MarshalJSON encodes PassportElementErrorTranslationFile with the discriminator field "source" forced to "translation_file". The hardcoded value frees callers from setting Source by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type PassportElementErrorTranslationFileType

type PassportElementErrorTranslationFileType string


const (
    PassportElementErrorTranslationFileTypePassport              PassportElementErrorTranslationFileType = "passport"
    PassportElementErrorTranslationFileTypeDriverLicense         PassportElementErrorTranslationFileType = "driver_license"
    PassportElementErrorTranslationFileTypeIdentityCard          PassportElementErrorTranslationFileType = "identity_card"
    PassportElementErrorTranslationFileTypeInternalPassport      PassportElementErrorTranslationFileType = "internal_passport"
    PassportElementErrorTranslationFileTypeUtilityBill           PassportElementErrorTranslationFileType = "utility_bill"
    PassportElementErrorTranslationFileTypeBankStatement         PassportElementErrorTranslationFileType = "bank_statement"
    PassportElementErrorTranslationFileTypeRentalAgreement       PassportElementErrorTranslationFileType = "rental_agreement"
    PassportElementErrorTranslationFileTypePassportRegistration  PassportElementErrorTranslationFileType = "passport_registration"
    PassportElementErrorTranslationFileTypeTemporaryRegistration PassportElementErrorTranslationFileType = "temporary_registration"
)

type PassportElementErrorTranslationFiles

Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation change.

type PassportElementErrorTranslationFiles struct {
    // Error source, must be translation_files
    Source PassportElementErrorSource `json:"source"`
    // Type of element of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”
    Type PassportElementErrorTranslationFileType `json:"type"`
    // List of base64-encoded file hashes
    FileHashes []string `json:"file_hashes"`
    // Error message
    Message string `json:"message"`
}

func (*PassportElementErrorTranslationFiles) MarshalJSON

func (v *PassportElementErrorTranslationFiles) MarshalJSON() ([]byte, error)

MarshalJSON encodes PassportElementErrorTranslationFiles with the discriminator field "source" forced to "translation_files". The hardcoded value frees callers from setting Source by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type PassportElementErrorUnspecified

Represents an issue in an unspecified place. The error is considered resolved when new data is added.

type PassportElementErrorUnspecified struct {
    // Error source, must be unspecified
    Source PassportElementErrorSource `json:"source"`
    // Type of element of the user's Telegram Passport which has the issue
    Type string `json:"type"`
    // Base64-encoded element hash
    ElementHash string `json:"element_hash"`
    // Error message
    Message string `json:"message"`
}

func (*PassportElementErrorUnspecified) MarshalJSON

func (v *PassportElementErrorUnspecified) MarshalJSON() ([]byte, error)

MarshalJSON encodes PassportElementErrorUnspecified with the discriminator field "source" forced to "unspecified". The hardcoded value frees callers from setting Source by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type PassportFile

This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB.

type PassportFile struct {
    // Identifier for this file, which can be used to download or reuse the file
    FileID string `json:"file_id"`
    // Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
    FileUniqueID string `json:"file_unique_id"`
    // File size in bytes
    FileSize int64 `json:"file_size"`
    // Unix time when the file was uploaded
    FileDate int64 `json:"file_date"`
}

type PhotoSize

This object represents one size of a photo or a file / sticker thumbnail.

type PhotoSize struct {
    // Identifier for this file, which can be used to download or reuse the file
    FileID string `json:"file_id"`
    // Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
    FileUniqueID string `json:"file_unique_id"`
    // Photo width
    Width int64 `json:"width"`
    // Photo height
    Height int64 `json:"height"`
    // Optional. File size in bytes
    FileSize *int64 `json:"file_size,omitempty"`
}

type PinChatMessageParams

PinChatMessageParams is the parameter set for PinChatMessage.

Use this method to add a message to the list of pinned messages in a chat. In private chats and channel direct messages chats, all non-service messages can be pinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to pin messages in groups and channels respectively. Returns True on success.

type PinChatMessageParams struct {
    // Unique identifier of the business connection on behalf of which the message will be pinned
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Unique identifier for the target chat or username of the target channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Identifier of a message to pin
    MessageID int64 `json:"message_id"`
    // Pass True if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats.
    DisableNotification *bool `json:"disable_notification,omitempty"`
}

type Poll

This object contains information about a poll.

type Poll struct {
    // Unique poll identifier
    ID  string `json:"id"`
    // Poll question, 1-300 characters
    Question string `json:"question"`
    // Optional. Special entities that appear in the question. Currently, only custom emoji entities are allowed in poll questions
    QuestionEntities []MessageEntity `json:"question_entities,omitempty"`
    // List of poll options
    Options []PollOption `json:"options"`
    // Total number of users that voted in the poll
    TotalVoterCount int64 `json:"total_voter_count"`
    // True, if the poll is closed
    IsClosed bool `json:"is_closed"`
    // True, if the poll is anonymous
    IsAnonymous bool `json:"is_anonymous"`
    // Poll type, currently can be “regular” or “quiz”
    Type PollType `json:"type"`
    // True, if the poll allows multiple answers
    AllowsMultipleAnswers bool `json:"allows_multiple_answers"`
    // True, if the poll allows to change the chosen answer options
    AllowsRevoting bool `json:"allows_revoting"`
    // True if voting is limited to users who have been members of the chat where the poll was originally sent for more than 24 hours
    MembersOnly bool `json:"members_only"`
    // Optional. A list of two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which users can vote in the poll. The country code “FT” is used for users with anonymous numbers. If omitted, then users from any country can participate in the poll.
    CountryCodes []string `json:"country_codes,omitempty"`
    // Optional. Array of 0-based identifiers of the correct answer options. Available only for polls in quiz mode which are closed or were sent (not forwarded) by the bot or to the private chat with the bot.
    CorrectOptionIds []int64 `json:"correct_option_ids,omitempty"`
    // Optional. Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters
    Explanation string `json:"explanation,omitempty"`
    // Optional. Special entities like usernames, URLs, bot commands, etc. that appear in the explanation
    ExplanationEntities []MessageEntity `json:"explanation_entities,omitempty"`
    // Optional. Media added to the quiz explanation
    ExplanationMedia *PollMedia `json:"explanation_media,omitempty"`
    // Optional. Amount of time in seconds the poll will be active after creation
    OpenPeriod *int64 `json:"open_period,omitempty"`
    // Optional. Point in time (Unix timestamp) when the poll will be automatically closed
    CloseDate *int64 `json:"close_date,omitempty"`
    // Optional. Description of the poll; for polls inside the Message object only
    Description string `json:"description,omitempty"`
    // Optional. Special entities like usernames, URLs, bot commands, etc. that appear in the description
    DescriptionEntities []MessageEntity `json:"description_entities,omitempty"`
    // Optional. Media added to the poll description; for polls inside the Message object only
    Media *PollMedia `json:"media,omitempty"`
}

func StopPoll

func StopPoll(ctx context.Context, b *client.Bot, p *StopPollParams) (*Poll, error)

StopPoll calls the stopPoll Telegram Bot API method.

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

type PollAnswer

This object represents an answer of a user in a non-anonymous poll.

type PollAnswer struct {
    // Unique poll identifier
    PollID string `json:"poll_id"`
    // Optional. The chat that changed the answer to the poll, if the voter is anonymous
    VoterChat *Chat `json:"voter_chat,omitempty"`
    // Optional. The user that changed the answer to the poll, if the voter isn't anonymous
    User *User `json:"user,omitempty"`
    // 0-based identifiers of chosen answer options. May be empty if the vote was retracted.
    OptionIds []int64 `json:"option_ids"`
    // Persistent identifiers of the chosen answer options. May be empty if the vote was retracted.
    OptionPersistentIds []string `json:"option_persistent_ids"`
}

func (*PollAnswer) GetSender

func (pa *PollAnswer) GetSender() *Sender

GetSender constructs a Sender for a PollAnswer.

type PollMedia

At most one of the optional fields can be present in any given object.

type PollMedia struct {
    // Optional. Media is an animation, information about the animation
    Animation *Animation `json:"animation,omitempty"`
    // Optional. Media is an audio file, information about the file; currently, can't be received in a poll option
    Audio *Audio `json:"audio,omitempty"`
    // Optional. Media is a general file, information about the file; currently, can't be received in a poll option
    Document *Document `json:"document,omitempty"`
    // Optional. Media is a live photo, information about the live photo
    LivePhoto *LivePhoto `json:"live_photo,omitempty"`
    // Optional. Media is a shared location, information about the location
    Location *Location `json:"location,omitempty"`
    // Optional. Media is a photo, available sizes of the photo
    Photo []PhotoSize `json:"photo,omitempty"`
    // Optional. Media is a sticker, information about the sticker; currently, for poll options only
    Sticker *Sticker `json:"sticker,omitempty"`
    // Optional. Media is a venue, information about the venue
    Venue *Venue `json:"venue,omitempty"`
    // Optional. Media is a video, information about the video
    Video *Video `json:"video,omitempty"`
}

type PollOption

This object contains information about one answer option in a poll.

type PollOption struct {
    // Unique identifier of the option, persistent on option addition and deletion
    PersistentID string `json:"persistent_id"`
    // Option text, 1-100 characters
    Text string `json:"text"`
    // Optional. Special entities that appear in the option text. Currently, only custom emoji entities are allowed in poll option texts
    TextEntities []MessageEntity `json:"text_entities,omitempty"`
    // Optional. Media added to the poll option
    Media *PollMedia `json:"media,omitempty"`
    // Number of users who voted for this option; may be 0 if unknown
    VoterCount int64 `json:"voter_count"`
    // Optional. User who added the option; omitted if the option wasn't added by a user after poll creation
    AddedByUser *User `json:"added_by_user,omitempty"`
    // Optional. Chat that added the option; omitted if the option wasn't added by a chat after poll creation
    AddedByChat *Chat `json:"added_by_chat,omitempty"`
    // Optional. Point in time (Unix timestamp) when the option was added; omitted if the option existed in the original poll
    AdditionDate *int64 `json:"addition_date,omitempty"`
}

type PollOptionAdded

Describes a service message about an option added to a poll.

type PollOptionAdded struct {
    // Optional. Message containing the poll to which the option was added, if known. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.
    PollMessage MaybeInaccessibleMessage `json:"poll_message,omitempty"`
    // Unique identifier of the added option
    OptionPersistentID string `json:"option_persistent_id"`
    // Option text
    OptionText string `json:"option_text"`
    // Optional. Special entities that appear in the option_text
    OptionTextEntities []MessageEntity `json:"option_text_entities,omitempty"`
}

func (*PollOptionAdded) UnmarshalJSON

func (m *PollOptionAdded) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes PollOptionAdded by dispatching union-typed fields (PollMessage) through their concrete UnmarshalXxx helpers.

type PollOptionDeleted

Describes a service message about an option deleted from a poll.

type PollOptionDeleted struct {
    // Optional. Message containing the poll from which the option was deleted, if known. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.
    PollMessage MaybeInaccessibleMessage `json:"poll_message,omitempty"`
    // Unique identifier of the deleted option
    OptionPersistentID string `json:"option_persistent_id"`
    // Option text
    OptionText string `json:"option_text"`
    // Optional. Special entities that appear in the option_text
    OptionTextEntities []MessageEntity `json:"option_text_entities,omitempty"`
}

func (*PollOptionDeleted) UnmarshalJSON

func (m *PollOptionDeleted) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes PollOptionDeleted by dispatching union-typed fields (PollMessage) through their concrete UnmarshalXxx helpers.

type PollType

type PollType string


const (
    PollTypeRegular PollType = "regular"
    PollTypeQuiz    PollType = "quiz"
)

type PostStoryParams

PostStoryParams is the parameter set for PostStory.

Posts a story on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.

type PostStoryParams struct {
    // Unique identifier of the business connection
    BusinessConnectionID string `json:"business_connection_id"`
    // Content of the story
    Content InputStoryContent `json:"content"`
    // Period after which the story is moved to the archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400
    ActivePeriod int64 `json:"active_period"`
    // Caption of the story, 0-2048 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Mode for parsing entities in the story caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // A JSON-serialized list of clickable areas to be shown on the story
    Areas []StoryArea `json:"areas,omitempty"`
    // Pass True to keep the story accessible after it expires
    PostToChatPage *bool `json:"post_to_chat_page,omitempty"`
    // Pass True if the content of the story must be protected from forwarding and screenshotting
    ProtectContent *bool `json:"protect_content,omitempty"`
}

type PreCheckoutQuery

This object contains information about an incoming pre-checkout query.

type PreCheckoutQuery struct {
    // Unique query identifier
    ID  string `json:"id"`
    // User who sent the query
    From User `json:"from"`
    // Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars
    Currency string `json:"currency"`
    // Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
    TotalAmount int64 `json:"total_amount"`
    // Bot-specified invoice payload
    InvoicePayload string `json:"invoice_payload"`
    // Optional. Identifier of the shipping option chosen by the user
    ShippingOptionID string `json:"shipping_option_id,omitempty"`
    // Optional. Order information provided by the user
    OrderInfo *OrderInfo `json:"order_info,omitempty"`
}

type PreparedInlineMessage

Describes an inline message to be sent by a user of a Mini App.

type PreparedInlineMessage struct {
    // Unique identifier of the prepared message
    ID  string `json:"id"`
    // Expiration date of the prepared message, in Unix time. Expired prepared messages can no longer be used.
    ExpirationDate int64 `json:"expiration_date"`
}

func SavePreparedInlineMessage

func SavePreparedInlineMessage(ctx context.Context, b *client.Bot, p *SavePreparedInlineMessageParams) (*PreparedInlineMessage, error)

SavePreparedInlineMessage calls the savePreparedInlineMessage Telegram Bot API method.

Stores a message that can be sent by a user of a Mini App. Returns a PreparedInlineMessage object.

type PreparedKeyboardButton

Describes a keyboard button to be used by a user of a Mini App.

type PreparedKeyboardButton struct {
    // Unique identifier of the keyboard button
    ID string `json:"id"`
}

func SavePreparedKeyboardButton

func SavePreparedKeyboardButton(ctx context.Context, b *client.Bot, p *SavePreparedKeyboardButtonParams) (*PreparedKeyboardButton, error)

SavePreparedKeyboardButton calls the savePreparedKeyboardButton Telegram Bot API method.

Stores a keyboard button that can be used by a user within a Mini App. Returns a PreparedKeyboardButton object.

type PromoteChatMemberParams

PromoteChatMemberParams is the parameter set for 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.

type PromoteChatMemberParams struct {
    // Unique identifier for the target chat or username of the target channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier of the target user
    UserID int64 `json:"user_id"`
    // Pass True if the administrator's presence in the chat is hidden
    IsAnonymous *bool `json:"is_anonymous,omitempty"`
    // Pass True if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.
    CanManageChat *bool `json:"can_manage_chat,omitempty"`
    // Pass True if the administrator can delete messages of other users
    CanDeleteMessages *bool `json:"can_delete_messages,omitempty"`
    // Pass True if the administrator can manage video chats
    CanManageVideoChats *bool `json:"can_manage_video_chats,omitempty"`
    // Pass True if the administrator can restrict, ban or unban chat members, or access supergroup statistics. For backward compatibility, defaults to True for promotions of channel administrators.
    CanRestrictMembers *bool `json:"can_restrict_members,omitempty"`
    // Pass True if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by him)
    CanPromoteMembers *bool `json:"can_promote_members,omitempty"`
    // Pass True if the administrator can change chat title, photo and other settings
    CanChangeInfo *bool `json:"can_change_info,omitempty"`
    // Pass True if the administrator can invite new users to the chat
    CanInviteUsers *bool `json:"can_invite_users,omitempty"`
    // Pass True if the administrator can post stories to the chat
    CanPostStories *bool `json:"can_post_stories,omitempty"`
    // Pass True if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive
    CanEditStories *bool `json:"can_edit_stories,omitempty"`
    // Pass True if the administrator can delete stories posted by other users
    CanDeleteStories *bool `json:"can_delete_stories,omitempty"`
    // Pass True if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only
    CanPostMessages *bool `json:"can_post_messages,omitempty"`
    // Pass True if the administrator can edit messages of other users and can pin messages; for channels only
    CanEditMessages *bool `json:"can_edit_messages,omitempty"`
    // Pass True if the administrator can pin messages; for supergroups only
    CanPinMessages *bool `json:"can_pin_messages,omitempty"`
    // Pass True if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only
    CanManageTopics *bool `json:"can_manage_topics,omitempty"`
    // Pass True if the administrator can manage direct messages within the channel and decline suggested posts; for channels only
    CanManageDirectMessages *bool `json:"can_manage_direct_messages,omitempty"`
    // Pass True if the administrator can edit the tags of regular members; for groups and supergroups only
    CanManageTags *bool `json:"can_manage_tags,omitempty"`
}

type ProximityAlertTriggered

This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user.

type ProximityAlertTriggered struct {
    // User that triggered the alert
    Traveler User `json:"traveler"`
    // User that set the alert
    Watcher User `json:"watcher"`
    // The distance between the users
    Distance int64 `json:"distance"`
}

type ReactionCount

Represents a reaction added to a message along with the number of times it was added.

type ReactionCount struct {
    // Type of the reaction
    Type ReactionType `json:"type"`
    // Number of times the reaction was added
    TotalCount int64 `json:"total_count"`
}

func (*ReactionCount) UnmarshalJSON

func (m *ReactionCount) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes ReactionCount by dispatching union-typed fields (Type) through their concrete UnmarshalXxx helpers.

type ReactionEmoji

ReactionEmoji is the set of emoji Telegram allows in a ReactionTypeEmoji.Emoji value. Hand-curated from https://core.telegram.org/bots/api#reactiontypeemoji because the scraper's curly-quote regex strips the emoji literals (byte-boundary issue on multi-byte sequences). Names mirror the Unicode CLDR short name where one exists; otherwise a stable common-English label. Telegram occasionally extends this set — passers of unrecognised strings still type-check (ReactionEmoji is a string alias) so this list need not block runtime use of newer values.

type ReactionEmoji string


const (
    ReactionEmojiHeart                     ReactionEmoji = "❤"
    ReactionEmojiThumbsUp                  ReactionEmoji = "👍"
    ReactionEmojiThumbsDown                ReactionEmoji = "👎"
    ReactionEmojiFire                      ReactionEmoji = "🔥"
    ReactionEmojiSmilingFaceWithHearts     ReactionEmoji = "🥰"
    ReactionEmojiClappingHands             ReactionEmoji = "👏"
    ReactionEmojiBeamingFace               ReactionEmoji = "😁"
    ReactionEmojiThinkingFace              ReactionEmoji = "🤔"
    ReactionEmojiExplodingHead             ReactionEmoji = "🤯"
    ReactionEmojiScreamingFace             ReactionEmoji = "😱"
    ReactionEmojiCursingFace               ReactionEmoji = "🤬"
    ReactionEmojiCryingFace                ReactionEmoji = "😢"
    ReactionEmojiPartyPopper               ReactionEmoji = "🎉"
    ReactionEmojiStarStruck                ReactionEmoji = "🤩"
    ReactionEmojiVomiting                  ReactionEmoji = "🤮"
    ReactionEmojiPileOfPoo                 ReactionEmoji = "💩"
    ReactionEmojiFoldedHands               ReactionEmoji = "🙏"
    ReactionEmojiOKHand                    ReactionEmoji = "👌"
    ReactionEmojiDove                      ReactionEmoji = "🕊"
    ReactionEmojiClown                     ReactionEmoji = "🤡"
    ReactionEmojiYawning                   ReactionEmoji = "🥱"
    ReactionEmojiWoozyFace                 ReactionEmoji = "🥴"
    ReactionEmojiHeartEyes                 ReactionEmoji = "😍"
    ReactionEmojiWhale                     ReactionEmoji = "🐳"
    ReactionEmojiHeartOnFire               ReactionEmoji = "❤‍🔥"
    ReactionEmojiNewMoonFace               ReactionEmoji = "🌚"
    ReactionEmojiHotDog                    ReactionEmoji = "🌭"
    ReactionEmojiHundredPoints             ReactionEmoji = "💯"
    ReactionEmojiRollingOnFloor            ReactionEmoji = "🤣"
    ReactionEmojiLightning                 ReactionEmoji = "⚡"
    ReactionEmojiBanana                    ReactionEmoji = "🍌"
    ReactionEmojiTrophy                    ReactionEmoji = "🏆"
    ReactionEmojiBrokenHeart               ReactionEmoji = "💔"
    ReactionEmojiRaisedEyebrow             ReactionEmoji = "🤨"
    ReactionEmojiNeutralFace               ReactionEmoji = "😐"
    ReactionEmojiStrawberry                ReactionEmoji = "🍓"
    ReactionEmojiChampagne                 ReactionEmoji = "🍾"
    ReactionEmojiKissMark                  ReactionEmoji = "💋"
    ReactionEmojiMiddleFinger              ReactionEmoji = "🖕"
    ReactionEmojiDevil                     ReactionEmoji = "😈"
    ReactionEmojiSleeping                  ReactionEmoji = "😴"
    ReactionEmojiLoudlyCrying              ReactionEmoji = "😭"
    ReactionEmojiNerd                      ReactionEmoji = "🤓"
    ReactionEmojiGhost                     ReactionEmoji = "👻"
    ReactionEmojiManTechnologist           ReactionEmoji = "👨‍💻"
    ReactionEmojiEyes                      ReactionEmoji = "👀"
    ReactionEmojiJackOLantern              ReactionEmoji = "🎃"
    ReactionEmojiSeeNoEvil                 ReactionEmoji = "🙈"
    ReactionEmojiHalo                      ReactionEmoji = "😇"
    ReactionEmojiFearful                   ReactionEmoji = "😨"
    ReactionEmojiHandshake                 ReactionEmoji = "🤝"
    ReactionEmojiWriting                   ReactionEmoji = "✍"
    ReactionEmojiHugging                   ReactionEmoji = "🤗"
    ReactionEmojiSaluting                  ReactionEmoji = "🫡"
    ReactionEmojiSantaClaus                ReactionEmoji = "🎅"
    ReactionEmojiChristmasTree             ReactionEmoji = "🎄"
    ReactionEmojiSnowman                   ReactionEmoji = "☃"
    ReactionEmojiNailPolish                ReactionEmoji = "💅"
    ReactionEmojiZanyFace                  ReactionEmoji = "🤪"
    ReactionEmojiMoai                      ReactionEmoji = "🗿"
    ReactionEmojiCool                      ReactionEmoji = "🆒"
    ReactionEmojiHeartWithArrow            ReactionEmoji = "💘"
    ReactionEmojiHearNoEvil                ReactionEmoji = "🙉"
    ReactionEmojiUnicorn                   ReactionEmoji = "🦄"
    ReactionEmojiKissingFace               ReactionEmoji = "😘"
    ReactionEmojiPill                      ReactionEmoji = "💊"
    ReactionEmojiSpeakNoEvil               ReactionEmoji = "🙊"
    ReactionEmojiSmilingFaceWithSunglasses ReactionEmoji = "😎"
    ReactionEmojiAlienMonster              ReactionEmoji = "👾"
    ReactionEmojiManShrugging              ReactionEmoji = "🤷‍♂"
    ReactionEmojiPersonShrugging           ReactionEmoji = "🤷"
    ReactionEmojiWomanShrugging            ReactionEmoji = "🤷‍♀"
    ReactionEmojiPoutingFace               ReactionEmoji = "😡"
)

type ReactionType

ReactionType is a union type. The following concrete variants implement it:

  • ReactionTypeEmoji
  • ReactionTypeCustomEmoji
  • ReactionTypePaid

This object describes the type of a reaction. Currently, it can be one of

type ReactionType interface {
    // contains filtered or unexported methods
}

func UnmarshalReactionType

func UnmarshalReactionType(data []byte) (ReactionType, error)

UnmarshalReactionType decodes a ReactionType from JSON by inspecting the "type" field and dispatching to the correct concrete type.

type ReactionTypeCustomEmoji

The reaction is based on a custom emoji.

type ReactionTypeCustomEmoji struct {
    // Type of the reaction, always “custom_emoji”
    Type ReactionTypeKind `json:"type"`
    // Custom emoji identifier
    CustomEmojiID string `json:"custom_emoji_id"`
}

func (*ReactionTypeCustomEmoji) MarshalJSON

func (v *ReactionTypeCustomEmoji) MarshalJSON() ([]byte, error)

MarshalJSON encodes ReactionTypeCustomEmoji with the discriminator field "type" forced to "custom_emoji". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type ReactionTypeEmoji

The reaction is based on an emoji.

type ReactionTypeEmoji struct {
    // Type of the reaction, always “emoji”
    Type ReactionTypeKind `json:"type"`
    // Reaction emoji. Currently, it can be one of "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "".
    Emoji ReactionEmoji `json:"emoji"`
}

func (*ReactionTypeEmoji) MarshalJSON

func (v *ReactionTypeEmoji) MarshalJSON() ([]byte, error)

MarshalJSON encodes ReactionTypeEmoji with the discriminator field "type" forced to "emoji". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type ReactionTypeKind

type ReactionTypeKind string


const (
    ReactionTypeKindEmoji       ReactionTypeKind = "emoji"
    ReactionTypeKindCustomEmoji ReactionTypeKind = "custom_emoji"
    ReactionTypeKindPaid        ReactionTypeKind = "paid"
)

type ReactionTypePaid

The reaction is paid.

type ReactionTypePaid struct {
    // Type of the reaction, always “paid”
    Type ReactionTypeKind `json:"type"`
}

func (*ReactionTypePaid) MarshalJSON

func (v *ReactionTypePaid) MarshalJSON() ([]byte, error)

MarshalJSON encodes ReactionTypePaid with the discriminator field "type" forced to "paid". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type ReadBusinessMessageParams

ReadBusinessMessageParams is the parameter set for ReadBusinessMessage.

Marks incoming message as read on behalf of a business account. Requires the can_read_messages business bot right. Returns True on success.

type ReadBusinessMessageParams struct {
    // Unique identifier of the business connection on behalf of which to read the message
    BusinessConnectionID string `json:"business_connection_id"`
    // Unique identifier of the chat in which the message was received. The chat must have been active in the last 24 hours.
    ChatID int64 `json:"chat_id"`
    // Unique identifier of the message to mark as read
    MessageID int64 `json:"message_id"`
}

type RefundStarPaymentParams

RefundStarPaymentParams is the parameter set for RefundStarPayment.

Refunds a successful payment in Telegram Stars. Returns True on success.

type RefundStarPaymentParams struct {
    // Identifier of the user whose payment will be refunded
    UserID int64 `json:"user_id"`
    // Telegram payment identifier
    TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`
}

type RefundedPayment

This object contains basic information about a refunded payment.

type RefundedPayment struct {
    // Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars. Currently, always “XTR”.
    Currency RefundedPaymentCurrency `json:"currency"`
    // Total refunded price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45, total_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
    TotalAmount int64 `json:"total_amount"`
    // Bot-specified invoice payload
    InvoicePayload string `json:"invoice_payload"`
    // Telegram payment identifier
    TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`
    // Optional. Provider payment identifier
    ProviderPaymentChargeID string `json:"provider_payment_charge_id,omitempty"`
}

type RefundedPaymentCurrency

type RefundedPaymentCurrency string


const (
    RefundedPaymentCurrencyXTR RefundedPaymentCurrency = "XTR"
)

type RemoveBusinessAccountProfilePhotoParams

RemoveBusinessAccountProfilePhotoParams is the parameter set for RemoveBusinessAccountProfilePhoto.

Removes the current profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.

type RemoveBusinessAccountProfilePhotoParams struct {
    // Unique identifier of the business connection
    BusinessConnectionID string `json:"business_connection_id"`
    // Pass True to remove the public photo, which is visible even if the main photo is hidden by the business account's privacy settings. After the main photo is removed, the previous profile photo (if present) becomes the main photo.
    IsPublic *bool `json:"is_public,omitempty"`
}

type RemoveChatVerificationParams

RemoveChatVerificationParams is the parameter set for RemoveChatVerification.

Removes verification from a chat that is currently verified on behalf of the organization represented by the bot. Returns True on success.

type RemoveChatVerificationParams struct {
    // Unique identifier for the target chat or username of the target bot or channel in the format @username
    ChatID ChatID `json:"chat_id"`
}

type RemoveMyProfilePhotoParams

RemoveMyProfilePhotoParams is the parameter set for RemoveMyProfilePhoto.

Removes the profile photo of the bot. Requires no parameters. Returns True on success.

type RemoveMyProfilePhotoParams struct {
}

type RemoveUserVerificationParams

RemoveUserVerificationParams is the parameter set for RemoveUserVerification.

Removes verification from a user who is currently verified on behalf of the organization represented by the bot. Returns True on success.

type RemoveUserVerificationParams struct {
    // Unique identifier of the target user
    UserID int64 `json:"user_id"`
}

type ReopenForumTopicParams

ReopenForumTopicParams is the parameter set for 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.

type ReopenForumTopicParams struct {
    // Unique identifier for the target chat or username of the target supergroup in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message thread of the forum topic
    MessageThreadID int64 `json:"message_thread_id"`
}

type ReopenGeneralForumTopicParams

ReopenGeneralForumTopicParams is the parameter set for 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.

type ReopenGeneralForumTopicParams struct {
    // Unique identifier for the target chat or username of the target supergroup in the format @username
    ChatID ChatID `json:"chat_id"`
}

type ReplaceManagedBotTokenParams

ReplaceManagedBotTokenParams is the parameter set for ReplaceManagedBotToken.

Use this method to revoke the current token of a managed bot and generate a new one. Returns the new token as String on success.

type ReplaceManagedBotTokenParams struct {
    // User identifier of the managed bot whose token will be replaced
    UserID int64 `json:"user_id"`
}

type ReplaceStickerInSetParams

ReplaceStickerInSetParams is the parameter set for ReplaceStickerInSet.

Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling deleteStickerFromSet, then addStickerToSet, then setStickerPositionInSet. Returns True on success.

type ReplaceStickerInSetParams struct {
    // User identifier of the sticker set owner
    UserID int64 `json:"user_id"`
    // Sticker set name
    Name string `json:"name"`
    // File identifier of the replaced sticker
    OldSticker string `json:"old_sticker"`
    // 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 remains unchanged.
    Sticker InputSticker `json:"sticker"`
}

type ReplyKeyboardMarkup

This object represents a custom keyboard with reply options (see Introduction to bots for details and examples). Not supported in channels and for messages sent on behalf of a business account.

type ReplyKeyboardMarkup struct {
    // Array of button rows, each represented by an Array of KeyboardButton objects
    Keyboard [][]KeyboardButton `json:"keyboard"`
    // Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon.
    IsPersistent *bool `json:"is_persistent,omitempty"`
    // Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard.
    ResizeKeyboard *bool `json:"resize_keyboard,omitempty"`
    // Optional. Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to false.
    OneTimeKeyboard *bool `json:"one_time_keyboard,omitempty"`
    // Optional. The placeholder to be shown in the input field when the keyboard is active; 1-64 characters
    InputFieldPlaceholder string `json:"input_field_placeholder,omitempty"`
    // Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the original message.Example: A user requests to change the bot's language, bot replies to the request with a keyboard to select the new language. Other users in the group don't see the keyboard.
    Selective *bool `json:"selective,omitempty"`
}

type ReplyKeyboardRemove

Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup). Not supported in channels and for messages sent on behalf of a business account.

type ReplyKeyboardRemove struct {
    // Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup)
    RemoveKeyboard bool `json:"remove_keyboard"`
    // Optional. Use this parameter if you want to remove the keyboard for specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the original message.Example: A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet.
    Selective *bool `json:"selective,omitempty"`
}

type ReplyParameters

Describes reply parameters for the message that is being sent.

type ReplyParameters struct {
    // Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified
    MessageID int64 `json:"message_id"`
    // Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of the bot, supergroup or channel in the format @username. Not supported for messages sent on behalf of a business account and messages from channel direct messages chats.
    ChatID *ChatID `json:"chat_id,omitempty"`
    // Optional. Pass True if the message should be sent even if the specified message to be replied to is not found. Always False for replies in another chat or forum topic. Always True for messages sent on behalf of a business account.
    AllowSendingWithoutReply *bool `json:"allow_sending_without_reply,omitempty"`
    // Optional. Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, custom_emoji, and date_time entities. The message will fail to send if the quote isn't found in the original message.
    Quote string `json:"quote,omitempty"`
    // Optional. Mode for parsing entities in the quote. See formatting options for more details.
    QuoteParseMode ParseMode `json:"quote_parse_mode,omitempty"`
    // Optional. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of quote_parse_mode.
    QuoteEntities []MessageEntity `json:"quote_entities,omitempty"`
    // Optional. Position of the quote in the original message in UTF-16 code units
    QuotePosition *int64 `json:"quote_position,omitempty"`
    // Optional. Identifier of the specific checklist task to be replied to
    ChecklistTaskID *int64 `json:"checklist_task_id,omitempty"`
    // Optional. Persistent identifier of the specific poll option to be replied to
    PollOptionID string `json:"poll_option_id,omitempty"`
}

type RepostStoryParams

RepostStoryParams is the parameter set for RepostStory.

Reposts a story on behalf of a business account from another business account. Both business accounts must be managed by the same bot, and the story on the source account must have been posted (or reposted) by the bot. Requires the can_manage_stories business bot right for both business accounts. Returns Story on success.

type RepostStoryParams struct {
    // Unique identifier of the business connection
    BusinessConnectionID string `json:"business_connection_id"`
    // Unique identifier of the chat which posted the story that should be reposted
    FromChatID int64 `json:"from_chat_id"`
    // Unique identifier of the story that should be reposted
    FromStoryID int64 `json:"from_story_id"`
    // Period after which the story is moved to the archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400
    ActivePeriod int64 `json:"active_period"`
    // Pass True to keep the story accessible after it expires
    PostToChatPage *bool `json:"post_to_chat_page,omitempty"`
    // Pass True if the content of the story must be protected from forwarding and screenshotting
    ProtectContent *bool `json:"protect_content,omitempty"`
}

type ResponseParameters

ResponseParameters is the optional metadata Telegram includes on certain failures. The most common is RetryAfter (seconds) on 429 responses.

https://core.telegram.org/bots/api#responseparameters

type ResponseParameters struct {
    MigrateToChatID int64 `json:"migrate_to_chat_id,omitempty"`
    RetryAfter      int   `json:"retry_after,omitempty"`
}

type RestrictChatMemberParams

RestrictChatMemberParams is the parameter set for 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.

type RestrictChatMemberParams struct {
    // Unique identifier for the target chat or username of the target supergroup in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier of the target user
    UserID int64 `json:"user_id"`
    // A JSON-serialized object for new user permissions
    Permissions ChatPermissions `json:"permissions"`
    // Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.
    UseIndependentChatPermissions *bool `json:"use_independent_chat_permissions,omitempty"`
    // Date when restrictions will be lifted for the user; Unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever.
    UntilDate *int64 `json:"until_date,omitempty"`
}

type RevenueWithdrawalState

RevenueWithdrawalState is a union type. The following concrete variants implement it:

  • RevenueWithdrawalStatePending
  • RevenueWithdrawalStateSucceeded
  • RevenueWithdrawalStateFailed

This object describes the state of a revenue withdrawal operation. Currently, it can be one of

type RevenueWithdrawalState interface {
    // contains filtered or unexported methods
}

func UnmarshalRevenueWithdrawalState

func UnmarshalRevenueWithdrawalState(data []byte) (RevenueWithdrawalState, error)

UnmarshalRevenueWithdrawalState decodes a RevenueWithdrawalState from JSON by inspecting the "type" field and dispatching to the correct concrete type.

type RevenueWithdrawalStateFailed

The withdrawal failed and the transaction was refunded.

type RevenueWithdrawalStateFailed struct {
    // Type of the state, always “failed”
    Type RevenueWithdrawalStateKind `json:"type"`
}

func (*RevenueWithdrawalStateFailed) MarshalJSON

func (v *RevenueWithdrawalStateFailed) MarshalJSON() ([]byte, error)

MarshalJSON encodes RevenueWithdrawalStateFailed with the discriminator field "type" forced to "failed". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type RevenueWithdrawalStateKind

type RevenueWithdrawalStateKind string


const (
    RevenueWithdrawalStateKindPending   RevenueWithdrawalStateKind = "pending"
    RevenueWithdrawalStateKindSucceeded RevenueWithdrawalStateKind = "succeeded"
    RevenueWithdrawalStateKindFailed    RevenueWithdrawalStateKind = "failed"
)

type RevenueWithdrawalStatePending

The withdrawal is in progress.

type RevenueWithdrawalStatePending struct {
    // Type of the state, always “pending”
    Type RevenueWithdrawalStateKind `json:"type"`
}

func (*RevenueWithdrawalStatePending) MarshalJSON

func (v *RevenueWithdrawalStatePending) MarshalJSON() ([]byte, error)

MarshalJSON encodes RevenueWithdrawalStatePending with the discriminator field "type" forced to "pending". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type RevenueWithdrawalStateSucceeded

The withdrawal succeeded.

type RevenueWithdrawalStateSucceeded struct {
    // Type of the state, always “succeeded”
    Type RevenueWithdrawalStateKind `json:"type"`
    // Date the withdrawal was completed in Unix time
    Date int64 `json:"date"`
    // An HTTPS URL that can be used to see transaction details
    URL string `json:"url"`
}

func (*RevenueWithdrawalStateSucceeded) MarshalJSON

func (v *RevenueWithdrawalStateSucceeded) MarshalJSON() ([]byte, error)

MarshalJSON encodes RevenueWithdrawalStateSucceeded with the discriminator field "type" forced to "succeeded". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type RevokeChatInviteLinkParams

RevokeChatInviteLinkParams is the parameter set for 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.

type RevokeChatInviteLinkParams struct {
    // Unique identifier of the target chat or username of the target channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // The invite link to revoke
    InviteLink string `json:"invite_link"`
}

type SavePreparedInlineMessageParams

SavePreparedInlineMessageParams is the parameter set for SavePreparedInlineMessage.

Stores a message that can be sent by a user of a Mini App. Returns a PreparedInlineMessage object.

type SavePreparedInlineMessageParams struct {
    // Unique identifier of the target user that can use the prepared message
    UserID int64 `json:"user_id"`
    // A JSON-serialized object describing the message to be sent
    Result InlineQueryResult `json:"result"`
    // Pass True if the message can be sent to private chats with users
    AllowUserChats *bool `json:"allow_user_chats,omitempty"`
    // Pass True if the message can be sent to private chats with bots
    AllowBotChats *bool `json:"allow_bot_chats,omitempty"`
    // Pass True if the message can be sent to group and supergroup chats
    AllowGroupChats *bool `json:"allow_group_chats,omitempty"`
    // Pass True if the message can be sent to channel chats
    AllowChannelChats *bool `json:"allow_channel_chats,omitempty"`
}

type SavePreparedKeyboardButtonParams

SavePreparedKeyboardButtonParams is the parameter set for SavePreparedKeyboardButton.

Stores a keyboard button that can be used by a user within a Mini App. Returns a PreparedKeyboardButton object.

type SavePreparedKeyboardButtonParams struct {
    // Unique identifier of the target user that can use the button
    UserID int64 `json:"user_id"`
    // A JSON-serialized object describing the button to be saved. The button must be of the type request_users, request_chat, or request_managed_bot.
    Button KeyboardButton `json:"button"`
}

type SendAnimationParams

SendAnimationParams is the parameter set for 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.

type SendAnimationParams struct {
    // Unique identifier of the business connection on behalf of which the message will be sent
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
    MessageThreadID *int64 `json:"message_thread_id,omitempty"`
    // Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
    DirectMessagesTopicID *int64 `json:"direct_messages_topic_id,omitempty"`
    // 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 »
    Animation *InputFile `json:"animation"`
    // Duration of sent animation in seconds
    Duration *int64 `json:"duration,omitempty"`
    // Animation width
    Width *int64 `json:"width,omitempty"`
    // Animation height
    Height *int64 `json:"height,omitempty"`
    // Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
    Thumbnail *InputFile `json:"thumbnail,omitempty"`
    // Animation caption (may also be used when resending animation by file_id), 0-1024 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Mode for parsing entities in the animation caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Pass True, if the caption must be shown above the message media
    ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
    // Pass True if the animation needs to be covered with a spoiler animation
    HasSpoiler *bool `json:"has_spoiler,omitempty"`
    // Sends the message silently. Users will receive a notification with no sound.
    DisableNotification *bool `json:"disable_notification,omitempty"`
    // Protects the contents of the sent message from forwarding and saving
    ProtectContent *bool `json:"protect_content,omitempty"`
    // Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
    AllowPaidBroadcast *bool `json:"allow_paid_broadcast,omitempty"`
    // Unique identifier of the message effect to be added to the message; for private chats only
    MessageEffectID string `json:"message_effect_id,omitempty"`
    // A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
    SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
    // Description of the message to reply to
    ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
    // Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
    ReplyMarkup any `json:"reply_markup,omitempty"`
}

func (*SendAnimationParams) HasFile

func (p *SendAnimationParams) HasFile() bool

HasFile reports whether a multipart upload is required.

func (*SendAnimationParams) MultipartFields

func (p *SendAnimationParams) MultipartFields() map[string]string

MultipartFields returns the non-file fields used in the multipart body.

func (*SendAnimationParams) MultipartFiles

func (p *SendAnimationParams) MultipartFiles() []client.MultipartFile

MultipartFiles returns the file parts.

type SendAudioParams

SendAudioParams is the parameter set for 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.

type SendAudioParams struct {
    // Unique identifier of the business connection on behalf of which the message will be sent
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
    MessageThreadID *int64 `json:"message_thread_id,omitempty"`
    // Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
    DirectMessagesTopicID *int64 `json:"direct_messages_topic_id,omitempty"`
    // 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 »
    Audio *InputFile `json:"audio"`
    // Audio caption, 0-1024 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Mode for parsing entities in the audio caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Duration of the audio in seconds
    Duration *int64 `json:"duration,omitempty"`
    // Performer
    Performer string `json:"performer,omitempty"`
    // Track name
    Title string `json:"title,omitempty"`
    // Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
    Thumbnail *InputFile `json:"thumbnail,omitempty"`
    // Sends the message silently. Users will receive a notification with no sound.
    DisableNotification *bool `json:"disable_notification,omitempty"`
    // Protects the contents of the sent message from forwarding and saving
    ProtectContent *bool `json:"protect_content,omitempty"`
    // Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
    AllowPaidBroadcast *bool `json:"allow_paid_broadcast,omitempty"`
    // Unique identifier of the message effect to be added to the message; for private chats only
    MessageEffectID string `json:"message_effect_id,omitempty"`
    // A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
    SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
    // Description of the message to reply to
    ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
    // Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
    ReplyMarkup any `json:"reply_markup,omitempty"`
}

func (*SendAudioParams) HasFile

func (p *SendAudioParams) HasFile() bool

HasFile reports whether a multipart upload is required.

func (*SendAudioParams) MultipartFields

func (p *SendAudioParams) MultipartFields() map[string]string

MultipartFields returns the non-file fields used in the multipart body.

func (*SendAudioParams) MultipartFiles

func (p *SendAudioParams) MultipartFiles() []client.MultipartFile

MultipartFiles returns the file parts.

type SendChatActionParams

SendChatActionParams is the parameter set for 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. Example: The ImageBot needs some time to process a request and upload the image. Instead of sending a text message along the lines of “Retrieving image, please wait…”, the bot may use sendChatAction with action = upload_photo. The user will see a “sending photo” status for the bot. We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.

type SendChatActionParams struct {
    // Unique identifier of the business connection on behalf of which the action will be sent
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Unique identifier for the target chat or username of the target bot or supergroup in the format @username. Channel chats and channel direct messages chats aren't supported.
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message thread or topic of a forum; for supergroups and private chats of bots with forum topic mode enabled only
    MessageThreadID *int64 `json:"message_thread_id,omitempty"`
    // 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.
    Action string `json:"action"`
}

type SendChecklistParams

SendChecklistParams is the parameter set for SendChecklist.

Use this method to send a checklist on behalf of a connected business account. On success, the sent Message is returned.

type SendChecklistParams struct {
    // Unique identifier of the business connection on behalf of which the message will be sent
    BusinessConnectionID string `json:"business_connection_id"`
    // Unique identifier for the target chat or username of the target bot in the format @username
    ChatID ChatID `json:"chat_id"`
    // A JSON-serialized object for the checklist to send
    Checklist InputChecklist `json:"checklist"`
    // Sends the message silently. Users will receive a notification with no sound.
    DisableNotification *bool `json:"disable_notification,omitempty"`
    // Protects the contents of the sent message from forwarding and saving
    ProtectContent *bool `json:"protect_content,omitempty"`
    // Unique identifier of the message effect to be added to the message
    MessageEffectID string `json:"message_effect_id,omitempty"`
    // A JSON-serialized object for description of the message to reply to
    ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
    // A JSON-serialized object for an inline keyboard
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

type SendContactParams

SendContactParams is the parameter set for SendContact.

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

type SendContactParams struct {
    // Unique identifier of the business connection on behalf of which the message will be sent
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
    MessageThreadID *int64 `json:"message_thread_id,omitempty"`
    // Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
    DirectMessagesTopicID *int64 `json:"direct_messages_topic_id,omitempty"`
    // Contact's phone number
    PhoneNumber string `json:"phone_number"`
    // Contact's first name
    FirstName string `json:"first_name"`
    // Contact's last name
    LastName string `json:"last_name,omitempty"`
    // Additional data about the contact in the form of a vCard, 0-2048 bytes
    Vcard string `json:"vcard,omitempty"`
    // Sends the message silently. Users will receive a notification with no sound.
    DisableNotification *bool `json:"disable_notification,omitempty"`
    // Protects the contents of the sent message from forwarding and saving
    ProtectContent *bool `json:"protect_content,omitempty"`
    // Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
    AllowPaidBroadcast *bool `json:"allow_paid_broadcast,omitempty"`
    // Unique identifier of the message effect to be added to the message; for private chats only
    MessageEffectID string `json:"message_effect_id,omitempty"`
    // A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
    SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
    // Description of the message to reply to
    ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
    // Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
    ReplyMarkup any `json:"reply_markup,omitempty"`
}

type SendDiceParams

SendDiceParams is the parameter set for SendDice.

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

type SendDiceParams struct {
    // Unique identifier of the business connection on behalf of which the message will be sent
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
    MessageThreadID *int64 `json:"message_thread_id,omitempty"`
    // Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
    DirectMessagesTopicID *int64 `json:"direct_messages_topic_id,omitempty"`
    // Emoji on which the dice throw animation is based. Currently, must be one of “”, “”, “”, “”, “”, or “”. Dice can have values 1-6 for “”, “” and “”, values 1-5 for “” and “”, and values 1-64 for “”. Defaults to “”.
    Emoji DiceEmoji `json:"emoji,omitempty"`
    // Sends the message silently. Users will receive a notification with no sound.
    DisableNotification *bool `json:"disable_notification,omitempty"`
    // Protects the contents of the sent message from forwarding
    ProtectContent *bool `json:"protect_content,omitempty"`
    // Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
    AllowPaidBroadcast *bool `json:"allow_paid_broadcast,omitempty"`
    // Unique identifier of the message effect to be added to the message; for private chats only
    MessageEffectID string `json:"message_effect_id,omitempty"`
    // A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
    SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
    // Description of the message to reply to
    ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
    // Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
    ReplyMarkup any `json:"reply_markup,omitempty"`
}

type SendDocumentParams

SendDocumentParams is the parameter set for 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.

type SendDocumentParams struct {
    // Unique identifier of the business connection on behalf of which the message will be sent
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
    MessageThreadID *int64 `json:"message_thread_id,omitempty"`
    // Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
    DirectMessagesTopicID *int64 `json:"direct_messages_topic_id,omitempty"`
    // 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 »
    Document *InputFile `json:"document"`
    // Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
    Thumbnail *InputFile `json:"thumbnail,omitempty"`
    // Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Mode for parsing entities in the document caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Disables automatic server-side content type detection for files uploaded using multipart/form-data
    DisableContentTypeDetection *bool `json:"disable_content_type_detection,omitempty"`
    // Sends the message silently. Users will receive a notification with no sound.
    DisableNotification *bool `json:"disable_notification,omitempty"`
    // Protects the contents of the sent message from forwarding and saving
    ProtectContent *bool `json:"protect_content,omitempty"`
    // Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
    AllowPaidBroadcast *bool `json:"allow_paid_broadcast,omitempty"`
    // Unique identifier of the message effect to be added to the message; for private chats only
    MessageEffectID string `json:"message_effect_id,omitempty"`
    // A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
    SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
    // Description of the message to reply to
    ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
    // Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
    ReplyMarkup any `json:"reply_markup,omitempty"`
}

func (*SendDocumentParams) HasFile

func (p *SendDocumentParams) HasFile() bool

HasFile reports whether a multipart upload is required.

func (*SendDocumentParams) MultipartFields

func (p *SendDocumentParams) MultipartFields() map[string]string

MultipartFields returns the non-file fields used in the multipart body.

func (*SendDocumentParams) MultipartFiles

func (p *SendDocumentParams) MultipartFiles() []client.MultipartFile

MultipartFiles returns the file parts.

type SendGameParams

SendGameParams is the parameter set for SendGame.

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

type SendGameParams struct {
    // Unique identifier of the business connection on behalf of which the message will be sent
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Unique identifier for the target chat or username of the target bot in the format @username. Games can't be sent to channel direct messages chats and channel chats.
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
    MessageThreadID *int64 `json:"message_thread_id,omitempty"`
    // Short name of the game, serves as the unique identifier for the game. Set up your games via @BotFather.
    GameShortName string `json:"game_short_name"`
    // Sends the message silently. Users will receive a notification with no sound.
    DisableNotification *bool `json:"disable_notification,omitempty"`
    // Protects the contents of the sent message from forwarding and saving
    ProtectContent *bool `json:"protect_content,omitempty"`
    // Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
    AllowPaidBroadcast *bool `json:"allow_paid_broadcast,omitempty"`
    // Unique identifier of the message effect to be added to the message; for private chats only
    MessageEffectID string `json:"message_effect_id,omitempty"`
    // Description of the message to reply to
    ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
    // A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game.
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

type SendGiftParams

SendGiftParams is the parameter set for SendGift.

Sends a gift to the given user or channel chat. The gift can't be converted to Telegram Stars by the receiver. Returns True on success.

type SendGiftParams struct {
    // Required if chat_id is not specified. Unique identifier of the target user who will receive the gift.
    UserID *int64 `json:"user_id,omitempty"`
    // Required if user_id is not specified. Unique identifier for the chat or username of the channel (in the format @username) that will receive the gift.
    ChatID *ChatID `json:"chat_id,omitempty"`
    // Identifier of the gift; limited gifts can't be sent to channel chats
    GiftID string `json:"gift_id"`
    // Pass True to pay for the gift upgrade from the bot's balance, thereby making the upgrade free for the receiver
    PayForUpgrade *bool `json:"pay_for_upgrade,omitempty"`
    // Text that will be shown along with the gift; 0-128 characters
    Text string `json:"text,omitempty"`
    // Mode for parsing entities in the text. See formatting options for more details. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored.
    TextParseMode ParseMode `json:"text_parse_mode,omitempty"`
    // A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of text_parse_mode. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored.
    TextEntities []MessageEntity `json:"text_entities,omitempty"`
}

type SendInvoiceParams

SendInvoiceParams is the parameter set for SendInvoice.

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

type SendInvoiceParams struct {
    // Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
    MessageThreadID *int64 `json:"message_thread_id,omitempty"`
    // Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
    DirectMessagesTopicID *int64 `json:"direct_messages_topic_id,omitempty"`
    // Product name, 1-32 characters
    Title string `json:"title"`
    // Product description, 1-255 characters
    Description string `json:"description"`
    // Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.
    Payload string `json:"payload"`
    // Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.
    ProviderToken string `json:"provider_token,omitempty"`
    // Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars.
    Currency string `json:"currency"`
    // Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars.
    Prices []LabeledPrice `json:"prices"`
    // The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars.
    MaxTipAmount *int64 `json:"max_tip_amount,omitempty"`
    // A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.
    SuggestedTipAmounts []int64 `json:"suggested_tip_amounts,omitempty"`
    // Unique deep-linking parameter. If left empty, forwarded copies of the sent message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using the same invoice. If non-empty, forwarded copies of the sent message will have a URL button with a deep link to the bot (instead of a Pay button), with the value used as the start parameter.
    StartParameter string `json:"start_parameter,omitempty"`
    // JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.
    ProviderData string `json:"provider_data,omitempty"`
    // URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.
    PhotoURL string `json:"photo_url,omitempty"`
    // Photo size in bytes
    PhotoSize *int64 `json:"photo_size,omitempty"`
    // Photo width
    PhotoWidth *int64 `json:"photo_width,omitempty"`
    // Photo height
    PhotoHeight *int64 `json:"photo_height,omitempty"`
    // Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars.
    NeedName *bool `json:"need_name,omitempty"`
    // Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars.
    NeedPhoneNumber *bool `json:"need_phone_number,omitempty"`
    // Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars.
    NeedEmail *bool `json:"need_email,omitempty"`
    // Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars.
    NeedShippingAddress *bool `json:"need_shipping_address,omitempty"`
    // Pass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars.
    SendPhoneNumberToProvider *bool `json:"send_phone_number_to_provider,omitempty"`
    // Pass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars.
    SendEmailToProvider *bool `json:"send_email_to_provider,omitempty"`
    // Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars.
    IsFlexible *bool `json:"is_flexible,omitempty"`
    // Sends the message silently. Users will receive a notification with no sound.
    DisableNotification *bool `json:"disable_notification,omitempty"`
    // Protects the contents of the sent message from forwarding and saving
    ProtectContent *bool `json:"protect_content,omitempty"`
    // Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
    AllowPaidBroadcast *bool `json:"allow_paid_broadcast,omitempty"`
    // Unique identifier of the message effect to be added to the message; for private chats only
    MessageEffectID string `json:"message_effect_id,omitempty"`
    // A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
    SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
    // Description of the message to reply to
    ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
    // A JSON-serialized object for an inline keyboard. If empty, one 'Pay total price' button will be shown. If not empty, the first button must be a Pay button.
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

type SendLivePhotoParams

SendLivePhotoParams is the parameter set for SendLivePhoto.

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

type SendLivePhotoParams struct {
    // Unique identifier of the business connection on behalf of which the message will be sent
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Unique identifier for the target chat or username of the target channel (in the format @channelusername)
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
    MessageThreadID *int64 `json:"message_thread_id,omitempty"`
    // Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
    DirectMessagesTopicID *int64 `json:"direct_messages_topic_id,omitempty"`
    // Live photo video to send. The video must be no longer than 10 seconds and must not exceed 10 MB in size. Pass a file_id as String to send a video that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending live photos by a URL is currently unsupported.
    LivePhoto *InputFile `json:"live_photo"`
    // The static photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending live photos by a URL is currently unsupported.
    Photo *InputFile `json:"photo"`
    // Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Mode for parsing entities in the video caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Pass True, if the caption must be shown above the message media
    ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
    // Pass True if the video needs to be covered with a spoiler animation
    HasSpoiler *bool `json:"has_spoiler,omitempty"`
    // Sends the message silently. Users will receive a notification with no sound.
    DisableNotification *bool `json:"disable_notification,omitempty"`
    // Protects the contents of the sent message from forwarding and saving
    ProtectContent *bool `json:"protect_content,omitempty"`
    // Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
    AllowPaidBroadcast *bool `json:"allow_paid_broadcast,omitempty"`
    // Unique identifier of the message effect to be added to the message; for private chats only
    MessageEffectID string `json:"message_effect_id,omitempty"`
    // A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
    SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
    // Description of the message to reply to
    ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
    // Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
    ReplyMarkup any `json:"reply_markup,omitempty"`
}

func (*SendLivePhotoParams) HasFile

func (p *SendLivePhotoParams) HasFile() bool

HasFile reports whether a multipart upload is required.

func (*SendLivePhotoParams) MultipartFields

func (p *SendLivePhotoParams) MultipartFields() map[string]string

MultipartFields returns the non-file fields used in the multipart body.

func (*SendLivePhotoParams) MultipartFiles

func (p *SendLivePhotoParams) MultipartFiles() []client.MultipartFile

MultipartFiles returns the file parts.

type SendLocationParams

SendLocationParams is the parameter set for SendLocation.

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

type SendLocationParams struct {
    // Unique identifier of the business connection on behalf of which the message will be sent
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
    MessageThreadID *int64 `json:"message_thread_id,omitempty"`
    // Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
    DirectMessagesTopicID *int64 `json:"direct_messages_topic_id,omitempty"`
    // Latitude of the location
    Latitude float64 `json:"latitude"`
    // Longitude of the location
    Longitude float64 `json:"longitude"`
    // The radius of uncertainty for the location, measured in meters; 0-1500
    HorizontalAccuracy *float64 `json:"horizontal_accuracy,omitempty"`
    // Period in seconds during which the location will be updated (see Live Locations, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely
    LivePeriod *int64 `json:"live_period,omitempty"`
    // For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.
    Heading *int64 `json:"heading,omitempty"`
    // For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.
    ProximityAlertRadius *int64 `json:"proximity_alert_radius,omitempty"`
    // Sends the message silently. Users will receive a notification with no sound.
    DisableNotification *bool `json:"disable_notification,omitempty"`
    // Protects the contents of the sent message from forwarding and saving
    ProtectContent *bool `json:"protect_content,omitempty"`
    // Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
    AllowPaidBroadcast *bool `json:"allow_paid_broadcast,omitempty"`
    // Unique identifier of the message effect to be added to the message; for private chats only
    MessageEffectID string `json:"message_effect_id,omitempty"`
    // A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
    SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
    // Description of the message to reply to
    ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
    // Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
    ReplyMarkup any `json:"reply_markup,omitempty"`
}

type SendMediaGroupParams

SendMediaGroupParams is the parameter set for SendMediaGroup.

Use this method to send a group of photos, live 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 Message objects that were sent is returned.

type SendMediaGroupParams struct {
    // Unique identifier of the business connection on behalf of which the message will be sent
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
    MessageThreadID *int64 `json:"message_thread_id,omitempty"`
    // Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat
    DirectMessagesTopicID *int64 `json:"direct_messages_topic_id,omitempty"`
    // A JSON-serialized array describing messages to be sent, must include 2-10 items
    Media []any `json:"media"`
    // Sends messages silently. Users will receive a notification with no sound.
    DisableNotification *bool `json:"disable_notification,omitempty"`
    // Protects the contents of the sent messages from forwarding and saving
    ProtectContent *bool `json:"protect_content,omitempty"`
    // Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
    AllowPaidBroadcast *bool `json:"allow_paid_broadcast,omitempty"`
    // Unique identifier of the message effect to be added to the message; for private chats only
    MessageEffectID string `json:"message_effect_id,omitempty"`
    // Description of the message to reply to
    ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
}

func (*SendMediaGroupParams) HasFile

func (p *SendMediaGroupParams) HasFile() bool

HasFile reports whether a multipart upload is required.

func (*SendMediaGroupParams) MultipartFields

func (p *SendMediaGroupParams) MultipartFields() map[string]string

MultipartFields returns the non-file fields used in the multipart body.

func (*SendMediaGroupParams) MultipartFiles

func (p *SendMediaGroupParams) MultipartFiles() []client.MultipartFile

MultipartFiles returns the file parts.

type SendMessageDraftParams

SendMessageDraftParams is the parameter set for SendMessageDraft.

Use this method to stream a partial message to a user while the message is being generated. Note that the streamed draft is ephemeral and acts as a temporary 30-second preview - once the output is finalized, you must call sendMessage with the complete message to persist it in the user's chat. Returns True on success.

type SendMessageDraftParams struct {
    // Unique identifier for the target private chat
    ChatID int64 `json:"chat_id"`
    // Unique identifier for the target message thread
    MessageThreadID *int64 `json:"message_thread_id,omitempty"`
    // Unique identifier of the message draft; must be non-zero. Changes of drafts with the same identifier are animated.
    DraftID int64 `json:"draft_id"`
    // Text of the message to be sent, 0-4096 characters after entities parsing. Pass an empty text to show a “Thinking…” placeholder.
    Text string `json:"text,omitempty"`
    // Mode for parsing entities in the message text. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode
    Entities []MessageEntity `json:"entities,omitempty"`
}

type SendMessageParams

SendMessageParams is the parameter set for SendMessage.

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

type SendMessageParams struct {
    // Unique identifier of the business connection on behalf of which the message will be sent
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
    MessageThreadID *int64 `json:"message_thread_id,omitempty"`
    // Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
    DirectMessagesTopicID *int64 `json:"direct_messages_topic_id,omitempty"`
    // Text of the message to be sent, 1-4096 characters after entities parsing
    Text string `json:"text"`
    // Mode for parsing entities in the message text. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode
    Entities []MessageEntity `json:"entities,omitempty"`
    // Link preview generation options for the message
    LinkPreviewOptions *LinkPreviewOptions `json:"link_preview_options,omitempty"`
    // Sends the message silently. Users will receive a notification with no sound.
    DisableNotification *bool `json:"disable_notification,omitempty"`
    // Protects the contents of the sent message from forwarding and saving
    ProtectContent *bool `json:"protect_content,omitempty"`
    // Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
    AllowPaidBroadcast *bool `json:"allow_paid_broadcast,omitempty"`
    // Unique identifier of the message effect to be added to the message; for private chats only
    MessageEffectID string `json:"message_effect_id,omitempty"`
    // A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
    SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
    // Description of the message to reply to
    ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
    // Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
    ReplyMarkup any `json:"reply_markup,omitempty"`
}

type SendPaidMediaParams

SendPaidMediaParams is the parameter set for SendPaidMedia.

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

type SendPaidMediaParams struct {
    // Unique identifier of the business connection on behalf of which the message will be sent
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. If the chat is a channel, all Telegram Star proceeds from this media will be credited to the chat's balance. Otherwise, they will be credited to the bot's balance.
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
    MessageThreadID *int64 `json:"message_thread_id,omitempty"`
    // Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
    DirectMessagesTopicID *int64 `json:"direct_messages_topic_id,omitempty"`
    // The number of Telegram Stars that must be paid to buy access to the media; 1-25000
    StarCount int64 `json:"star_count"`
    // A JSON-serialized array describing the media to be sent; up to 10 items
    Media []InputPaidMedia `json:"media"`
    // Bot-defined paid media payload, 0-128 bytes. This will not be displayed to the user, use it for your internal processes.
    Payload string `json:"payload,omitempty"`
    // Media caption, 0-1024 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Mode for parsing entities in the media caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Pass True, if the caption must be shown above the message media
    ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
    // Sends the message silently. Users will receive a notification with no sound.
    DisableNotification *bool `json:"disable_notification,omitempty"`
    // Protects the contents of the sent message from forwarding and saving
    ProtectContent *bool `json:"protect_content,omitempty"`
    // Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
    AllowPaidBroadcast *bool `json:"allow_paid_broadcast,omitempty"`
    // A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
    SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
    // Description of the message to reply to
    ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
    // Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
    ReplyMarkup any `json:"reply_markup,omitempty"`
}

func (*SendPaidMediaParams) HasFile

func (p *SendPaidMediaParams) HasFile() bool

HasFile reports whether a multipart upload is required.

func (*SendPaidMediaParams) MultipartFields

func (p *SendPaidMediaParams) MultipartFields() map[string]string

MultipartFields returns the non-file fields used in the multipart body.

func (*SendPaidMediaParams) MultipartFiles

func (p *SendPaidMediaParams) MultipartFiles() []client.MultipartFile

MultipartFiles returns the file parts.

type SendPhotoParams

SendPhotoParams is the parameter set for SendPhoto.

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

type SendPhotoParams struct {
    // Unique identifier of the business connection on behalf of which the message will be sent
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
    MessageThreadID *int64 `json:"message_thread_id,omitempty"`
    // Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
    DirectMessagesTopicID *int64 `json:"direct_messages_topic_id,omitempty"`
    // 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 »
    Photo *InputFile `json:"photo"`
    // Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Mode for parsing entities in the photo caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Pass True, if the caption must be shown above the message media
    ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
    // Pass True if the photo needs to be covered with a spoiler animation
    HasSpoiler *bool `json:"has_spoiler,omitempty"`
    // Sends the message silently. Users will receive a notification with no sound.
    DisableNotification *bool `json:"disable_notification,omitempty"`
    // Protects the contents of the sent message from forwarding and saving
    ProtectContent *bool `json:"protect_content,omitempty"`
    // Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
    AllowPaidBroadcast *bool `json:"allow_paid_broadcast,omitempty"`
    // Unique identifier of the message effect to be added to the message; for private chats only
    MessageEffectID string `json:"message_effect_id,omitempty"`
    // A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
    SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
    // Description of the message to reply to
    ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
    // Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
    ReplyMarkup any `json:"reply_markup,omitempty"`
}

func (*SendPhotoParams) HasFile

func (p *SendPhotoParams) HasFile() bool

HasFile reports whether a multipart upload is required.

func (*SendPhotoParams) MultipartFields

func (p *SendPhotoParams) MultipartFields() map[string]string

MultipartFields returns the non-file fields used in the multipart body.

func (*SendPhotoParams) MultipartFiles

func (p *SendPhotoParams) MultipartFiles() []client.MultipartFile

MultipartFiles returns the file parts.

type SendPollParams

SendPollParams is the parameter set for SendPoll.

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

type SendPollParams struct {
    // Unique identifier of the business connection on behalf of which the message will be sent
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. Polls can't be sent to channel direct messages chats.
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
    MessageThreadID *int64 `json:"message_thread_id,omitempty"`
    // Poll question, 1-300 characters
    Question string `json:"question"`
    // Mode for parsing entities in the question. See formatting options for more details. Currently, only custom emoji entities are allowed.
    QuestionParseMode ParseMode `json:"question_parse_mode,omitempty"`
    // A JSON-serialized list of special entities that appear in the poll question. It can be specified instead of question_parse_mode.
    QuestionEntities []MessageEntity `json:"question_entities,omitempty"`
    // A JSON-serialized list of 1-12 answer options
    Options []InputPollOption `json:"options"`
    // True, if the poll needs to be anonymous, defaults to True
    IsAnonymous *bool `json:"is_anonymous,omitempty"`
    // Poll type, “quiz” or “regular”, defaults to “regular”
    Type string `json:"type,omitempty"`
    // Pass True, if the poll allows multiple answers, defaults to False
    AllowsMultipleAnswers *bool `json:"allows_multiple_answers,omitempty"`
    // Pass True, if the poll allows to change chosen answer options, defaults to False for quizzes and to True for regular polls
    AllowsRevoting *bool `json:"allows_revoting,omitempty"`
    // Pass True, if the poll options must be shown in random order
    ShuffleOptions *bool `json:"shuffle_options,omitempty"`
    // Pass True, if answer options can be added to the poll after creation; not supported for anonymous polls and quizzes
    AllowAddingOptions *bool `json:"allow_adding_options,omitempty"`
    // Pass True, if poll results must be shown only after the poll closes
    HideResultsUntilCloses *bool `json:"hide_results_until_closes,omitempty"`
    // Pass True, if voting is limited to users who have been members of the chat where the poll is being sent for more than 24 hours; for channel chats only
    MembersOnly *bool `json:"members_only,omitempty"`
    // A JSON-serialized list of 0-12 two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which users can vote in the poll; for channel chats only. Use “FT” as a country code to allow users with anonymous numbers to vote. If omitted or empty, then users from any country can participate in the poll.
    CountryCodes []string `json:"country_codes,omitempty"`
    // A JSON-serialized list of monotonically increasing 0-based identifiers of the correct answer options, required for polls in quiz mode
    CorrectOptionIds []int64 `json:"correct_option_ids,omitempty"`
    // Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing
    Explanation string `json:"explanation,omitempty"`
    // Mode for parsing entities in the explanation. See formatting options for more details.
    ExplanationParseMode ParseMode `json:"explanation_parse_mode,omitempty"`
    // A JSON-serialized list of special entities that appear in the poll explanation. It can be specified instead of explanation_parse_mode.
    ExplanationEntities []MessageEntity `json:"explanation_entities,omitempty"`
    // Media added to the quiz explanation
    ExplanationMedia InputPollMedia `json:"explanation_media,omitempty"`
    // Amount of time in seconds the poll will be active after creation, 5-2628000. Can't be used together with close_date.
    OpenPeriod *int64 `json:"open_period,omitempty"`
    // Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 2628000 seconds in the future. Can't be used together with open_period.
    CloseDate *int64 `json:"close_date,omitempty"`
    // Pass True if the poll needs to be immediately closed. This can be useful for poll preview.
    IsClosed *bool `json:"is_closed,omitempty"`
    // Description of the poll to be sent, 0-1024 characters after entities parsing
    Description string `json:"description,omitempty"`
    // Mode for parsing entities in the poll description. See formatting options for more details.
    DescriptionParseMode ParseMode `json:"description_parse_mode,omitempty"`
    // A JSON-serialized list of special entities that appear in the poll description, which can be specified instead of description_parse_mode
    DescriptionEntities []MessageEntity `json:"description_entities,omitempty"`
    // Media added to the poll description
    Media InputPollMedia `json:"media,omitempty"`
    // Sends the message silently. Users will receive a notification with no sound.
    DisableNotification *bool `json:"disable_notification,omitempty"`
    // Protects the contents of the sent message from forwarding and saving
    ProtectContent *bool `json:"protect_content,omitempty"`
    // Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
    AllowPaidBroadcast *bool `json:"allow_paid_broadcast,omitempty"`
    // Unique identifier of the message effect to be added to the message; for private chats only
    MessageEffectID string `json:"message_effect_id,omitempty"`
    // Description of the message to reply to
    ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
    // Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
    ReplyMarkup any `json:"reply_markup,omitempty"`
}

type SendStickerParams

SendStickerParams is the parameter set for SendSticker.

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

type SendStickerParams struct {
    // Unique identifier of the business connection on behalf of which the message will be sent
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
    MessageThreadID *int64 `json:"message_thread_id,omitempty"`
    // Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
    DirectMessagesTopicID *int64 `json:"direct_messages_topic_id,omitempty"`
    // 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, .TGS, or .WEBM sticker using multipart/form-data. More information on Sending Files ». Video and animated stickers can't be sent via an HTTP URL.
    Sticker *InputFile `json:"sticker"`
    // Emoji associated with the sticker; only for just uploaded stickers
    Emoji string `json:"emoji,omitempty"`
    // Sends the message silently. Users will receive a notification with no sound.
    DisableNotification *bool `json:"disable_notification,omitempty"`
    // Protects the contents of the sent message from forwarding and saving
    ProtectContent *bool `json:"protect_content,omitempty"`
    // Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
    AllowPaidBroadcast *bool `json:"allow_paid_broadcast,omitempty"`
    // Unique identifier of the message effect to be added to the message; for private chats only
    MessageEffectID string `json:"message_effect_id,omitempty"`
    // A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
    SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
    // Description of the message to reply to
    ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
    // Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
    ReplyMarkup any `json:"reply_markup,omitempty"`
}

func (*SendStickerParams) HasFile

func (p *SendStickerParams) HasFile() bool

HasFile reports whether a multipart upload is required.

func (*SendStickerParams) MultipartFields

func (p *SendStickerParams) MultipartFields() map[string]string

MultipartFields returns the non-file fields used in the multipart body.

func (*SendStickerParams) MultipartFiles

func (p *SendStickerParams) MultipartFiles() []client.MultipartFile

MultipartFiles returns the file parts.

type SendVenueParams

SendVenueParams is the parameter set for SendVenue.

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

type SendVenueParams struct {
    // Unique identifier of the business connection on behalf of which the message will be sent
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
    MessageThreadID *int64 `json:"message_thread_id,omitempty"`
    // Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
    DirectMessagesTopicID *int64 `json:"direct_messages_topic_id,omitempty"`
    // Latitude of the venue
    Latitude float64 `json:"latitude"`
    // Longitude of the venue
    Longitude float64 `json:"longitude"`
    // Name of the venue
    Title string `json:"title"`
    // Address of the venue
    Address string `json:"address"`
    // Foursquare identifier of the venue
    FoursquareID string `json:"foursquare_id,omitempty"`
    // Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)
    FoursquareType string `json:"foursquare_type,omitempty"`
    // Google Places identifier of the venue
    GooglePlaceID string `json:"google_place_id,omitempty"`
    // Google Places type of the venue. (See supported types.)
    GooglePlaceType string `json:"google_place_type,omitempty"`
    // Sends the message silently. Users will receive a notification with no sound.
    DisableNotification *bool `json:"disable_notification,omitempty"`
    // Protects the contents of the sent message from forwarding and saving
    ProtectContent *bool `json:"protect_content,omitempty"`
    // Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
    AllowPaidBroadcast *bool `json:"allow_paid_broadcast,omitempty"`
    // Unique identifier of the message effect to be added to the message; for private chats only
    MessageEffectID string `json:"message_effect_id,omitempty"`
    // A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
    SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
    // Description of the message to reply to
    ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
    // Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
    ReplyMarkup any `json:"reply_markup,omitempty"`
}

type SendVideoNoteParams

SendVideoNoteParams is the parameter set for 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.

type SendVideoNoteParams struct {
    // Unique identifier of the business connection on behalf of which the message will be sent
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
    MessageThreadID *int64 `json:"message_thread_id,omitempty"`
    // Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
    DirectMessagesTopicID *int64 `json:"direct_messages_topic_id,omitempty"`
    // 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 ». Sending video notes by a URL is currently unsupported.
    VideoNote *InputFile `json:"video_note"`
    // Duration of sent video in seconds
    Duration *int64 `json:"duration,omitempty"`
    // Video width and height, i.e. diameter of the video message
    Length *int64 `json:"length,omitempty"`
    // Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
    Thumbnail *InputFile `json:"thumbnail,omitempty"`
    // Sends the message silently. Users will receive a notification with no sound.
    DisableNotification *bool `json:"disable_notification,omitempty"`
    // Protects the contents of the sent message from forwarding and saving
    ProtectContent *bool `json:"protect_content,omitempty"`
    // Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
    AllowPaidBroadcast *bool `json:"allow_paid_broadcast,omitempty"`
    // Unique identifier of the message effect to be added to the message; for private chats only
    MessageEffectID string `json:"message_effect_id,omitempty"`
    // A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
    SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
    // Description of the message to reply to
    ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
    // Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
    ReplyMarkup any `json:"reply_markup,omitempty"`
}

func (*SendVideoNoteParams) HasFile

func (p *SendVideoNoteParams) HasFile() bool

HasFile reports whether a multipart upload is required.

func (*SendVideoNoteParams) MultipartFields

func (p *SendVideoNoteParams) MultipartFields() map[string]string

MultipartFields returns the non-file fields used in the multipart body.

func (*SendVideoNoteParams) MultipartFiles

func (p *SendVideoNoteParams) MultipartFiles() []client.MultipartFile

MultipartFiles returns the file parts.

type SendVideoParams

SendVideoParams is the parameter set for 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.

type SendVideoParams struct {
    // Unique identifier of the business connection on behalf of which the message will be sent
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
    MessageThreadID *int64 `json:"message_thread_id,omitempty"`
    // Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
    DirectMessagesTopicID *int64 `json:"direct_messages_topic_id,omitempty"`
    // 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 »
    Video *InputFile `json:"video"`
    // Duration of sent video in seconds
    Duration *int64 `json:"duration,omitempty"`
    // Video width
    Width *int64 `json:"width,omitempty"`
    // Video height
    Height *int64 `json:"height,omitempty"`
    // Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
    Thumbnail *InputFile `json:"thumbnail,omitempty"`
    // Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »
    Cover *InputFile `json:"cover,omitempty"`
    // Start timestamp for the video in the message
    StartTimestamp *int64 `json:"start_timestamp,omitempty"`
    // Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Mode for parsing entities in the video caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Pass True, if the caption must be shown above the message media
    ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
    // Pass True if the video needs to be covered with a spoiler animation
    HasSpoiler *bool `json:"has_spoiler,omitempty"`
    // Pass True if the uploaded video is suitable for streaming
    SupportsStreaming *bool `json:"supports_streaming,omitempty"`
    // Sends the message silently. Users will receive a notification with no sound.
    DisableNotification *bool `json:"disable_notification,omitempty"`
    // Protects the contents of the sent message from forwarding and saving
    ProtectContent *bool `json:"protect_content,omitempty"`
    // Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
    AllowPaidBroadcast *bool `json:"allow_paid_broadcast,omitempty"`
    // Unique identifier of the message effect to be added to the message; for private chats only
    MessageEffectID string `json:"message_effect_id,omitempty"`
    // A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
    SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
    // Description of the message to reply to
    ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
    // Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
    ReplyMarkup any `json:"reply_markup,omitempty"`
}

func (*SendVideoParams) HasFile

func (p *SendVideoParams) HasFile() bool

HasFile reports whether a multipart upload is required.

func (*SendVideoParams) MultipartFields

func (p *SendVideoParams) MultipartFields() map[string]string

MultipartFields returns the non-file fields used in the multipart body.

func (*SendVideoParams) MultipartFiles

func (p *SendVideoParams) MultipartFiles() []client.MultipartFile

MultipartFiles returns the file parts.

type SendVoiceParams

SendVoiceParams is the parameter set for 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, or in .MP3 format, or in .M4A format (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.

type SendVoiceParams struct {
    // Unique identifier of the business connection on behalf of which the message will be sent
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
    MessageThreadID *int64 `json:"message_thread_id,omitempty"`
    // Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
    DirectMessagesTopicID *int64 `json:"direct_messages_topic_id,omitempty"`
    // 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 »
    Voice *InputFile `json:"voice"`
    // Voice message caption, 0-1024 characters after entities parsing
    Caption string `json:"caption,omitempty"`
    // Mode for parsing entities in the voice message caption. See formatting options for more details.
    ParseMode ParseMode `json:"parse_mode,omitempty"`
    // A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
    CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
    // Duration of the voice message in seconds
    Duration *int64 `json:"duration,omitempty"`
    // Sends the message silently. Users will receive a notification with no sound.
    DisableNotification *bool `json:"disable_notification,omitempty"`
    // Protects the contents of the sent message from forwarding and saving
    ProtectContent *bool `json:"protect_content,omitempty"`
    // Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
    AllowPaidBroadcast *bool `json:"allow_paid_broadcast,omitempty"`
    // Unique identifier of the message effect to be added to the message; for private chats only
    MessageEffectID string `json:"message_effect_id,omitempty"`
    // A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
    SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
    // Description of the message to reply to
    ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
    // Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
    ReplyMarkup any `json:"reply_markup,omitempty"`
}

func (*SendVoiceParams) HasFile

func (p *SendVoiceParams) HasFile() bool

HasFile reports whether a multipart upload is required.

func (*SendVoiceParams) MultipartFields

func (p *SendVoiceParams) MultipartFields() map[string]string

MultipartFields returns the non-file fields used in the multipart body.

func (*SendVoiceParams) MultipartFiles

func (p *SendVoiceParams) MultipartFiles() []client.MultipartFile

MultipartFiles returns the file parts.

type Sender

Sender condenses the various ways a Telegram update can identify the originator of a message or reaction into a single shape. Use the GetSender methods on supported types to construct one.

type Sender struct {
    // User is the human user who sent the update, when applicable.
    User *User
    // Chat is the chat that sent the update (channel forwards,
    // anonymous group admins, anonymous channel posts).
    Chat *Chat
    // IsAutomaticForward is true when the update originated as an
    // automatic forward from a linked channel.
    IsAutomaticForward bool
    // ChatID is the chat the update was delivered into. Used to
    // distinguish "this user" from "this anonymous admin posting
    // in <chat>" when User is nil.
    ChatID int64
    // AuthorSignature is the custom title of an anonymous group
    // administrator. Only meaningful when Chat == this chat.
    AuthorSignature string
}

func (*Sender) ID

func (s *Sender) ID() int64

ID returns the most-specific identifier available: prefers Chat.ID over User.ID. Returns 0 if neither is set.

func (*Sender) IsAnonymousAdmin

func (s *Sender) IsAnonymousAdmin() bool

IsAnonymousAdmin reports whether the sender is a group admin posting anonymously (Chat equals the message's own chat).

func (*Sender) IsAnonymousChannel

func (s *Sender) IsAnonymousChannel() bool

IsAnonymousChannel reports whether the sender is an anonymous channel post (Chat differs from the message's own chat).

type SentGuestMessage

Describes an inline message sent by a guest bot.

type SentGuestMessage struct {
    // Identifier of the sent inline message
    InlineMessageID string `json:"inline_message_id"`
}

func AnswerGuestQuery

func AnswerGuestQuery(ctx context.Context, b *client.Bot, p *AnswerGuestQueryParams) (*SentGuestMessage, error)

AnswerGuestQuery calls the answerGuestQuery Telegram Bot API method.

Use this method to reply to a received guest message. On success, a SentGuestMessage object is returned.

type SentWebAppMessage

Describes an inline message sent by a Web App on behalf of a user.

type SentWebAppMessage struct {
    // Optional. Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message.
    InlineMessageID string `json:"inline_message_id,omitempty"`
}

func AnswerWebAppQuery

func AnswerWebAppQuery(ctx context.Context, b *client.Bot, p *AnswerWebAppQueryParams) (*SentWebAppMessage, error)

AnswerWebAppQuery calls the answerWebAppQuery Telegram Bot API method.

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.

type SetBusinessAccountBioParams

SetBusinessAccountBioParams is the parameter set for SetBusinessAccountBio.

Changes the bio of a managed business account. Requires the can_change_bio business bot right. Returns True on success.

type SetBusinessAccountBioParams struct {
    // Unique identifier of the business connection
    BusinessConnectionID string `json:"business_connection_id"`
    // The new value of the bio for the business account; 0-140 characters
    Bio string `json:"bio,omitempty"`
}

type SetBusinessAccountGiftSettingsParams

SetBusinessAccountGiftSettingsParams is the parameter set for SetBusinessAccountGiftSettings.

Changes the privacy settings pertaining to incoming gifts in a managed business account. Requires the can_change_gift_settings business bot right. Returns True on success.

type SetBusinessAccountGiftSettingsParams struct {
    // Unique identifier of the business connection
    BusinessConnectionID string `json:"business_connection_id"`
    // Pass True, if a button for sending a gift to the user or by the business account must always be shown in the input field
    ShowGiftButton bool `json:"show_gift_button"`
    // Types of gifts accepted by the business account
    AcceptedGiftTypes AcceptedGiftTypes `json:"accepted_gift_types"`
}

type SetBusinessAccountNameParams

SetBusinessAccountNameParams is the parameter set for SetBusinessAccountName.

Changes the first and last name of a managed business account. Requires the can_change_name business bot right. Returns True on success.

type SetBusinessAccountNameParams struct {
    // Unique identifier of the business connection
    BusinessConnectionID string `json:"business_connection_id"`
    // The new value of the first name for the business account; 1-64 characters
    FirstName string `json:"first_name"`
    // The new value of the last name for the business account; 0-64 characters
    LastName string `json:"last_name,omitempty"`
}

type SetBusinessAccountProfilePhotoParams

SetBusinessAccountProfilePhotoParams is the parameter set for SetBusinessAccountProfilePhoto.

Changes the profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.

type SetBusinessAccountProfilePhotoParams struct {
    // Unique identifier of the business connection
    BusinessConnectionID string `json:"business_connection_id"`
    // The new profile photo to set
    Photo InputProfilePhoto `json:"photo"`
    // Pass True to set the public photo, which will be visible even if the main photo is hidden by the business account's privacy settings. An account can have only one public photo.
    IsPublic *bool `json:"is_public,omitempty"`
}

type SetBusinessAccountUsernameParams

SetBusinessAccountUsernameParams is the parameter set for SetBusinessAccountUsername.

Changes the username of a managed business account. Requires the can_change_username business bot right. Returns True on success.

type SetBusinessAccountUsernameParams struct {
    // Unique identifier of the business connection
    BusinessConnectionID string `json:"business_connection_id"`
    // The new value of the username for the business account; 0-32 characters
    Username string `json:"username,omitempty"`
}

type SetChatAdministratorCustomTitleParams

SetChatAdministratorCustomTitleParams is the parameter set for SetChatAdministratorCustomTitle.

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

type SetChatAdministratorCustomTitleParams struct {
    // Unique identifier for the target chat or username of the target supergroup in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier of the target user
    UserID int64 `json:"user_id"`
    // New custom title for the administrator; 0-16 characters, emoji are not allowed
    CustomTitle string `json:"custom_title"`
}

type SetChatDescriptionParams

SetChatDescriptionParams is the parameter set for 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.

type SetChatDescriptionParams struct {
    // Unique identifier for the target chat or username of the target channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // New chat description, 0-255 characters
    Description string `json:"description,omitempty"`
}

type SetChatMemberTagParams

SetChatMemberTagParams is the parameter set for SetChatMemberTag.

Use this method to set a tag for a regular member in a group or a supergroup. The bot must be an administrator in the chat for this to work and must have the can_manage_tags administrator right. Returns True on success.

type SetChatMemberTagParams struct {
    // Unique identifier for the target chat or username of the target supergroup in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier of the target user
    UserID int64 `json:"user_id"`
    // New tag for the member; 0-16 characters, emoji are not allowed
    Tag string `json:"tag,omitempty"`
}

type SetChatMenuButtonParams

SetChatMenuButtonParams is the parameter set for SetChatMenuButton.

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

type SetChatMenuButtonParams struct {
    // Unique identifier for the target private chat. If not specified, the bot's default menu button will be changed.
    ChatID *int64 `json:"chat_id,omitempty"`
    // A JSON-serialized object for the bot's new menu button. Defaults to MenuButtonDefault.
    MenuButton MenuButton `json:"menu_button,omitempty"`
}

type SetChatPermissionsParams

SetChatPermissionsParams is the parameter set for 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.

type SetChatPermissionsParams struct {
    // Unique identifier for the target chat or username of the target supergroup in the format @username
    ChatID ChatID `json:"chat_id"`
    // A JSON-serialized object for new default chat permissions
    Permissions ChatPermissions `json:"permissions"`
    // Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.
    UseIndependentChatPermissions *bool `json:"use_independent_chat_permissions,omitempty"`
}

type SetChatPhotoParams

SetChatPhotoParams is the parameter set for 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.

type SetChatPhotoParams struct {
    // Unique identifier for the target chat or username of the target channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // New chat photo, uploaded using multipart/form-data
    Photo *InputFile `json:"photo"`
}

func (*SetChatPhotoParams) HasFile

func (p *SetChatPhotoParams) HasFile() bool

HasFile reports whether a multipart upload is required.

func (*SetChatPhotoParams) MultipartFields

func (p *SetChatPhotoParams) MultipartFields() map[string]string

MultipartFields returns the non-file fields used in the multipart body.

func (*SetChatPhotoParams) MultipartFiles

func (p *SetChatPhotoParams) MultipartFiles() []client.MultipartFile

MultipartFiles returns the file parts.

type SetChatStickerSetParams

SetChatStickerSetParams is the parameter set for 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.

type SetChatStickerSetParams struct {
    // Unique identifier for the target chat or username of the target supergroup in the format @username
    ChatID ChatID `json:"chat_id"`
    // Name of the sticker set to be set as the group sticker set
    StickerSetName string `json:"sticker_set_name"`
}

type SetChatTitleParams

SetChatTitleParams is the parameter set for 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.

type SetChatTitleParams struct {
    // Unique identifier for the target chat or username of the target channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // New chat title, 1-128 characters
    Title string `json:"title"`
}

type SetCustomEmojiStickerSetThumbnailParams

SetCustomEmojiStickerSetThumbnailParams is the parameter set for SetCustomEmojiStickerSetThumbnail.

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

type SetCustomEmojiStickerSetThumbnailParams struct {
    // Sticker set name
    Name string `json:"name"`
    // Custom emoji identifier of a sticker from the sticker set; pass an empty string to drop the thumbnail and use the first sticker as the thumbnail
    CustomEmojiID string `json:"custom_emoji_id,omitempty"`
}

type SetGameScoreParams

SetGameScoreParams is the parameter set for 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.

type SetGameScoreParams struct {
    // User identifier
    UserID int64 `json:"user_id"`
    // New score, must be non-negative
    Score int64 `json:"score"`
    // Pass True if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters.
    Force *bool `json:"force,omitempty"`
    // Pass True if the game message should not be automatically edited to include the current scoreboard
    DisableEditMessage *bool `json:"disable_edit_message,omitempty"`
    // Required if inline_message_id is not specified. Unique identifier for the target chat.
    ChatID *int64 `json:"chat_id,omitempty"`
    // Required if inline_message_id is not specified. Identifier of the sent message.
    MessageID *int64 `json:"message_id,omitempty"`
    // Required if chat_id and message_id are not specified. Identifier of the inline message.
    InlineMessageID string `json:"inline_message_id,omitempty"`
}

type SetManagedBotAccessSettingsParams

SetManagedBotAccessSettingsParams is the parameter set for SetManagedBotAccessSettings.

Use this method to change the access settings of a managed bot. Returns True on success.

type SetManagedBotAccessSettingsParams struct {
    // User identifier of the managed bot whose access settings will be changed
    UserID int64 `json:"user_id"`
    // Pass True, if only selected users can access the bot. The bot's owner can always access it.
    IsAccessRestricted bool `json:"is_access_restricted"`
    // A JSON-serialized list of up to 10 identifiers of users who will have access to the bot in addition to its owner. Ignored if is_access_restricted is false.
    AddedUserIds []int64 `json:"added_user_ids,omitempty"`
}

type SetMessageReactionParams

SetMessageReactionParams is the parameter set for SetMessageReaction.

Use this method to change the chosen reactions on a message. Service messages of some types 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. Bots can't use paid reactions. Returns True on success.

type SetMessageReactionParams struct {
    // Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // 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.
    MessageID int64 `json:"message_id"`
    // A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators. Paid reactions can't be used by bots.
    Reaction []ReactionType `json:"reaction,omitempty"`
    // Pass True to set the reaction with a big animation
    IsBig *bool `json:"is_big,omitempty"`
}

type SetMyCommandsParams

SetMyCommandsParams is the parameter set for 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.

type SetMyCommandsParams struct {
    // 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.
    Commands []BotCommand `json:"commands"`
    // A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault.
    Scope BotCommandScope `json:"scope,omitempty"`
    // A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands.
    LanguageCode string `json:"language_code,omitempty"`
}

type SetMyDefaultAdministratorRightsParams

SetMyDefaultAdministratorRightsParams is the parameter set for 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.

type SetMyDefaultAdministratorRightsParams struct {
    // A JSON-serialized object describing new default administrator rights. If not specified, the default administrator rights will be cleared.
    Rights *ChatAdministratorRights `json:"rights,omitempty"`
    // Pass True to change the default administrator rights of the bot in channels. Otherwise, the default administrator rights of the bot for groups and supergroups will be changed.
    ForChannels *bool `json:"for_channels,omitempty"`
}

type SetMyDescriptionParams

SetMyDescriptionParams is the parameter set for 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.

type SetMyDescriptionParams struct {
    // New bot description; 0-512 characters. Pass an empty string to remove the dedicated description for the given language.
    Description string `json:"description,omitempty"`
    // A two-letter ISO 639-1 language code. If empty, the description will be applied to all users for whose language there is no dedicated description.
    LanguageCode string `json:"language_code,omitempty"`
}

type SetMyNameParams

SetMyNameParams is the parameter set for SetMyName.

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

type SetMyNameParams struct {
    // New bot name; 0-64 characters. Pass an empty string to remove the dedicated name for the given language.
    Name string `json:"name,omitempty"`
    // A two-letter ISO 639-1 language code. If empty, the name will be shown to all users for whose language there is no dedicated name.
    LanguageCode string `json:"language_code,omitempty"`
}

type SetMyProfilePhotoParams

SetMyProfilePhotoParams is the parameter set for SetMyProfilePhoto.

Changes the profile photo of the bot. Returns True on success.

type SetMyProfilePhotoParams struct {
    // The new profile photo to set
    Photo InputProfilePhoto `json:"photo"`
}

type SetMyShortDescriptionParams

SetMyShortDescriptionParams is the parameter set for 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.

type SetMyShortDescriptionParams struct {
    // New short description for the bot; 0-120 characters. Pass an empty string to remove the dedicated short description for the given language.
    ShortDescription string `json:"short_description,omitempty"`
    // A two-letter ISO 639-1 language code. If empty, the short description will be applied to all users for whose language there is no dedicated short description.
    LanguageCode string `json:"language_code,omitempty"`
}

type SetPassportDataErrorsParams

SetPassportDataErrorsParams is the parameter set for 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.

type SetPassportDataErrorsParams struct {
    // User identifier
    UserID int64 `json:"user_id"`
    // A JSON-serialized array describing the errors
    Errors []PassportElementError `json:"errors"`
}

type SetStickerEmojiListParams

SetStickerEmojiListParams is the parameter set for 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.

type SetStickerEmojiListParams struct {
    // File identifier of the sticker
    Sticker string `json:"sticker"`
    // A JSON-serialized list of 1-20 emoji associated with the sticker
    EmojiList []string `json:"emoji_list"`
}

type SetStickerKeywordsParams

SetStickerKeywordsParams is the parameter set for 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.

type SetStickerKeywordsParams struct {
    // File identifier of the sticker
    Sticker string `json:"sticker"`
    // A JSON-serialized list of 0-20 search keywords for the sticker with total length of up to 64 characters
    Keywords []string `json:"keywords,omitempty"`
}

type SetStickerMaskPositionParams

SetStickerMaskPositionParams is the parameter set for 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.

type SetStickerMaskPositionParams struct {
    // File identifier of the sticker
    Sticker string `json:"sticker"`
    // A JSON-serialized object with the position where the mask should be placed on faces. Omit the parameter to remove the mask position.
    MaskPosition *MaskPosition `json:"mask_position,omitempty"`
}

type SetStickerPositionInSetParams

SetStickerPositionInSetParams is the parameter set for SetStickerPositionInSet.

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

type SetStickerPositionInSetParams struct {
    // File identifier of the sticker
    Sticker string `json:"sticker"`
    // New sticker position in the set, zero-based
    Position int64 `json:"position"`
}

type SetStickerSetThumbnailParams

SetStickerSetThumbnailParams is the parameter set for 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.

type SetStickerSetThumbnailParams struct {
    // Sticker set name
    Name string `json:"name"`
    // User identifier of the sticker set owner
    UserID int64 `json:"user_id"`
    // A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animation-requirements for animated sticker technical requirements), or a .WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, 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 ». Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.
    Thumbnail *InputFile `json:"thumbnail,omitempty"`
    // Format of the thumbnail, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, or “video” for a .WEBM video
    Format InputStickerFormat `json:"format"`
}

func (*SetStickerSetThumbnailParams) HasFile

func (p *SetStickerSetThumbnailParams) HasFile() bool

HasFile reports whether a multipart upload is required.

func (*SetStickerSetThumbnailParams) MultipartFields

func (p *SetStickerSetThumbnailParams) MultipartFields() map[string]string

MultipartFields returns the non-file fields used in the multipart body.

func (*SetStickerSetThumbnailParams) MultipartFiles

func (p *SetStickerSetThumbnailParams) MultipartFiles() []client.MultipartFile

MultipartFiles returns the file parts.

type SetStickerSetTitleParams

SetStickerSetTitleParams is the parameter set for SetStickerSetTitle.

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

type SetStickerSetTitleParams struct {
    // Sticker set name
    Name string `json:"name"`
    // Sticker set title, 1-64 characters
    Title string `json:"title"`
}

type SetUserEmojiStatusParams

SetUserEmojiStatusParams is the parameter set for SetUserEmojiStatus.

Changes the emoji status for a given user that previously allowed the bot to manage their emoji status via the Mini App method requestEmojiStatusAccess. Returns True on success.

type SetUserEmojiStatusParams struct {
    // Unique identifier of the target user
    UserID int64 `json:"user_id"`
    // Custom emoji identifier of the emoji status to set. Pass an empty string to remove the status.
    EmojiStatusCustomEmojiID string `json:"emoji_status_custom_emoji_id,omitempty"`
    // Expiration date of the emoji status, if any
    EmojiStatusExpirationDate *int64 `json:"emoji_status_expiration_date,omitempty"`
}

type SetWebhookParams

SetWebhookParams is the parameter set for 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 (a request with response HTTP status code different from 2XY), we will repeat the request and 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. Notes1. You will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up.2. To use a self-signed certificate, you need to upload your public key certificate using certificate parameter. Please upload as InputFile, sending a String will not work.3. Ports currently supported for webhooks: 443, 80, 88, 8443. If you're having any trouble setting up webhooks, please check out this amazing guide to webhooks.

type SetWebhookParams struct {
    // HTTPS URL to send updates to. Use an empty string to remove webhook integration.
    URL string `json:"url"`
    // Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details.
    Certificate *InputFile `json:"certificate,omitempty"`
    // The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS
    IPAddress string `json:"ip_address,omitempty"`
    // The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput.
    MaxConnections *int64 `json:"max_connections,omitempty"`
    // A JSON-serialized list of the update types you want your bot to receive. For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used.Please note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time.
    AllowedUpdates []UpdateType `json:"allowed_updates,omitempty"`
    // Pass True to drop all pending updates
    DropPendingUpdates *bool `json:"drop_pending_updates,omitempty"`
    // A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you.
    SecretToken string `json:"secret_token,omitempty"`
}

func (*SetWebhookParams) HasFile

func (p *SetWebhookParams) HasFile() bool

HasFile reports whether a multipart upload is required.

func (*SetWebhookParams) MultipartFields

func (p *SetWebhookParams) MultipartFields() map[string]string

MultipartFields returns the non-file fields used in the multipart body.

func (*SetWebhookParams) MultipartFiles

func (p *SetWebhookParams) MultipartFiles() []client.MultipartFile

MultipartFiles returns the file parts.

type SharedUser

This object contains information about a user that was shared with the bot using a KeyboardButtonRequestUsers button.

type SharedUser struct {
    // Identifier of the shared user. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so 64-bit integers or double-precision float types are safe for storing these identifiers. The bot may not have access to the user and could be unable to use this identifier, unless the user is already known to the bot by some other means.
    UserID int64 `json:"user_id"`
    // Optional. First name of the user, if the name was requested by the bot
    FirstName string `json:"first_name,omitempty"`
    // Optional. Last name of the user, if the name was requested by the bot
    LastName string `json:"last_name,omitempty"`
    // Optional. Username of the user, if the username was requested by the bot
    Username string `json:"username,omitempty"`
    // Optional. Available sizes of the chat photo, if the photo was requested by the bot
    Photo []PhotoSize `json:"photo,omitempty"`
}

type ShippingAddress

This object represents a shipping address.

type ShippingAddress struct {
    // Two-letter ISO 3166-1 alpha-2 country code
    CountryCode string `json:"country_code"`
    // State, if applicable
    State string `json:"state"`
    // City
    City string `json:"city"`
    // First line for the address
    StreetLine1 string `json:"street_line1"`
    // Second line for the address
    StreetLine2 string `json:"street_line2"`
    // Address post code
    PostCode string `json:"post_code"`
}

type ShippingOption

This object represents one shipping option.

type ShippingOption struct {
    // Shipping option identifier
    ID  string `json:"id"`
    // Option title
    Title string `json:"title"`
    // List of price portions
    Prices []LabeledPrice `json:"prices"`
}

type ShippingQuery

This object contains information about an incoming shipping query.

type ShippingQuery struct {
    // Unique query identifier
    ID  string `json:"id"`
    // User who sent the query
    From User `json:"from"`
    // Bot-specified invoice payload
    InvoicePayload string `json:"invoice_payload"`
    // User specified shipping address
    ShippingAddress ShippingAddress `json:"shipping_address"`
}

type StarAmount

Describes an amount of Telegram Stars.

type StarAmount struct {
    // Integer amount of Telegram Stars, rounded to 0; can be negative
    Amount int64 `json:"amount"`
    // Optional. The number of 1/1000000000 shares of Telegram Stars; from -999999999 to 999999999; can be negative if and only if amount is non-positive
    NanostarAmount *int64 `json:"nanostar_amount,omitempty"`
}

func GetBusinessAccountStarBalance

func GetBusinessAccountStarBalance(ctx context.Context, b *client.Bot, p *GetBusinessAccountStarBalanceParams) (*StarAmount, error)

GetBusinessAccountStarBalance calls the getBusinessAccountStarBalance Telegram Bot API method.

Returns the amount of Telegram Stars owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns StarAmount on success.

func GetMyStarBalance

func GetMyStarBalance(ctx context.Context, b *client.Bot, p *GetMyStarBalanceParams) (*StarAmount, error)

GetMyStarBalance calls the getMyStarBalance Telegram Bot API method.

A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a StarAmount object.

type StarTransaction

Describes a Telegram Star transaction. Note that if the buyer initiates a chargeback with the payment provider from whom they acquired Stars (e.g., Apple, Google) following this transaction, the refunded Stars will be deducted from the bot's balance. This is outside of Telegram's control.

type StarTransaction struct {
    // Unique identifier of the transaction. Coincides with the identifier of the original transaction for refund transactions. Coincides with SuccessfulPayment.telegram_payment_charge_id for successful incoming payments from users.
    ID  string `json:"id"`
    // Integer amount of Telegram Stars transferred by the transaction
    Amount int64 `json:"amount"`
    // Optional. The number of 1/1000000000 shares of Telegram Stars transferred by the transaction; from 0 to 999999999
    NanostarAmount *int64 `json:"nanostar_amount,omitempty"`
    // Date the transaction was created in Unix time
    Date int64 `json:"date"`
    // Optional. Source of an incoming transaction (e.g., a user purchasing goods or services, Fragment refunding a failed withdrawal). Only for incoming transactions.
    Source TransactionPartner `json:"source,omitempty"`
    // Optional. Receiver of an outgoing transaction (e.g., a user for a purchase refund, Fragment for a withdrawal). Only for outgoing transactions.
    Receiver TransactionPartner `json:"receiver,omitempty"`
}

func (*StarTransaction) UnmarshalJSON

func (m *StarTransaction) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes StarTransaction by dispatching union-typed fields (Source, Receiver) through their concrete UnmarshalXxx helpers.

type StarTransactions

Contains a list of Telegram Star transactions.

type StarTransactions struct {
    // The list of transactions
    Transactions []StarTransaction `json:"transactions"`
}

func GetStarTransactions

func GetStarTransactions(ctx context.Context, b *client.Bot, p *GetStarTransactionsParams) (*StarTransactions, error)

GetStarTransactions calls the getStarTransactions Telegram Bot API method.

Returns the bot's Telegram Star transactions in chronological order. On success, returns a StarTransactions object.

type Sticker

This object represents a sticker.

type Sticker struct {
    // Identifier for this file, which can be used to download or reuse the file
    FileID string `json:"file_id"`
    // Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
    FileUniqueID string `json:"file_unique_id"`
    // Type of the sticker, currently one of “regular”, “mask”, “custom_emoji”. The type of the sticker is independent from its format, which is determined by the fields is_animated and is_video.
    Type StickerType `json:"type"`
    // Sticker width
    Width int64 `json:"width"`
    // Sticker height
    Height int64 `json:"height"`
    // True, if the sticker is animated
    IsAnimated bool `json:"is_animated"`
    // True, if the sticker is a video sticker
    IsVideo bool `json:"is_video"`
    // Optional. Sticker thumbnail in the .WEBP or .JPG format
    Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
    // Optional. Emoji associated with the sticker
    Emoji string `json:"emoji,omitempty"`
    // Optional. Name of the sticker set to which the sticker belongs
    SetName string `json:"set_name,omitempty"`
    // Optional. For premium regular stickers, premium animation for the sticker
    PremiumAnimation *File `json:"premium_animation,omitempty"`
    // Optional. For mask stickers, the position where the mask should be placed
    MaskPosition *MaskPosition `json:"mask_position,omitempty"`
    // Optional. For custom emoji stickers, unique identifier of the custom emoji
    CustomEmojiID string `json:"custom_emoji_id,omitempty"`
    // Optional. True, if the sticker must be repainted to a text color in messages, the color of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in other places
    NeedsRepainting *bool `json:"needs_repainting,omitempty"`
    // Optional. File size in bytes
    FileSize *int64 `json:"file_size,omitempty"`
}

func GetCustomEmojiStickers

func GetCustomEmojiStickers(ctx context.Context, b *client.Bot, p *GetCustomEmojiStickersParams) ([]Sticker, error)

GetCustomEmojiStickers calls the getCustomEmojiStickers Telegram Bot API method.

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

func GetForumTopicIconStickers

func GetForumTopicIconStickers(ctx context.Context, b *client.Bot, p *GetForumTopicIconStickersParams) ([]Sticker, error)

GetForumTopicIconStickers calls the getForumTopicIconStickers Telegram Bot API method.

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.

type StickerSet

This object represents a sticker set.

type StickerSet struct {
    // Sticker set name
    Name string `json:"name"`
    // Sticker set title
    Title string `json:"title"`
    // Type of stickers in the set, currently one of “regular”, “mask”, “custom_emoji”
    StickerType StickerType `json:"sticker_type"`
    // List of all set stickers
    Stickers []Sticker `json:"stickers"`
    // Optional. Sticker set thumbnail in the .WEBP, .TGS, or .WEBM format
    Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
}

func GetStickerSet

func GetStickerSet(ctx context.Context, b *client.Bot, p *GetStickerSetParams) (*StickerSet, error)

GetStickerSet calls the getStickerSet Telegram Bot API method.

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

type StickerType

type StickerType string


const (
    StickerTypeRegular     StickerType = "regular"
    StickerTypeMask        StickerType = "mask"
    StickerTypeCustomEmoji StickerType = "custom_emoji"
)

type StopMessageLiveLocationParams

StopMessageLiveLocationParams is the parameter set for 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.

type StopMessageLiveLocationParams struct {
    // Unique identifier of the business connection on behalf of which the message to be edited was sent
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username.
    ChatID *ChatID `json:"chat_id,omitempty"`
    // Required if inline_message_id is not specified. Identifier of the message with live location to stop.
    MessageID *int64 `json:"message_id,omitempty"`
    // Required if chat_id and message_id are not specified. Identifier of the inline message.
    InlineMessageID string `json:"inline_message_id,omitempty"`
    // A JSON-serialized object for a new inline keyboard
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

type StopPollParams

StopPollParams is the parameter set for StopPoll.

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

type StopPollParams struct {
    // Unique identifier of the business connection on behalf of which the message to be edited was sent
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Identifier of the original message with the poll
    MessageID int64 `json:"message_id"`
    // A JSON-serialized object for a new message inline keyboard
    ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

type Story

This object represents a story.

type Story struct {
    // Chat that posted the story
    Chat Chat `json:"chat"`
    // Unique identifier for the story in the chat
    ID  int64 `json:"id"`
}

func EditStory

func EditStory(ctx context.Context, b *client.Bot, p *EditStoryParams) (*Story, error)

EditStory calls the editStory Telegram Bot API method.

Edits a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.

func PostStory

func PostStory(ctx context.Context, b *client.Bot, p *PostStoryParams) (*Story, error)

PostStory calls the postStory Telegram Bot API method.

Posts a story on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.

func RepostStory

func RepostStory(ctx context.Context, b *client.Bot, p *RepostStoryParams) (*Story, error)

RepostStory calls the repostStory Telegram Bot API method.

Reposts a story on behalf of a business account from another business account. Both business accounts must be managed by the same bot, and the story on the source account must have been posted (or reposted) by the bot. Requires the can_manage_stories business bot right for both business accounts. Returns Story on success.

type StoryArea

Describes a clickable area on a story media.

type StoryArea struct {
    // Position of the area
    Position StoryAreaPosition `json:"position"`
    // Type of the area
    Type StoryAreaType `json:"type"`
}

func (*StoryArea) UnmarshalJSON

func (m *StoryArea) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes StoryArea by dispatching union-typed fields (Type) through their concrete UnmarshalXxx helpers.

type StoryAreaPosition

Describes the position of a clickable area within a story.

type StoryAreaPosition struct {
    // The abscissa of the area's center, as a percentage of the media width
    XPercentage float64 `json:"x_percentage"`
    // The ordinate of the area's center, as a percentage of the media height
    YPercentage float64 `json:"y_percentage"`
    // The width of the area's rectangle, as a percentage of the media width
    WidthPercentage float64 `json:"width_percentage"`
    // The height of the area's rectangle, as a percentage of the media height
    HeightPercentage float64 `json:"height_percentage"`
    // The clockwise rotation angle of the rectangle, in degrees; 0-360
    RotationAngle float64 `json:"rotation_angle"`
    // The radius of the rectangle corner rounding, as a percentage of the media width
    CornerRadiusPercentage float64 `json:"corner_radius_percentage"`
}

type StoryAreaType

StoryAreaType is a union type. The following concrete variants implement it:

  • StoryAreaTypeLocation
  • StoryAreaTypeSuggestedReaction
  • StoryAreaTypeLink
  • StoryAreaTypeWeather
  • StoryAreaTypeUniqueGift

Describes the type of a clickable area on a story. Currently, it can be one of

type StoryAreaType interface {
    // contains filtered or unexported methods
}

func UnmarshalStoryAreaType

func UnmarshalStoryAreaType(data []byte) (StoryAreaType, error)

UnmarshalStoryAreaType decodes a StoryAreaType from JSON by inspecting the "type" field and dispatching to the correct concrete type.

type StoryAreaTypeKind

type StoryAreaTypeKind string


const (
    StoryAreaTypeKindLocation          StoryAreaTypeKind = "location"
    StoryAreaTypeKindSuggestedReaction StoryAreaTypeKind = "suggested_reaction"
    StoryAreaTypeKindLink              StoryAreaTypeKind = "link"
    StoryAreaTypeKindWeather           StoryAreaTypeKind = "weather"
    StoryAreaTypeKindUniqueGift        StoryAreaTypeKind = "unique_gift"
)

type StoryAreaTypeLink

Describes a story area pointing to an HTTP or tg:// link. Currently, a story can have up to 3 link areas.

type StoryAreaTypeLink struct {
    // Type of the area, always “link”
    Type StoryAreaTypeKind `json:"type"`
    // HTTP or tg:// URL to be opened when the area is clicked
    URL string `json:"url"`
}

func (*StoryAreaTypeLink) MarshalJSON

func (v *StoryAreaTypeLink) MarshalJSON() ([]byte, error)

MarshalJSON encodes StoryAreaTypeLink with the discriminator field "type" forced to "link". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type StoryAreaTypeLocation

Describes a story area pointing to a location. Currently, a story can have up to 10 location areas.

type StoryAreaTypeLocation struct {
    // Type of the area, always “location”
    Type StoryAreaTypeKind `json:"type"`
    // Location latitude in degrees
    Latitude float64 `json:"latitude"`
    // Location longitude in degrees
    Longitude float64 `json:"longitude"`
    // Optional. Address of the location
    Address *LocationAddress `json:"address,omitempty"`
}

func (*StoryAreaTypeLocation) MarshalJSON

func (v *StoryAreaTypeLocation) MarshalJSON() ([]byte, error)

MarshalJSON encodes StoryAreaTypeLocation with the discriminator field "type" forced to "location". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type StoryAreaTypeSuggestedReaction

Describes a story area pointing to a suggested reaction. Currently, a story can have up to 5 suggested reaction areas.

type StoryAreaTypeSuggestedReaction struct {
    // Type of the area, always “suggested_reaction”
    Type StoryAreaTypeKind `json:"type"`
    // Type of the reaction
    ReactionType ReactionType `json:"reaction_type"`
    // Optional. Pass True if the reaction area has a dark background
    IsDark *bool `json:"is_dark,omitempty"`
    // Optional. Pass True if reaction area corner is flipped
    IsFlipped *bool `json:"is_flipped,omitempty"`
}

func (*StoryAreaTypeSuggestedReaction) MarshalJSON

func (v *StoryAreaTypeSuggestedReaction) MarshalJSON() ([]byte, error)

MarshalJSON encodes StoryAreaTypeSuggestedReaction with the discriminator field "type" forced to "suggested_reaction". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

func (*StoryAreaTypeSuggestedReaction) UnmarshalJSON

func (m *StoryAreaTypeSuggestedReaction) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes StoryAreaTypeSuggestedReaction by dispatching union-typed fields (ReactionType) through their concrete UnmarshalXxx helpers.

type StoryAreaTypeUniqueGift

Describes a story area pointing to a unique gift. Currently, a story can have at most 1 unique gift area.

type StoryAreaTypeUniqueGift struct {
    // Type of the area, always “unique_gift”
    Type StoryAreaTypeKind `json:"type"`
    // Unique name of the gift
    Name string `json:"name"`
}

func (*StoryAreaTypeUniqueGift) MarshalJSON

func (v *StoryAreaTypeUniqueGift) MarshalJSON() ([]byte, error)

MarshalJSON encodes StoryAreaTypeUniqueGift with the discriminator field "type" forced to "unique_gift". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type StoryAreaTypeWeather

Describes a story area containing weather information. Currently, a story can have up to 3 weather areas.

type StoryAreaTypeWeather struct {
    // Type of the area, always “weather”
    Type StoryAreaTypeKind `json:"type"`
    // Temperature, in degree Celsius
    Temperature float64 `json:"temperature"`
    // Emoji representing the weather
    Emoji string `json:"emoji"`
    // A color of the area background in the ARGB format
    BackgroundColor int64 `json:"background_color"`
}

func (*StoryAreaTypeWeather) MarshalJSON

func (v *StoryAreaTypeWeather) MarshalJSON() ([]byte, error)

MarshalJSON encodes StoryAreaTypeWeather with the discriminator field "type" forced to "weather". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type SuccessfulPayment

This object contains basic information about a successful payment. Note that if the buyer initiates a chargeback with the relevant payment provider following this transaction, the funds may be debited from your balance. This is outside of Telegram's control.

type SuccessfulPayment struct {
    // Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars
    Currency string `json:"currency"`
    // Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
    TotalAmount int64 `json:"total_amount"`
    // Bot-specified invoice payload
    InvoicePayload string `json:"invoice_payload"`
    // Optional. Expiration date of the subscription, in Unix time; for recurring payments only
    SubscriptionExpirationDate *int64 `json:"subscription_expiration_date,omitempty"`
    // Optional. True, if the payment is a recurring payment for a subscription
    IsRecurring *bool `json:"is_recurring,omitempty"`
    // Optional. True, if the payment is the first payment for a subscription
    IsFirstRecurring *bool `json:"is_first_recurring,omitempty"`
    // Optional. Identifier of the shipping option chosen by the user
    ShippingOptionID string `json:"shipping_option_id,omitempty"`
    // Optional. Order information provided by the user
    OrderInfo *OrderInfo `json:"order_info,omitempty"`
    // Telegram payment identifier
    TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`
    // Provider payment identifier
    ProviderPaymentChargeID string `json:"provider_payment_charge_id"`
}

type SuggestedPostApprovalFailed

Describes a service message about the failed approval of a suggested post. Currently, only caused by insufficient user funds at the time of approval.

type SuggestedPostApprovalFailed struct {
    // Optional. Message containing the suggested post whose approval has failed. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.
    SuggestedPostMessage *Message `json:"suggested_post_message,omitempty"`
    // Expected price of the post
    Price SuggestedPostPrice `json:"price"`
}

type SuggestedPostApproved

Describes a service message about the approval of a suggested post.

type SuggestedPostApproved struct {
    // Optional. Message containing the suggested post. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.
    SuggestedPostMessage *Message `json:"suggested_post_message,omitempty"`
    // Optional. Amount paid for the post
    Price *SuggestedPostPrice `json:"price,omitempty"`
    // Date when the post will be published
    SendDate int64 `json:"send_date"`
}

type SuggestedPostDeclined

Describes a service message about the rejection of a suggested post.

type SuggestedPostDeclined struct {
    // Optional. Message containing the suggested post. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.
    SuggestedPostMessage *Message `json:"suggested_post_message,omitempty"`
    // Optional. Comment with which the post was declined
    Comment string `json:"comment,omitempty"`
}

type SuggestedPostInfo

Contains information about a suggested post.

type SuggestedPostInfo struct {
    // State of the suggested post. Currently, it can be one of “pending”, “approved”, “declined”.
    State SuggestedPostInfoState `json:"state"`
    // Optional. Proposed price of the post. If the field is omitted, then the post is unpaid.
    Price *SuggestedPostPrice `json:"price,omitempty"`
    // Optional. Proposed send date of the post. If the field is omitted, then the post can be published at any time within 30 days at the sole discretion of the user or administrator who approves it.
    SendDate *int64 `json:"send_date,omitempty"`
}

type SuggestedPostInfoState

type SuggestedPostInfoState string


const (
    SuggestedPostInfoStatePending  SuggestedPostInfoState = "pending"
    SuggestedPostInfoStateApproved SuggestedPostInfoState = "approved"
    SuggestedPostInfoStateDeclined SuggestedPostInfoState = "declined"
)

type SuggestedPostPaid

Describes a service message about a successful payment for a suggested post.

type SuggestedPostPaid struct {
    // Optional. Message containing the suggested post. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.
    SuggestedPostMessage *Message `json:"suggested_post_message,omitempty"`
    // Currency in which the payment was made. Currently, one of “XTR” for Telegram Stars or “TON” for toncoins.
    Currency SuggestedPostPaidCurrency `json:"currency"`
    // Optional. The amount of the currency that was received by the channel in nanotoncoins; for payments in toncoins only
    Amount *int64 `json:"amount,omitempty"`
    // Optional. The amount of Telegram Stars that was received by the channel; for payments in Telegram Stars only
    StarAmount *StarAmount `json:"star_amount,omitempty"`
}

type SuggestedPostPaidCurrency

type SuggestedPostPaidCurrency string


const (
    SuggestedPostPaidCurrencyXTR SuggestedPostPaidCurrency = "XTR"
    SuggestedPostPaidCurrencyTON SuggestedPostPaidCurrency = "TON"
)

type SuggestedPostParameters

Contains parameters of a post that is being suggested by the bot.

type SuggestedPostParameters struct {
    // Optional. Proposed price for the post. If the field is omitted, then the post is unpaid.
    Price *SuggestedPostPrice `json:"price,omitempty"`
    // Optional. Proposed send date of the post. If specified, then the date must be between 300 second and 2678400 seconds (30 days) in the future. If the field is omitted, then the post can be published at any time within 30 days at the sole discretion of the user who approves it.
    SendDate *int64 `json:"send_date,omitempty"`
}

type SuggestedPostPrice

Describes the price of a suggested post.

type SuggestedPostPrice struct {
    // Currency in which the post will be paid. Currently, must be one of “XTR” for Telegram Stars or “TON” for toncoins.
    Currency SuggestedPostPaidCurrency `json:"currency"`
    // The amount of the currency that will be paid for the post in the smallest units of the currency, i.e. Telegram Stars or nanotoncoins. Currently, price in Telegram Stars must be between 5 and 100000, and price in nanotoncoins must be between 10000000 and 10000000000000.
    Amount int64 `json:"amount"`
}

type SuggestedPostRefunded

Describes a service message about a payment refund for a suggested post.

type SuggestedPostRefunded struct {
    // Optional. Message containing the suggested post. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.
    SuggestedPostMessage *Message `json:"suggested_post_message,omitempty"`
    // Reason for the refund. Currently, one of “post_deleted” if the post was deleted within 24 hours of being posted or removed from scheduled messages without being posted, or “payment_refunded” if the payer refunded their payment.
    Reason SuggestedPostRefundedReason `json:"reason"`
}

type SuggestedPostRefundedReason

type SuggestedPostRefundedReason string


const (
    SuggestedPostRefundedReasonPostDeleted     SuggestedPostRefundedReason = "post_deleted"
    SuggestedPostRefundedReasonPaymentRefunded SuggestedPostRefundedReason = "payment_refunded"
)

type SwitchInlineQueryChosenChat

This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query.

type SwitchInlineQueryChosenChat struct {
    // Optional. The default inline query to be inserted in the input field. If left empty, only the bot's username will be inserted.
    Query string `json:"query,omitempty"`
    // Optional. True, if private chats with users can be chosen
    AllowUserChats *bool `json:"allow_user_chats,omitempty"`
    // Optional. True, if private chats with bots can be chosen
    AllowBotChats *bool `json:"allow_bot_chats,omitempty"`
    // Optional. True, if group and supergroup chats can be chosen
    AllowGroupChats *bool `json:"allow_group_chats,omitempty"`
    // Optional. True, if channel chats can be chosen
    AllowChannelChats *bool `json:"allow_channel_chats,omitempty"`
}

type TextQuote

This object contains information about the quoted part of a message that is replied to by the given message.

type TextQuote struct {
    // Text of the quoted part of a message that is replied to by the given message
    Text string `json:"text"`
    // Optional. Special entities that appear in the quote. Currently, only bold, italic, underline, strikethrough, spoiler, custom_emoji, and date_time entities are kept in quotes.
    Entities []MessageEntity `json:"entities,omitempty"`
    // Approximate quote position in the original message in UTF-16 code units as specified by the sender
    Position int64 `json:"position"`
    // Optional. True, if the quote was chosen manually by the message sender. Otherwise, the quote was added automatically by the server.
    IsManual *bool `json:"is_manual,omitempty"`
}

type TransactionPartner

TransactionPartner is a union type. The following concrete variants implement it:

  • TransactionPartnerUser
  • TransactionPartnerChat
  • TransactionPartnerAffiliateProgram
  • TransactionPartnerFragment
  • TransactionPartnerTelegramAds
  • TransactionPartnerTelegramApi
  • TransactionPartnerOther

This object describes the source of a transaction, or its recipient for outgoing transactions. Currently, it can be one of

type TransactionPartner interface {
    // contains filtered or unexported methods
}

func UnmarshalTransactionPartner

func UnmarshalTransactionPartner(data []byte) (TransactionPartner, error)

UnmarshalTransactionPartner decodes a TransactionPartner from JSON by inspecting the "type" field and dispatching to the correct concrete type.

type TransactionPartnerAffiliateProgram

Describes the affiliate program that issued the affiliate commission received via this transaction.

type TransactionPartnerAffiliateProgram struct {
    // Type of the transaction partner, always “affiliate_program”
    Type TransactionPartnerType `json:"type"`
    // Optional. Information about the bot that sponsored the affiliate program
    SponsorUser *User `json:"sponsor_user,omitempty"`
    // The number of Telegram Stars received by the bot for each 1000 Telegram Stars received by the affiliate program sponsor from referred users
    CommissionPerMille int64 `json:"commission_per_mille"`
}

func (*TransactionPartnerAffiliateProgram) MarshalJSON

func (v *TransactionPartnerAffiliateProgram) MarshalJSON() ([]byte, error)

MarshalJSON encodes TransactionPartnerAffiliateProgram with the discriminator field "type" forced to "affiliate_program". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type TransactionPartnerChat

Describes a transaction with a chat.

type TransactionPartnerChat struct {
    // Type of the transaction partner, always “chat”
    Type TransactionPartnerType `json:"type"`
    // Information about the chat
    Chat Chat `json:"chat"`
    // Optional. The gift sent to the chat by the bot
    Gift *Gift `json:"gift,omitempty"`
}

func (*TransactionPartnerChat) MarshalJSON

func (v *TransactionPartnerChat) MarshalJSON() ([]byte, error)

MarshalJSON encodes TransactionPartnerChat with the discriminator field "type" forced to "chat". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type TransactionPartnerFragment

Describes a withdrawal transaction with Fragment.

type TransactionPartnerFragment struct {
    // Type of the transaction partner, always “fragment”
    Type TransactionPartnerType `json:"type"`
    // Optional. State of the transaction if the transaction is outgoing
    WithdrawalState RevenueWithdrawalState `json:"withdrawal_state,omitempty"`
}

func (*TransactionPartnerFragment) MarshalJSON

func (v *TransactionPartnerFragment) MarshalJSON() ([]byte, error)

MarshalJSON encodes TransactionPartnerFragment with the discriminator field "type" forced to "fragment". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

func (*TransactionPartnerFragment) UnmarshalJSON

func (m *TransactionPartnerFragment) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes TransactionPartnerFragment by dispatching union-typed fields (WithdrawalState) through their concrete UnmarshalXxx helpers.

type TransactionPartnerOther

Describes a transaction with an unknown source or recipient.

type TransactionPartnerOther struct {
    // Type of the transaction partner, always “other”
    Type TransactionPartnerType `json:"type"`
}

func (*TransactionPartnerOther) MarshalJSON

func (v *TransactionPartnerOther) MarshalJSON() ([]byte, error)

MarshalJSON encodes TransactionPartnerOther with the discriminator field "type" forced to "other". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type TransactionPartnerTelegramAds

Describes a withdrawal transaction to the Telegram Ads platform.

type TransactionPartnerTelegramAds struct {
    // Type of the transaction partner, always “telegram_ads”
    Type TransactionPartnerType `json:"type"`
}

func (*TransactionPartnerTelegramAds) MarshalJSON

func (v *TransactionPartnerTelegramAds) MarshalJSON() ([]byte, error)

MarshalJSON encodes TransactionPartnerTelegramAds with the discriminator field "type" forced to "telegram_ads". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type TransactionPartnerTelegramApi

Describes a transaction with payment for paid broadcasting.

type TransactionPartnerTelegramApi struct {
    // Type of the transaction partner, always “telegram_api”
    Type TransactionPartnerType `json:"type"`
    // The number of successful requests that exceeded regular limits and were therefore billed
    RequestCount int64 `json:"request_count"`
}

func (*TransactionPartnerTelegramApi) MarshalJSON

func (v *TransactionPartnerTelegramApi) MarshalJSON() ([]byte, error)

MarshalJSON encodes TransactionPartnerTelegramApi with the discriminator field "type" forced to "telegram_api". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

type TransactionPartnerType

type TransactionPartnerType string


const (
    TransactionPartnerTypeUser             TransactionPartnerType = "user"
    TransactionPartnerTypeChat             TransactionPartnerType = "chat"
    TransactionPartnerTypeAffiliateProgram TransactionPartnerType = "affiliate_program"
    TransactionPartnerTypeFragment         TransactionPartnerType = "fragment"
    TransactionPartnerTypeTelegramAds      TransactionPartnerType = "telegram_ads"
    TransactionPartnerTypeTelegramApi      TransactionPartnerType = "telegram_api"
    TransactionPartnerTypeOther            TransactionPartnerType = "other"
)

type TransactionPartnerUser

Describes a transaction with a user.

type TransactionPartnerUser struct {
    // Type of the transaction partner, always “user”
    Type TransactionPartnerType `json:"type"`
    // Type of the transaction, currently one of “invoice_payment” for payments via invoices, “paid_media_payment” for payments for paid media, “gift_purchase” for gifts sent by the bot, “premium_purchase” for Telegram Premium subscriptions gifted by the bot, “business_account_transfer” for direct transfers from managed business accounts
    TransactionType TransactionPartnerUserTransactionType `json:"transaction_type"`
    // Information about the user
    User User `json:"user"`
    // Optional. Information about the affiliate that received a commission via this transaction. Can be available only for “invoice_payment” and “paid_media_payment” transactions.
    Affiliate *AffiliateInfo `json:"affiliate,omitempty"`
    // Optional. Bot-specified invoice payload. Can be available only for “invoice_payment” transactions.
    InvoicePayload string `json:"invoice_payload,omitempty"`
    // Optional. The duration of the paid subscription. Can be available only for “invoice_payment” transactions.
    SubscriptionPeriod *int64 `json:"subscription_period,omitempty"`
    // Optional. Information about the paid media bought by the user; for “paid_media_payment” transactions only
    PaidMedia []PaidMedia `json:"paid_media,omitempty"`
    // Optional. Bot-specified paid media payload. Can be available only for “paid_media_payment” transactions.
    PaidMediaPayload string `json:"paid_media_payload,omitempty"`
    // Optional. The gift sent to the user by the bot; for “gift_purchase” transactions only
    Gift *Gift `json:"gift,omitempty"`
    // Optional. Number of months the gifted Telegram Premium subscription will be active for; for “premium_purchase” transactions only
    PremiumSubscriptionDuration *int64 `json:"premium_subscription_duration,omitempty"`
}

func (*TransactionPartnerUser) MarshalJSON

func (v *TransactionPartnerUser) MarshalJSON() ([]byte, error)

MarshalJSON encodes TransactionPartnerUser with the discriminator field "type" forced to "user". The hardcoded value frees callers from setting Type by hand — any user-supplied value on the struct literal is overridden so a typo can't slip through to Telegram.

func (*TransactionPartnerUser) UnmarshalJSON

func (m *TransactionPartnerUser) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes TransactionPartnerUser by dispatching union-typed fields (PaidMedia) through their concrete UnmarshalXxx helpers.

type TransactionPartnerUserTransactionType

type TransactionPartnerUserTransactionType string


const (
    TransactionPartnerUserTransactionTypeInvoicePayment          TransactionPartnerUserTransactionType = "invoice_payment"
    TransactionPartnerUserTransactionTypePaidMediaPayment        TransactionPartnerUserTransactionType = "paid_media_payment"
    TransactionPartnerUserTransactionTypeGiftPurchase            TransactionPartnerUserTransactionType = "gift_purchase"
    TransactionPartnerUserTransactionTypePremiumPurchase         TransactionPartnerUserTransactionType = "premium_purchase"
    TransactionPartnerUserTransactionTypeBusinessAccountTransfer TransactionPartnerUserTransactionType = "business_account_transfer"
)

type TransferBusinessAccountStarsParams

TransferBusinessAccountStarsParams is the parameter set for TransferBusinessAccountStars.

Transfers Telegram Stars from the business account balance to the bot's balance. Requires the can_transfer_stars business bot right. Returns True on success.

type TransferBusinessAccountStarsParams struct {
    // Unique identifier of the business connection
    BusinessConnectionID string `json:"business_connection_id"`
    // Number of Telegram Stars to transfer; 1-10000
    StarCount int64 `json:"star_count"`
}

type TransferGiftParams

TransferGiftParams is the parameter set for TransferGift.

Transfers an owned unique gift to another user. Requires the can_transfer_and_upgrade_gifts business bot right. Requires can_transfer_stars business bot right if the transfer is paid. Returns True on success.

type TransferGiftParams struct {
    // Unique identifier of the business connection
    BusinessConnectionID string `json:"business_connection_id"`
    // Unique identifier of the regular gift that should be transferred
    OwnedGiftID string `json:"owned_gift_id"`
    // Unique identifier of the chat which will own the gift. The chat must be active in the last 24 hours.
    NewOwnerChatID int64 `json:"new_owner_chat_id"`
    // The amount of Telegram Stars that will be paid for the transfer from the business account balance. If positive, then the can_transfer_stars business bot right is required.
    StarCount *int64 `json:"star_count,omitempty"`
}

type UnbanChatMemberParams

UnbanChatMemberParams is the parameter set for 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.

type UnbanChatMemberParams struct {
    // Unique identifier for the target group or username of the target supergroup or channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier of the target user
    UserID int64 `json:"user_id"`
    // Do nothing if the user is not banned
    OnlyIfBanned *bool `json:"only_if_banned,omitempty"`
}

type UnbanChatSenderChatParams

UnbanChatSenderChatParams is the parameter set for 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.

type UnbanChatSenderChatParams struct {
    // Unique identifier for the target chat or username of the target channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier of the target sender chat
    SenderChatID int64 `json:"sender_chat_id"`
}

type UnhideGeneralForumTopicParams

UnhideGeneralForumTopicParams is the parameter set for 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.

type UnhideGeneralForumTopicParams struct {
    // Unique identifier for the target chat or username of the target supergroup in the format @username
    ChatID ChatID `json:"chat_id"`
}

type UniqueGift

This object describes a unique gift that was upgraded from a regular gift.

type UniqueGift struct {
    // Identifier of the regular gift from which the gift was upgraded
    GiftID string `json:"gift_id"`
    // Human-readable name of the regular gift from which this unique gift was upgraded
    BaseName string `json:"base_name"`
    // Unique name of the gift. This name can be used in https://t.me/nft/... links and story areas.
    Name string `json:"name"`
    // Unique number of the upgraded gift among gifts upgraded from the same regular gift
    Number int64 `json:"number"`
    // Model of the gift
    Model UniqueGiftModel `json:"model"`
    // Symbol of the gift
    Symbol UniqueGiftSymbol `json:"symbol"`
    // Backdrop of the gift
    Backdrop UniqueGiftBackdrop `json:"backdrop"`
    // Optional. True, if the original regular gift was exclusively purchaseable by Telegram Premium subscribers
    IsPremium *bool `json:"is_premium,omitempty"`
    // Optional. True, if the gift was used to craft another gift and isn't available anymore
    IsBurned *bool `json:"is_burned,omitempty"`
    // Optional. True, if the gift is assigned from the TON blockchain and can't be resold or transferred in Telegram
    IsFromBlockchain *bool `json:"is_from_blockchain,omitempty"`
    // Optional. The color scheme that can be used by the gift's owner for the chat's name, replies to messages and link previews; for business account gifts and gifts that are currently on sale only
    Colors *UniqueGiftColors `json:"colors,omitempty"`
    // Optional. Information about the chat that published the gift
    PublisherChat *Chat `json:"publisher_chat,omitempty"`
}

type UniqueGiftBackdrop

This object describes the backdrop of a unique gift.

type UniqueGiftBackdrop struct {
    // Name of the backdrop
    Name string `json:"name"`
    // Colors of the backdrop
    Colors UniqueGiftBackdropColors `json:"colors"`
    // The number of unique gifts that receive this backdrop for every 1000 gifts upgraded
    RarityPerMille int64 `json:"rarity_per_mille"`
}

type UniqueGiftBackdropColors

This object describes the colors of the backdrop of a unique gift.

type UniqueGiftBackdropColors struct {
    // The color in the center of the backdrop in RGB format
    CenterColor int64 `json:"center_color"`
    // The color on the edges of the backdrop in RGB format
    EdgeColor int64 `json:"edge_color"`
    // The color to be applied to the symbol in RGB format
    SymbolColor int64 `json:"symbol_color"`
    // The color for the text on the backdrop in RGB format
    TextColor int64 `json:"text_color"`
}

type UniqueGiftColors

This object contains information about the color scheme for a user's name, message replies and link previews based on a unique gift.

type UniqueGiftColors struct {
    // Custom emoji identifier of the unique gift's model
    ModelCustomEmojiID string `json:"model_custom_emoji_id"`
    // Custom emoji identifier of the unique gift's symbol
    SymbolCustomEmojiID string `json:"symbol_custom_emoji_id"`
    // Main color used in light themes; RGB format
    LightThemeMainColor int64 `json:"light_theme_main_color"`
    // List of 1-3 additional colors used in light themes; RGB format
    LightThemeOtherColors []int64 `json:"light_theme_other_colors"`
    // Main color used in dark themes; RGB format
    DarkThemeMainColor int64 `json:"dark_theme_main_color"`
    // List of 1-3 additional colors used in dark themes; RGB format
    DarkThemeOtherColors []int64 `json:"dark_theme_other_colors"`
}

type UniqueGiftInfo

Describes a service message about a unique gift that was sent or received.

type UniqueGiftInfo struct {
    // Information about the gift
    Gift UniqueGift `json:"gift"`
    // Origin of the gift. Currently, either “upgrade” for gifts upgraded from regular gifts, “transfer” for gifts transferred from other users or channels, “resale” for gifts bought from other users, “gifted_upgrade” for upgrades purchased after the gift was sent, or “offer” for gifts bought or sold through gift purchase offers.
    Origin UniqueGiftInfoOrigin `json:"origin"`
    // Optional. For gifts bought from other users, the currency in which the payment for the gift was done. Currently, one of “XTR” for Telegram Stars or “TON” for toncoins.
    LastResaleCurrency SuggestedPostPaidCurrency `json:"last_resale_currency,omitempty"`
    // Optional. For gifts bought from other users, the price paid for the gift in either Telegram Stars or nanotoncoins
    LastResaleAmount *int64 `json:"last_resale_amount,omitempty"`
    // Optional. Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts
    OwnedGiftID string `json:"owned_gift_id,omitempty"`
    // Optional. Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift
    TransferStarCount *int64 `json:"transfer_star_count,omitempty"`
    // Optional. Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift can be transferred now.
    NextTransferDate *int64 `json:"next_transfer_date,omitempty"`
}

type UniqueGiftInfoOrigin

type UniqueGiftInfoOrigin string


const (
    UniqueGiftInfoOriginUpgrade       UniqueGiftInfoOrigin = "upgrade"
    UniqueGiftInfoOriginTransfer      UniqueGiftInfoOrigin = "transfer"
    UniqueGiftInfoOriginResale        UniqueGiftInfoOrigin = "resale"
    UniqueGiftInfoOriginGiftedUpgrade UniqueGiftInfoOrigin = "gifted_upgrade"
    UniqueGiftInfoOriginOffer         UniqueGiftInfoOrigin = "offer"
)

type UniqueGiftModel

This object describes the model of a unique gift.

type UniqueGiftModel struct {
    // Name of the model
    Name string `json:"name"`
    // The sticker that represents the unique gift
    Sticker Sticker `json:"sticker"`
    // The number of unique gifts that receive this model for every 1000 gift upgrades. Always 0 for crafted gifts.
    RarityPerMille int64 `json:"rarity_per_mille"`
    // Optional. Rarity of the model if it is a crafted model. Currently, can be “uncommon”, “rare”, “epic”, or “legendary”.
    Rarity UniqueGiftModelRarity `json:"rarity,omitempty"`
}

type UniqueGiftModelRarity

type UniqueGiftModelRarity string


const (
    UniqueGiftModelRarityUncommon  UniqueGiftModelRarity = "uncommon"
    UniqueGiftModelRarityRare      UniqueGiftModelRarity = "rare"
    UniqueGiftModelRarityEpic      UniqueGiftModelRarity = "epic"
    UniqueGiftModelRarityLegendary UniqueGiftModelRarity = "legendary"
)

type UniqueGiftSymbol

This object describes the symbol shown on the pattern of a unique gift.

type UniqueGiftSymbol struct {
    // Name of the symbol
    Name string `json:"name"`
    // The sticker that represents the unique gift
    Sticker Sticker `json:"sticker"`
    // The number of unique gifts that receive this model for every 1000 gifts upgraded
    RarityPerMille int64 `json:"rarity_per_mille"`
}

type UnpinAllChatMessagesParams

UnpinAllChatMessagesParams is the parameter set for UnpinAllChatMessages.

Use this method to clear the list of pinned messages in a chat. In private chats and channel direct messages chats, no additional rights are required to unpin all pinned messages. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin all pinned messages in groups and channels respectively. Returns True on success.

type UnpinAllChatMessagesParams struct {
    // Unique identifier for the target chat or username of the target channel in the format @username
    ChatID ChatID `json:"chat_id"`
}

type UnpinAllForumTopicMessagesParams

UnpinAllForumTopicMessagesParams is the parameter set for UnpinAllForumTopicMessages.

Use this method to clear the list of pinned messages in a forum topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat 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.

type UnpinAllForumTopicMessagesParams struct {
    // Unique identifier for the target chat or username of the target supergroup in the format @username
    ChatID ChatID `json:"chat_id"`
    // Unique identifier for the target message thread of the forum topic
    MessageThreadID int64 `json:"message_thread_id"`
}

type UnpinAllGeneralForumTopicMessagesParams

UnpinAllGeneralForumTopicMessagesParams is the parameter set for 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.

type UnpinAllGeneralForumTopicMessagesParams struct {
    // Unique identifier for the target chat or username of the target supergroup in the format @username
    ChatID ChatID `json:"chat_id"`
}

type UnpinChatMessageParams

UnpinChatMessageParams is the parameter set for UnpinChatMessage.

Use this method to remove a message from the list of pinned messages in a chat. In private chats and channel direct messages chats, all messages can be unpinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin messages in groups and channels respectively. Returns True on success.

type UnpinChatMessageParams struct {
    // Unique identifier of the business connection on behalf of which the message will be unpinned
    BusinessConnectionID string `json:"business_connection_id,omitempty"`
    // Unique identifier for the target chat or username of the target channel in the format @username
    ChatID ChatID `json:"chat_id"`
    // Identifier of the message to unpin. Required if business_connection_id is specified. If not specified, the most recent pinned message (by sending date) will be unpinned.
    MessageID *int64 `json:"message_id,omitempty"`
}

type Update

This object represents an incoming update.At most one of the optional fields can be present in any given update.

type Update struct {
    // The update's unique identifier. Update identifiers start from a certain positive number and increase sequentially. This identifier becomes especially handy if you're using webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order. If there are no new updates for at least a week, then identifier of the next update will be chosen randomly instead of sequentially.
    UpdateID int64 `json:"update_id"`
    // Optional. New incoming message of any kind - text, photo, sticker, etc.
    Message *Message `json:"message,omitempty"`
    // Optional. New version of a message that is known to the bot and was edited. This update may at times be triggered by changes to message fields that are either unavailable or not actively used by your bot.
    EditedMessage *Message `json:"edited_message,omitempty"`
    // Optional. New incoming channel post of any kind - text, photo, sticker, etc.
    ChannelPost *Message `json:"channel_post,omitempty"`
    // Optional. New version of a channel post that is known to the bot and was edited. This update may at times be triggered by changes to message fields that are either unavailable or not actively used by your bot.
    EditedChannelPost *Message `json:"edited_channel_post,omitempty"`
    // Optional. The bot was connected to or disconnected from a business account, or a user edited an existing connection with the bot
    BusinessConnection *BusinessConnection `json:"business_connection,omitempty"`
    // Optional. New message from a connected business account
    BusinessMessage *Message `json:"business_message,omitempty"`
    // Optional. New version of a message from a connected business account
    EditedBusinessMessage *Message `json:"edited_business_message,omitempty"`
    // Optional. Messages were deleted from a connected business account
    DeletedBusinessMessages *BusinessMessagesDeleted `json:"deleted_business_messages,omitempty"`
    // Optional. New guest message. The bot can use the field Message.guest_query_id and the method answerGuestQuery to send a message in response.
    GuestMessage *Message `json:"guest_message,omitempty"`
    // Optional. A reaction to a message was changed by a user. The bot must be an administrator in the chat and must explicitly specify "message_reaction" in the list of allowed_updates to receive these updates. The update isn't received for reactions set by bots.
    MessageReaction *MessageReactionUpdated `json:"message_reaction,omitempty"`
    // Optional. Reactions to a message with anonymous reactions were changed. The bot must be an administrator in the chat and must explicitly specify "message_reaction_count" in the list of allowed_updates to receive these updates. The updates are grouped and can be sent with delay up to a few minutes.
    MessageReactionCount *MessageReactionCountUpdated `json:"message_reaction_count,omitempty"`
    // Optional. New incoming inline query
    InlineQuery *InlineQuery `json:"inline_query,omitempty"`
    // Optional. The result of an inline query that was chosen by a user and sent to their chat partner. Please see our documentation on the feedback collecting for details on how to enable these updates for your bot.
    ChosenInlineResult *ChosenInlineResult `json:"chosen_inline_result,omitempty"`
    // Optional. New incoming callback query
    CallbackQuery *CallbackQuery `json:"callback_query,omitempty"`
    // Optional. New incoming shipping query. Only for invoices with flexible price.
    ShippingQuery *ShippingQuery `json:"shipping_query,omitempty"`
    // Optional. New incoming pre-checkout query. Contains full information about checkout.
    PreCheckoutQuery *PreCheckoutQuery `json:"pre_checkout_query,omitempty"`
    // Optional. A user purchased paid media with a non-empty payload sent by the bot in a non-channel chat
    PurchasedPaidMedia *PaidMediaPurchased `json:"purchased_paid_media,omitempty"`
    // Optional. New poll state. Bots receive only updates about manually stopped polls and polls, which are sent by the bot.
    Poll *Poll `json:"poll,omitempty"`
    // Optional. A user changed their answer in a non-anonymous poll. Bots receive new votes only in polls that were sent by the bot itself.
    PollAnswer *PollAnswer `json:"poll_answer,omitempty"`
    // Optional. The bot's chat member status was updated in a chat. For private chats, this update is received only when the bot is blocked or unblocked by the user.
    MyChatMember *ChatMemberUpdated `json:"my_chat_member,omitempty"`
    // Optional. A chat member's status was updated in a chat. The bot must be an administrator in the chat and must explicitly specify "chat_member" in the list of allowed_updates to receive these updates.
    ChatMember *ChatMemberUpdated `json:"chat_member,omitempty"`
    // Optional. A request to join the chat has been sent. The bot must have the can_invite_users administrator right in the chat to receive these updates.
    ChatJoinRequest *ChatJoinRequest `json:"chat_join_request,omitempty"`
    // Optional. A chat boost was added or changed. The bot must be an administrator in the chat to receive these updates.
    ChatBoost *ChatBoostUpdated `json:"chat_boost,omitempty"`
    // Optional. A boost was removed from a chat. The bot must be an administrator in the chat to receive these updates.
    RemovedChatBoost *ChatBoostRemoved `json:"removed_chat_boost,omitempty"`
    // Optional. A new bot was created to be managed by the bot, or token or owner of a managed bot was changed
    ManagedBot *ManagedBotUpdated `json:"managed_bot,omitempty"`
}

func GetUpdates

func GetUpdates(ctx context.Context, b *client.Bot, p *GetUpdatesParams) ([]Update, error)

GetUpdates calls the getUpdates Telegram Bot API method.

Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects. Notes1. This method will not work if an outgoing webhook is set up.2. In order to avoid getting duplicate updates, recalculate offset after each server response.

type UpdateType

UpdateType identifies an Update payload variant. Used by allowed_updates in getUpdates / setWebhook. The Telegram docs do not enumerate these values inline (they are derived from the optional fields of Update), so the codegen pipeline cannot synthesise this enum and it lives here as a hand-curated companion to the generated enums.gen.go.

type UpdateType string


const (
    UpdateMessage                 UpdateType = "message"
    UpdateEditedMessage           UpdateType = "edited_message"
    UpdateChannelPost             UpdateType = "channel_post"
    UpdateEditedChannelPost       UpdateType = "edited_channel_post"
    UpdateBusinessConnection      UpdateType = "business_connection"
    UpdateBusinessMessage         UpdateType = "business_message"
    UpdateEditedBusinessMessage   UpdateType = "edited_business_message"
    UpdateDeletedBusinessMessages UpdateType = "deleted_business_messages"
    UpdateMessageReaction         UpdateType = "message_reaction"
    UpdateMessageReactionCount    UpdateType = "message_reaction_count"
    UpdateInlineQuery             UpdateType = "inline_query"
    UpdateChosenInlineResult      UpdateType = "chosen_inline_result"
    UpdateCallbackQuery           UpdateType = "callback_query"
    UpdateShippingQuery           UpdateType = "shipping_query"
    UpdatePreCheckoutQuery        UpdateType = "pre_checkout_query"
    UpdatePurchasedPaidMedia      UpdateType = "purchased_paid_media"
    UpdatePoll                    UpdateType = "poll"
    UpdatePollAnswer              UpdateType = "poll_answer"
    UpdateMyChatMember            UpdateType = "my_chat_member"
    UpdateChatMember              UpdateType = "chat_member"
    UpdateChatJoinRequest         UpdateType = "chat_join_request"
    UpdateChatBoost               UpdateType = "chat_boost"
    UpdateRemovedChatBoost        UpdateType = "removed_chat_boost"
)

type UpgradeGiftParams

UpgradeGiftParams is the parameter set for UpgradeGift.

Upgrades a given regular gift to a unique gift. Requires the can_transfer_and_upgrade_gifts business bot right. Additionally requires the can_transfer_stars business bot right if the upgrade is paid. Returns True on success.

type UpgradeGiftParams struct {
    // Unique identifier of the business connection
    BusinessConnectionID string `json:"business_connection_id"`
    // Unique identifier of the regular gift that should be upgraded to a unique one
    OwnedGiftID string `json:"owned_gift_id"`
    // Pass True to keep the original gift text, sender and receiver in the upgraded gift
    KeepOriginalDetails *bool `json:"keep_original_details,omitempty"`
    // The amount of Telegram Stars that will be paid for the upgrade from the business account balance. If gift.prepaid_upgrade_star_count > 0, then pass 0, otherwise, the can_transfer_stars business bot right is required and gift.upgrade_star_count must be passed.
    StarCount *int64 `json:"star_count,omitempty"`
}

type UploadStickerFileParams

UploadStickerFileParams is the parameter set for UploadStickerFile.

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

type UploadStickerFileParams struct {
    // User identifier of sticker file owner
    UserID int64 `json:"user_id"`
    // 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 »
    Sticker *InputFile `json:"sticker"`
    // Format of the sticker, must be one of “static”, “animated”, “video”
    StickerFormat InputStickerFormat `json:"sticker_format"`
}

func (*UploadStickerFileParams) HasFile

func (p *UploadStickerFileParams) HasFile() bool

HasFile reports whether a multipart upload is required.

func (*UploadStickerFileParams) MultipartFields

func (p *UploadStickerFileParams) MultipartFields() map[string]string

MultipartFields returns the non-file fields used in the multipart body.

func (*UploadStickerFileParams) MultipartFiles

func (p *UploadStickerFileParams) MultipartFiles() []client.MultipartFile

MultipartFiles returns the file parts.

type User

This object represents a Telegram user or bot.

type User struct {
    // Unique identifier for this user or bot. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.
    ID  int64 `json:"id"`
    // True, if this user is a bot
    IsBot bool `json:"is_bot"`
    // User's or bot's first name
    FirstName string `json:"first_name"`
    // Optional. User's or bot's last name
    LastName string `json:"last_name,omitempty"`
    // Optional. User's or bot's username
    Username string `json:"username,omitempty"`
    // Optional. IETF language tag of the user's language
    LanguageCode string `json:"language_code,omitempty"`
    // Optional. True, if this user is a Telegram Premium user
    IsPremium *bool `json:"is_premium,omitempty"`
    // Optional. True, if this user added the bot to the attachment menu
    AddedToAttachmentMenu *bool `json:"added_to_attachment_menu,omitempty"`
    // Optional. True, if the bot can be invited to groups. Returned only in getMe.
    CanJoinGroups *bool `json:"can_join_groups,omitempty"`
    // Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.
    CanReadAllGroupMessages *bool `json:"can_read_all_group_messages,omitempty"`
    // Optional. True, if the bot supports guest queries from chats it is not a member of. Returned only in getMe.
    SupportsGuestQueries *bool `json:"supports_guest_queries,omitempty"`
    // Optional. True, if the bot supports inline queries. Returned only in getMe.
    SupportsInlineQueries *bool `json:"supports_inline_queries,omitempty"`
    // Optional. True, if the bot can be connected to a user account to manage it. Returned only in getMe.
    CanConnectToBusiness *bool `json:"can_connect_to_business,omitempty"`
    // Optional. True, if the bot has a main Web App. Returned only in getMe.
    HasMainWebApp *bool `json:"has_main_web_app,omitempty"`
    // Optional. True, if the bot has forum topic mode enabled in private chats. Returned only in getMe.
    HasTopicsEnabled *bool `json:"has_topics_enabled,omitempty"`
    // Optional. True, if the bot allows users to create and delete topics in private chats. Returned only in getMe.
    AllowsUsersToCreateTopics *bool `json:"allows_users_to_create_topics,omitempty"`
    // Optional. True, if other bots can be created to be controlled by the bot. Returned only in getMe.
    CanManageBots *bool `json:"can_manage_bots,omitempty"`
}

func GetMe

func GetMe(ctx context.Context, b *client.Bot, p *GetMeParams) (*User, error)

GetMe calls the getMe Telegram Bot API method.

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.

type UserChatBoosts

This object represents a list of boosts added to a chat by a user.

type UserChatBoosts struct {
    // The list of boosts added to the chat by the user
    Boosts []ChatBoost `json:"boosts"`
}

func GetUserChatBoosts

func GetUserChatBoosts(ctx context.Context, b *client.Bot, p *GetUserChatBoostsParams) (*UserChatBoosts, error)

GetUserChatBoosts calls the getUserChatBoosts Telegram Bot API method.

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.

type UserProfileAudios

This object represents the audios displayed on a user's profile.

type UserProfileAudios struct {
    // Total number of profile audios for the target user
    TotalCount int64 `json:"total_count"`
    // Requested profile audios
    Audios []Audio `json:"audios"`
}

func GetUserProfileAudios

func GetUserProfileAudios(ctx context.Context, b *client.Bot, p *GetUserProfileAudiosParams) (*UserProfileAudios, error)

GetUserProfileAudios calls the getUserProfileAudios Telegram Bot API method.

Use this method to get a list of profile audios for a user. Returns a UserProfileAudios object.

type UserProfilePhotos

This object represent a user's profile pictures.

type UserProfilePhotos struct {
    // Total number of profile pictures the target user has
    TotalCount int64 `json:"total_count"`
    // Requested profile pictures (in up to 4 sizes each)
    Photos [][]PhotoSize `json:"photos"`
}

func GetUserProfilePhotos

func GetUserProfilePhotos(ctx context.Context, b *client.Bot, p *GetUserProfilePhotosParams) (*UserProfilePhotos, error)

GetUserProfilePhotos calls the getUserProfilePhotos Telegram Bot API method.

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

type UserRating

This object describes the rating of a user based on their Telegram Star spendings.

type UserRating struct {
    // Current level of the user, indicating their reliability when purchasing digital goods and services. A higher level suggests a more trustworthy customer; a negative level is likely reason for concern.
    Level int64 `json:"level"`
    // Numerical value of the user's rating; the higher the rating, the better
    Rating int64 `json:"rating"`
    // The rating value required to get the current level
    CurrentLevelRating int64 `json:"current_level_rating"`
    // Optional. The rating value required to get to the next level; omitted if the maximum level was reached
    NextLevelRating *int64 `json:"next_level_rating,omitempty"`
}

type UsersShared

This object contains information about the users whose identifiers were shared with the bot using a KeyboardButtonRequestUsers button.

type UsersShared struct {
    // Identifier of the request
    RequestID int64 `json:"request_id"`
    // Information about users shared with the bot
    Users []SharedUser `json:"users"`
}

type Venue

This object represents a venue.

type Venue struct {
    // Venue location. Can't be a live location.
    Location Location `json:"location"`
    // Name of the venue
    Title string `json:"title"`
    // Address of the venue
    Address string `json:"address"`
    // Optional. Foursquare identifier of the venue
    FoursquareID string `json:"foursquare_id,omitempty"`
    // Optional. Foursquare type of the venue. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)
    FoursquareType string `json:"foursquare_type,omitempty"`
    // Optional. Google Places identifier of the venue
    GooglePlaceID string `json:"google_place_id,omitempty"`
    // Optional. Google Places type of the venue. (See supported types.)
    GooglePlaceType string `json:"google_place_type,omitempty"`
}

type VerifyChatParams

VerifyChatParams is the parameter set for VerifyChat.

Verifies a chat on behalf of the organization which is represented by the bot. Returns True on success.

type VerifyChatParams struct {
    // Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. Channel direct messages chats can't be verified.
    ChatID ChatID `json:"chat_id"`
    // Custom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description.
    CustomDescription string `json:"custom_description,omitempty"`
}

type VerifyUserParams

VerifyUserParams is the parameter set for VerifyUser.

Verifies a user on behalf of the organization which is represented by the bot. Returns True on success.

type VerifyUserParams struct {
    // Unique identifier of the target user
    UserID int64 `json:"user_id"`
    // Custom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description.
    CustomDescription string `json:"custom_description,omitempty"`
}

type Video

This object represents a video file.

type Video struct {
    // Identifier for this file, which can be used to download or reuse the file
    FileID string `json:"file_id"`
    // Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
    FileUniqueID string `json:"file_unique_id"`
    // Video width as defined by the sender
    Width int64 `json:"width"`
    // Video height as defined by the sender
    Height int64 `json:"height"`
    // Duration of the video in seconds as defined by the sender
    Duration int64 `json:"duration"`
    // Optional. Video thumbnail
    Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
    // Optional. Available sizes of the cover of the video in the message
    Cover []PhotoSize `json:"cover,omitempty"`
    // Optional. Timestamp in seconds from which the video will play in the message
    StartTimestamp *int64 `json:"start_timestamp,omitempty"`
    // Optional. List of available qualities of the video
    Qualities []VideoQuality `json:"qualities,omitempty"`
    // Optional. Original filename as defined by the sender
    FileName string `json:"file_name,omitempty"`
    // Optional. MIME type of the file as defined by the sender
    MimeType string `json:"mime_type,omitempty"`
    // Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
    FileSize *int64 `json:"file_size,omitempty"`
}

type VideoChatEnded

This object represents a service message about a video chat ended in the chat.

type VideoChatEnded struct {
    // Video chat duration in seconds
    Duration int64 `json:"duration"`
}

type VideoChatParticipantsInvited

This object represents a service message about new members invited to a video chat.

type VideoChatParticipantsInvited struct {
    // New members that were invited to the video chat
    Users []User `json:"users"`
}

type VideoChatScheduled

This object represents a service message about a video chat scheduled in the chat.

type VideoChatScheduled struct {
    // Point in time (Unix timestamp) when the video chat is supposed to be started by a chat administrator
    StartDate int64 `json:"start_date"`
}

type VideoChatStarted

This object represents a service message about a video chat started in the chat. Currently holds no information.

type VideoChatStarted struct {
}

type VideoNote

This object represents a video message (available in Telegram apps as of v.4.0).

type VideoNote struct {
    // Identifier for this file, which can be used to download or reuse the file
    FileID string `json:"file_id"`
    // Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
    FileUniqueID string `json:"file_unique_id"`
    // Video width and height (diameter of the video message) as defined by the sender
    Length int64 `json:"length"`
    // Duration of the video in seconds as defined by the sender
    Duration int64 `json:"duration"`
    // Optional. Video thumbnail
    Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
    // Optional. File size in bytes
    FileSize *int64 `json:"file_size,omitempty"`
}

type VideoQuality

This object represents a video file of a specific quality.

type VideoQuality struct {
    // Identifier for this file, which can be used to download or reuse the file
    FileID string `json:"file_id"`
    // Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
    FileUniqueID string `json:"file_unique_id"`
    // Video width
    Width int64 `json:"width"`
    // Video height
    Height int64 `json:"height"`
    // Codec that was used to encode the video, for example, “h264”, “h265”, or “av01”
    Codec string `json:"codec"`
    // Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
    FileSize *int64 `json:"file_size,omitempty"`
}

type Voice

This object represents a voice note.

type Voice struct {
    // Identifier for this file, which can be used to download or reuse the file
    FileID string `json:"file_id"`
    // Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
    FileUniqueID string `json:"file_unique_id"`
    // Duration of the audio in seconds as defined by the sender
    Duration int64 `json:"duration"`
    // Optional. MIME type of the file as defined by the sender
    MimeType string `json:"mime_type,omitempty"`
    // Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
    FileSize *int64 `json:"file_size,omitempty"`
}

type WebAppData

Describes data sent from a Web App to the bot.

type WebAppData struct {
    // The data. Be aware that a bad client can send arbitrary data in this field.
    Data string `json:"data"`
    // Text of the web_app keyboard button from which the Web App was opened. Be aware that a bad client can send arbitrary data in this field.
    ButtonText string `json:"button_text"`
}

type WebAppInfo

Describes a Web App.

type WebAppInfo struct {
    // An HTTPS URL of a Web App to be opened with additional data as specified in Initializing Web Apps
    URL string `json:"url"`
}

type WebhookInfo

Describes the current status of a webhook.

type WebhookInfo struct {
    // Webhook URL, may be empty if webhook is not set up
    URL string `json:"url"`
    // True, if a custom certificate was provided for webhook certificate checks
    HasCustomCertificate bool `json:"has_custom_certificate"`
    // Number of updates awaiting delivery
    PendingUpdateCount int64 `json:"pending_update_count"`
    // Optional. Currently used webhook IP address
    IPAddress string `json:"ip_address,omitempty"`
    // Optional. Unix time for the most recent error that happened when trying to deliver an update via webhook
    LastErrorDate *int64 `json:"last_error_date,omitempty"`
    // Optional. Error message in human-readable format for the most recent error that happened when trying to deliver an update via webhook
    LastErrorMessage string `json:"last_error_message,omitempty"`
    // Optional. Unix time of the most recent error that happened when trying to synchronize available updates with Telegram datacenters
    LastSynchronizationErrorDate *int64 `json:"last_synchronization_error_date,omitempty"`
    // Optional. The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery
    MaxConnections *int64 `json:"max_connections,omitempty"`
    // Optional. A list of update types the bot is subscribed to. Defaults to all update types except chat_member, message_reaction, and message_reaction_count.
    AllowedUpdates []UpdateType `json:"allowed_updates,omitempty"`
}

func GetWebhookInfo

func GetWebhookInfo(ctx context.Context, b *client.Bot, p *GetWebhookInfoParams) (*WebhookInfo, error)

GetWebhookInfo calls the getWebhookInfo Telegram Bot API method.

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.

type WriteAccessAllowed

This object represents a service message about a user allowing a bot to write messages after adding it to the attachment menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method requestWriteAccess.

type WriteAccessAllowed struct {
    // Optional. True, if the access was granted after the user accepted an explicit request from a Web App sent by the method requestWriteAccess
    FromRequest *bool `json:"from_request,omitempty"`
    // Optional. Name of the Web App, if the access was granted when the Web App was launched from a link
    WebAppName string `json:"web_app_name,omitempty"`
    // Optional. True, if the access was granted when the bot was added to the attachment or side menu
    FromAttachmentMenu *bool `json:"from_attachment_menu,omitempty"`
}

Generated by gomarkdoc

Reference in New Issue View Git Blame Copy Permalink