Documentation ¶
Index ¶
- func GetHash(salt string, bot *Bot) string
- type AddStickerToSetRequest
- type Animation
- type AnswerCallbackQueryRequest
- type AnswerInlineQueryRequest
- type AnswerPreCheckoutQueryRequest
- type AnswerShippingQueryRequest
- type AnyKeyboard
- type Audio
- type Bot
- func (b *Bot) AddStickerToSet(req *AddStickerToSetRequest) (json.RawMessage, error)
- func (b *Bot) AnswerCallbackQuery(req *AnswerCallbackQueryRequest) (json.RawMessage, error)
- func (b *Bot) AnswerInlineQuery(req *AnswerInlineQueryRequest) (json.RawMessage, error)
- func (b *Bot) AnswerPreCheckoutQuery(req *AnswerPreCheckoutQueryRequest) (*Update, error)
- func (b *Bot) AnswerShippingQuery(req *AnswerShippingQueryRequest) (*Update, error)
- func (b *Bot) Close(req *CloseRequest) (json.RawMessage, error)
- func (b *Bot) CopyMessage(req *CopyMessageRequest) (*MessageId, error)
- func (b *Bot) CreateChatInviteLink(req *CreateChatInviteLinkRequest) (*ChatInviteLink, error)
- func (b *Bot) CreateNewStickerSet(req *CreateNewStickerSetRequest) (json.RawMessage, error)
- func (b *Bot) DeleteChatPhoto(req *DeleteChatPhotoRequest) (json.RawMessage, error)
- func (b *Bot) DeleteChatStickerSet(req *DeleteChatStickerSetRequest) (json.RawMessage, error)
- func (b *Bot) DeleteMessage(req *DeleteMessageRequest) (json.RawMessage, error)
- func (b *Bot) DeleteStickerFromSet(req *DeleteStickerFromSetRequest) (json.RawMessage, error)
- func (b *Bot) DeleteWebhook(req *DeleteWebhookRequest) (json.RawMessage, error)
- func (b *Bot) EditChatInviteLink(req *EditChatInviteLinkRequest) (*ChatInviteLink, error)
- func (b *Bot) EditMessageCaption(req *EditMessageCaptionRequest) (*Message, error)
- func (b *Bot) EditMessageLiveLocation(req *EditMessageLiveLocationRequest) (*Message, error)
- func (b *Bot) EditMessageMedia(req *EditMessageMediaRequest) (*Message, error)
- func (b *Bot) EditMessageReplyMarkup(req *EditMessageReplyMarkupRequest) (*Message, error)
- func (b *Bot) EditMessageText(req *EditMessageTextRequest) (*Message, error)
- func (b *Bot) ExportChatInviteLink(req *ExportChatInviteLinkRequest) (json.RawMessage, error)
- func (b *Bot) ForwardMessage(req *ForwardMessageRequest) (*Message, error)
- func (b *Bot) GetChat(req *GetChatRequest) (*Chat, error)
- func (b *Bot) GetChatAdministrators(req *GetChatAdministratorsRequest) (*ChatMember, error)
- func (b *Bot) GetChatMember(req *GetChatMemberRequest) (*ChatMember, error)
- func (b *Bot) GetChatMembersCount(req *GetChatMembersCountRequest) (json.RawMessage, error)
- func (b *Bot) GetFile(req *GetFileRequest) (*File, error)
- func (b *Bot) GetFileURL(fileID string, uploader func(tempURL string) (string, error)) (string, error)
- func (b *Bot) GetGameHighScores(req *GetGameHighScoresRequest) (*GameHighScore, error)
- func (b *Bot) GetMe(req *GetMeRequest) (*User, error)
- func (b *Bot) GetMyCommands(req *GetMyCommandsRequest) (*BotCommand, error)
- func (b *Bot) GetStickerSet(req *GetStickerSetRequest) (*StickerSet, error)
- func (b *Bot) GetUpdates(req *GetUpdatesRequest) (*[]Update, error)
- func (b *Bot) GetUserProfilePhotos(req *GetUserProfilePhotosRequest) (*UserProfilePhotos, error)
- func (b *Bot) GetWebhookInfo(req *GetWebhookInfoRequest) (*WebhookInfo, error)
- func (b *Bot) KickChatMember(req *KickChatMemberRequest) (json.RawMessage, error)
- func (b *Bot) LeaveChat(req *LeaveChatRequest) (json.RawMessage, error)
- func (b *Bot) LogOut(req *LogOutRequest) (json.RawMessage, error)
- func (b *Bot) PinChatMessage(req *PinChatMessageRequest) (json.RawMessage, error)
- func (b *Bot) PromoteChatMember(req *PromoteChatMemberRequest) (json.RawMessage, error)
- func (b *Bot) RestrictChatMember(req *RestrictChatMemberRequest) (json.RawMessage, error)
- func (b *Bot) RevokeChatInviteLink(req *RevokeChatInviteLinkRequest) (*ChatInviteLink, error)
- func (b *Bot) SendAnimation(req *SendAnimationRequest) (*Message, error)
- func (b *Bot) SendAudio(req *SendAudioRequest) (*Message, error)
- func (b *Bot) SendChatAction(req *SendChatActionRequest) (json.RawMessage, error)
- func (b *Bot) SendContact(req *SendContactRequest) (*Message, error)
- func (b *Bot) SendDice(req *SendDiceRequest) (*Message, error)
- func (b *Bot) SendDocument(req *SendDocumentRequest) (*Message, error)
- func (b *Bot) SendGame(req *SendGameRequest) (*Message, error)
- func (b *Bot) SendInvoice(req *SendInvoiceRequest) (*Message, error)
- func (b *Bot) SendLocation(req *SendLocationRequest) (*Message, error)
- func (b *Bot) SendMessage(req *SendMessageRequest) (*Message, error)
- func (b *Bot) SendPhoto(req *SendPhotoRequest) (*Message, error)
- func (b *Bot) SendPoll(req *SendPollRequest) (*Message, error)
- func (b *Bot) SendSticker(req *SendStickerRequest) (*Message, error)
- func (b *Bot) SendVenue(req *SendVenueRequest) (*Message, error)
- func (b *Bot) SendVideo(req *SendVideoRequest) (*Message, error)
- func (b *Bot) SendVideoNote(req *SendVideoNoteRequest) (*Message, error)
- func (b *Bot) SendVoice(req *SendVoiceRequest) (*Message, error)
- func (b *Bot) SetChatAdministratorCustomTitle(req *SetChatAdministratorCustomTitleRequest) (json.RawMessage, error)
- func (b *Bot) SetChatDescription(req *SetChatDescriptionRequest) (json.RawMessage, error)
- func (b *Bot) SetChatPermissions(req *SetChatPermissionsRequest) (json.RawMessage, error)
- func (b *Bot) SetChatPhoto(req *SetChatPhotoRequest) (json.RawMessage, error)
- func (b *Bot) SetChatStickerSet(req *SetChatStickerSetRequest) (json.RawMessage, error)
- func (b *Bot) SetChatTitle(req *SetChatTitleRequest) (json.RawMessage, error)
- func (b *Bot) SetGameScore(req *SetGameScoreRequest) (*Message, error)
- func (b *Bot) SetMyCommands(req *SetMyCommandsRequest) (json.RawMessage, error)
- func (b *Bot) SetPassportDataErrors(req *SetPassportDataErrorsRequest) (json.RawMessage, error)
- func (b *Bot) SetStickerPositionInSet(req *SetStickerPositionInSetRequest) (json.RawMessage, error)
- func (b *Bot) SetStickerSetThumb(req *SetStickerSetThumbRequest) (json.RawMessage, error)
- func (b *Bot) SetWebhook(req *SetWebhookRequest) (json.RawMessage, error)
- func (b *Bot) StopMessageLiveLocation(req *StopMessageLiveLocationRequest) (*Message, error)
- func (b *Bot) StopPoll(req *StopPollRequest) (*Poll, error)
- func (b *Bot) UnbanChatMember(req *UnbanChatMemberRequest) (json.RawMessage, error)
- func (b *Bot) UnpinAllChatMessages(req *UnpinAllChatMessagesRequest) (json.RawMessage, error)
- func (b *Bot) UnpinChatMessage(req *UnpinChatMessageRequest) (json.RawMessage, error)
- func (b *Bot) UploadStickerFile(req *UploadStickerFileRequest) (*File, error)
- type BotCommand
- type CallbackGame
- type CallbackQuery
- type Chat
- type ChatInviteLink
- type ChatLocation
- type ChatMember
- type ChatMemberUpdated
- type ChatPermissions
- type ChatPhoto
- type ChosenInlineResult
- type CloseRequest
- type Contact
- type CopyMessageRequest
- type CreateChatInviteLinkRequest
- type CreateNewStickerSetRequest
- type DeleteChatPhotoRequest
- type DeleteChatStickerSetRequest
- type DeleteMessageRequest
- type DeleteStickerFromSetRequest
- type DeleteWebhookRequest
- type Dice
- type Document
- type EditChatInviteLinkRequest
- type EditMessageCaptionRequest
- type EditMessageLiveLocationRequest
- type EditMessageMediaRequest
- type EditMessageReplyMarkupRequest
- type EditMessageTextRequest
- type EncryptedCredentials
- type EncryptedPassportElement
- type ErrorResponse
- type ExportChatInviteLinkRequest
- type File
- type FileUploader
- type Fileable
- type ForceReply
- type ForwardMessageRequest
- type Game
- type GameHighScore
- type GetChatAdministratorsRequest
- type GetChatMemberRequest
- type GetChatMembersCountRequest
- type GetChatRequest
- type GetFileRequest
- type GetGameHighScoresRequest
- type GetMeRequest
- type GetMyCommandsRequest
- type GetStickerSetRequest
- type GetUpdatesRequest
- type GetUserProfilePhotosRequest
- type GetWebhookInfoRequest
- type InlineKeyboardButton
- type InlineKeyboardMarkup
- type InlineQuery
- type InlineQueryResult
- type InlineQueryResultArticle
- type InlineQueryResultAudio
- type InlineQueryResultCachedAudio
- type InlineQueryResultCachedDocument
- type InlineQueryResultCachedGif
- type InlineQueryResultCachedMpeg4Gif
- type InlineQueryResultCachedPhoto
- type InlineQueryResultCachedSticker
- type InlineQueryResultCachedVideo
- type InlineQueryResultCachedVoice
- type InlineQueryResultContact
- type InlineQueryResultDocument
- type InlineQueryResultGame
- type InlineQueryResultGif
- type InlineQueryResultLocation
- type InlineQueryResultMpeg4Gif
- type InlineQueryResultPhoto
- type InlineQueryResultVenue
- type InlineQueryResultVideo
- type InlineQueryResultVoice
- type InputContactMessageContent
- type InputFile
- type InputInvoiceMessageContent
- type InputLocationMessageContent
- type InputMedia
- type InputMediaAnimation
- type InputMediaAudio
- type InputMediaDocument
- type InputMediaPhoto
- type InputMediaVideo
- type InputMessageContent
- type InputTextMessageContent
- type InputVenueMessageContent
- type Invoice
- type KeyboardButton
- type KeyboardButtonPollType
- type KickChatMemberRequest
- type LabeledPrice
- type LeaveChatRequest
- type Location
- type LogOutRequest
- type LoginURL
- type MaskPosition
- type Message
- type MessageAutoDeleteTimerChanged
- type MessageEntity
- type MessageId
- type Opts
- type OrderInfo
- type PassportData
- type PassportElementError
- type PassportElementErrorDataField
- type PassportElementErrorFile
- type PassportElementErrorFiles
- type PassportElementErrorFrontSide
- type PassportElementErrorReverseSide
- type PassportElementErrorSelfie
- type PassportElementErrorTranslationFile
- type PassportElementErrorTranslationFiles
- type PassportElementErrorUnspecified
- type PassportFile
- type PhotoSize
- type PinChatMessageRequest
- type Poll
- type PollAnswer
- type PollOption
- type PreCheckoutQuery
- type PromoteChatMemberRequest
- type ProximityAlertTriggered
- type ReplyKeyboardMarkup
- type ReplyKeyboardRemove
- type RequestHandler
- type Response
- type ResponseParameters
- type RestrictChatMemberRequest
- type RevokeChatInviteLinkRequest
- type SendAnimationRequest
- type SendAudioRequest
- type SendChatActionRequest
- type SendContactRequest
- type SendDiceRequest
- type SendDocumentRequest
- type SendGameRequest
- type SendInvoiceRequest
- type SendLocationRequest
- type SendMessageRequest
- type SendPhotoRequest
- type SendPollRequest
- type SendStickerRequest
- type SendVenueRequest
- type SendVideoNoteRequest
- type SendVideoRequest
- type SendVoiceRequest
- type SetChatAdministratorCustomTitleRequest
- type SetChatDescriptionRequest
- type SetChatPermissionsRequest
- type SetChatPhotoRequest
- type SetChatStickerSetRequest
- type SetChatTitleRequest
- type SetGameScoreRequest
- type SetMyCommandsRequest
- type SetPassportDataErrorsRequest
- type SetStickerPositionInSetRequest
- type SetStickerSetThumbRequest
- type SetWebhookRequest
- type ShippingAddress
- type ShippingOption
- type ShippingQuery
- type Sticker
- type StickerSet
- type StopMessageLiveLocationRequest
- type StopPollRequest
- type SuccessfulPayment
- type UnbanChatMemberRequest
- type UnpinAllChatMessagesRequest
- type UnpinChatMessageRequest
- type Update
- type UploadStickerFileRequest
- type User
- type UserProfilePhotos
- type Venue
- type Video
- type VideoNote
- type Voice
- type VoiceChatEnded
- type VoiceChatParticipantsInvited
- type VoiceChatScheduled
- type VoiceChatStarted
- type WebhookInfo
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type AddStickerToSetRequest ¶
type AddStickerToSetRequest struct { // User identifier of sticker set owner UserID int `json:"user_id"` // Sticker set name Name string `json:"name"` // Optional. PNG image with the sticker, must be up to 512 kilobytes in size, // dimensions must not exceed 512px, and either width or height must be exactly // 512px. 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 info on // Sending Files » PngSticker Fileable `json:"png_sticker,omitempty"` // Optional. TGS animation with the sticker, uploaded using multipart/form-data. // See https://core.telegram.org/animated_stickers#technical-requirements for // technical requirements TgsSticker *InputFile `json:"tgs_sticker,omitempty"` // One or more emoji corresponding to the sticker Emojis string `json:"emojis"` // Optional. A JSON-serialized object for position where the mask should be placed // on faces MaskPosition *MaskPosition `json:"mask_position,omitempty"` }
type Animation ¶
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 sender Width int `json:"width"` // Video height as defined by sender Height int `json:"height"` // Duration of the video in seconds as defined by sender Duration int `json:"duration"` // Optional. Animation thumbnail as defined by sender Thumb *PhotoSize `json:"thumb,omitempty"` // Optional. Original animation filename as defined by sender FileName string `json:"file_name,omitempty"` // Optional. MIME type of the file as defined by sender MimeType string `json:"mime_type,omitempty"` // Optional. File size FileSize int `json:"file_size,omitempty"` }
This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).
type AnswerCallbackQueryRequest ¶
type AnswerCallbackQueryRequest struct { // Unique identifier for the query to be answered CallbackQueryID string `json:"callback_query_id"` // Optional. Text of the notification. If not specified, nothing will be shown to // the user, 0-200 characters Text string `json:"text,omitempty"` // Optional. 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"` // Optional. 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"` // Optional. 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 int `json:"cache_time,omitempty"` }
type AnswerInlineQueryRequest ¶
type AnswerInlineQueryRequest 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"` // Optional. The maximum amount of time in seconds that the result of the inline // query may be cached on the server. Defaults to 300. CacheTime int `json:"cache_time,omitempty"` // Optional. 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"` // Optional. 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"` // Optional. If passed, clients will display a button with specified text that // switches the user to a private chat with the bot and sends the bot a start // message with the parameter switch_pm_parameter SwitchPmText string `json:"switch_pm_text,omitempty"` // Optional. Deep-linking parameter for the /start message sent to the bot when // user presses the switch 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. SwitchPmParameter string `json:"switch_pm_parameter,omitempty"` }
type AnswerPreCheckoutQueryRequest ¶
type AnswerPreCheckoutQueryRequest 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"` // Optional. 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 AnswerShippingQueryRequest ¶
type AnswerShippingQueryRequest struct { // Unique identifier for the query to be answered ShippingQueryID string `json:"shipping_query_id"` // Specify 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"` // Optional. Required if ok is True. A JSON-serialized array of available shipping // options. ShippingOptions []ShippingOption `json:"shipping_options,omitempty"` // Optional. 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 AnyKeyboard ¶
type AnyKeyboard interface{}
type Audio ¶
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 sender Duration int `json:"duration"` // Optional. Performer of the audio as defined by sender or by audio tags Performer string `json:"performer,omitempty"` // Optional. Title of the audio as defined by sender or by audio tags Title string `json:"title,omitempty"` // Optional. Original filename as defined by sender FileName string `json:"file_name,omitempty"` // Optional. MIME type of the file as defined by sender MimeType string `json:"mime_type,omitempty"` // Optional. File size FileSize int `json:"file_size,omitempty"` // Optional. Thumbnail of the album cover to which the music file belongs Thumb *PhotoSize `json:"thumb,omitempty"` }
This object represents an audio file to be treated as music by the Telegram clients.
type Bot ¶
type Bot struct {
// contains filtered or unexported fields
}
func NewBotWithOpts ¶
func (*Bot) AddStickerToSet ¶
func (b *Bot) AddStickerToSet(req *AddStickerToSetRequest) (json.RawMessage, error)
Use this method to add a new sticker to a set created by the bot. You must use exactly one of the fields png_sticker or tgs_sticker. Animated stickers can be added to animated sticker sets and only to them. Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.
func (*Bot) AnswerCallbackQuery ¶
func (b *Bot) AnswerCallbackQuery(req *AnswerCallbackQueryRequest) (json.RawMessage, error)
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 (*Bot) AnswerInlineQuery ¶
func (b *Bot) AnswerInlineQuery(req *AnswerInlineQueryRequest) (json.RawMessage, error)
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 (*Bot) AnswerPreCheckoutQuery ¶
func (b *Bot) AnswerPreCheckoutQuery(req *AnswerPreCheckoutQueryRequest) (*Update, error)
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 (*Bot) AnswerShippingQuery ¶
func (b *Bot) AnswerShippingQuery(req *AnswerShippingQueryRequest) (*Update, error)
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 (*Bot) Close ¶
func (b *Bot) Close(req *CloseRequest) (json.RawMessage, error)
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 (*Bot) CopyMessage ¶
func (b *Bot) CopyMessage(req *CopyMessageRequest) (*MessageId, error)
Use this method to copy messages of any kind. Service messages and invoice messages can't be copied. 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 (*Bot) CreateChatInviteLink ¶
func (b *Bot) CreateChatInviteLink(req *CreateChatInviteLinkRequest) (*ChatInviteLink, error)
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 admin rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.
func (*Bot) CreateNewStickerSet ¶
func (b *Bot) CreateNewStickerSet(req *CreateNewStickerSetRequest) (json.RawMessage, error)
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. You must use exactly one of the fields png_sticker or tgs_sticker. Returns True on success.
func (*Bot) DeleteChatPhoto ¶
func (b *Bot) DeleteChatPhoto(req *DeleteChatPhotoRequest) (json.RawMessage, error)
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 admin rights. Returns True on success.
func (*Bot) DeleteChatStickerSet ¶
func (b *Bot) DeleteChatStickerSet(req *DeleteChatStickerSetRequest) (json.RawMessage, error)
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 admin 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 (*Bot) DeleteMessage ¶
func (b *Bot) DeleteMessage(req *DeleteMessageRequest) (json.RawMessage, error)
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. - A dice message in a private chat can only be deleted if it was sent more than 24 hours ago. - Bots can delete outgoing messages in private chats, groups, and supergroups. - Bots can delete incoming messages in private chats. - Bots granted can_post_messages permissions can delete outgoing messages in channels. - If the bot is an administrator of a group, it can delete any message there. - If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any message there. Returns True on success.
func (*Bot) DeleteStickerFromSet ¶
func (b *Bot) DeleteStickerFromSet(req *DeleteStickerFromSetRequest) (json.RawMessage, error)
Use this method to delete a sticker from a set created by the bot. Returns True on success.
func (*Bot) DeleteWebhook ¶
func (b *Bot) DeleteWebhook(req *DeleteWebhookRequest) (json.RawMessage, error)
Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success.
func (*Bot) EditChatInviteLink ¶
func (b *Bot) EditChatInviteLink(req *EditChatInviteLinkRequest) (*ChatInviteLink, error)
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 admin rights. Returns the edited invite link as a ChatInviteLink object.
func (*Bot) EditMessageCaption ¶
func (b *Bot) EditMessageCaption(req *EditMessageCaptionRequest) (*Message, error)
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.
func (*Bot) EditMessageLiveLocation ¶
func (b *Bot) EditMessageLiveLocation(req *EditMessageLiveLocationRequest) (*Message, error)
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 (*Bot) EditMessageMedia ¶
func (b *Bot) EditMessageMedia(req *EditMessageMediaRequest) (*Message, error)
Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded. Use a previously uploaded file via its file_id or specify a URL. On success, if the edited message was sent by the bot, the edited Message is returned, otherwise True is returned.
func (*Bot) EditMessageReplyMarkup ¶
func (b *Bot) EditMessageReplyMarkup(req *EditMessageReplyMarkupRequest) (*Message, error)
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.
func (*Bot) EditMessageText ¶
func (b *Bot) EditMessageText(req *EditMessageTextRequest) (*Message, error)
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.
func (*Bot) ExportChatInviteLink ¶
func (b *Bot) ExportChatInviteLink(req *ExportChatInviteLinkRequest) (json.RawMessage, error)
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 admin 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 (*Bot) ForwardMessage ¶
func (b *Bot) ForwardMessage(req *ForwardMessageRequest) (*Message, error)
Use this method to forward messages of any kind. Service messages can't be forwarded. On success, the sent Message is returned.
func (*Bot) GetChat ¶
func (b *Bot) GetChat(req *GetChatRequest) (*Chat, error)
Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a Chat object on success.
func (*Bot) GetChatAdministrators ¶
func (b *Bot) GetChatAdministrators(req *GetChatAdministratorsRequest) (*ChatMember, error)
Use this method to get a list of administrators in a chat. On success, returns an Array of ChatMember objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned.
func (*Bot) GetChatMember ¶
func (b *Bot) GetChatMember(req *GetChatMemberRequest) (*ChatMember, error)
Use this method to get information about a member of a chat. Returns a ChatMember object on success.
func (*Bot) GetChatMembersCount ¶
func (b *Bot) GetChatMembersCount(req *GetChatMembersCountRequest) (json.RawMessage, error)
Use this method to get the number of members in a chat. Returns Int on success.
func (*Bot) GetFile ¶
func (b *Bot) GetFile(req *GetFileRequest) (*File, error)
Use this method to get basic info 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 (*Bot) GetFileURL ¶
func (*Bot) GetGameHighScores ¶
func (b *Bot) GetGameHighScores(req *GetGameHighScoresRequest) (*GameHighScore, error)
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. On success, 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 his neighbors are not among them. Please note that this behavior is subject to change.
func (*Bot) GetMe ¶
func (b *Bot) GetMe(req *GetMeRequest) (*User, error)
A simple method for testing your bot's auth token. Requires no parameters. Returns basic information about the bot in form of a User object.
func (*Bot) GetMyCommands ¶
func (b *Bot) GetMyCommands(req *GetMyCommandsRequest) (*BotCommand, error)
Use this method to get the current list of the bot's commands. Requires no parameters. Returns Array of BotCommand on success.
func (*Bot) GetStickerSet ¶
func (b *Bot) GetStickerSet(req *GetStickerSetRequest) (*StickerSet, error)
Use this method to get a sticker set. On success, a StickerSet object is returned.
func (*Bot) GetUpdates ¶
func (b *Bot) GetUpdates(req *GetUpdatesRequest) (*[]Update, error)
Use this method to receive incoming updates using long polling (wiki). An Array of Update objects is returned.
Notes 1. 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.
func (*Bot) GetUserProfilePhotos ¶
func (b *Bot) GetUserProfilePhotos(req *GetUserProfilePhotosRequest) (*UserProfilePhotos, error)
Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.
func (*Bot) GetWebhookInfo ¶
func (b *Bot) GetWebhookInfo(req *GetWebhookInfoRequest) (*WebhookInfo, error)
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.
func (*Bot) KickChatMember ¶
func (b *Bot) KickChatMember(req *KickChatMemberRequest) (json.RawMessage, error)
Use this method to kick a user from 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 admin rights. Returns True on success.
func (*Bot) LeaveChat ¶
func (b *Bot) LeaveChat(req *LeaveChatRequest) (json.RawMessage, error)
Use this method for your bot to leave a group, supergroup or channel. Returns True on success.
func (*Bot) LogOut ¶
func (b *Bot) LogOut(req *LogOutRequest) (json.RawMessage, error)
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 (*Bot) PinChatMessage ¶
func (b *Bot) PinChatMessage(req *PinChatMessageRequest) (json.RawMessage, error)
Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns True on success.
func (*Bot) PromoteChatMember ¶
func (b *Bot) PromoteChatMember(req *PromoteChatMemberRequest) (json.RawMessage, error)
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 admin rights. Pass False for all boolean parameters to demote a user. Returns True on success.
func (*Bot) RestrictChatMember ¶
func (b *Bot) RestrictChatMember(req *RestrictChatMemberRequest) (json.RawMessage, error)
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 admin rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.
func (*Bot) RevokeChatInviteLink ¶
func (b *Bot) RevokeChatInviteLink(req *RevokeChatInviteLinkRequest) (*ChatInviteLink, error)
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 admin rights. Returns the revoked invite link as ChatInviteLink object.
func (*Bot) SendAnimation ¶
func (b *Bot) SendAnimation(req *SendAnimationRequest) (*Message, error)
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 (*Bot) SendAudio ¶
func (b *Bot) SendAudio(req *SendAudioRequest) (*Message, error)
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 (*Bot) SendChatAction ¶
func (b *Bot) SendChatAction(req *SendChatActionRequest) (json.RawMessage, error)
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 (*Bot) SendContact ¶
func (b *Bot) SendContact(req *SendContactRequest) (*Message, error)
Use this method to send phone contacts. On success, the sent Message is returned.
func (*Bot) SendDice ¶
func (b *Bot) SendDice(req *SendDiceRequest) (*Message, error)
Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.
func (*Bot) SendDocument ¶
func (b *Bot) SendDocument(req *SendDocumentRequest) (*Message, error)
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 (*Bot) SendGame ¶
func (b *Bot) SendGame(req *SendGameRequest) (*Message, error)
Use this method to send a game. On success, the sent Message is returned.
func (*Bot) SendInvoice ¶
func (b *Bot) SendInvoice(req *SendInvoiceRequest) (*Message, error)
Use this method to send invoices. On success, the sent Message is returned.
func (*Bot) SendLocation ¶
func (b *Bot) SendLocation(req *SendLocationRequest) (*Message, error)
Use this method to send point on the map. On success, the sent Message is returned.
func (*Bot) SendMessage ¶
func (b *Bot) SendMessage(req *SendMessageRequest) (*Message, error)
Use this method to send text messages. On success, the sent Message is returned.
func (*Bot) SendPhoto ¶
func (b *Bot) SendPhoto(req *SendPhotoRequest) (*Message, error)
Use this method to send photos. On success, the sent Message is returned.
func (*Bot) SendPoll ¶
func (b *Bot) SendPoll(req *SendPollRequest) (*Message, error)
Use this method to send a native poll. On success, the sent Message is returned.
func (*Bot) SendSticker ¶
func (b *Bot) SendSticker(req *SendStickerRequest) (*Message, error)
Use this method to send static .WEBP or animated .TGS stickers. On success, the sent Message is returned.
func (*Bot) SendVenue ¶
func (b *Bot) SendVenue(req *SendVenueRequest) (*Message, error)
Use this method to send information about a venue. On success, the sent Message is returned.
func (*Bot) SendVideo ¶
func (b *Bot) SendVideo(req *SendVideoRequest) (*Message, error)
Use this method to send video files, Telegram clients support mp4 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 (*Bot) SendVideoNote ¶
func (b *Bot) SendVideoNote(req *SendVideoNoteRequest) (*Message, error)
As of v.4.0, Telegram clients support rounded square mp4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned.
func (*Bot) SendVoice ¶
func (b *Bot) SendVoice(req *SendVoiceRequest) (*Message, error)
Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.
func (*Bot) SetChatAdministratorCustomTitle ¶
func (b *Bot) SetChatAdministratorCustomTitle(req *SetChatAdministratorCustomTitleRequest) (json.RawMessage, error)
Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.
func (*Bot) SetChatDescription ¶
func (b *Bot) SetChatDescription(req *SetChatDescriptionRequest) (json.RawMessage, error)
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 admin rights. Returns True on success.
func (*Bot) SetChatPermissions ¶
func (b *Bot) SetChatPermissions(req *SetChatPermissionsRequest) (json.RawMessage, error)
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 admin rights. Returns True on success.
func (*Bot) SetChatPhoto ¶
func (b *Bot) SetChatPhoto(req *SetChatPhotoRequest) (json.RawMessage, error)
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 admin rights. Returns True on success.
func (*Bot) SetChatStickerSet ¶
func (b *Bot) SetChatStickerSet(req *SetChatStickerSetRequest) (json.RawMessage, error)
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 admin 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 (*Bot) SetChatTitle ¶
func (b *Bot) SetChatTitle(req *SetChatTitleRequest) (json.RawMessage, error)
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 admin rights. Returns True on success.
func (*Bot) SetGameScore ¶
func (b *Bot) SetGameScore(req *SetGameScoreRequest) (*Message, error)
Use this method to set the score of the specified user in a game. On success, if the message was sent by the bot, returns the edited Message, otherwise returns True. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.
func (*Bot) SetMyCommands ¶
func (b *Bot) SetMyCommands(req *SetMyCommandsRequest) (json.RawMessage, error)
Use this method to change the list of the bot's commands. Returns True on success.
func (*Bot) SetPassportDataErrors ¶
func (b *Bot) SetPassportDataErrors(req *SetPassportDataErrorsRequest) (json.RawMessage, error)
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 (*Bot) SetStickerPositionInSet ¶
func (b *Bot) SetStickerPositionInSet(req *SetStickerPositionInSetRequest) (json.RawMessage, error)
Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.
func (*Bot) SetStickerSetThumb ¶
func (b *Bot) SetStickerSetThumb(req *SetStickerSetThumbRequest) (json.RawMessage, error)
Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Returns True on success.
func (*Bot) SetWebhook ¶
func (b *Bot) SetWebhook(req *SetWebhookRequest) (json.RawMessage, error)
Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.
If you'd like to make sure that the Webhook request comes from Telegram, we recommend using a secret path in the URL, e.g. https://www.example.com/<token>. Since nobody else knows your bot's token, you can be pretty sure it's us.
Notes 1. 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. NEW! If you're having any trouble setting up webhooks, please check out this amazing guide to Webhooks.
func (*Bot) StopMessageLiveLocation ¶
func (b *Bot) StopMessageLiveLocation(req *StopMessageLiveLocationRequest) (*Message, error)
Use this method to stop updating a live location message before live_period expires. On success, if the message was sent by the bot, the sent Message is returned, otherwise True is returned.
func (*Bot) StopPoll ¶
func (b *Bot) StopPoll(req *StopPollRequest) (*Poll, error)
Use this method to stop a poll which was sent by the bot. On success, the stopped Poll with the final results is returned.
func (*Bot) UnbanChatMember ¶
func (b *Bot) UnbanChatMember(req *UnbanChatMemberRequest) (json.RawMessage, error)
Use this method to unban a previously kicked 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 (*Bot) UnpinAllChatMessages ¶
func (b *Bot) UnpinAllChatMessages(req *UnpinAllChatMessagesRequest) (json.RawMessage, error)
Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns True on success.
func (*Bot) UnpinChatMessage ¶
func (b *Bot) UnpinChatMessage(req *UnpinChatMessageRequest) (json.RawMessage, error)
Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns True on success.
func (*Bot) UploadStickerFile ¶
func (b *Bot) UploadStickerFile(req *UploadStickerFileRequest) (*File, error)
Use this method to upload a .PNG file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times). Returns the uploaded File on success.
type BotCommand ¶
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, 3-256 characters. Description string `json:"description"` }
This object represents a bot command.
type CallbackGame ¶
type CallbackGame struct{}
type CallbackQuery ¶
type CallbackQuery struct { // Unique identifier for this query ID string `json:"id"` // Sender From *User `json:"from"` // Optional. Message with the callback button that originated the query. Note that // message content and message date will not be available if the message is too // old Message *Message `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 a bad client // can send arbitrary data in this field. 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"` }
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 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 int `json:"id"` // Type of chat, can be either “private”, “group”, “supergroup” or // “channel” Type string `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. Chat photo. Returned only in getChat. Photo *ChatPhoto `json:"photo,omitempty"` // Optional. Bio of the other party in a private chat. Returned only in getChat. Bio string `json:"bio,omitempty"` // Optional. Description, for groups, supergroups and channel chats. Returned only // in getChat. Description string `json:"description,omitempty"` // Optional. Primary invite link, for groups, supergroups and channel chats. // Returned only in getChat. InviteLink string `json:"invite_link,omitempty"` // Optional. The most recent pinned message (by sending date). Returned only in // getChat. PinnedMessage *Message `json:"pinned_message,omitempty"` // Optional. Default chat member permissions, for groups and supergroups. Returned // only in getChat. Permissions *ChatPermissions `json:"permissions,omitempty"` // Optional. For supergroups, the minimum allowed delay between consecutive // messages sent by each unpriviledged user. Returned only in getChat. SlowModeDelay int `json:"slow_mode_delay,omitempty"` // Optional. The time after which all messages sent to the chat will be // automatically deleted; in seconds. Returned only in getChat. MessageAutoDeleteTime int `json:"message_auto_delete_time,omitempty"` // Optional. For supergroups, name of group sticker set. Returned only in getChat. StickerSetName string `json:"sticker_set_name,omitempty"` // Optional. True, if the bot can change the group sticker set. Returned only in // getChat. CanSetStickerSet bool `json:"can_set_sticker_set,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. Returned only in getChat. LinkedChatID int `json:"linked_chat_id,omitempty"` // Optional. For supergroups, the location to which the supergroup is connected. // Returned only in getChat. Location *ChatLocation `json:"location,omitempty"` }
This object represents a chat.
type ChatInviteLink ¶
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 the link is primary IsPrimary bool `json:"is_primary"` // True, if the link is revoked IsRevoked bool `json:"is_revoked"` // Optional. Point in time (Unix timestamp) when the link will expire or has been // expired ExpireDate int `json:"expire_date,omitempty"` // Optional. Maximum number of users that can be members of the chat simultaneously // after joining the chat via this invite link; 1-99999 MemberLimit int `json:"member_limit,omitempty"` }
Represents an invite link for a chat.
type ChatLocation ¶
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"` }
Represents a location to which a chat is connected.
type ChatMember ¶
type ChatMember struct { // Information about the user User *User `json:"user"` // The member's status in the chat. Can be “creator”, “administrator”, // “member”, “restricted”, “left” or “kicked” Status string `json:"status"` // Optional. Owner and administrators only. Custom title for this user CustomTitle string `json:"custom_title,omitempty"` // Optional. Owner and administrators only. True, if the user's presence in the // chat is hidden IsAnonymous bool `json:"is_anonymous,omitempty"` // Optional. Administrators only. True, if the bot is allowed to edit administrator // privileges of that user CanBeEdited bool `json:"can_be_edited,omitempty"` // Optional. Administrators only. True, if the administrator can access the chat // event log, chat statistics, message statistics in channels, see channel members, // see anonymous administrators in supergroups and ignore slow mode. Implied by any // other administrator privilege CanManageChat bool `json:"can_manage_chat,omitempty"` // Optional. Administrators only. True, if the administrator can post in the // channel; channels only CanPostMessages bool `json:"can_post_messages,omitempty"` // Optional. Administrators only. True, if the administrator can edit messages of // other users and can pin messages; channels only CanEditMessages bool `json:"can_edit_messages,omitempty"` // Optional. Administrators only. True, if the administrator can delete messages of // other users CanDeleteMessages bool `json:"can_delete_messages,omitempty"` // Optional. Administrators only. True, if the administrator can manage voice // chats CanManageVoiceChats bool `json:"can_manage_voice_chats,omitempty"` // Optional. Administrators only. True, if the administrator can restrict, ban or // unban chat members CanRestrictMembers bool `json:"can_restrict_members,omitempty"` // Optional. Administrators only. True, if the administrator can add new // administrators with a subset of their own privileges or demote administrators // that he has promoted, directly or indirectly (promoted by administrators that // were appointed by the user) CanPromoteMembers bool `json:"can_promote_members,omitempty"` // Optional. Administrators and restricted only. True, if the user is allowed to // change the chat title, photo and other settings CanChangeInfo bool `json:"can_change_info,omitempty"` // Optional. Administrators and restricted only. True, if the user is allowed to // invite new users to the chat CanInviteUsers bool `json:"can_invite_users,omitempty"` // Optional. Administrators and restricted only. True, if the user is allowed to // pin messages; groups and supergroups only CanPinMessages bool `json:"can_pin_messages,omitempty"` // Optional. Restricted only. True, if the user is a member of the chat at the // moment of the request IsMember bool `json:"is_member,omitempty"` // Optional. Restricted only. True, if the user is allowed to send text messages, // contacts, locations and venues CanSendMessages bool `json:"can_send_messages,omitempty"` // Optional. Restricted only. True, if the user is allowed to send audios, // documents, photos, videos, video notes and voice notes CanSendMediaMessages bool `json:"can_send_media_messages,omitempty"` // Optional. Restricted only. True, if the user is allowed to send polls CanSendPolls bool `json:"can_send_polls,omitempty"` // Optional. Restricted only. True, if the user is allowed to send animations, // games, stickers and use inline bots CanSendOtherMessages bool `json:"can_send_other_messages,omitempty"` // Optional. Restricted only. True, if the user is allowed to add web page previews // to their messages CanAddWebPagePreviews bool `json:"can_add_web_page_previews,omitempty"` // Optional. Restricted and kicked only. Date when restrictions will be lifted for // this user; unix time UntilDate int `json:"until_date,omitempty"` }
This object contains information about one member of a chat.
type ChatMemberUpdated ¶
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 int `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"` }
This object represents changes in the status of a chat member.
type ChatPermissions ¶
type ChatPermissions struct { // Optional. True, if the user is allowed to send text messages, contacts, // locations and venues CanSendMessages bool `json:"can_send_messages,omitempty"` // Optional. True, if the user is allowed to send audios, documents, photos, // videos, video notes and voice notes, implies can_send_messages CanSendMediaMessages bool `json:"can_send_media_messages,omitempty"` // Optional. True, if the user is allowed to send polls, implies can_send_messages CanSendPolls bool `json:"can_send_polls,omitempty"` // Optional. True, if the user is allowed to send animations, games, stickers and // use inline bots, implies can_send_media_messages CanSendOtherMessages bool `json:"can_send_other_messages,omitempty"` // Optional. True, if the user is allowed to add web page previews to their // messages, implies can_send_media_messages CanAddWebPagePreviews bool `json:"can_add_web_page_previews,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"` }
Describes actions that a non-administrator user is allowed to take in a chat.
type ChatPhoto ¶
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"` }
This object represents a chat photo.
type ChosenInlineResult ¶
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"` }
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 CloseRequest ¶
type CloseRequest struct{}
type 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 int `json:"user_id,omitempty"` // Optional. Additional data about the contact in the form of a vCard Vcard string `json:"vcard,omitempty"` }
This object represents a phone contact.
type CopyMessageRequest ¶
type CopyMessageRequest struct { // Unique identifier for the target chat or username of the target channel (in the // format @channelusername) ChatID string `json:"chat_id"` // Unique identifier for the chat where the original message was sent (or channel // username in the format @channelusername) FromChatID string `json:"from_chat_id"` // Message identifier in the chat specified in from_chat_id MessageID int `json:"message_id"` // Optional. New caption for media, 0-1024 characters after entities parsing. If // not specified, the original caption is kept Caption string `json:"caption,omitempty"` // Optional. Mode for parsing entities in the new caption. See formatting options // for more details. ParseMode string `json:"parse_mode,omitempty"` // Optional. List of special entities that appear in the new caption, which can be // specified instead of parse_mode CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // Optional. Sends the message silently. Users will receive a notification with no // sound. DisableNotification bool `json:"disable_notification,omitempty"` // Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // Optional. Pass True, if the message should be sent even if the specified // replied-to message is not found AllowSendingWithoutReply bool `json:"allow_sending_without_reply,omitempty"` // Optional. Additional interface options. A JSON-serialized object for an inline // keyboard, custom reply keyboard, instructions to remove reply keyboard or to // force a reply from the user. ReplyMarkup AnyKeyboard `json:"reply_markup,omitempty"` }
type CreateChatInviteLinkRequest ¶
type CreateChatInviteLinkRequest struct { // Unique identifier for the target chat or username of the target channel (in the // format @channelusername) ChatID string `json:"chat_id"` // Optional. Point in time (Unix timestamp) when the link will expire ExpireDate int `json:"expire_date,omitempty"` // Optional. Maximum number of users that can be members of the chat simultaneously // after joining the chat via this invite link; 1-99999 MemberLimit int `json:"member_limit,omitempty"` }
type CreateNewStickerSetRequest ¶
type CreateNewStickerSetRequest struct { // User identifier of created sticker set owner UserID int `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"` // Optional. PNG image with the sticker, must be up to 512 kilobytes in size, // dimensions must not exceed 512px, and either width or height must be exactly // 512px. 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 info on // Sending Files » PngSticker Fileable `json:"png_sticker,omitempty"` // Optional. TGS animation with the sticker, uploaded using multipart/form-data. // See https://core.telegram.org/animated_stickers#technical-requirements for // technical requirements TgsSticker *InputFile `json:"tgs_sticker,omitempty"` // One or more emoji corresponding to the sticker Emojis string `json:"emojis"` // Optional. Pass True, if a set of mask stickers should be created ContainsMasks bool `json:"contains_masks,omitempty"` // Optional. A JSON-serialized object for position where the mask should be placed // on faces MaskPosition *MaskPosition `json:"mask_position,omitempty"` }
type DeleteChatPhotoRequest ¶
type DeleteChatPhotoRequest struct { // Unique identifier for the target chat or username of the target channel (in the // format @channelusername) ChatID string `json:"chat_id"` }
type DeleteChatStickerSetRequest ¶
type DeleteChatStickerSetRequest struct { // Unique identifier for the target chat or username of the target supergroup (in // the format @supergroupusername) ChatID string `json:"chat_id"` }
type DeleteMessageRequest ¶
type DeleteStickerFromSetRequest ¶
type DeleteStickerFromSetRequest struct { // File identifier of the sticker Sticker string `json:"sticker"` }
type DeleteWebhookRequest ¶
type DeleteWebhookRequest struct { // Optional. Pass True to drop all pending updates DropPendingUpdates bool `json:"drop_pending_updates,omitempty"` }
type Dice ¶
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 int `json:"value"` }
This object represents an animated emoji that displays a random value.
type Document ¶
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 sender Thumb *PhotoSize `json:"thumb,omitempty"` // Optional. Original filename as defined by sender FileName string `json:"file_name,omitempty"` // Optional. MIME type of the file as defined by sender MimeType string `json:"mime_type,omitempty"` // Optional. File size FileSize int `json:"file_size,omitempty"` }
This object represents a general file (as opposed to photos, voice messages and audio files).
type EditChatInviteLinkRequest ¶
type EditChatInviteLinkRequest struct { // Unique identifier for the target chat or username of the target channel (in the // format @channelusername) ChatID string `json:"chat_id"` // The invite link to edit InviteLink string `json:"invite_link"` // Optional. Point in time (Unix timestamp) when the link will expire ExpireDate int `json:"expire_date,omitempty"` // Optional. Maximum number of users that can be members of the chat simultaneously // after joining the chat via this invite link; 1-99999 MemberLimit int `json:"member_limit,omitempty"` }
type EditMessageCaptionRequest ¶
type EditMessageCaptionRequest struct { // Optional. Required if inline_message_id is not specified. Unique identifier for // the target chat or username of the target channel (in the format // @channelusername) ChatID string `json:"chat_id,omitempty"` // Optional. Required if inline_message_id is not specified. Identifier of the // message to edit MessageID int `json:"message_id,omitempty"` // Optional. Required if chat_id and message_id are not specified. Identifier of // the inline message InlineMessageID string `json:"inline_message_id,omitempty"` // Optional. New caption of the message, 0-1024 characters after entities parsing Caption string `json:"caption,omitempty"` // Optional. Mode for parsing entities in the message caption. See formatting // options for more details. ParseMode string `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. A JSON-serialized object for an inline keyboard. ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` }
type EditMessageLiveLocationRequest ¶
type EditMessageLiveLocationRequest struct { // Optional. Required if inline_message_id is not specified. Unique identifier for // the target chat or username of the target channel (in the format // @channelusername) ChatID string `json:"chat_id,omitempty"` // Optional. Required if inline_message_id is not specified. Identifier of the // message to edit MessageID int `json:"message_id,omitempty"` // Optional. 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"` // Optional. The radius of uncertainty for the location, measured in meters; // 0-1500 HorizontalAccuracy float64 `json:"horizontal_accuracy,omitempty"` // Optional. Direction in which the user is moving, in degrees. Must be between 1 // and 360 if specified. Heading int `json:"heading,omitempty"` // Optional. Maximum distance for proximity alerts about approaching another chat // member, in meters. Must be between 1 and 100000 if specified. ProximityAlertRadius int `json:"proximity_alert_radius,omitempty"` // Optional. A JSON-serialized object for a new inline keyboard. ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` }
type EditMessageMediaRequest ¶
type EditMessageMediaRequest struct { // Optional. Required if inline_message_id is not specified. Unique identifier for // the target chat or username of the target channel (in the format // @channelusername) ChatID string `json:"chat_id,omitempty"` // Optional. Required if inline_message_id is not specified. Identifier of the // message to edit MessageID int `json:"message_id,omitempty"` // Optional. 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"` // Optional. A JSON-serialized object for a new inline keyboard. ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` }
type EditMessageReplyMarkupRequest ¶
type EditMessageReplyMarkupRequest struct { // Optional. Required if inline_message_id is not specified. Unique identifier for // the target chat or username of the target channel (in the format // @channelusername) ChatID string `json:"chat_id,omitempty"` // Optional. Required if inline_message_id is not specified. Identifier of the // message to edit MessageID int `json:"message_id,omitempty"` // Optional. Required if chat_id and message_id are not specified. Identifier of // the inline message InlineMessageID string `json:"inline_message_id,omitempty"` // Optional. A JSON-serialized object for an inline keyboard. ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` }
type EditMessageTextRequest ¶
type EditMessageTextRequest struct { // Optional. Required if inline_message_id is not specified. Unique identifier for // the target chat or username of the target channel (in the format // @channelusername) ChatID string `json:"chat_id,omitempty"` // Optional. Required if inline_message_id is not specified. Identifier of the // message to edit MessageID int `json:"message_id,omitempty"` // Optional. 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"` // Optional. Mode for parsing entities in the message text. See formatting options // for more details. ParseMode string `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. Disables link previews for links in this message DisableWebPagePreview bool `json:"disable_web_page_preview,omitempty"` // Optional. A JSON-serialized object for an inline keyboard. ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` }
type EncryptedCredentials ¶
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"` }
Contains data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.
type EncryptedPassportElement ¶
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 string `json:"type"` // Optional. Base64-encoded encrypted Telegram Passport element data provided by // the user, available 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 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 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 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 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"` }
Contains information about documents or other Telegram Passport elements shared with the bot by the user.
type ErrorResponse ¶
type ErrorResponse Response
func (ErrorResponse) Error ¶
func (e ErrorResponse) Error() string
type ExportChatInviteLinkRequest ¶
type ExportChatInviteLinkRequest struct { // Unique identifier for the target chat or username of the target channel (in the // format @channelusername) ChatID string `json:"chat_id"` }
type File ¶
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, if known FileSize int `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"` }
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.
Maximum file size to download is 20 MB
type FileUploader ¶
type ForceReply ¶
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. 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 (has reply_to_message_id), sender of the // original message. Selective bool `json:"selective,omitempty"` }
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.
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:
- Explain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish.
- Guide the user through a step-by-step process. 'Please send me your question', 'Cool, now let's add the first answer option', 'Great. Keep adding answer options, then send /done when you're ready'.
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 ForwardMessageRequest ¶
type ForwardMessageRequest struct { // Unique identifier for the target chat or username of the target channel (in the // format @channelusername) ChatID string `json:"chat_id"` // Unique identifier for the chat where the original message was sent (or channel // username in the format @channelusername) FromChatID string `json:"from_chat_id"` // Optional. Sends the message silently. Users will receive a notification with no // sound. DisableNotification bool `json:"disable_notification,omitempty"` // Message identifier in the chat specified in from_chat_id MessageID int `json:"message_id"` }
type Game ¶
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"` }
This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.
type GameHighScore ¶
type GameHighScore struct { // Position in high score table for the game Position int `json:"position"` // User User *User `json:"user"` // Score Score int `json:"score"` }
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 GetChatAdministratorsRequest ¶
type GetChatAdministratorsRequest struct { // Unique identifier for the target chat or username of the target supergroup or // channel (in the format @channelusername) ChatID string `json:"chat_id"` }
type GetChatMemberRequest ¶
type GetChatMembersCountRequest ¶
type GetChatMembersCountRequest struct { // Unique identifier for the target chat or username of the target supergroup or // channel (in the format @channelusername) ChatID string `json:"chat_id"` }
type GetChatRequest ¶
type GetChatRequest struct { // Unique identifier for the target chat or username of the target supergroup or // channel (in the format @channelusername) ChatID string `json:"chat_id"` }
type GetFileRequest ¶
type GetFileRequest struct { // File identifier to get info about FileID string `json:"file_id"` }
type GetGameHighScoresRequest ¶
type GetGameHighScoresRequest struct { // Target user id UserID int `json:"user_id"` // Optional. Required if inline_message_id is not specified. Unique identifier for // the target chat ChatID int `json:"chat_id,omitempty"` // Optional. Required if inline_message_id is not specified. Identifier of the sent // message MessageID int `json:"message_id,omitempty"` // Optional. Required if chat_id and message_id are not specified. Identifier of // the inline message InlineMessageID string `json:"inline_message_id,omitempty"` }
type GetMeRequest ¶
type GetMeRequest struct{}
type GetMyCommandsRequest ¶
type GetMyCommandsRequest struct{}
type GetStickerSetRequest ¶
type GetStickerSetRequest struct { // Name of the sticker set Name string `json:"name"` }
type GetUpdatesRequest ¶
type GetUpdatesRequest struct { // Optional. 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 forgotten. Offset int `json:"offset,omitempty"` // Optional. Limits the number of updates to be retrieved. Values between 1-100 are // accepted. Defaults to 100. Limit int `json:"limit,omitempty"` // Optional. 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 int `json:"timeout,omitempty"` // Optional. 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 (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 getUpdates, so unwanted updates may be received for a short period of // time. AllowedUpdates []string `json:"allowed_updates,omitempty"` }
type GetUserProfilePhotosRequest ¶
type GetUserProfilePhotosRequest struct { // Unique identifier of the target user UserID int `json:"user_id"` // Optional. Sequential number of the first photo to be returned. By default, all // photos are returned. Offset int `json:"offset,omitempty"` // Optional. Limits the number of photos to be retrieved. Values between 1-100 are // accepted. Defaults to 100. Limit int `json:"limit,omitempty"` }
type GetWebhookInfoRequest ¶
type GetWebhookInfoRequest struct{}
type InlineKeyboardButton ¶
type InlineKeyboardButton struct { // Label text on the button Text string `json:"text"` // Optional. HTTP or tg:// url to be opened when button is pressed URL string `json:"url,omitempty"` // Optional. An HTTP 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. Data to be sent in a callback query to the bot when button is pressed, // 1-64 bytes CallbackData string `json:"callback_data,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. Can be empty, in which case just the bot's // username will be inserted. // // Note: This offers an easy way for users to start using your bot in inline mode // when they are currently in a private chat with it. Especially useful when // combined with switch_pm… actions – in this case the user will be // automatically returned to the chat they switched from, skipping the chat // selection screen. 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. Can 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. SwitchInlineQueryCurrentChat string `json:"switch_inline_query_current_chat,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. // // NOTE: This type of button must always be the first button in the first row. Pay bool `json:"pay,omitempty"` }
This object represents one button of an inline keyboard. You must use exactly one of the optional fields.
type InlineKeyboardMarkup ¶
type InlineKeyboardMarkup struct { // Array of button rows, each represented by an Array of InlineKeyboardButton // objects InlineKeyboard [][]InlineKeyboardButton `json:"inline_keyboard"` }
This object represents an inline keyboard that appears right next to the message it belongs to.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message.
type InlineQuery ¶
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 string `json:"chat_type,omitempty"` // Optional. Sender location, only for bots that request user location Location *Location `json:"location,omitempty"` }
This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.
type InlineQueryResult ¶
type InlineQueryResult interface{}
This object represents one result of an inline query. Telegram clients currently support results of the following 20 types: - InlineQueryResultCachedAudio - InlineQueryResultCachedDocument - InlineQueryResultCachedGif - InlineQueryResultCachedMpeg4Gif - InlineQueryResultCachedPhoto - InlineQueryResultCachedSticker - InlineQueryResultCachedVideo - InlineQueryResultCachedVoice - InlineQueryResultArticle - InlineQueryResultAudio - InlineQueryResultContact - InlineQueryResultGame - InlineQueryResultDocument - InlineQueryResultGif - InlineQueryResultLocation - InlineQueryResultMpeg4Gif - InlineQueryResultPhoto - InlineQueryResultVenue - InlineQueryResultVideo - InlineQueryResultVoice
type InlineQueryResultArticle ¶
type InlineQueryResultArticle struct { // Type of the result, must be article Type string `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. Pass True, if you don't want the URL to be shown in the message HideURL bool `json:"hide_url,omitempty"` // Optional. Short description of the result Description string `json:"description,omitempty"` // Optional. Url of the thumbnail for the result ThumbURL string `json:"thumb_url,omitempty"` // Optional. Thumbnail width ThumbWidth int `json:"thumb_width,omitempty"` // Optional. Thumbnail height ThumbHeight int `json:"thumb_height,omitempty"` }
Represents a link to an article or web page.
type InlineQueryResultAudio ¶
type InlineQueryResultAudio struct { // Type of the result, must be audio Type string `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 string `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 int `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"` }
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.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
type InlineQueryResultCachedAudio ¶
type InlineQueryResultCachedAudio struct { // Type of the result, must be audio Type string `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 string `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"` }
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.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
type InlineQueryResultCachedDocument ¶
type InlineQueryResultCachedDocument struct { // Type of the result, must be document Type string `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 string `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"` }
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.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
type InlineQueryResultCachedGif ¶
type InlineQueryResultCachedGif struct { // Type of the result, must be gif Type string `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 string `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 GIF animation InputMessageContent InputMessageContent `json:"input_message_content,omitempty"` }
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 InlineQueryResultCachedMpeg4Gif ¶
type InlineQueryResultCachedMpeg4Gif struct { // Type of the result, must be mpeg4_gif Type string `json:"type"` // Unique identifier for this result, 1-64 bytes ID string `json:"id"` // A valid file identifier for the MP4 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 string `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 video animation InputMessageContent InputMessageContent `json:"input_message_content,omitempty"` }
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 InlineQueryResultCachedPhoto ¶
type InlineQueryResultCachedPhoto struct { // Type of the result, must be photo Type string `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 string `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 photo InputMessageContent InputMessageContent `json:"input_message_content,omitempty"` }
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 InlineQueryResultCachedSticker ¶
type InlineQueryResultCachedSticker struct { // Type of the result, must be sticker Type string `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"` }
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.
Note: This will only work in Telegram versions released after 9 April, 2016 for static stickers and after 06 July, 2019 for animated stickers. Older clients will ignore them.
type InlineQueryResultCachedVideo ¶
type InlineQueryResultCachedVideo struct { // Type of the result, must be video Type string `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 string `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 video InputMessageContent InputMessageContent `json:"input_message_content,omitempty"` }
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 InlineQueryResultCachedVoice ¶
type InlineQueryResultCachedVoice struct { // Type of the result, must be voice Type string `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 string `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"` }
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.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
type InlineQueryResultContact ¶
type InlineQueryResultContact struct { // Type of the result, must be contact Type string `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 ThumbURL string `json:"thumb_url,omitempty"` // Optional. Thumbnail width ThumbWidth int `json:"thumb_width,omitempty"` // Optional. Thumbnail height ThumbHeight int `json:"thumb_height,omitempty"` }
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.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
type InlineQueryResultDocument ¶
type InlineQueryResultDocument struct { // Type of the result, must be document Type string `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 string `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 string `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 ThumbURL string `json:"thumb_url,omitempty"` // Optional. Thumbnail width ThumbWidth int `json:"thumb_width,omitempty"` // Optional. Thumbnail height ThumbHeight int `json:"thumb_height,omitempty"` }
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.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
type InlineQueryResultGame ¶
type InlineQueryResultGame struct { // Type of the result, must be game Type string `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"` }
Represents a Game.
Note: This will only work in Telegram versions released after October 1, 2016. Older clients will not display any inline results if a game result is among them.
type InlineQueryResultGif ¶
type InlineQueryResultGif struct { // Type of the result, must be gif Type string `json:"type"` // Unique identifier for this result, 1-64 bytes ID string `json:"id"` // A valid URL for the GIF file. File size must not exceed 1MB GifURL string `json:"gif_url"` // Optional. Width of the GIF GifWidth int `json:"gif_width,omitempty"` // Optional. Height of the GIF GifHeight int `json:"gif_height,omitempty"` // Optional. Duration of the GIF GifDuration int `json:"gif_duration,omitempty"` // URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result ThumbURL string `json:"thumb_url"` // Optional. MIME type of the thumbnail, must be one of “image/jpeg”, // “image/gif”, or “video/mp4”. Defaults to “image/jpeg” ThumbMimeType string `json:"thumb_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 string `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 GIF animation InputMessageContent InputMessageContent `json:"input_message_content,omitempty"` }
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 InlineQueryResultLocation ¶
type InlineQueryResultLocation struct { // Type of the result, must be location Type string `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 for which the location can be updated, should be // between 60 and 86400. LivePeriod int `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 int `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 int `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 ThumbURL string `json:"thumb_url,omitempty"` // Optional. Thumbnail width ThumbWidth int `json:"thumb_width,omitempty"` // Optional. Thumbnail height ThumbHeight int `json:"thumb_height,omitempty"` }
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.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
type InlineQueryResultMpeg4Gif ¶
type InlineQueryResultMpeg4Gif struct { // Type of the result, must be mpeg4_gif Type string `json:"type"` // Unique identifier for this result, 1-64 bytes ID string `json:"id"` // A valid URL for the MP4 file. File size must not exceed 1MB Mpeg4URL string `json:"mpeg4_url"` // Optional. Video width Mpeg4Width int `json:"mpeg4_width,omitempty"` // Optional. Video height Mpeg4Height int `json:"mpeg4_height,omitempty"` // Optional. Video duration Mpeg4Duration int `json:"mpeg4_duration,omitempty"` // URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result ThumbURL string `json:"thumb_url"` // Optional. MIME type of the thumbnail, must be one of “image/jpeg”, // “image/gif”, or “video/mp4”. Defaults to “image/jpeg” ThumbMimeType string `json:"thumb_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 string `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 video animation InputMessageContent InputMessageContent `json:"input_message_content,omitempty"` }
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 InlineQueryResultPhoto ¶
type InlineQueryResultPhoto struct { // Type of the result, must be photo Type string `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 ThumbURL string `json:"thumb_url"` // Optional. Width of the photo PhotoWidth int `json:"photo_width,omitempty"` // Optional. Height of the photo PhotoHeight int `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 string `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 photo InputMessageContent InputMessageContent `json:"input_message_content,omitempty"` }
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 InlineQueryResultVenue ¶
type InlineQueryResultVenue struct { // Type of the result, must be venue Type string `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 ThumbURL string `json:"thumb_url,omitempty"` // Optional. Thumbnail width ThumbWidth int `json:"thumb_width,omitempty"` // Optional. Thumbnail height ThumbHeight int `json:"thumb_height,omitempty"` }
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.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
type InlineQueryResultVideo ¶
type InlineQueryResultVideo struct { // Type of the result, must be video Type string `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 video url, “text/html” or “video/mp4” MimeType string `json:"mime_type"` // URL of the thumbnail (jpeg only) for the video ThumbURL string `json:"thumb_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 string `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. Video width VideoWidth int `json:"video_width,omitempty"` // Optional. Video height VideoHeight int `json:"video_height,omitempty"` // Optional. Video duration in seconds VideoDuration int `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"` }
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 InlineQueryResultVoice ¶
type InlineQueryResultVoice struct { // Type of the result, must be voice Type string `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 string `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 int `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"` }
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.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
type InputContactMessageContent ¶
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"` }
Represents the content of a contact message to be sent as the result of an inline query.
type InputFile ¶
type InputFile struct{}
This object represents the contents of a file to be uploaded. Must be posted using multipart/form-data in the usual way that files are uploaded via the browser.
type InputInvoiceMessageContent ¶
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 for your internal processes. Payload string `json:"payload"` // Payment provider token, obtained via Botfather ProviderToken string `json:"provider_token"` // Three-letter ISO 4217 currency code, see more on currencies Currency string `json:"currency"` // Price breakdown, a JSON-serialized list of components (e.g. product price, tax, // discount, delivery cost, delivery tax, bonus, etc.) 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 MaxTipAmount int `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 []int `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. People like it better when they see what // they are paying for. PhotoURL string `json:"photo_url,omitempty"` // Optional. Photo size PhotoSize int `json:"photo_size,omitempty"` // Optional. Photo width PhotoWidth int `json:"photo_width,omitempty"` // Optional. Photo height PhotoHeight int `json:"photo_height,omitempty"` // Optional. Pass True, if you require the user's full name to complete the order NeedName bool `json:"need_name,omitempty"` // Optional. Pass True, if you require the user's phone number to complete the // order NeedPhoneNumber bool `json:"need_phone_number,omitempty"` // Optional. Pass True, if you require the user's email address to complete the // order NeedEmail bool `json:"need_email,omitempty"` // Optional. Pass True, if you require the user's shipping address to complete the // order NeedShippingAddress bool `json:"need_shipping_address,omitempty"` // Optional. Pass True, if user's phone number should be sent to provider SendPhoneNumberToProvider bool `json:"send_phone_number_to_provider,omitempty"` // Optional. Pass True, if user's email address should be sent to provider SendEmailToProvider bool `json:"send_email_to_provider,omitempty"` // Optional. Pass True, if the final price depends on the shipping method IsFlexible bool `json:"is_flexible,omitempty"` }
Represents the content of an invoice message to be sent as the result of an inline query.
type InputLocationMessageContent ¶
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 for which the location can be updated, should be // between 60 and 86400. LivePeriod int `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 int `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 int `json:"proximity_alert_radius,omitempty"` }
Represents the content of a location message to be sent as the result of an inline query.
type InputMedia ¶
type InputMedia struct{}
This object represents the content of a media message to be sent. It should be one of
- InputMediaAnimation
- InputMediaDocument
- InputMediaAudio
- InputMediaPhoto
- InputMediaVideo
type InputMediaAnimation ¶
type InputMediaAnimation struct { // Type of the result, must be animation Type string `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 info 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 info on Sending Files » Thumb Fileable `json:"thumb,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 string `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. Animation width Width int `json:"width,omitempty"` // Optional. Animation height Height int `json:"height,omitempty"` // Optional. Animation duration Duration int `json:"duration,omitempty"` }
Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.
type InputMediaAudio ¶
type InputMediaAudio struct { // Type of the result, must be audio Type string `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 info 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 info on Sending Files » Thumb Fileable `json:"thumb,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 string `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 int `json:"duration,omitempty"` // Optional. Performer of the audio Performer string `json:"performer,omitempty"` // Optional. Title of the audio Title string `json:"title,omitempty"` }
Represents an audio file to be treated as music to be sent.
type InputMediaDocument ¶
type InputMediaDocument struct { // Type of the result, must be document Type string `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 info 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 info on Sending Files » Thumb Fileable `json:"thumb,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 string `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"` }
Represents a general file to be sent.
type InputMediaPhoto ¶
type InputMediaPhoto struct { // Type of the result, must be photo Type string `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 info 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 string `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"` }
Represents a photo to be sent.
type InputMediaVideo ¶
type InputMediaVideo struct { // Type of the result, must be video Type string `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 info 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 info on Sending Files » Thumb Fileable `json:"thumb,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 string `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. Video width Width int `json:"width,omitempty"` // Optional. Video height Height int `json:"height,omitempty"` // Optional. Video duration Duration int `json:"duration,omitempty"` // Optional. Pass True, if the uploaded video is suitable for streaming SupportsStreaming bool `json:"supports_streaming,omitempty"` }
Represents a video to be sent.
type InputMessageContent ¶
type InputMessageContent interface{}
This object represents the content of a message to be sent as a result of an inline query. Telegram clients currently support the following 4 types: - InputTextMessageContent - InputLocationMessageContent - InputVenueMessageContent - InputContactMessageContent
type InputTextMessageContent ¶
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 string `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. Disables link previews for links in the sent message DisableWebPagePreview bool `json:"disable_web_page_preview,omitempty"` }
Represents the content of a text message to be sent as the result of an inline query.
type InputVenueMessageContent ¶
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"` }
Represents the content of a venue message to be sent as the result of an inline query.
type 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 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 int `json:"total_amount"` }
This object contains basic information about an invoice.
type KeyboardButton ¶
type KeyboardButton struct { // Text of the button. If none of the optional fields are used, it will be sent as // a message when the button is pressed Text string `json:"text"` // 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"` }
This object represents one button of the reply keyboard. For simple text buttons String can be used instead of this object to specify text of the button. Optional fields request_contact, request_location, and request_poll are mutually exclusive.
Note: request_contact and request_location options will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message. Note: request_poll option will only work in Telegram versions released after 23 January, 2020. Older clients will display unsupported message.
type KeyboardButtonPollType ¶
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"` }
This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.
type KickChatMemberRequest ¶
type KickChatMemberRequest struct { // Unique identifier for the target group or username of the target supergroup or // channel (in the format @channelusername) ChatID string `json:"chat_id"` // Unique identifier of the target user UserID int `json:"user_id"` // Optional. 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 int `json:"until_date,omitempty"` // Optional. 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 LabeledPrice ¶
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 int `json:"amount"` }
This object represents a portion of the price for goods or services.
type LeaveChatRequest ¶
type LeaveChatRequest struct { // Unique identifier for the target chat or username of the target supergroup or // channel (in the format @channelusername) ChatID string `json:"chat_id"` }
type Location ¶
type Location struct { // Longitude as defined by sender Longitude float64 `json:"longitude"` // Latitude as defined by sender Latitude float64 `json:"latitude"` // 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 int `json:"live_period,omitempty"` // Optional. The direction in which user is moving, in degrees; 1-360. For active // live locations only. Heading int `json:"heading,omitempty"` // Optional. Maximum distance for proximity alerts about approaching another chat // member, in meters. For sent live locations only. ProximityAlertRadius int `json:"proximity_alert_radius,omitempty"` }
This object represents a point on the map.
type LogOutRequest ¶
type LogOutRequest struct{}
type LoginURL ¶
type LoginURL struct { // An HTTP 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"` }
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 MaskPosition ¶
type MaskPosition struct { // The part of the face relative to which the mask should be placed. One of // “forehead”, “eyes”, “mouth”, or “chin”. Point string `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"` }
This object describes the position on faces where a mask should be placed by default.
type Message ¶
type Message struct { // Unique message identifier inside this chat MessageID int `json:"message_id"` // Optional. Sender, empty for messages sent to channels From *User `json:"from,omitempty"` // Optional. Sender of the message, sent on behalf of a chat. The channel itself // for channel messages. The supergroup itself for messages from anonymous group // administrators. The linked channel for messages automatically forwarded to the // discussion group SenderChat *Chat `json:"sender_chat,omitempty"` // Date the message was sent in Unix time Date int `json:"date"` // Conversation the message belongs to Chat *Chat `json:"chat"` // Optional. For forwarded messages, sender of the original message ForwardFrom *User `json:"forward_from,omitempty"` // Optional. For messages forwarded from channels or from anonymous administrators, // information about the original sender chat ForwardFromChat *Chat `json:"forward_from_chat,omitempty"` // Optional. For messages forwarded from channels, identifier of the original // message in the channel ForwardFromMessageID int `json:"forward_from_message_id,omitempty"` // Optional. For messages forwarded from channels, signature of the post author if // present ForwardSignature string `json:"forward_signature,omitempty"` // Optional. Sender's name for messages forwarded from users who disallow adding a // link to their account in forwarded messages ForwardSenderName string `json:"forward_sender_name,omitempty"` // Optional. For forwarded messages, date the original message was sent in Unix // time ForwardDate int `json:"forward_date,omitempty"` // Optional. For replies, 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. Bot through which the message was sent ViaBot *User `json:"via_bot,omitempty"` // Optional. Date the message was last edited in Unix time EditDate int `json:"edit_date,omitempty"` // Optional. The unique identifier 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. For text messages, the actual UTF-8 text of the message, 0-4096 // characters 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. 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 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 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, photo, video or voice, // 0-1024 characters 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. 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. 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 int `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 int `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 is itself a // reply. PinnedMessage *Message `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. The domain name of the website on which the user has logged in. More // about Telegram Login » ConnectedWebsite string `json:"connected_website,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: voice chat scheduled VoiceChatScheduled *VoiceChatScheduled `json:"voice_chat_scheduled,omitempty"` // Optional. Service message: voice chat started VoiceChatStarted *VoiceChatStarted `json:"voice_chat_started,omitempty"` // Optional. Service message: voice chat ended VoiceChatEnded *VoiceChatEnded `json:"voice_chat_ended,omitempty"` // Optional. Service message: new participants invited to a voice chat VoiceChatParticipantsInvited *VoiceChatParticipantsInvited `json:"voice_chat_participants_invited,omitempty"` // Optional. Inline keyboard attached to the message. login_url buttons are // represented as ordinary url buttons. ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` }
This object represents a message.
type MessageAutoDeleteTimerChanged ¶
type MessageAutoDeleteTimerChanged struct { // New auto-delete time for messages in the chat MessageAutoDeleteTime int `json:"message_auto_delete_time"` }
This object represents a service message about a change in auto-delete timer settings.
type MessageEntity ¶
type MessageEntity struct { // Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), // “cashtag” ($USD), “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), “code” (monowidth string), “pre” (monowidth // block), “text_link” (for clickable text URLs), “text_mention” (for users // without usernames) Type string `json:"type"` // Offset in UTF-16 code units to the start of the entity Offset int `json:"offset"` // Length of the entity in UTF-16 code units Length int `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"` }
This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.
type MessageId ¶
type MessageId struct { // Unique message identifier MessageID int `json:"message_id"` }
This object represents a unique message identifier.
type Opts ¶
type Opts struct { Client *http.Client Middleware func(RequestHandler) RequestHandler }
type OrderInfo ¶
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"` }
This object represents information about an order.
type PassportData ¶
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"` }
Contains information about Telegram Passport data shared with the bot by the user.
type PassportElementError ¶
type PassportElementError struct{}
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:
- PassportElementErrorDataField
- PassportElementErrorFrontSide
- PassportElementErrorReverseSide
- PassportElementErrorSelfie
- PassportElementErrorFile
- PassportElementErrorFiles
- PassportElementErrorTranslationFile
- PassportElementErrorTranslationFiles
- PassportElementErrorUnspecified
type PassportElementErrorDataField ¶
type PassportElementErrorDataField struct { // Error source, must be data Source string `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 string `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"` }
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 PassportElementErrorFile ¶
type PassportElementErrorFile struct { // Error source, must be file Source string `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 string `json:"type"` // Base64-encoded file hash FileHash string `json:"file_hash"` // Error message Message string `json:"message"` }
Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes.
type PassportElementErrorFiles ¶
type PassportElementErrorFiles struct { // Error source, must be files Source string `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 string `json:"type"` // List of base64-encoded file hashes FileHashes []string `json:"file_hashes"` // Error message Message string `json:"message"` }
Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.
type PassportElementErrorFrontSide ¶
type PassportElementErrorFrontSide struct { // Error source, must be front_side Source string `json:"source"` // The section of the user's Telegram Passport which has the issue, one of // “passport”, “driver_license”, “identity_card”, // “internal_passport” Type string `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"` }
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 PassportElementErrorReverseSide ¶
type PassportElementErrorReverseSide struct { // Error source, must be reverse_side Source string `json:"source"` // The section of the user's Telegram Passport which has the issue, one of // “driver_license”, “identity_card” Type string `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"` }
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 PassportElementErrorSelfie ¶
type PassportElementErrorSelfie struct { // Error source, must be selfie Source string `json:"source"` // The section of the user's Telegram Passport which has the issue, one of // “passport”, “driver_license”, “identity_card”, // “internal_passport” Type string `json:"type"` // Base64-encoded hash of the file with the selfie FileHash string `json:"file_hash"` // Error message Message string `json:"message"` }
Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes.
type PassportElementErrorTranslationFile ¶
type PassportElementErrorTranslationFile struct { // Error source, must be translation_file Source string `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 string `json:"type"` // Base64-encoded file hash FileHash string `json:"file_hash"` // Error message Message string `json:"message"` }
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 PassportElementErrorTranslationFiles ¶
type PassportElementErrorTranslationFiles struct { // Error source, must be translation_files Source string `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 string `json:"type"` // List of base64-encoded file hashes FileHashes []string `json:"file_hashes"` // Error message Message string `json:"message"` }
Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation change.
type PassportElementErrorUnspecified ¶
type PassportElementErrorUnspecified struct { // Error source, must be unspecified Source string `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"` }
Represents an issue in an unspecified place. The error is considered resolved when new data is added.
type PassportFile ¶
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 FileSize int `json:"file_size"` // Unix time when the file was uploaded FileDate int `json:"file_date"` }
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 PhotoSize ¶
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 int `json:"width"` // Photo height Height int `json:"height"` // Optional. File size FileSize int `json:"file_size,omitempty"` }
This object represents one size of a photo or a file / sticker thumbnail.
type PinChatMessageRequest ¶
type PinChatMessageRequest struct { // Unique identifier for the target chat or username of the target channel (in the // format @channelusername) ChatID string `json:"chat_id"` // Identifier of a message to pin MessageID int `json:"message_id"` // Optional. 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 ¶
type Poll struct { // Unique poll identifier ID string `json:"id"` // Poll question, 1-300 characters Question string `json:"question"` // List of poll options Options []PollOption `json:"options"` // Total number of users that voted in the poll TotalVoterCount int `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 string `json:"type"` // True, if the poll allows multiple answers AllowsMultipleAnswers bool `json:"allows_multiple_answers"` // Optional. 0-based identifier of the correct answer option. Available only for // polls in the quiz mode, which are closed, or was sent (not forwarded) by the bot // or to the private chat with the bot. CorrectOptionID int `json:"correct_option_id,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. Amount of time in seconds the poll will be active after creation OpenPeriod int `json:"open_period,omitempty"` // Optional. Point in time (Unix timestamp) when the poll will be automatically // closed CloseDate int `json:"close_date,omitempty"` }
This object contains information about a poll.
type PollAnswer ¶
type PollAnswer struct { // Unique poll identifier PollID string `json:"poll_id"` // The user, who changed the answer to the poll User *User `json:"user"` // 0-based identifiers of answer options, chosen by the user. May be empty if the // user retracted their vote. OptionIds []int `json:"option_ids"` }
This object represents an answer of a user in a non-anonymous poll.
type PollOption ¶
type PollOption struct { // Option text, 1-100 characters Text string `json:"text"` // Number of users that voted for this option VoterCount int `json:"voter_count"` }
This object contains information about one answer option in a poll.
type PreCheckoutQuery ¶
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 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 int `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 info provided by the user OrderInfo *OrderInfo `json:"order_info,omitempty"` }
This object contains information about an incoming pre-checkout query.
type PromoteChatMemberRequest ¶
type PromoteChatMemberRequest struct { // Unique identifier for the target chat or username of the target channel (in the // format @channelusername) ChatID string `json:"chat_id"` // Unique identifier of the target user UserID int `json:"user_id"` // Optional. Pass True, if the administrator's presence in the chat is hidden IsAnonymous bool `json:"is_anonymous,omitempty"` // Optional. Pass True, if the administrator can access the chat event log, chat // statistics, message statistics in channels, see channel members, see anonymous // administrators in supergroups and ignore slow mode. Implied by any other // administrator privilege CanManageChat bool `json:"can_manage_chat,omitempty"` // Optional. Pass True, if the administrator can create channel posts, channels // only CanPostMessages bool `json:"can_post_messages,omitempty"` // Optional. Pass True, if the administrator can edit messages of other users and // can pin messages, channels only CanEditMessages bool `json:"can_edit_messages,omitempty"` // Optional. Pass True, if the administrator can delete messages of other users CanDeleteMessages bool `json:"can_delete_messages,omitempty"` // Optional. Pass True, if the administrator can manage voice chats CanManageVoiceChats bool `json:"can_manage_voice_chats,omitempty"` // Optional. Pass True, if the administrator can restrict, ban or unban chat // members CanRestrictMembers bool `json:"can_restrict_members,omitempty"` // Optional. Pass True, if the administrator can add new administrators with a // subset of their own privileges or demote administrators that he has promoted, // directly or indirectly (promoted by administrators that were appointed by him) CanPromoteMembers bool `json:"can_promote_members,omitempty"` // Optional. Pass True, if the administrator can change chat title, photo and other // settings CanChangeInfo bool `json:"can_change_info,omitempty"` // Optional. Pass True, if the administrator can invite new users to the chat CanInviteUsers bool `json:"can_invite_users,omitempty"` // Optional. Pass True, if the administrator can pin messages, supergroups only CanPinMessages bool `json:"can_pin_messages,omitempty"` }
type ProximityAlertTriggered ¶
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 int `json:"distance"` }
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 ReplyKeyboardMarkup ¶
type ReplyKeyboardMarkup struct { // Array of button rows, each represented by an Array of KeyboardButton objects Keyboard [][]KeyboardButton `json:"keyboard"` // 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. 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 (has reply_to_message_id), 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"` }
This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).
type ReplyKeyboardRemove ¶
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 (has reply_to_message_id), 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"` }
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).
type RequestHandler ¶
type RequestHandler func(methodName string, req interface{}) (json.RawMessage, error)
type Response ¶
type Response struct { Ok bool `json:"ok"` Result json.RawMessage `json:"result"` ErrorCode int `json:"error_code"` Description string `json:"description"` Parameters *ResponseParameters `json:"parameters"` }
type ResponseParameters ¶
type ResponseParameters struct { // 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 int `json:"migrate_to_chat_id,omitempty"` // Optional. In case of exceeding flood control, the number of seconds left to wait // before the request can be repeated RetryAfter int `json:"retry_after,omitempty"` }
Contains information about why a request was unsuccessful.
type RestrictChatMemberRequest ¶
type RestrictChatMemberRequest struct { // Unique identifier for the target chat or username of the target supergroup (in // the format @supergroupusername) ChatID string `json:"chat_id"` // Unique identifier of the target user UserID int `json:"user_id"` // A JSON-serialized object for new user permissions Permissions *ChatPermissions `json:"permissions"` // Optional. 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 int `json:"until_date,omitempty"` }
type SendAnimationRequest ¶
type SendAnimationRequest struct { // Unique identifier for the target chat or username of the target channel (in the // format @channelusername) ChatID string `json:"chat_id"` // 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 info on Sending Files » Animation Fileable `json:"animation"` // Optional. Duration of sent animation in seconds Duration int `json:"duration,omitempty"` // Optional. Animation width Width int `json:"width,omitempty"` // Optional. Animation height Height int `json:"height,omitempty"` // 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 info on Sending Files » Thumb Fileable `json:"thumb,omitempty"` // Optional. Animation caption (may also be used when resending animation by // file_id), 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 string `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. Sends the message silently. Users will receive a notification with no // sound. DisableNotification bool `json:"disable_notification,omitempty"` // Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // Optional. Pass True, if the message should be sent even if the specified // replied-to message is not found AllowSendingWithoutReply bool `json:"allow_sending_without_reply,omitempty"` // Optional. Additional interface options. A JSON-serialized object for an inline // keyboard, custom reply keyboard, instructions to remove reply keyboard or to // force a reply from the user. ReplyMarkup AnyKeyboard `json:"reply_markup,omitempty"` }
type SendAudioRequest ¶
type SendAudioRequest struct { // Unique identifier for the target chat or username of the target channel (in the // format @channelusername) ChatID string `json:"chat_id"` // 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 info on Sending Files » Audio Fileable `json:"audio"` // Optional. Audio 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 string `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 int `json:"duration,omitempty"` // Optional. Performer Performer string `json:"performer,omitempty"` // Optional. Track name Title string `json:"title,omitempty"` // 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 info on Sending Files » Thumb Fileable `json:"thumb,omitempty"` // Optional. Sends the message silently. Users will receive a notification with no // sound. DisableNotification bool `json:"disable_notification,omitempty"` // Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // Optional. Pass True, if the message should be sent even if the specified // replied-to message is not found AllowSendingWithoutReply bool `json:"allow_sending_without_reply,omitempty"` // Optional. Additional interface options. A JSON-serialized object for an inline // keyboard, custom reply keyboard, instructions to remove reply keyboard or to // force a reply from the user. ReplyMarkup AnyKeyboard `json:"reply_markup,omitempty"` }
type SendChatActionRequest ¶
type SendChatActionRequest struct { // Unique identifier for the target chat or username of the target channel (in the // format @channelusername) ChatID string `json:"chat_id"` // 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, find_location for location data, // record_video_note or upload_video_note for video notes. Action string `json:"action"` }
type SendContactRequest ¶
type SendContactRequest struct { // Unique identifier for the target chat or username of the target channel (in the // format @channelusername) ChatID string `json:"chat_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. Sends the message silently. Users will receive a notification with no // sound. DisableNotification bool `json:"disable_notification,omitempty"` // Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // Optional. Pass True, if the message should be sent even if the specified // replied-to message is not found AllowSendingWithoutReply bool `json:"allow_sending_without_reply,omitempty"` // Optional. Additional interface options. A JSON-serialized object for an inline // keyboard, custom reply keyboard, instructions to remove keyboard or to force a // reply from the user. ReplyMarkup AnyKeyboard `json:"reply_markup,omitempty"` }
type SendDiceRequest ¶
type SendDiceRequest struct { // Unique identifier for the target chat or username of the target channel (in the // format @channelusername) ChatID string `json:"chat_id"` // Optional. 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 string `json:"emoji,omitempty"` // Optional. Sends the message silently. Users will receive a notification with no // sound. DisableNotification bool `json:"disable_notification,omitempty"` // Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // Optional. Pass True, if the message should be sent even if the specified // replied-to message is not found AllowSendingWithoutReply bool `json:"allow_sending_without_reply,omitempty"` // Optional. Additional interface options. A JSON-serialized object for an inline // keyboard, custom reply keyboard, instructions to remove reply keyboard or to // force a reply from the user. ReplyMarkup AnyKeyboard `json:"reply_markup,omitempty"` }
type SendDocumentRequest ¶
type SendDocumentRequest struct { // Unique identifier for the target chat or username of the target channel (in the // format @channelusername) ChatID string `json:"chat_id"` // 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 // info on Sending Files » Document Fileable `json:"document"` // 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 info on Sending Files » Thumb Fileable `json:"thumb,omitempty"` // Optional. Document caption (may also be used when resending documents by // file_id), 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 string `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 DisableContentTypeDetection bool `json:"disable_content_type_detection,omitempty"` // Optional. Sends the message silently. Users will receive a notification with no // sound. DisableNotification bool `json:"disable_notification,omitempty"` // Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // Optional. Pass True, if the message should be sent even if the specified // replied-to message is not found AllowSendingWithoutReply bool `json:"allow_sending_without_reply,omitempty"` // Optional. Additional interface options. A JSON-serialized object for an inline // keyboard, custom reply keyboard, instructions to remove reply keyboard or to // force a reply from the user. ReplyMarkup AnyKeyboard `json:"reply_markup,omitempty"` }
type SendGameRequest ¶
type SendGameRequest struct { // Unique identifier for the target chat ChatID int `json:"chat_id"` // 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"` // Optional. Sends the message silently. Users will receive a notification with no // sound. DisableNotification bool `json:"disable_notification,omitempty"` // Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // Optional. Pass True, if the message should be sent even if the specified // replied-to message is not found AllowSendingWithoutReply bool `json:"allow_sending_without_reply,omitempty"` // Optional. 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 SendInvoiceRequest ¶
type SendInvoiceRequest struct { // Unique identifier for the target chat or username of the target channel (in the // format @channelusername) ChatID string `json:"chat_id"` // 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 for your internal processes. Payload string `json:"payload"` // Payments provider token, obtained via Botfather ProviderToken string `json:"provider_token"` // Three-letter ISO 4217 currency code, see more on currencies Currency string `json:"currency"` // Price breakdown, a JSON-serialized list of components (e.g. product price, tax, // discount, delivery cost, delivery tax, bonus, etc.) 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 MaxTipAmount int `json:"max_tip_amount,omitempty"` // Optional. 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 []int `json:"suggested_tip_amounts,omitempty"` // Optional. 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"` // Optional. A 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"` // Optional. 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"` // Optional. Photo size PhotoSize int `json:"photo_size,omitempty"` // Optional. Photo width PhotoWidth int `json:"photo_width,omitempty"` // Optional. Photo height PhotoHeight int `json:"photo_height,omitempty"` // Optional. Pass True, if you require the user's full name to complete the order NeedName bool `json:"need_name,omitempty"` // Optional. Pass True, if you require the user's phone number to complete the // order NeedPhoneNumber bool `json:"need_phone_number,omitempty"` // Optional. Pass True, if you require the user's email address to complete the // order NeedEmail bool `json:"need_email,omitempty"` // Optional. Pass True, if you require the user's shipping address to complete the // order NeedShippingAddress bool `json:"need_shipping_address,omitempty"` // Optional. Pass True, if user's phone number should be sent to provider SendPhoneNumberToProvider bool `json:"send_phone_number_to_provider,omitempty"` // Optional. Pass True, if user's email address should be sent to provider SendEmailToProvider bool `json:"send_email_to_provider,omitempty"` // Optional. Pass True, if the final price depends on the shipping method IsFlexible bool `json:"is_flexible,omitempty"` // Optional. Sends the message silently. Users will receive a notification with no // sound. DisableNotification bool `json:"disable_notification,omitempty"` // Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // Optional. Pass True, if the message should be sent even if the specified // replied-to message is not found AllowSendingWithoutReply bool `json:"allow_sending_without_reply,omitempty"` // Optional. 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 SendLocationRequest ¶
type SendLocationRequest struct { // Unique identifier for the target chat or username of the target channel (in the // format @channelusername) ChatID string `json:"chat_id"` // 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"` // Optional. Period in seconds for which the location will be updated (see Live // Locations, should be between 60 and 86400. LivePeriod int `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 int `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 int `json:"proximity_alert_radius,omitempty"` // Optional. Sends the message silently. Users will receive a notification with no // sound. DisableNotification bool `json:"disable_notification,omitempty"` // Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // Optional. Pass True, if the message should be sent even if the specified // replied-to message is not found AllowSendingWithoutReply bool `json:"allow_sending_without_reply,omitempty"` // Optional. Additional interface options. A JSON-serialized object for an inline // keyboard, custom reply keyboard, instructions to remove reply keyboard or to // force a reply from the user. ReplyMarkup AnyKeyboard `json:"reply_markup,omitempty"` }
type SendMessageRequest ¶
type SendMessageRequest struct { // Unique identifier for the target chat or username of the target channel (in the // format @channelusername) ChatID string `json:"chat_id"` // Text of the message to be sent, 1-4096 characters after entities parsing Text string `json:"text"` // Optional. Mode for parsing entities in the message text. See formatting options // for more details. ParseMode string `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. Disables link previews for links in this message DisableWebPagePreview bool `json:"disable_web_page_preview,omitempty"` // Optional. Sends the message silently. Users will receive a notification with no // sound. DisableNotification bool `json:"disable_notification,omitempty"` // Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // Optional. Pass True, if the message should be sent even if the specified // replied-to message is not found AllowSendingWithoutReply bool `json:"allow_sending_without_reply,omitempty"` // Optional. Additional interface options. A JSON-serialized object for an inline // keyboard, custom reply keyboard, instructions to remove reply keyboard or to // force a reply from the user. ReplyMarkup AnyKeyboard `json:"reply_markup,omitempty"` }
type SendPhotoRequest ¶
type SendPhotoRequest struct { // Unique identifier for the target chat or username of the target channel (in the // format @channelusername) ChatID string `json:"chat_id"` // 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 info on // Sending Files » Photo Fileable `json:"photo"` // Optional. Photo caption (may also be used when resending photos by file_id), // 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 string `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. Sends the message silently. Users will receive a notification with no // sound. DisableNotification bool `json:"disable_notification,omitempty"` // Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // Optional. Pass True, if the message should be sent even if the specified // replied-to message is not found AllowSendingWithoutReply bool `json:"allow_sending_without_reply,omitempty"` // Optional. Additional interface options. A JSON-serialized object for an inline // keyboard, custom reply keyboard, instructions to remove reply keyboard or to // force a reply from the user. ReplyMarkup AnyKeyboard `json:"reply_markup,omitempty"` }
type SendPollRequest ¶
type SendPollRequest struct { // Unique identifier for the target chat or username of the target channel (in the // format @channelusername) ChatID string `json:"chat_id"` // Poll question, 1-300 characters Question string `json:"question"` // A JSON-serialized list of answer options, 2-10 strings 1-100 characters each Options []string `json:"options"` // Optional. True, if the poll needs to be anonymous, defaults to True IsAnonymous bool `json:"is_anonymous,omitempty"` // Optional. Poll type, “quiz” or “regular”, defaults to “regular” Type string `json:"type,omitempty"` // Optional. True, if the poll allows multiple answers, ignored for polls in quiz // mode, defaults to False AllowsMultipleAnswers bool `json:"allows_multiple_answers,omitempty"` // Optional. 0-based identifier of the correct answer option, required for polls in // quiz mode CorrectOptionID int `json:"correct_option_id,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 with at most 2 line feeds // after entities parsing Explanation string `json:"explanation,omitempty"` // Optional. Mode for parsing entities in the explanation. See formatting options // for more details. ExplanationParseMode string `json:"explanation_parse_mode,omitempty"` // Optional. List of special entities that appear in the poll explanation, which // can be specified instead of parse_mode ExplanationEntities []MessageEntity `json:"explanation_entities,omitempty"` // Optional. Amount of time in seconds the poll will be active after creation, // 5-600. Can't be used together with close_date. OpenPeriod int `json:"open_period,omitempty"` // Optional. Point in time (Unix timestamp) when the poll will be automatically // closed. Must be at least 5 and no more than 600 seconds in the future. Can't be // used together with open_period. CloseDate int `json:"close_date,omitempty"` // Optional. Pass True, if the poll needs to be immediately closed. This can be // useful for poll preview. IsClosed bool `json:"is_closed,omitempty"` // Optional. Sends the message silently. Users will receive a notification with no // sound. DisableNotification bool `json:"disable_notification,omitempty"` // Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // Optional. Pass True, if the message should be sent even if the specified // replied-to message is not found AllowSendingWithoutReply bool `json:"allow_sending_without_reply,omitempty"` // Optional. Additional interface options. A JSON-serialized object for an inline // keyboard, custom reply keyboard, instructions to remove reply keyboard or to // force a reply from the user. ReplyMarkup AnyKeyboard `json:"reply_markup,omitempty"` }
type SendStickerRequest ¶
type SendStickerRequest struct { // Unique identifier for the target chat or username of the target channel (in the // format @channelusername) ChatID string `json:"chat_id"` // 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 file from the Internet, or upload a new one using multipart/form-data. // More info on Sending Files » Sticker Fileable `json:"sticker"` // Optional. Sends the message silently. Users will receive a notification with no // sound. DisableNotification bool `json:"disable_notification,omitempty"` // Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // Optional. Pass True, if the message should be sent even if the specified // replied-to message is not found AllowSendingWithoutReply bool `json:"allow_sending_without_reply,omitempty"` // Optional. Additional interface options. A JSON-serialized object for an inline // keyboard, custom reply keyboard, instructions to remove reply keyboard or to // force a reply from the user. ReplyMarkup AnyKeyboard `json:"reply_markup,omitempty"` }
type SendVenueRequest ¶
type SendVenueRequest struct { // Unique identifier for the target chat or username of the target channel (in the // format @channelusername) ChatID string `json:"chat_id"` // 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"` // 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"` // Optional. Sends the message silently. Users will receive a notification with no // sound. DisableNotification bool `json:"disable_notification,omitempty"` // Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // Optional. Pass True, if the message should be sent even if the specified // replied-to message is not found AllowSendingWithoutReply bool `json:"allow_sending_without_reply,omitempty"` // Optional. Additional interface options. A JSON-serialized object for an inline // keyboard, custom reply keyboard, instructions to remove reply keyboard or to // force a reply from the user. ReplyMarkup AnyKeyboard `json:"reply_markup,omitempty"` }
type SendVideoNoteRequest ¶
type SendVideoNoteRequest struct { // Unique identifier for the target chat or username of the target channel (in the // format @channelusername) ChatID string `json:"chat_id"` // 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 info on Sending Files ». Sending video notes by a URL // is currently unsupported VideoNote Fileable `json:"video_note"` // Optional. Duration of sent video in seconds Duration int `json:"duration,omitempty"` // Optional. Video width and height, i.e. diameter of the video message Length int `json:"length,omitempty"` // 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 info on Sending Files » Thumb Fileable `json:"thumb,omitempty"` // Optional. Sends the message silently. Users will receive a notification with no // sound. DisableNotification bool `json:"disable_notification,omitempty"` // Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // Optional. Pass True, if the message should be sent even if the specified // replied-to message is not found AllowSendingWithoutReply bool `json:"allow_sending_without_reply,omitempty"` // Optional. Additional interface options. A JSON-serialized object for an inline // keyboard, custom reply keyboard, instructions to remove reply keyboard or to // force a reply from the user. ReplyMarkup AnyKeyboard `json:"reply_markup,omitempty"` }
type SendVideoRequest ¶
type SendVideoRequest struct { // Unique identifier for the target chat or username of the target channel (in the // format @channelusername) ChatID string `json:"chat_id"` // 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 // info on Sending Files » Video Fileable `json:"video"` // Optional. Duration of sent video in seconds Duration int `json:"duration,omitempty"` // Optional. Video width Width int `json:"width,omitempty"` // Optional. Video height Height int `json:"height,omitempty"` // 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 info on Sending Files » Thumb Fileable `json:"thumb,omitempty"` // Optional. Video caption (may also be used when resending videos by file_id), // 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 string `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 uploaded video is suitable for streaming SupportsStreaming bool `json:"supports_streaming,omitempty"` // Optional. Sends the message silently. Users will receive a notification with no // sound. DisableNotification bool `json:"disable_notification,omitempty"` // Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // Optional. Pass True, if the message should be sent even if the specified // replied-to message is not found AllowSendingWithoutReply bool `json:"allow_sending_without_reply,omitempty"` // Optional. Additional interface options. A JSON-serialized object for an inline // keyboard, custom reply keyboard, instructions to remove reply keyboard or to // force a reply from the user. ReplyMarkup AnyKeyboard `json:"reply_markup,omitempty"` }
type SendVoiceRequest ¶
type SendVoiceRequest struct { // Unique identifier for the target chat or username of the target channel (in the // format @channelusername) ChatID string `json:"chat_id"` // 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 // info on Sending Files » Voice Fileable `json:"voice"` // Optional. Voice message 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 string `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 voice message in seconds Duration int `json:"duration,omitempty"` // Optional. Sends the message silently. Users will receive a notification with no // sound. DisableNotification bool `json:"disable_notification,omitempty"` // Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // Optional. Pass True, if the message should be sent even if the specified // replied-to message is not found AllowSendingWithoutReply bool `json:"allow_sending_without_reply,omitempty"` // Optional. Additional interface options. A JSON-serialized object for an inline // keyboard, custom reply keyboard, instructions to remove reply keyboard or to // force a reply from the user. ReplyMarkup AnyKeyboard `json:"reply_markup,omitempty"` }
type SetChatAdministratorCustomTitleRequest ¶
type SetChatAdministratorCustomTitleRequest struct { // Unique identifier for the target chat or username of the target supergroup (in // the format @supergroupusername) ChatID string `json:"chat_id"` // Unique identifier of the target user UserID int `json:"user_id"` // New custom title for the administrator; 0-16 characters, emoji are not allowed CustomTitle string `json:"custom_title"` }
type SetChatPermissionsRequest ¶
type SetChatPermissionsRequest struct { // Unique identifier for the target chat or username of the target supergroup (in // the format @supergroupusername) ChatID string `json:"chat_id"` // New default chat permissions Permissions *ChatPermissions `json:"permissions"` }
type SetChatPhotoRequest ¶
type SetChatTitleRequest ¶
type SetGameScoreRequest ¶
type SetGameScoreRequest struct { // User identifier UserID int `json:"user_id"` // New score, must be non-negative Score int `json:"score"` // Optional. 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"` // Optional. Pass True, if the game message should not be automatically edited to // include the current scoreboard DisableEditMessage bool `json:"disable_edit_message,omitempty"` // Optional. Required if inline_message_id is not specified. Unique identifier for // the target chat ChatID int `json:"chat_id,omitempty"` // Optional. Required if inline_message_id is not specified. Identifier of the sent // message MessageID int `json:"message_id,omitempty"` // Optional. Required if chat_id and message_id are not specified. Identifier of // the inline message InlineMessageID string `json:"inline_message_id,omitempty"` }
type SetMyCommandsRequest ¶
type SetMyCommandsRequest 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"` }
type SetPassportDataErrorsRequest ¶
type SetPassportDataErrorsRequest struct { // User identifier UserID int `json:"user_id"` // A JSON-serialized array describing the errors Errors []PassportElementError `json:"errors"` }
type SetStickerSetThumbRequest ¶
type SetStickerSetThumbRequest struct { // Sticker set name Name string `json:"name"` // User identifier of the sticker set owner UserID int `json:"user_id"` // Optional. A PNG image with the thumbnail, must be up to 128 kilobytes in size // and have width and height exactly 100px, or a TGS animation with the thumbnail // up to 32 kilobytes in size; see // https://core.telegram.org/animated_stickers#technical-requirements for animated // 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 info on Sending Files ». Animated sticker set // thumbnail can't be uploaded via HTTP URL. Thumb Fileable `json:"thumb,omitempty"` }
type SetWebhookRequest ¶
type SetWebhookRequest struct { // HTTPS url to send updates to. Use an empty string to remove webhook integration URL string `json:"url"` // Optional. 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"` // Optional. 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"` // Optional. 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 int `json:"max_connections,omitempty"` // Optional. 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 (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 []string `json:"allowed_updates,omitempty"` // Optional. Pass True to drop all pending updates DropPendingUpdates bool `json:"drop_pending_updates,omitempty"` }
type ShippingAddress ¶
type ShippingAddress struct { // 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"` }
This object represents a shipping address.
type ShippingOption ¶
type ShippingOption struct { // Shipping option identifier ID string `json:"id"` // Option title Title string `json:"title"` // List of price portions Prices []LabeledPrice `json:"prices"` }
This object represents one shipping option.
type ShippingQuery ¶
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"` }
This object contains information about an incoming shipping query.
type 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"` // Sticker width Width int `json:"width"` // Sticker height Height int `json:"height"` // True, if the sticker is animated IsAnimated bool `json:"is_animated"` // Optional. Sticker thumbnail in the .WEBP or .JPG format Thumb *PhotoSize `json:"thumb,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 mask stickers, the position where the mask should be placed MaskPosition *MaskPosition `json:"mask_position,omitempty"` // Optional. File size FileSize int `json:"file_size,omitempty"` }
This object represents a sticker.
type StickerSet ¶
type StickerSet struct { // Sticker set name Name string `json:"name"` // Sticker set title Title string `json:"title"` // True, if the sticker set contains animated stickers IsAnimated bool `json:"is_animated"` // True, if the sticker set contains masks ContainsMasks bool `json:"contains_masks"` // List of all set stickers Stickers []Sticker `json:"stickers"` // Optional. Sticker set thumbnail in the .WEBP or .TGS format Thumb *PhotoSize `json:"thumb,omitempty"` }
This object represents a sticker set.
type StopMessageLiveLocationRequest ¶
type StopMessageLiveLocationRequest struct { // Optional. Required if inline_message_id is not specified. Unique identifier for // the target chat or username of the target channel (in the format // @channelusername) ChatID string `json:"chat_id,omitempty"` // Optional. Required if inline_message_id is not specified. Identifier of the // message with live location to stop MessageID int `json:"message_id,omitempty"` // Optional. Required if chat_id and message_id are not specified. Identifier of // the inline message InlineMessageID string `json:"inline_message_id,omitempty"` // Optional. A JSON-serialized object for a new inline keyboard. ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` }
type StopPollRequest ¶
type StopPollRequest struct { // Unique identifier for the target chat or username of the target channel (in the // format @channelusername) ChatID string `json:"chat_id"` // Identifier of the original message with the poll MessageID int `json:"message_id"` // Optional. A JSON-serialized object for a new message inline keyboard. ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` }
type SuccessfulPayment ¶
type SuccessfulPayment struct { // Three-letter ISO 4217 currency code 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 int `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 info 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"` }
This object contains basic information about a successful payment.
type UnbanChatMemberRequest ¶
type UnbanChatMemberRequest struct { // Unique identifier for the target group or username of the target supergroup or // channel (in the format @username) ChatID string `json:"chat_id"` // Unique identifier of the target user UserID int `json:"user_id"` // Optional. Do nothing if the user is not banned OnlyIfBanned bool `json:"only_if_banned,omitempty"` }
type UnpinAllChatMessagesRequest ¶
type UnpinAllChatMessagesRequest struct { // Unique identifier for the target chat or username of the target channel (in the // format @channelusername) ChatID string `json:"chat_id"` }
type UnpinChatMessageRequest ¶
type UnpinChatMessageRequest struct { // Unique identifier for the target chat or username of the target channel (in the // format @channelusername) ChatID string `json:"chat_id"` // Optional. Identifier of a message to unpin. If not specified, the most recent // pinned message (by sending date) will be unpinned. MessageID int `json:"message_id,omitempty"` }
type Update ¶
type Update struct { // The update's unique identifier. Update identifiers start from a certain positive // number and increase sequentially. This ID 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 int `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 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 EditedChannelPost *Message `json:"edited_channel_post,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. New poll state. Bots receive only updates about 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"` }
This object represents an incoming update. At most one of the optional parameters can be present in any given update.
type UploadStickerFileRequest ¶
type UploadStickerFileRequest struct { // User identifier of sticker file owner UserID int `json:"user_id"` // PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must // not exceed 512px, and either width or height must be exactly 512px. More info on // Sending Files » PngSticker *InputFile `json:"png_sticker"` }
type User ¶
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 int `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 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 inline queries. Returned only in getMe. SupportsInlineQueries bool `json:"supports_inline_queries,omitempty"` }
This object represents a Telegram user or bot.
type UserProfilePhotos ¶
type UserProfilePhotos struct { // Total number of profile pictures the target user has TotalCount int `json:"total_count"` // Requested profile pictures (in up to 4 sizes each) Photos [][]PhotoSize `json:"photos"` }
This object represent a user's profile pictures.
type 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"` }
This object represents a venue.
type Video ¶
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 sender Width int `json:"width"` // Video height as defined by sender Height int `json:"height"` // Duration of the video in seconds as defined by sender Duration int `json:"duration"` // Optional. Video thumbnail Thumb *PhotoSize `json:"thumb,omitempty"` // Optional. Original filename as defined by sender FileName string `json:"file_name,omitempty"` // Optional. Mime type of a file as defined by sender MimeType string `json:"mime_type,omitempty"` // Optional. File size FileSize int `json:"file_size,omitempty"` }
This object represents a video file.
type VideoNote ¶
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 sender Length int `json:"length"` // Duration of the video in seconds as defined by sender Duration int `json:"duration"` // Optional. Video thumbnail Thumb *PhotoSize `json:"thumb,omitempty"` // Optional. File size FileSize int `json:"file_size,omitempty"` }
This object represents a video message (available in Telegram apps as of v.4.0).
type Voice ¶
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 sender Duration int `json:"duration"` // Optional. MIME type of the file as defined by sender MimeType string `json:"mime_type,omitempty"` // Optional. File size FileSize int `json:"file_size,omitempty"` }
This object represents a voice note.
type VoiceChatEnded ¶
type VoiceChatEnded struct { // Voice chat duration; in seconds Duration int `json:"duration"` }
This object represents a service message about a voice chat ended in the chat.
type VoiceChatParticipantsInvited ¶
type VoiceChatParticipantsInvited struct { // Optional. New members that were invited to the voice chat Users []User `json:"users,omitempty"` }
This object represents a service message about new members invited to a voice chat.
type VoiceChatScheduled ¶
type VoiceChatScheduled struct { // Point in time (Unix timestamp) when the voice chat is supposed to be started by // a chat administrator StartDate int `json:"start_date"` }
This object represents a service message about a voice chat scheduled in the chat.
type VoiceChatStarted ¶
type VoiceChatStarted struct{}
This object represents a service message about a voice chat started in the chat. Currently holds no information.
type WebhookInfo ¶
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 int `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 int `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. Maximum allowed number of simultaneous HTTPS connections to the // webhook for update delivery MaxConnections int `json:"max_connections,omitempty"` // Optional. A list of update types the bot is subscribed to. Defaults to all // update types except chat_member AllowedUpdates []string `json:"allowed_updates,omitempty"` }
Contains information about the current status of a webhook.