Documentation ¶
Index ¶
- Constants
- Variables
- type AddStickerToSetParams
- type Animation
- type AnswerCallbackQueryParams
- type AnswerInlineQueryParams
- type AnswerPreCheckoutQueryParams
- type AnswerShippingQueryParams
- type Audio
- type BanChatMemberParams
- type Bot
- func (b *Bot) AddStickerToSet(params *AddStickerToSetParams) error
- func (b *Bot) AnswerCallbackQuery(params *AnswerCallbackQueryParams) error
- func (b *Bot) AnswerInlineQuery(params *AnswerInlineQueryParams) error
- func (b *Bot) AnswerPreCheckoutQuery(params *AnswerPreCheckoutQueryParams) error
- func (b *Bot) AnswerShippingQuery(params *AnswerShippingQueryParams) error
- func (b *Bot) BanChatMember(params *BanChatMemberParams) error
- func (b *Bot) Close() error
- func (b *Bot) CopyMessage(params *CopyMessageParams) (*MessageID, error)
- func (b *Bot) CreateChatInviteLink(params *CreateChatInviteLinkParams) (*ChatInviteLink, error)
- func (b *Bot) CreateNewStickerSet(params *CreateNewStickerSetParams) error
- func (b *Bot) DeleteChatPhoto(params *DeleteChatPhotoParams) error
- func (b *Bot) DeleteChatStickerSet(params *DeleteChatStickerSetParams) error
- func (b *Bot) DeleteMessage(params *DeleteMessageParams) error
- func (b *Bot) DeleteMyCommands(params *DeleteMyCommandsParams) error
- func (b *Bot) DeleteStickerFromSet(params *DeleteStickerFromSetParams) error
- func (b *Bot) DeleteWebhook(params *DeleteWebhookParams) error
- func (b *Bot) EditChatInviteLink(params *EditChatInviteLinkParams) (*ChatInviteLink, error)
- func (b *Bot) EditMessageCaption(params *EditMessageCaptionParams) (*Message, error)
- func (b *Bot) EditMessageLiveLocation(params *EditMessageLiveLocationParams) (*Message, error)
- func (b *Bot) EditMessageMedia(params *EditMessageMediaParams) (*Message, error)
- func (b *Bot) EditMessageReplyMarkup(params *EditMessageReplyMarkupParams) (*Message, error)
- func (b *Bot) EditMessageText(params *EditMessageTextParams) (*Message, error)
- func (b *Bot) ExportChatInviteLink(params *ExportChatInviteLinkParams) (*string, error)
- func (b *Bot) ForwardMessage(params *ForwardMessageParams) (*Message, error)
- func (b *Bot) GetChat(params *GetChatParams) (*Chat, error)
- func (b *Bot) GetChatAdministrators(params *GetChatAdministratorsParams) ([]ChatMember, error)
- func (b *Bot) GetChatMember(params *GetChatMemberParams) (ChatMember, error)
- func (b *Bot) GetChatMemberCount(params *GetChatMemberCountParams) (*int, error)
- func (b *Bot) GetFile(params *GetFileParams) (*File, error)
- func (b *Bot) GetGameHighScores(params *GetGameHighScoresParams) ([]GameHighScore, error)
- func (b *Bot) GetMe() (*User, error)
- func (b *Bot) GetMyCommands(params *GetMyCommandsParams) ([]BotCommand, error)
- func (b *Bot) GetStickerSet(params *GetStickerSetParams) (*StickerSet, error)
- func (b *Bot) GetUpdates(params *GetUpdatesParams) ([]Update, error)
- func (b *Bot) GetUpdatesChan(params *GetUpdatesParams) (chan Update, error)
- func (b *Bot) GetUserProfilePhotos(params *GetUserProfilePhotosParams) (*UserProfilePhotos, error)
- func (b *Bot) GetWebhookInfo() (*WebhookInfo, error)
- func (b *Bot) LeaveChat(params *LeaveChatParams) error
- func (b *Bot) ListenForWebhook(path string) (chan Update, error)
- func (b *Bot) LogOut() error
- func (b *Bot) PinChatMessage(params *PinChatMessageParams) error
- func (b *Bot) PromoteChatMember(params *PromoteChatMemberParams) error
- func (b *Bot) RestrictChatMember(params *RestrictChatMemberParams) error
- func (b *Bot) RevokeChatInviteLink(params *RevokeChatInviteLinkParams) (*ChatInviteLink, error)
- func (b *Bot) SendAnimation(params *SendAnimationParams) (*Message, error)
- func (b *Bot) SendAudio(params *SendAudioParams) (*Message, error)
- func (b *Bot) SendChatAction(params *SendChatActionParams) error
- func (b *Bot) SendContact(params *SendContactParams) (*Message, error)
- func (b *Bot) SendDice(params *SendDiceParams) (*Message, error)
- func (b *Bot) SendDocument(params *SendDocumentParams) (*Message, error)
- func (b *Bot) SendGame(params *SendGameParams) (*Message, error)
- func (b *Bot) SendInvoice(params *SendInvoiceParams) (*Message, error)
- func (b *Bot) SendLocation(params *SendLocationParams) (*Message, error)
- func (b *Bot) SendMediaGroup(params *SendMediaGroupParams) ([]Message, error)
- func (b *Bot) SendMessage(params *SendMessageParams) (*Message, error)
- func (b *Bot) SendPhoto(params *SendPhotoParams) (*Message, error)
- func (b *Bot) SendPoll(params *SendPollParams) (*Message, error)
- func (b *Bot) SendSticker(params *SendStickerParams) (*Message, error)
- func (b *Bot) SendVenue(params *SendVenueParams) (*Message, error)
- func (b *Bot) SendVideo(params *SendVideoParams) (*Message, error)
- func (b *Bot) SendVideoNote(params *SendVideoNoteParams) (*Message, error)
- func (b *Bot) SendVoice(params *SendVoiceParams) (*Message, error)
- func (b *Bot) SetChatAdministratorCustomTitle(params *SetChatAdministratorCustomTitleParams) error
- func (b *Bot) SetChatDescription(params *SetChatDescriptionParams) error
- func (b *Bot) SetChatPermissions(params *SetChatPermissionsParams) error
- func (b *Bot) SetChatPhoto(params *SetChatPhotoParams) error
- func (b *Bot) SetChatStickerSet(params *SetChatStickerSetParams) error
- func (b *Bot) SetChatTitle(params *SetChatTitleParams) error
- func (b *Bot) SetGameScore(params *SetGameScoreParams) (*Message, error)
- func (b *Bot) SetMyCommands(params *SetMyCommandsParams) error
- func (b *Bot) SetPassportDataErrors(params *SetPassportDataErrorsParams) error
- func (b *Bot) SetStickerPositionInSet(params *SetStickerPositionInSetParams) error
- func (b *Bot) SetStickerSetThumb(params *SetStickerSetThumbParams) error
- func (b *Bot) SetUpdateInterval(interval time.Duration)
- func (b *Bot) SetWebhook(params *SetWebhookParams) error
- func (b *Bot) StartListeningForWebhook(address string)
- func (b *Bot) StartListeningForWebhookTLS(address, certificateFile, keyFile string)
- func (b *Bot) StartListeningForWebhookTLSEmbed(address string, certificateData []byte, keyData []byte)
- func (b *Bot) StopGettingUpdates()
- func (b *Bot) StopMessageLiveLocation(params *StopMessageLiveLocationParams) (*Message, error)
- func (b *Bot) StopPoll(params *StopPollParams) (*Poll, error)
- func (b *Bot) Token() string
- func (b *Bot) UnbanChatMember(params *UnbanChatMemberParams) error
- func (b *Bot) UnpinAllChatMessages(params *UnpinAllChatMessagesParams) error
- func (b *Bot) UnpinChatMessage(params *UnpinChatMessageParams) error
- func (b *Bot) UploadStickerFile(params *UploadStickerFileParams) (*File, error)
- type BotCommand
- type BotCommandScope
- type BotCommandScopeAllChatAdministrators
- type BotCommandScopeAllGroupChats
- type BotCommandScopeAllPrivateChats
- type BotCommandScopeChat
- type BotCommandScopeChatAdministrators
- type BotCommandScopeChatMember
- type BotCommandScopeDefault
- type BotOption
- func CustomAPICaller(caller api.Caller) BotOption
- func CustomRequestConstructor(constructor api.RequestConstructor) BotOption
- func DefaultLogger(debugMode, printErrors bool) BotOption
- func FastHTTPClient(client *fasthttp.Client) BotOption
- func SetAPIServer(apiURL string) BotOption
- func SetLogger(log Logger) BotOption
- type CallbackGame
- type CallbackQuery
- type Chat
- type ChatID
- type ChatInviteLink
- type ChatLocation
- type ChatMember
- type ChatMemberAdministrator
- type ChatMemberBanned
- type ChatMemberLeft
- type ChatMemberMember
- type ChatMemberOwner
- type ChatMemberRestricted
- type ChatMemberUpdated
- type ChatPermissions
- type ChatPhoto
- type ChosenInlineResult
- type Contact
- type CopyMessageParams
- type CreateChatInviteLinkParams
- type CreateNewStickerSetParams
- type DeleteChatPhotoParams
- type DeleteChatStickerSetParams
- type DeleteMessageParams
- type DeleteMyCommandsParams
- type DeleteStickerFromSetParams
- type DeleteWebhookParams
- type Dice
- type Document
- type EditChatInviteLinkParams
- type EditMessageCaptionParams
- type EditMessageLiveLocationParams
- type EditMessageMediaParams
- type EditMessageReplyMarkupParams
- type EditMessageTextParams
- type EncryptedCredentials
- type EncryptedPassportElement
- type ExportChatInviteLinkParams
- type File
- type ForceReply
- type ForwardMessageParams
- type Game
- type GameHighScore
- type GetChatAdministratorsParams
- type GetChatMemberCountParams
- type GetChatMemberParams
- type GetChatParams
- type GetFileParams
- type GetGameHighScoresParams
- type GetMyCommandsParams
- type GetStickerSetParams
- type GetUpdatesParams
- type GetUserProfilePhotosParams
- 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 LabeledPrice
- type LeaveChatParams
- type Location
- type Logger
- type LoginURL
- type MaskPosition
- type Message
- type MessageAutoDeleteTimerChanged
- type MessageEntity
- type MessageID
- 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 PinChatMessageParams
- type Poll
- type PollAnswer
- type PollOption
- type PreCheckoutQuery
- type PromoteChatMemberParams
- type ProximityAlertTriggered
- type ReplyKeyboardMarkup
- type ReplyKeyboardRemove
- type ReplyMarkup
- type RestrictChatMemberParams
- type RevokeChatInviteLinkParams
- type SendAnimationParams
- type SendAudioParams
- type SendChatActionParams
- type SendContactParams
- type SendDiceParams
- type SendDocumentParams
- type SendGameParams
- type SendInvoiceParams
- type SendLocationParams
- type SendMediaGroupParams
- type SendMessageParams
- type SendPhotoParams
- type SendPollParams
- type SendStickerParams
- type SendVenueParams
- type SendVideoNoteParams
- type SendVideoParams
- type SendVoiceParams
- type SetChatAdministratorCustomTitleParams
- type SetChatDescriptionParams
- type SetChatPermissionsParams
- type SetChatPhotoParams
- type SetChatStickerSetParams
- type SetChatTitleParams
- type SetGameScoreParams
- type SetMyCommandsParams
- type SetPassportDataErrorsParams
- type SetStickerPositionInSetParams
- type SetStickerSetThumbParams
- type SetWebhookParams
- type ShippingAddress
- type ShippingOption
- type ShippingQuery
- type Sticker
- type StickerSet
- type StopMessageLiveLocationParams
- type StopPollParams
- type SuccessfulPayment
- type UnbanChatMemberParams
- type UnpinAllChatMessagesParams
- type UnpinChatMessageParams
- type Update
- type UploadStickerFileParams
- type User
- type UserProfilePhotos
- type Venue
- type Video
- type VideoNote
- type Voice
- type VoiceChatEnded
- type VoiceChatParticipantsInvited
- type VoiceChatScheduled
- type VoiceChatStarted
- type WebhookInfo
Constants ¶
const ( MessageUpdates = "message" EditedMessageUpdates = "edited_message" ChannelPostUpdates = "channel_post" EditedChannelPostUpdates = "edited_channel_post" InlineQueryUpdates = "inline_query" ChosenInlineResultUpdates = "chosen_inline_result" CallbackQueryUpdates = "callback_query" ShippingQueryUpdates = "shipping_query" PreCheckoutQueryUpdates = "pre_checkout_query" PollUpdates = "poll" PollAnswerUpdates = "poll_answer" MyChatMemberUpdates = "my_chat_member" ChatMemberUpdates = "chat_member" )
Update types you want your bot to receive
const ( ModeHTML = "HTML" ModeMarkdown = "Markdown" ModeMarkdownV2 = "MarkdownV2" )
Parse modes
const ( EmojiDice = "🎲" EmojiDarts = "🎯" EmojiBowling = "🎳" EmojiBasketball = "🏀" EmojiSoccer = "⚽" EmojiSlotMachine = "🎰" )
Dice emojis
const ( ChatTypePrivate = "private" ChatTypeGroup = "group" ChatTypeSupergroup = "supergroup" ChatTypeChannel = "channel" )
Chat types
const ( PollTypeRegular = "regular" PollTypeQuiz = "quiz" )
Poll types
const ( MarkupTypeReplyKeyboard = "ReplyKeyboardMarkup" MarkupTypeReplyKeyboardRemove = "ReplyKeyboardRemove" MarkupTypeInlineKeyboard = "InlineKeyboardMarkup" MarkupTypeForceReply = "ForceReply" )
ReplyMarkup types
const ( MemberStatusCreator = "creator" MemberStatusAdministrator = "administrator" MemberStatusMember = "member" MemberStatusRestricted = "restricted" MemberStatusLeft = "left" MemberStatusKicked = "kicked" )
ChatMember statuses
const ( ScopeTypeDefault = "default" ScopeTypeAllPrivateChats = "all_private_chats" ScopeTypeAllGroupChats = "all_group_chats" ScopeTypeAllChatAdministrators = "all_chat_administrators" ScopeTypeChat = "chat" ScopeTypeChatAdministrators = "chat_administrators" ScopeTypeChatMember = "chat_member" )
BotCommandScope types
const ( MediaTypePhoto = "photo" MediaTypeVideo = "video" MediaTypeAnimation = "animation" MediaTypeAudio = "audio" MediaTypeDocument = "document" )
InputMedia types
const ( ResultTypeArticle = "article" ResultTypePhoto = "photo" ResultTypeGif = "gif" ResultTypeMpeg4Gif = "mpeg4_gif" ResultTypeVideo = "video" ResultTypeAudio = "audio" ResultTypeVoice = "voice" ResultTypeDocument = "document" ResultTypeLocation = "location" ResultTypeVenue = "venue" ResultTypeContact = "contact" ResultTypeGame = "game" ResultTypeSticker = "sticker" )
InlineQueryResult types
const ( ThumbMimeTypeImageJpeg = "image/jpeg" ThumbMimeTypeImageGif = "image/gif" ThumbMimeTypeVideoMp4 = "video/mp4" )
ThumbMimeType types
const ( ContentTypeText = "InputTextMessage" ContentTypeLocation = "InputLocationMessage" ContentTypeVenue = "InputVenueMessage" ContentTypeContact = "InputContactMessage" ContentTypeInvoice = "InputInvoiceMessage" )
InputMessageContent types
const ( ErrorSourceDataField = "data" ErrorSourceFrontSide = "front_side" ErrorSourceReverseSide = "reverse_side" ErrorSourceSelfie = "selfie" ErrorSourceFile = "file" ErrorSourceFiles = "files" ErrorSourceTranslationFile = "translation_file" ErrorSourceTranslationFiles = "translation_files" ErrorSourceUnspecified = "unspecified" )
PassportElementError sources
Variables ¶
var ( // ErrInvalidToken Bot token is invalid according to token regexp ErrInvalidToken = errors.New("invalid token") )
Functions ¶
This section is empty.
Types ¶
type AddStickerToSetParams ¶
type AddStickerToSetParams struct { // UserID - User identifier of sticker set owner UserID int64 `json:"user_id"` // Name - Sticker set name Name string `json:"name"` // PngSticker - 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 » // (https://core.telegram.org/bots/api#sending-files) PngSticker *InputFile `json:"png_sticker,omitempty"` // TgsSticker - Optional. TGS animation with the sticker, uploaded using multipart/form-data. See // https://core.telegram.org/animated_stickers#technical-requirements // (https://core.telegram.org/animated_stickers#technical-requirements) for technical requirements TgsSticker *InputFile `json:"tgs_sticker,omitempty"` // Emojis - One or more emoji corresponding to the sticker Emojis string `json:"emojis"` // MaskPosition - Optional. A JSON-serialized object for position where the mask should be placed on faces MaskPosition *MaskPosition `json:"mask_position,omitempty"` }
AddStickerToSetParams - Represents parameters of addStickerToSet method.
type Animation ¶
type Animation struct { // FileID - Identifier for this file, which can be used to download or reuse the file FileID string `json:"file_id"` // FileUniqueID - 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"` // Width - Video width as defined by sender Width int `json:"width"` // Height - Video height as defined by sender Height int `json:"height"` // Duration - Duration of the video in seconds as defined by sender Duration int `json:"duration"` // Thumb - Optional. Animation thumbnail as defined by sender Thumb *PhotoSize `json:"thumb,omitempty"` // FileName - Optional. Original animation filename as defined by sender FileName string `json:"file_name,omitempty"` // MimeType - Optional. MIME type of the file as defined by sender MimeType string `json:"mime_type,omitempty"` // FileSize - Optional. File size FileSize int `json:"file_size,omitempty"` }
Animation - This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).
type AnswerCallbackQueryParams ¶
type AnswerCallbackQueryParams struct { // CallbackQueryID - Unique identifier for the query to be answered CallbackQueryID string `json:"callback_query_id"` // Text - Optional. Text of the notification. If not specified, nothing will be shown to the user, 0-200 // characters Text string `json:"text,omitempty"` // ShowAlert - 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"` // URL - Optional. URL that will be opened by the user's client. If you have created a Game // (https://core.telegram.org/bots/api#game) and accepted the conditions via @Botfather // (https://t.me/botfather), specify the URL that opens your game — note that this will only work if the query // comes from a callback_game (https://core.telegram.org/bots/api#inlinekeyboardbutton) 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"` // CacheTime - 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"` }
AnswerCallbackQueryParams - Represents parameters of answerCallbackQuery method.
type AnswerInlineQueryParams ¶
type AnswerInlineQueryParams struct { // InlineQueryID - Unique identifier for the answered query InlineQueryID string `json:"inline_query_id"` // Results - A JSON-serialized array of results for the inline query Results []InlineQueryResult `json:"results"` // CacheTime - 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"` // IsPersonal - 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"` // NextOffset - 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"` // SwitchPmText - 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"` // SwitchPmParameter - Optional. Deep-linking (https://core.telegram.org/bots#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 // (https://core.telegram.org/bots/api#inlinekeyboardmarkup) 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"` }
AnswerInlineQueryParams - Represents parameters of answerInlineQuery method.
type AnswerPreCheckoutQueryParams ¶
type AnswerPreCheckoutQueryParams struct { // PreCheckoutQueryID - Unique identifier for the query to be answered PreCheckoutQueryID string `json:"pre_checkout_query_id"` // Ok - 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"` // ErrorMessage - 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"` }
AnswerPreCheckoutQueryParams - Represents parameters of answerPreCheckoutQuery method.
type AnswerShippingQueryParams ¶
type AnswerShippingQueryParams struct { // ShippingQueryID - Unique identifier for the query to be answered ShippingQueryID string `json:"shipping_query_id"` // Ok - 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"` // ShippingOptions - Optional. Required if ok is True. A JSON-serialized array of available shipping options. ShippingOptions []ShippingOption `json:"shipping_options,omitempty"` // ErrorMessage - 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"` }
AnswerShippingQueryParams - Represents parameters of answerShippingQuery method.
type Audio ¶
type Audio struct { // FileID - Identifier for this file, which can be used to download or reuse the file FileID string `json:"file_id"` // FileUniqueID - 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 - Duration of the audio in seconds as defined by sender Duration int `json:"duration"` // Performer - Optional. Performer of the audio as defined by sender or by audio tags Performer string `json:"performer,omitempty"` // Title - Optional. Title of the audio as defined by sender or by audio tags Title string `json:"title,omitempty"` // FileName - Optional. Original filename as defined by sender FileName string `json:"file_name,omitempty"` // MimeType - Optional. MIME type of the file as defined by sender MimeType string `json:"mime_type,omitempty"` // FileSize - Optional. File size FileSize int `json:"file_size,omitempty"` // Thumb - Optional. Thumbnail of the album cover to which the music file belongs Thumb *PhotoSize `json:"thumb,omitempty"` }
Audio - This object represents an audio file to be treated as music by the Telegram clients.
type BanChatMemberParams ¶
type BanChatMemberParams struct { // ChatID - Unique identifier for the target group or username of the target supergroup or channel (in the // format @channelusername) ChatID ChatID `json:"chat_id"` // UserID - Unique identifier of the target user UserID int64 `json:"user_id"` // UntilDate - 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"` // RevokeMessages - 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"` }
BanChatMemberParams - Represents parameters of banChatMember method.
type Bot ¶
type Bot struct {
// contains filtered or unexported fields
}
Bot represents Telegram bot
func NewBot ¶
NewBot creates new bot with given options. If no options specified default values are used
func (*Bot) AddStickerToSet ¶
func (b *Bot) AddStickerToSet(params *AddStickerToSetParams) error
AddStickerToSet - 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(params *AnswerCallbackQueryParams) error
AnswerCallbackQuery - Use this method to send answers to callback queries sent from inline keyboards (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating). 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.
func (*Bot) AnswerInlineQuery ¶
func (b *Bot) AnswerInlineQuery(params *AnswerInlineQueryParams) error
AnswerInlineQuery - Use this method to send answers to an inline query. On success, True is returned.No more than 50 results per query are allowed.
func (*Bot) AnswerPreCheckoutQuery ¶
func (b *Bot) AnswerPreCheckoutQuery(params *AnswerPreCheckoutQueryParams) error
AnswerPreCheckoutQuery - Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update (https://core.telegram.org/bots/api#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(params *AnswerShippingQueryParams) error
AnswerShippingQuery - If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update (https://core.telegram.org/bots/api#update) with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.
func (*Bot) BanChatMember ¶
func (b *Bot) BanChatMember(params *BanChatMemberParams) error
BanChatMember - Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned (https://core.telegram.org/bots/api#unbanchatmember) 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) Close ¶
Close - Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.
func (*Bot) CopyMessage ¶
func (b *Bot) CopyMessage(params *CopyMessageParams) (*MessageID, error)
CopyMessage - 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 (https://core.telegram.org/bots/api#forwardmessage), but the copied message doesn't have a link to the original message. Returns the MessageID (https://core.telegram.org/bots/api#messageid) of the sent message on success.
func (*Bot) CreateChatInviteLink ¶
func (b *Bot) CreateChatInviteLink(params *CreateChatInviteLinkParams) (*ChatInviteLink, error)
CreateChatInviteLink - Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. The link can be revoked using the method revokeChatInviteLink (https://core.telegram.org/bots/api#revokechatinvitelink). Returns the new invite link as ChatInviteLink (https://core.telegram.org/bots/api#chatinvitelink) object.
func (*Bot) CreateNewStickerSet ¶
func (b *Bot) CreateNewStickerSet(params *CreateNewStickerSetParams) error
CreateNewStickerSet - Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. You must use exactly one of the fields png_sticker or tgs_sticker. Returns True on success.
func (*Bot) DeleteChatPhoto ¶
func (b *Bot) DeleteChatPhoto(params *DeleteChatPhotoParams) error
DeleteChatPhoto - Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.
func (*Bot) DeleteChatStickerSet ¶
func (b *Bot) DeleteChatStickerSet(params *DeleteChatStickerSetParams) error
DeleteChatStickerSet - Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field can_set_sticker_set optionally returned in getChat (https://core.telegram.org/bots/api#getchat) requests to check if the bot can use this method. Returns True on success.
func (*Bot) DeleteMessage ¶
func (b *Bot) DeleteMessage(params *DeleteMessageParams) error
DeleteMessage - Use this method to delete a message, including service messages, with the following limitations:- A message can only be deleted if it was sent less than 48 hours ago.- 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) DeleteMyCommands ¶
func (b *Bot) DeleteMyCommands(params *DeleteMyCommandsParams) error
DeleteMyCommands - Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands (https://core.telegram.org/bots/api#determining-list-of-commands) will be shown to affected users. Returns True on success.
func (*Bot) DeleteStickerFromSet ¶
func (b *Bot) DeleteStickerFromSet(params *DeleteStickerFromSetParams) error
DeleteStickerFromSet - 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(params *DeleteWebhookParams) error
DeleteWebhook - Use this method to remove webhook integration if you decide to switch back to getUpdates (https://core.telegram.org/bots/api#getupdates). Returns True on success.
func (*Bot) EditChatInviteLink ¶
func (b *Bot) EditChatInviteLink(params *EditChatInviteLinkParams) (*ChatInviteLink, error)
EditChatInviteLink - Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the edited invite link as a ChatInviteLink (https://core.telegram.org/bots/api#chatinvitelink) object.
func (*Bot) EditMessageCaption ¶
func (b *Bot) EditMessageCaption(params *EditMessageCaptionParams) (*Message, error)
EditMessageCaption - Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message (https://core.telegram.org/bots/api#message) is returned, otherwise True is returned.
func (*Bot) EditMessageLiveLocation ¶
func (b *Bot) EditMessageLiveLocation(params *EditMessageLiveLocationParams) (*Message, error)
EditMessageLiveLocation - Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation (https://core.telegram.org/bots/api#stopmessagelivelocation). On success, if the edited message is not an inline message, the edited Message (https://core.telegram.org/bots/api#message) is returned, otherwise True is returned.
func (*Bot) EditMessageMedia ¶
func (b *Bot) EditMessageMedia(params *EditMessageMediaParams) (*Message, error)
EditMessageMedia - Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message (https://core.telegram.org/bots/api#message) is returned, otherwise True is returned.
func (*Bot) EditMessageReplyMarkup ¶
func (b *Bot) EditMessageReplyMarkup(params *EditMessageReplyMarkupParams) (*Message, error)
EditMessageReplyMarkup - Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message (https://core.telegram.org/bots/api#message) is returned, otherwise True is returned.
func (*Bot) EditMessageText ¶
func (b *Bot) EditMessageText(params *EditMessageTextParams) (*Message, error)
EditMessageText - Use this method to edit text and game (https://core.telegram.org/bots/api#games) messages. On success, if the edited message is not an inline message, the edited Message (https://core.telegram.org/bots/api#message) is returned, otherwise True is returned.
func (*Bot) ExportChatInviteLink ¶
func (b *Bot) ExportChatInviteLink(params *ExportChatInviteLinkParams) (*string, error)
ExportChatInviteLink - Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate 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(params *ForwardMessageParams) (*Message, error)
ForwardMessage - Use this method to forward messages of any kind. Service messages can't be forwarded. On success, the sent Message (https://core.telegram.org/bots/api#message) is returned.
func (*Bot) GetChat ¶
func (b *Bot) GetChat(params *GetChatParams) (*Chat, error)
GetChat - 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 (https://core.telegram.org/bots/api#chat) object on success.
func (*Bot) GetChatAdministrators ¶
func (b *Bot) GetChatAdministrators(params *GetChatAdministratorsParams) ([]ChatMember, error)
GetChatAdministrators - Use this method to get a list of administrators in a chat. On success, returns an Array of ChatMember (https://core.telegram.org/bots/api#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(params *GetChatMemberParams) (ChatMember, error)
GetChatMember - Use this method to get information about a member of a chat. Returns a ChatMember (https://core.telegram.org/bots/api#chatmember) object on success.
func (*Bot) GetChatMemberCount ¶
func (b *Bot) GetChatMemberCount(params *GetChatMemberCountParams) (*int, error)
GetChatMemberCount - Use this method to get the number of members in a chat. Returns Int on success.
func (*Bot) GetFile ¶
func (b *Bot) GetFile(params *GetFileParams) (*File, error)
GetFile - 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 (https://core.telegram.org/bots/api#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 (https://core.telegram.org/bots/api#getfile) again.
func (*Bot) GetGameHighScores ¶
func (b *Bot) GetGameHighScores(params *GetGameHighScoresParams) ([]GameHighScore, error)
GetGameHighScores - Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. On success, returns an Array of GameHighScore (https://core.telegram.org/bots/api#gamehighscore) objects.
func (*Bot) GetMe ¶
GetMe - A simple method for testing your bot's auth token. Requires no parameters. Returns basic information about the bot in form of a User (https://core.telegram.org/bots/api#user) object.
func (*Bot) GetMyCommands ¶
func (b *Bot) GetMyCommands(params *GetMyCommandsParams) ([]BotCommand, error)
GetMyCommands - Use this method to get the current list of the bot's commands for the given scope and user language. Returns Array of BotCommand (https://core.telegram.org/bots/api#botcommand) on success. If commands aren't set, an empty list is returned.
func (*Bot) GetStickerSet ¶
func (b *Bot) GetStickerSet(params *GetStickerSetParams) (*StickerSet, error)
GetStickerSet - Use this method to get a sticker set. On success, a StickerSet (https://core.telegram.org/bots/api#stickerset) object is returned.
func (*Bot) GetUpdates ¶
func (b *Bot) GetUpdates(params *GetUpdatesParams) ([]Update, error)
GetUpdates - Use this method to receive incoming updates using long polling (wiki (https://en.wikipedia.org/wiki/Push_technology#Long_polling)). An Array of Update (https://core.telegram.org/bots/api#update) objects is returned.
func (*Bot) GetUpdatesChan ¶
func (b *Bot) GetUpdatesChan(params *GetUpdatesParams) (chan Update, error)
GetUpdatesChan receive updates in chan
func (*Bot) GetUserProfilePhotos ¶
func (b *Bot) GetUserProfilePhotos(params *GetUserProfilePhotosParams) (*UserProfilePhotos, error)
GetUserProfilePhotos - Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos (https://core.telegram.org/bots/api#userprofilephotos) object.
func (*Bot) GetWebhookInfo ¶
func (b *Bot) GetWebhookInfo() (*WebhookInfo, error)
GetWebhookInfo - Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo (https://core.telegram.org/bots/api#webhookinfo) object. If the bot is using getUpdates (https://core.telegram.org/bots/api#getupdates), will return an object with the URL field empty.
func (*Bot) LeaveChat ¶
func (b *Bot) LeaveChat(params *LeaveChatParams) error
LeaveChat - Use this method for your bot to leave a group, supergroup or channel. Returns True on success.
func (*Bot) ListenForWebhook ¶
ListenForWebhook receive updates in chan from webhook
func (*Bot) LogOut ¶
LogOut - Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.
func (*Bot) PinChatMessage ¶
func (b *Bot) PinChatMessage(params *PinChatMessageParams) error
PinChatMessage - Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' 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(params *PromoteChatMemberParams) error
PromoteChatMember - Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Pass False for all boolean parameters to demote a user. Returns True on success.
func (*Bot) RestrictChatMember ¶
func (b *Bot) RestrictChatMember(params *RestrictChatMemberParams) error
RestrictChatMember - Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate admin rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.
func (*Bot) RevokeChatInviteLink ¶
func (b *Bot) RevokeChatInviteLink(params *RevokeChatInviteLinkParams) (*ChatInviteLink, error)
RevokeChatInviteLink - Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the revoked invite link as ChatInviteLink (https://core.telegram.org/bots/api#chatinvitelink) object.
func (*Bot) SendAnimation ¶
func (b *Bot) SendAnimation(params *SendAnimationParams) (*Message, error)
SendAnimation - Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message (https://core.telegram.org/bots/api#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(params *SendAudioParams) (*Message, error)
SendAudio - Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message (https://core.telegram.org/bots/api#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 (https://core.telegram.org/bots/api#sendvoice) method instead.
func (*Bot) SendChatAction ¶
func (b *Bot) SendChatAction(params *SendChatActionParams) error
SendChatAction - Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success. We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.
func (*Bot) SendContact ¶
func (b *Bot) SendContact(params *SendContactParams) (*Message, error)
SendContact - Use this method to send phone contacts. On success, the sent Message (https://core.telegram.org/bots/api#message) is returned.
func (*Bot) SendDice ¶
func (b *Bot) SendDice(params *SendDiceParams) (*Message, error)
SendDice - Use this method to send an animated emoji that will display a random value. On success, the sent Message (https://core.telegram.org/bots/api#message) is returned.
func (*Bot) SendDocument ¶
func (b *Bot) SendDocument(params *SendDocumentParams) (*Message, error)
SendDocument - Use this method to send general files. On success, the sent Message (https://core.telegram.org/bots/api#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(params *SendGameParams) (*Message, error)
SendGame - Use this method to send a game. On success, the sent Message (https://core.telegram.org/bots/api#message) is returned.
func (*Bot) SendInvoice ¶
func (b *Bot) SendInvoice(params *SendInvoiceParams) (*Message, error)
SendInvoice - Use this method to send invoices. On success, the sent Message (https://core.telegram.org/bots/api#message) is returned.
func (*Bot) SendLocation ¶
func (b *Bot) SendLocation(params *SendLocationParams) (*Message, error)
SendLocation - Use this method to send point on the map. On success, the sent Message (https://core.telegram.org/bots/api#message) is returned.
func (*Bot) SendMediaGroup ¶
func (b *Bot) SendMediaGroup(params *SendMediaGroupParams) ([]Message, error)
SendMediaGroup - Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Messages (https://core.telegram.org/bots/api#message) that were sent is returned.
func (*Bot) SendMessage ¶
func (b *Bot) SendMessage(params *SendMessageParams) (*Message, error)
SendMessage - Use this method to send text messages. On success, the sent Message (https://core.telegram.org/bots/api#message) is returned.
func (*Bot) SendPhoto ¶
func (b *Bot) SendPhoto(params *SendPhotoParams) (*Message, error)
SendPhoto - Use this method to send photos. On success, the sent Message (https://core.telegram.org/bots/api#message) is returned.
func (*Bot) SendPoll ¶
func (b *Bot) SendPoll(params *SendPollParams) (*Message, error)
SendPoll - Use this method to send a native poll. On success, the sent Message (https://core.telegram.org/bots/api#message) is returned.
func (*Bot) SendSticker ¶
func (b *Bot) SendSticker(params *SendStickerParams) (*Message, error)
SendSticker - Use this method to send static .WEBP or animated (https://telegram.org/blog/animated-stickers) .TGS stickers. On success, the sent Message (https://core.telegram.org/bots/api#message) is returned.
func (*Bot) SendVenue ¶
func (b *Bot) SendVenue(params *SendVenueParams) (*Message, error)
SendVenue - Use this method to send information about a venue. On success, the sent Message (https://core.telegram.org/bots/api#message) is returned.
func (*Bot) SendVideo ¶
func (b *Bot) SendVideo(params *SendVideoParams) (*Message, error)
SendVideo - Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document (https://core.telegram.org/bots/api#document)). On success, the sent Message (https://core.telegram.org/bots/api#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(params *SendVideoNoteParams) (*Message, error)
SendVideoNote - As of v.4.0 (https://telegram.org/blog/video-messages-and-telescope), 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 (https://core.telegram.org/bots/api#message) is returned.
func (*Bot) SendVoice ¶
func (b *Bot) SendVoice(params *SendVoiceParams) (*Message, error)
SendVoice - Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as Audio (https://core.telegram.org/bots/api#audio) or Document (https://core.telegram.org/bots/api#document)). On success, the sent Message (https://core.telegram.org/bots/api#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(params *SetChatAdministratorCustomTitleParams) error
SetChatAdministratorCustomTitle - 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(params *SetChatDescriptionParams) error
SetChatDescription - Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.
func (*Bot) SetChatPermissions ¶
func (b *Bot) SetChatPermissions(params *SetChatPermissionsParams) error
SetChatPermissions - Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members admin rights. Returns True on success.
func (*Bot) SetChatPhoto ¶
func (b *Bot) SetChatPhoto(params *SetChatPhotoParams) error
SetChatPhoto - Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.
func (*Bot) SetChatStickerSet ¶
func (b *Bot) SetChatStickerSet(params *SetChatStickerSetParams) error
SetChatStickerSet - Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field can_set_sticker_set optionally returned in getChat (https://core.telegram.org/bots/api#getchat) requests to check if the bot can use this method. Returns True on success.
func (*Bot) SetChatTitle ¶
func (b *Bot) SetChatTitle(params *SetChatTitleParams) error
SetChatTitle - Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.
func (*Bot) SetGameScore ¶
func (b *Bot) SetGameScore(params *SetGameScoreParams) (*Message, error)
SetGameScore - Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message (https://core.telegram.org/bots/api#message) is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.
func (*Bot) SetMyCommands ¶
func (b *Bot) SetMyCommands(params *SetMyCommandsParams) error
SetMyCommands - Use this method to change the list of the bot's commands. See https://core.telegram.org/bots#commands (https://core.telegram.org/bots#commands) for more details about bot commands. Returns True on success.
func (*Bot) SetPassportDataErrors ¶
func (b *Bot) SetPassportDataErrors(params *SetPassportDataErrorsParams) error
SetPassportDataErrors - Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.
func (*Bot) SetStickerPositionInSet ¶
func (b *Bot) SetStickerPositionInSet(params *SetStickerPositionInSetParams) error
SetStickerPositionInSet - 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(params *SetStickerSetThumbParams) error
SetStickerSetThumb - 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) SetUpdateInterval ¶
SetUpdateInterval sets interval of calling GetUpdates in GetUpdatesChan method. Ensures that between two calls of GetUpdates will be at least specified time, but it could be longer.
func (*Bot) SetWebhook ¶
func (b *Bot) SetWebhook(params *SetWebhookParams) error
SetWebhook - Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a JSON-serialized Update (https://core.telegram.org/bots/api#update). In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.
func (*Bot) StartListeningForWebhook ¶
StartListeningForWebhook start server for listening for webhook
func (*Bot) StartListeningForWebhookTLS ¶ added in v0.3.0
StartListeningForWebhookTLS start server with TLS for listening for webhook
func (*Bot) StartListeningForWebhookTLSEmbed ¶ added in v0.3.0
func (b *Bot) StartListeningForWebhookTLSEmbed(address string, certificateData []byte, keyData []byte)
StartListeningForWebhookTLSEmbed start server with TLS (embed) for listening for webhook
func (*Bot) StopGettingUpdates ¶
func (b *Bot) StopGettingUpdates()
StopGettingUpdates stop reviving updates from GetUpdatesChan method
func (*Bot) StopMessageLiveLocation ¶
func (b *Bot) StopMessageLiveLocation(params *StopMessageLiveLocationParams) (*Message, error)
StopMessageLiveLocation - Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message (https://core.telegram.org/bots/api#message) is returned, otherwise True is returned.
func (*Bot) StopPoll ¶
func (b *Bot) StopPoll(params *StopPollParams) (*Poll, error)
StopPoll - Use this method to stop a poll which was sent by the bot. On success, the stopped Poll (https://core.telegram.org/bots/api#poll) is returned.
func (*Bot) UnbanChatMember ¶
func (b *Bot) UnbanChatMember(params *UnbanChatMemberParams) error
UnbanChatMember - Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success.
func (*Bot) UnpinAllChatMessages ¶
func (b *Bot) UnpinAllChatMessages(params *UnpinAllChatMessagesParams) error
UnpinAllChatMessages - Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' 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(params *UnpinChatMessageParams) error
UnpinChatMessage - Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' 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(params *UploadStickerFileParams) (*File, error)
UploadStickerFile - 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 (https://core.telegram.org/bots/api#file) on success.
type BotCommand ¶
type BotCommand struct { // Command - Text of the command, 1-32 characters. Can contain only lowercase English letters, digits and // underscores. Command string `json:"command"` // Description - Description of the command, 3-256 characters. Description string `json:"description"` }
BotCommand - This object represents a bot command.
type BotCommandScope ¶
type BotCommandScope interface {
ScopeType() string
}
BotCommandScope - This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported: BotCommandScopeDefault BotCommandScopeAllPrivateChats BotCommandScopeAllGroupChats BotCommandScopeAllChatAdministrators BotCommandScopeChat BotCommandScopeChatAdministrators BotCommandScopeChatMember
type BotCommandScopeAllChatAdministrators ¶
type BotCommandScopeAllChatAdministrators struct { // Type - Scope type, must be all_chat_administrators Type string `json:"type"` }
BotCommandScopeAllChatAdministrators - Represents the scope (https://core.telegram.org/bots/api#botcommandscope) of bot commands, covering all group and supergroup chat administrators.
func (*BotCommandScopeAllChatAdministrators) ScopeType ¶
func (b *BotCommandScopeAllChatAdministrators) ScopeType() string
ScopeType returns BotCommandScope type
type BotCommandScopeAllGroupChats ¶
type BotCommandScopeAllGroupChats struct { // Type - Scope type, must be all_group_chats Type string `json:"type"` }
BotCommandScopeAllGroupChats - Represents the scope (https://core.telegram.org/bots/api#botcommandscope) of bot commands, covering all group and supergroup chats.
func (*BotCommandScopeAllGroupChats) ScopeType ¶
func (b *BotCommandScopeAllGroupChats) ScopeType() string
ScopeType returns BotCommandScope type
type BotCommandScopeAllPrivateChats ¶
type BotCommandScopeAllPrivateChats struct { // Type - Scope type, must be all_private_chats Type string `json:"type"` }
BotCommandScopeAllPrivateChats - Represents the scope (https://core.telegram.org/bots/api#botcommandscope) of bot commands, covering all private chats.
func (*BotCommandScopeAllPrivateChats) ScopeType ¶
func (b *BotCommandScopeAllPrivateChats) ScopeType() string
ScopeType returns BotCommandScope type
type BotCommandScopeChat ¶
type BotCommandScopeChat struct { // Type - Scope type, must be chat Type string `json:"type"` // ChatID - Unique identifier for the target chat or username of the target supergroup (in the format // @supergroupusername) ChatID ChatID `json:"chat_id"` }
BotCommandScopeChat - Represents the scope (https://core.telegram.org/bots/api#botcommandscope) of bot commands, covering a specific chat.
func (*BotCommandScopeChat) ScopeType ¶
func (b *BotCommandScopeChat) ScopeType() string
ScopeType returns BotCommandScope type
type BotCommandScopeChatAdministrators ¶
type BotCommandScopeChatAdministrators struct { // Type - Scope type, must be chat_administrators Type string `json:"type"` // ChatID - Unique identifier for the target chat or username of the target supergroup (in the format // @supergroupusername) ChatID ChatID `json:"chat_id"` }
BotCommandScopeChatAdministrators - Represents the scope (https://core.telegram.org/bots/api#botcommandscope) of bot commands, covering all administrators of a specific group or supergroup chat.
func (*BotCommandScopeChatAdministrators) ScopeType ¶
func (b *BotCommandScopeChatAdministrators) ScopeType() string
ScopeType returns BotCommandScope type
type BotCommandScopeChatMember ¶
type BotCommandScopeChatMember struct { // Type - Scope type, must be chat_member Type string `json:"type"` // ChatID - Unique identifier for the target chat or username of the target supergroup (in the format // @supergroupusername) ChatID ChatID `json:"chat_id"` // UserID - Unique identifier of the target user UserID int `json:"user_id"` }
BotCommandScopeChatMember - Represents the scope (https://core.telegram.org/bots/api#botcommandscope) of bot commands, covering a specific member of a group or supergroup chat.
func (*BotCommandScopeChatMember) ScopeType ¶
func (b *BotCommandScopeChatMember) ScopeType() string
ScopeType returns BotCommandScope type
type BotCommandScopeDefault ¶
type BotCommandScopeDefault struct { // Type - Scope type, must be default Type string `json:"type"` }
BotCommandScopeDefault - Represents the default scope (https://core.telegram.org/bots/api#botcommandscope) of bot commands. Default commands are used if no commands with a narrower scope (https://core.telegram.org/bots/api#determining-list-of-commands) are specified for the user.
func (*BotCommandScopeDefault) ScopeType ¶
func (b *BotCommandScopeDefault) ScopeType() string
ScopeType returns BotCommandScope type
type BotOption ¶ added in v0.3.0
BotOption represents option that can be applied to Bot
func CustomAPICaller ¶ added in v0.3.0
CustomAPICaller sets custom API caller to use
func CustomRequestConstructor ¶ added in v0.3.0
func CustomRequestConstructor(constructor api.RequestConstructor) BotOption
CustomRequestConstructor sets custom request constructor to use
func DefaultLogger ¶ added in v0.3.0
DefaultLogger configures default logger. Redefines existing logger
func FastHTTPClient ¶ added in v0.3.0
FastHTTPClient sets fasthttp client to use
func SetAPIServer ¶ added in v0.3.0
SetAPIServer sets bot API server URL to use
type CallbackGame ¶
type CallbackGame struct { }
CallbackGame - A placeholder, currently holds no information. Use BotFather (https://t.me/botfather) to set up your game.
type CallbackQuery ¶
type CallbackQuery struct { // ID - Unique identifier for this query ID string `json:"id"` // From - Sender From User `json:"from"` // Message - 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"` // InlineMessageID - Optional. Identifier of the message sent via the bot in inline mode, that originated // the query. InlineMessageID string `json:"inline_message_id,omitempty"` // ChatInstance - Global identifier, uniquely corresponding to the chat to which the message with the // callback button was sent. Useful for high scores in games (https://core.telegram.org/bots/api#games). ChatInstance string `json:"chat_instance"` // Data - 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"` // GameShortName - Optional. Short name of a Game (https://core.telegram.org/bots/api#games) to be returned, // serves as the unique identifier for the game GameShortName string `json:"game_short_name,omitempty"` }
CallbackQuery - This object represents an incoming callback query from a callback button in an inline keyboard (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating). 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 (https://core.telegram.org/bots/api#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 (https://core.telegram.org/bots/api#answercallbackquery). It is, therefore, necessary to react by calling answerCallbackQuery (https://core.telegram.org/bots/api#answercallbackquery) even if no notification to the user is needed (e.g., without specifying any of the optional parameters).
type Chat ¶
type Chat struct { // ID - Unique identifier for this chat. This number may have more than 32 significant bits and some // programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 // significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this // identifier. ID int64 `json:"id"` // Type - Type of chat, can be either “private”, “group”, “supergroup” or “channel” Type string `json:"type"` // Title - Optional. Title, for supergroups, channels and group chats Title string `json:"title,omitempty"` // Username - Optional. Username, for private chats, supergroups and channels if available Username string `json:"username,omitempty"` // FirstName - Optional. First name of the other party in a private chat FirstName string `json:"first_name,omitempty"` // LastName - Optional. Last name of the other party in a private chat LastName string `json:"last_name,omitempty"` // Photo - Optional. Chat photo. Returned only in getChat (https://core.telegram.org/bots/api#getchat). Photo *ChatPhoto `json:"photo,omitempty"` // Bio - Optional. Bio of the other party in a private chat. Returned only in getChat // (https://core.telegram.org/bots/api#getchat). Bio string `json:"bio,omitempty"` // Description - Optional. Description, for groups, supergroups and channel chats. Returned only in getChat // (https://core.telegram.org/bots/api#getchat). Description string `json:"description,omitempty"` // InviteLink - Optional. Primary invite link, for groups, supergroups and channel chats. Returned only in // getChat (https://core.telegram.org/bots/api#getchat). InviteLink string `json:"invite_link,omitempty"` // PinnedMessage - Optional. The most recent pinned message (by sending date). Returned only in getChat // (https://core.telegram.org/bots/api#getchat). PinnedMessage *Message `json:"pinned_message,omitempty"` // Permissions - Optional. Default chat member permissions, for groups and supergroups. Returned only in // getChat (https://core.telegram.org/bots/api#getchat). Permissions *ChatPermissions `json:"permissions,omitempty"` // SlowModeDelay - Optional. For supergroups, the minimum allowed delay between consecutive messages sent by // each unpriviledged user. Returned only in getChat (https://core.telegram.org/bots/api#getchat). SlowModeDelay int `json:"slow_mode_delay,omitempty"` // MessageAutoDeleteTime - Optional. The time after which all messages sent to the chat will be // automatically deleted; in seconds. Returned only in getChat (https://core.telegram.org/bots/api#getchat). MessageAutoDeleteTime int `json:"message_auto_delete_time,omitempty"` // StickerSetName - Optional. For supergroups, name of group sticker set. Returned only in getChat // (https://core.telegram.org/bots/api#getchat). StickerSetName string `json:"sticker_set_name,omitempty"` // CanSetStickerSet - Optional. True, if the bot can change the group sticker set. Returned only in getChat // (https://core.telegram.org/bots/api#getchat). CanSetStickerSet bool `json:"can_set_sticker_set,omitempty"` // LinkedChatID - 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 (https://core.telegram.org/bots/api#getchat). LinkedChatID int64 `json:"linked_chat_id,omitempty"` // Location - Optional. For supergroups, the location to which the supergroup is connected. Returned only in // getChat (https://core.telegram.org/bots/api#getchat). Location *ChatLocation `json:"location,omitempty"` }
Chat - This object represents a chat.
type ChatID ¶
ChatID - Represents chat ID as int64 or string
func (ChatID) MarshalJSON ¶
MarshalJSON returns JSON representation of ChatID
type ChatInviteLink ¶
type ChatInviteLink struct { // InviteLink - 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 - Creator of the link Creator User `json:"creator"` // IsPrimary - True, if the link is primary IsPrimary bool `json:"is_primary"` // IsRevoked - True, if the link is revoked IsRevoked bool `json:"is_revoked"` // ExpireDate - Optional. Point in time (Unix timestamp) when the link will expire or has been expired ExpireDate int64 `json:"expire_date,omitempty"` // MemberLimit - 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"` }
ChatInviteLink - Represents an invite link for a chat.
type ChatLocation ¶
type ChatLocation struct { // Location - The location to which the supergroup is connected. Can't be a live location. Location Location `json:"location"` // Address - Location address; 1-64 characters, as defined by the chat owner Address string `json:"address"` }
ChatLocation - Represents a location to which a chat is connected.
type ChatMember ¶
ChatMember - This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported: ChatMemberOwner ChatMemberAdministrator ChatMemberMember ChatMemberRestricted ChatMemberLeft ChatMemberBanned
type ChatMemberAdministrator ¶
type ChatMemberAdministrator struct { // Status - The member's status in the chat, always “administrator” Status string `json:"status"` // User - Information about the user User User `json:"user"` // CanBeEdited - True, if the bot is allowed to edit administrator privileges of that user CanBeEdited bool `json:"can_be_edited"` // IsAnonymous - True, if the user's presence in the chat is hidden IsAnonymous bool `json:"is_anonymous"` // CanManageChat - 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"` // CanDeleteMessages - True, if the administrator can delete messages of other users CanDeleteMessages bool `json:"can_delete_messages"` // CanManageVoiceChats - True, if the administrator can manage voice chats CanManageVoiceChats bool `json:"can_manage_voice_chats"` // CanRestrictMembers - True, if the administrator can restrict, ban or unban chat members CanRestrictMembers bool `json:"can_restrict_members"` // CanPromoteMembers - 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"` // CanChangeInfo - True, if the user is allowed to change the chat title, photo and other settings CanChangeInfo bool `json:"can_change_info"` // CanInviteUsers - True, if the user is allowed to invite new users to the chat CanInviteUsers bool `json:"can_invite_users"` // CanPostMessages - Optional. True, if the administrator can post in the channel; channels only CanPostMessages bool `json:"can_post_messages,omitempty"` // CanEditMessages - Optional. True, if the administrator can edit messages of other users and can pin // messages; channels only CanEditMessages bool `json:"can_edit_messages,omitempty"` // CanPinMessages - Optional. True, if the user is allowed to pin messages; groups and supergroups only CanPinMessages bool `json:"can_pin_messages,omitempty"` // CustomTitle - Optional. Custom title for this user CustomTitle string `json:"custom_title,omitempty"` }
ChatMemberAdministrator - Represents a chat member (https://core.telegram.org/bots/api#chatmember) that has some additional privileges.
func (*ChatMemberAdministrator) MemberStatus ¶
func (c *ChatMemberAdministrator) MemberStatus() string
MemberStatus returns ChatMember status
func (*ChatMemberAdministrator) MemberUser ¶
func (c *ChatMemberAdministrator) MemberUser() User
MemberUser returns ChatMember User
type ChatMemberBanned ¶
type ChatMemberBanned struct { // Status - The member's status in the chat, always “kicked” Status string `json:"status"` // User - Information about the user User User `json:"user"` // UntilDate - Date when restrictions will be lifted for this user; unix time. If 0, then the user is banned // forever UntilDate int64 `json:"until_date"` }
ChatMemberBanned - Represents a chat member (https://core.telegram.org/bots/api#chatmember) that was banned in the chat and can't return to the chat or view chat messages.
func (*ChatMemberBanned) MemberStatus ¶
func (c *ChatMemberBanned) MemberStatus() string
MemberStatus returns ChatMember status
func (*ChatMemberBanned) MemberUser ¶
func (c *ChatMemberBanned) MemberUser() User
MemberUser returns ChatMember User
type ChatMemberLeft ¶
type ChatMemberLeft struct { // Status - The member's status in the chat, always “left” Status string `json:"status"` // User - Information about the user User User `json:"user"` }
ChatMemberLeft - Represents a chat member (https://core.telegram.org/bots/api#chatmember) that isn't currently a member of the chat, but may join it themselves.
func (*ChatMemberLeft) MemberStatus ¶
func (c *ChatMemberLeft) MemberStatus() string
MemberStatus returns ChatMember status
func (*ChatMemberLeft) MemberUser ¶
func (c *ChatMemberLeft) MemberUser() User
MemberUser returns ChatMember User
type ChatMemberMember ¶
type ChatMemberMember struct { // Status - The member's status in the chat, always “member” Status string `json:"status"` // User - Information about the user User User `json:"user"` }
ChatMemberMember - Represents a chat member (https://core.telegram.org/bots/api#chatmember) that has no additional privileges or restrictions.
func (*ChatMemberMember) MemberStatus ¶
func (c *ChatMemberMember) MemberStatus() string
MemberStatus returns ChatMember status
func (*ChatMemberMember) MemberUser ¶
func (c *ChatMemberMember) MemberUser() User
MemberUser returns ChatMember User
type ChatMemberOwner ¶
type ChatMemberOwner struct { // Status - The member's status in the chat, always “creator” Status string `json:"status"` // User - Information about the user User User `json:"user"` // IsAnonymous - True, if the user's presence in the chat is hidden IsAnonymous bool `json:"is_anonymous"` // CustomTitle - Optional. Custom title for this user CustomTitle string `json:"custom_title,omitempty"` }
ChatMemberOwner - Represents a chat member (https://core.telegram.org/bots/api#chatmember) that owns the chat and has all administrator privileges.
func (*ChatMemberOwner) MemberStatus ¶
func (c *ChatMemberOwner) MemberStatus() string
MemberStatus returns ChatMember status
func (*ChatMemberOwner) MemberUser ¶
func (c *ChatMemberOwner) MemberUser() User
MemberUser returns ChatMember User
type ChatMemberRestricted ¶
type ChatMemberRestricted struct { // Status - The member's status in the chat, always “restricted” Status string `json:"status"` // User - Information about the user User User `json:"user"` // IsMember - True, if the user is a member of the chat at the moment of the request IsMember bool `json:"is_member"` // CanChangeInfo - True, if the user is allowed to change the chat title, photo and other settings CanChangeInfo bool `json:"can_change_info"` // CanInviteUsers - True, if the user is allowed to invite new users to the chat CanInviteUsers bool `json:"can_invite_users"` // CanPinMessages - True, if the user is allowed to pin messages CanPinMessages bool `json:"can_pin_messages"` // CanSendMessages - True, if the user is allowed to send text messages, contacts, locations and venues CanSendMessages bool `json:"can_send_messages"` // CanSendMediaMessages - True, if the user is allowed to send audios, documents, photos, videos, video // notes and voice notes CanSendMediaMessages bool `json:"can_send_media_messages"` // CanSendPolls - True, if the user is allowed to send polls CanSendPolls bool `json:"can_send_polls"` // CanSendOtherMessages - True, if the user is allowed to send animations, games, stickers and use inline // bots CanSendOtherMessages bool `json:"can_send_other_messages"` // CanAddWebPagePreviews - True, if the user is allowed to add web page previews to their messages CanAddWebPagePreviews bool `json:"can_add_web_page_previews"` // UntilDate - Date when restrictions will be lifted for this user; unix time. If 0, then the user is // restricted forever UntilDate int64 `json:"until_date"` }
ChatMemberRestricted - Represents a chat member (https://core.telegram.org/bots/api#chatmember) that is under certain restrictions in the chat. Supergroups only.
func (*ChatMemberRestricted) MemberStatus ¶
func (c *ChatMemberRestricted) MemberStatus() string
MemberStatus returns ChatMember status
func (*ChatMemberRestricted) MemberUser ¶
func (c *ChatMemberRestricted) MemberUser() User
MemberUser returns ChatMember User
type ChatMemberUpdated ¶
type ChatMemberUpdated struct { // Chat - Chat the user belongs to Chat Chat `json:"chat"` // From - Performer of the action, which resulted in the change From User `json:"from"` // Date - Date the change was done in Unix time Date int64 `json:"date"` // OldChatMember - Previous information about the chat member OldChatMember ChatMember `json:"old_chat_member"` // NewChatMember - New information about the chat member NewChatMember ChatMember `json:"new_chat_member"` // InviteLink - 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"` }
ChatMemberUpdated - This object represents changes in the status of a chat member.
func (*ChatMemberUpdated) UnmarshalJSON ¶
func (c *ChatMemberUpdated) UnmarshalJSON(bytes []byte) error
UnmarshalJSON converts JSON to ChatMemberUpdated
type ChatPermissions ¶
type ChatPermissions struct { // CanSendMessages - Optional. True, if the user is allowed to send text messages, contacts, locations and // venues CanSendMessages bool `json:"can_send_messages,omitempty"` // CanSendMediaMessages - 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"` // CanSendPolls - Optional. True, if the user is allowed to send polls, implies can_send_messages CanSendPolls bool `json:"can_send_polls,omitempty"` // CanSendOtherMessages - 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"` // CanAddWebPagePreviews - 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"` // CanChangeInfo - 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"` // CanInviteUsers - Optional. True, if the user is allowed to invite new users to the chat CanInviteUsers bool `json:"can_invite_users,omitempty"` // CanPinMessages - Optional. True, if the user is allowed to pin messages. Ignored in public supergroups CanPinMessages bool `json:"can_pin_messages,omitempty"` }
ChatPermissions - Describes actions that a non-administrator user is allowed to take in a chat.
type ChatPhoto ¶
type ChatPhoto struct { // SmallFileID - 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"` // SmallFileUniqueID - 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"` // BigFileID - 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"` // BigFileUniqueID - 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"` }
ChatPhoto - This object represents a chat photo.
type ChosenInlineResult ¶
type ChosenInlineResult struct { // ResultID - The unique identifier for the result that was chosen ResultID string `json:"result_id"` // From - The user that chose the result From User `json:"from"` // Location - Optional. Sender location, only for bots that require user location Location *Location `json:"location,omitempty"` // InlineMessageID - Optional. Identifier of the sent inline message. Available only if there is an inline // keyboard (https://core.telegram.org/bots/api#inlinekeyboardmarkup) attached to the message. Will be also // received in callback queries (https://core.telegram.org/bots/api#callbackquery) and can be used to edit // (https://core.telegram.org/bots/api#updating-messages) the message. InlineMessageID string `json:"inline_message_id,omitempty"` // Query - The query that was used to obtain the result Query string `json:"query"` }
ChosenInlineResult - Represents a result (https://core.telegram.org/bots/api#inlinequeryresult) of an inline query that was chosen by the user and sent to their chat partner.
type Contact ¶
type Contact struct { // PhoneNumber - Contact's phone number PhoneNumber string `json:"phone_number"` // FirstName - Contact's first name FirstName string `json:"first_name"` // LastName - Optional. Contact's last name LastName string `json:"last_name,omitempty"` // UserID - Optional. Contact's user identifier in Telegram. This number may have more than 32 significant // bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most // 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. UserID int64 `json:"user_id,omitempty"` // Vcard - Optional. Additional data about the contact in the form of a vCard // (https://en.wikipedia.org/wiki/VCard) Vcard string `json:"vcard,omitempty"` }
Contact - This object represents a phone contact.
type CopyMessageParams ¶
type CopyMessageParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // FromChatID - Unique identifier for the chat where the original message was sent (or channel username in // the format @channelusername) FromChatID ChatID `json:"from_chat_id"` // MessageID - Message identifier in the chat specified in from_chat_id MessageID int `json:"message_id"` // Caption - Optional. New caption for media, 0-1024 characters after entities parsing. If not specified, the // original caption is kept Caption string `json:"caption,omitempty"` // ParseMode - Optional. Mode for parsing entities in the new caption. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities - 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"` // DisableNotification - Optional. Sends the message silently // (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. DisableNotification bool `json:"disable_notification,omitempty"` // ReplyToMessageID - Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // AllowSendingWithoutReply - 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"` // ReplyMarkup - Optional. Additional interface options. A JSON-serialized object for an inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating), custom reply keyboard // (https://core.telegram.org/bots#keyboards), instructions to remove reply keyboard or to force a reply from // the user. ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"` }
CopyMessageParams - Represents parameters of copyMessage method.
type CreateChatInviteLinkParams ¶
type CreateChatInviteLinkParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // ExpireDate - Optional. Point in time (Unix timestamp) when the link will expire ExpireDate int `json:"expire_date,omitempty"` // MemberLimit - 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"` }
CreateChatInviteLinkParams - Represents parameters of createChatInviteLink method.
type CreateNewStickerSetParams ¶
type CreateNewStickerSetParams struct { // UserID - User identifier of created sticker set owner UserID int64 `json:"user_id"` // Name - 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"` // Title - Sticker set title, 1-64 characters Title string `json:"title"` // PngSticker - 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 » // (https://core.telegram.org/bots/api#sending-files) PngSticker *InputFile `json:"png_sticker,omitempty"` // TgsSticker - Optional. TGS animation with the sticker, uploaded using multipart/form-data. See // https://core.telegram.org/animated_stickers#technical-requirements // (https://core.telegram.org/animated_stickers#technical-requirements) for technical requirements TgsSticker *InputFile `json:"tgs_sticker,omitempty"` // Emojis - One or more emoji corresponding to the sticker Emojis string `json:"emojis"` // ContainsMasks - Optional. Pass True, if a set of mask stickers should be created ContainsMasks bool `json:"contains_masks,omitempty"` // MaskPosition - Optional. A JSON-serialized object for position where the mask should be placed on faces MaskPosition *MaskPosition `json:"mask_position,omitempty"` }
CreateNewStickerSetParams - Represents parameters of createNewStickerSet method.
type DeleteChatPhotoParams ¶
type DeleteChatPhotoParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` }
DeleteChatPhotoParams - Represents parameters of deleteChatPhoto method.
type DeleteChatStickerSetParams ¶
type DeleteChatStickerSetParams struct { // ChatID - Unique identifier for the target chat or username of the target supergroup (in the format // @supergroupusername) ChatID ChatID `json:"chat_id"` }
DeleteChatStickerSetParams - Represents parameters of deleteChatStickerSet method.
type DeleteMessageParams ¶
type DeleteMessageParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // MessageID - Identifier of the message to delete MessageID int `json:"message_id"` }
DeleteMessageParams - Represents parameters of deleteMessage method.
type DeleteMyCommandsParams ¶
type DeleteMyCommandsParams struct { // Scope - Optional. A JSON-serialized object, describing scope of users for which the commands are relevant. // Defaults to BotCommandScopeDefault (https://core.telegram.org/bots/api#botcommandscopedefault). Scope BotCommandScope `json:"scope,omitempty"` // LanguageCode - Optional. A two-letter ISO 639-1 language code. If empty, commands will be applied to all // users from the given scope, for whose language there are no dedicated commands LanguageCode string `json:"language_code,omitempty"` }
DeleteMyCommandsParams - Represents parameters of deleteMyCommands method.
type DeleteStickerFromSetParams ¶
type DeleteStickerFromSetParams struct { // Sticker - File identifier of the sticker Sticker string `json:"sticker"` }
DeleteStickerFromSetParams - Represents parameters of deleteStickerFromSet method.
type DeleteWebhookParams ¶
type DeleteWebhookParams struct { // DropPendingUpdates - Optional. Pass True to drop all pending updates DropPendingUpdates bool `json:"drop_pending_updates,omitempty"` }
DeleteWebhookParams - Represents parameters of deleteWebhook method.
type Dice ¶
type Dice struct { // Emoji - Emoji on which the dice throw animation is based Emoji string `json:"emoji"` // Value - 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"` }
Dice - This object represents an animated emoji that displays a random value.
type Document ¶
type Document struct { // FileID - Identifier for this file, which can be used to download or reuse the file FileID string `json:"file_id"` // FileUniqueID - 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"` // Thumb - Optional. Document thumbnail as defined by sender Thumb *PhotoSize `json:"thumb,omitempty"` // FileName - Optional. Original filename as defined by sender FileName string `json:"file_name,omitempty"` // MimeType - Optional. MIME type of the file as defined by sender MimeType string `json:"mime_type,omitempty"` // FileSize - Optional. File size FileSize int `json:"file_size,omitempty"` }
Document - This object represents a general file (as opposed to photos (https://core.telegram.org/bots/api#photosize), voice messages (https://core.telegram.org/bots/api#voice) and audio files (https://core.telegram.org/bots/api#audio)).
type EditChatInviteLinkParams ¶
type EditChatInviteLinkParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // InviteLink - The invite link to edit InviteLink string `json:"invite_link"` // ExpireDate - Optional. Point in time (Unix timestamp) when the link will expire ExpireDate int `json:"expire_date,omitempty"` // MemberLimit - 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"` }
EditChatInviteLinkParams - Represents parameters of editChatInviteLink method.
type EditMessageCaptionParams ¶
type EditMessageCaptionParams struct { // ChatID - 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 ChatID `json:"chat_id,omitempty"` // MessageID - Optional. Required if inline_message_id is not specified. Identifier of the message to edit MessageID int `json:"message_id,omitempty"` // InlineMessageID - Optional. Required if chat_id and message_id are not specified. Identifier of the inline // message InlineMessageID string `json:"inline_message_id,omitempty"` // Caption - Optional. New caption of the message, 0-1024 characters after entities parsing Caption string `json:"caption,omitempty"` // ParseMode - Optional. Mode for parsing entities in the message caption. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities - Optional. List of special entities that appear in the caption, which can be specified // instead of parse_mode CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // ReplyMarkup - Optional. A JSON-serialized object for an inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating). ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` }
EditMessageCaptionParams - Represents parameters of editMessageCaption method.
type EditMessageLiveLocationParams ¶
type EditMessageLiveLocationParams struct { // ChatID - 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 ChatID `json:"chat_id,omitempty"` // MessageID - Optional. Required if inline_message_id is not specified. Identifier of the message to edit MessageID int `json:"message_id,omitempty"` // InlineMessageID - Optional. Required if chat_id and message_id are not specified. Identifier of the inline // message InlineMessageID string `json:"inline_message_id,omitempty"` // Latitude - Latitude of new location Latitude float64 `json:"latitude"` // Longitude - Longitude of new location Longitude float64 `json:"longitude"` // HorizontalAccuracy - Optional. The radius of uncertainty for the location, measured in meters; 0-1500 HorizontalAccuracy float64 `json:"horizontal_accuracy,omitempty"` // Heading - Optional. Direction in which the user is moving, in degrees. Must be between 1 and 360 if // specified. Heading int `json:"heading,omitempty"` // ProximityAlertRadius - 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"` // ReplyMarkup - Optional. A JSON-serialized object for a new inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating). ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` }
EditMessageLiveLocationParams - Represents parameters of editMessageLiveLocation method.
type EditMessageMediaParams ¶
type EditMessageMediaParams struct { // ChatID - 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 ChatID `json:"chat_id,omitempty"` // MessageID - Optional. Required if inline_message_id is not specified. Identifier of the message to edit MessageID int `json:"message_id,omitempty"` // InlineMessageID - Optional. Required if chat_id and message_id are not specified. Identifier of the inline // message InlineMessageID string `json:"inline_message_id,omitempty"` // Media - A JSON-serialized object for a new media content of the message Media InputMedia `json:"media"` // ReplyMarkup - Optional. A JSON-serialized object for a new inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating). ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` }
EditMessageMediaParams - Represents parameters of editMessageMedia method.
type EditMessageReplyMarkupParams ¶
type EditMessageReplyMarkupParams struct { // ChatID - 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 ChatID `json:"chat_id,omitempty"` // MessageID - Optional. Required if inline_message_id is not specified. Identifier of the message to edit MessageID int `json:"message_id,omitempty"` // InlineMessageID - Optional. Required if chat_id and message_id are not specified. Identifier of the inline // message InlineMessageID string `json:"inline_message_id,omitempty"` // ReplyMarkup - Optional. A JSON-serialized object for an inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating). ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` }
EditMessageReplyMarkupParams - Represents parameters of editMessageReplyMarkup method.
type EditMessageTextParams ¶
type EditMessageTextParams struct { // ChatID - 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 ChatID `json:"chat_id,omitempty"` // MessageID - Optional. Required if inline_message_id is not specified. Identifier of the message to edit MessageID int `json:"message_id,omitempty"` // InlineMessageID - Optional. Required if chat_id and message_id are not specified. Identifier of the inline // message InlineMessageID string `json:"inline_message_id,omitempty"` // Text - New text of the message, 1-4096 characters after entities parsing Text string `json:"text"` // ParseMode - Optional. Mode for parsing entities in the message text. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // Entities - Optional. List of special entities that appear in message text, which can be specified instead // of parse_mode Entities []MessageEntity `json:"entities,omitempty"` // DisableWebPagePreview - Optional. Disables link previews for links in this message DisableWebPagePreview bool `json:"disable_web_page_preview,omitempty"` // ReplyMarkup - Optional. A JSON-serialized object for an inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating). ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` }
EditMessageTextParams - Represents parameters of editMessageText method.
type EncryptedCredentials ¶
type EncryptedCredentials struct { // Data - Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets // required for EncryptedPassportElement (https://core.telegram.org/bots/api#encryptedpassportelement) // decryption and authentication Data string `json:"data"` // Hash - Base64-encoded data hash for data authentication Hash string `json:"hash"` // Secret - Base64-encoded secret, encrypted with the bot's public RSA key, required for data decryption Secret string `json:"secret"` }
EncryptedCredentials - Contains data required for decrypting and authenticating EncryptedPassportElement (https://core.telegram.org/bots/api#encryptedpassportelement). See the Telegram Passport Documentation (https://core.telegram.org/passport#receiving-information) for a complete description of the data decryption and authentication processes.
type EncryptedPassportElement ¶
type EncryptedPassportElement struct { // Type - 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"` // Data - 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 (https://core.telegram.org/bots/api#encryptedcredentials). Data string `json:"data,omitempty"` // PhoneNumber - Optional. User's verified phone number, available only for “phone_number” type PhoneNumber string `json:"phone_number,omitempty"` // Email - Optional. User's verified email address, available only for “email” type Email string `json:"email,omitempty"` // Files - 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 (https://core.telegram.org/bots/api#encryptedcredentials). Files []PassportFile `json:"files,omitempty"` // FrontSide - 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 // (https://core.telegram.org/bots/api#encryptedcredentials). FrontSide *PassportFile `json:"front_side,omitempty"` // ReverseSide - 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 (https://core.telegram.org/bots/api#encryptedcredentials). ReverseSide *PassportFile `json:"reverse_side,omitempty"` // Selfie - 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 // (https://core.telegram.org/bots/api#encryptedcredentials). Selfie *PassportFile `json:"selfie,omitempty"` // Translation - 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 (https://core.telegram.org/bots/api#encryptedcredentials). Translation []PassportFile `json:"translation,omitempty"` // Hash - Base64-encoded element hash for using in PassportElementErrorUnspecified // (https://core.telegram.org/bots/api#passportelementerrorunspecified) Hash string `json:"hash"` }
EncryptedPassportElement - Contains information about documents or other Telegram Passport elements shared with the bot by the user.
type ExportChatInviteLinkParams ¶
type ExportChatInviteLinkParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` }
ExportChatInviteLinkParams - Represents parameters of exportChatInviteLink method.
type File ¶
type File struct { // FileID - Identifier for this file, which can be used to download or reuse the file FileID string `json:"file_id"` // FileUniqueID - 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"` // FileSize - Optional. File size, if known FileSize int `json:"file_size,omitempty"` // FilePath - Optional. File path. Use https://api.telegram.org/file/bot<token>/<file_path> to get the file. FilePath string `json:"file_path,omitempty"` }
File - This object represents a file ready to be downloaded. The file can be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile (https://core.telegram.org/bots/api#getfile).
type ForceReply ¶
type ForceReply struct { // ForceReply - Shows reply interface to the user, as if they manually selected the bot's message and tapped // 'Reply' ForceReply bool `json:"force_reply"` // InputFieldPlaceholder - Optional. The placeholder to be shown in the input field when the reply is // active; 1-64 characters InputFieldPlaceholder string `json:"input_field_placeholder,omitempty"` // Selective - 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 (https://core.telegram.org/bots/api#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"` }
ForceReply - Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode (https://core.telegram.org/bots#privacy-mode). Example: https://core.telegram.org/bots/api#forcereply
func (*ForceReply) ReplyType ¶
func (i *ForceReply) ReplyType() string
ReplyType - Returns ForceReply type
type ForwardMessageParams ¶
type ForwardMessageParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // FromChatID - Unique identifier for the chat where the original message was sent (or channel username in // the format @channelusername) FromChatID ChatID `json:"from_chat_id"` // DisableNotification - Optional. Sends the message silently // (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. DisableNotification bool `json:"disable_notification,omitempty"` // MessageID - Message identifier in the chat specified in from_chat_id MessageID int `json:"message_id"` }
ForwardMessageParams - Represents parameters of forwardMessage method.
type Game ¶
type Game struct { // Title - Title of the game Title string `json:"title"` // Description - Description of the game Description string `json:"description"` // Photo - Photo that will be displayed in the game message in chats. Photo []PhotoSize `json:"photo"` // Text - 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 // (https://core.telegram.org/bots/api#setgamescore), or manually edited using editMessageText // (https://core.telegram.org/bots/api#editmessagetext). 0-4096 characters. Text string `json:"text,omitempty"` // TextEntities - Optional. Special entities that appear in text, such as usernames, URLs, bot commands, // etc. TextEntities []MessageEntity `json:"text_entities,omitempty"` // Animation - Optional. Animation that will be displayed in the game message in chats. Upload via BotFather // (https://t.me/botfather) Animation *Animation `json:"animation,omitempty"` }
Game - 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 - Position in high score table for the game Position int `json:"position"` // User - User User User `json:"user"` // Score - Score Score int `json:"score"` }
GameHighScore - This object represents one row of the high scores table for a game.
type GetChatAdministratorsParams ¶
type GetChatAdministratorsParams struct { // ChatID - Unique identifier for the target chat or username of the target supergroup or channel (in the // format @channelusername) ChatID ChatID `json:"chat_id"` }
GetChatAdministratorsParams - Represents parameters of getChatAdministrators method.
type GetChatMemberCountParams ¶
type GetChatMemberCountParams struct { // ChatID - Unique identifier for the target chat or username of the target supergroup or channel (in the // format @channelusername) ChatID ChatID `json:"chat_id"` }
GetChatMemberCountParams - Represents parameters of getChatMemberCount method.
type GetChatMemberParams ¶
type GetChatMemberParams struct { // ChatID - Unique identifier for the target chat or username of the target supergroup or channel (in the // format @channelusername) ChatID ChatID `json:"chat_id"` // UserID - Unique identifier of the target user UserID int64 `json:"user_id"` }
GetChatMemberParams - Represents parameters of getChatMember method.
type GetChatParams ¶
type GetChatParams struct { // ChatID - Unique identifier for the target chat or username of the target supergroup or channel (in the // format @channelusername) ChatID ChatID `json:"chat_id"` }
GetChatParams - Represents parameters of getChat method.
type GetFileParams ¶
type GetFileParams struct { // FileID - File identifier to get info about FileID string `json:"file_id"` }
GetFileParams - Represents parameters of getFile method.
type GetGameHighScoresParams ¶
type GetGameHighScoresParams struct { // UserID - Target user ID UserID int64 `json:"user_id"` // ChatID - Optional. Required if inline_message_id is not specified. Unique identifier for the target chat ChatID int64 `json:"chat_id,omitempty"` // MessageID - Optional. Required if inline_message_id is not specified. Identifier of the sent message MessageID int `json:"message_id,omitempty"` // InlineMessageID - Optional. Required if chat_id and message_id are not specified. Identifier of the inline // message InlineMessageID string `json:"inline_message_id,omitempty"` }
GetGameHighScoresParams - Represents parameters of getGameHighScores method.
type GetMyCommandsParams ¶
type GetMyCommandsParams struct { // Scope - Optional. A JSON-serialized object, describing scope of users. Defaults to BotCommandScopeDefault // (https://core.telegram.org/bots/api#botcommandscopedefault). Scope BotCommandScope `json:"scope,omitempty"` // LanguageCode - Optional. A two-letter ISO 639-1 language code or an empty string LanguageCode string `json:"language_code,omitempty"` }
GetMyCommandsParams - Represents parameters of getMyCommands method.
type GetStickerSetParams ¶
type GetStickerSetParams struct { // Name - Name of the sticker set Name string `json:"name"` }
GetStickerSetParams - Represents parameters of getStickerSet method.
type GetUpdatesParams ¶
type GetUpdatesParams struct { // Offset - 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 // (https://core.telegram.org/bots/api#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"` // Limit - Optional. Limits the number of updates to be retrieved. Values between 1-100 are accepted. // Defaults to 100. Limit int `json:"limit,omitempty"` // Timeout - 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"` // AllowedUpdates - 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 (https://core.telegram.org/bots/api#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"` }
GetUpdatesParams - Represents parameters of getUpdates method.
type GetUserProfilePhotosParams ¶
type GetUserProfilePhotosParams struct { // UserID - Unique identifier of the target user UserID int64 `json:"user_id"` // Offset - Optional. Sequential number of the first photo to be returned. By default, all photos are // returned. Offset int `json:"offset,omitempty"` // Limit - Optional. Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults // to 100. Limit int `json:"limit,omitempty"` }
GetUserProfilePhotosParams - Represents parameters of getUserProfilePhotos method.
type InlineKeyboardButton ¶
type InlineKeyboardButton struct { // Text - Label text on the button Text string `json:"text"` // URL - Optional. HTTP or tg:// URL to be opened when button is pressed URL string `json:"url,omitempty"` // LoginURL - Optional. An HTTP URL used to automatically authorize the user. Can be used as a replacement // for the Telegram Login Widget (https://core.telegram.org/widgets/login). LoginURL *LoginURL `json:"login_url,omitempty"` // CallbackData - Optional. Data to be sent in a callback query // (https://core.telegram.org/bots/api#callbackquery) to the bot when button is pressed, 1-64 bytes CallbackData string `json:"callback_data,omitempty"` // SwitchInlineQuery - 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 (https://core.telegram.org/bots/inline) when they are currently in a // private chat with it. Especially useful when combined with switch_pm… // (https://core.telegram.org/bots/api#answerinlinequery) 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"` // SwitchInlineQueryCurrentChat - 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"` // CallbackGame - 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"` // Pay - Optional. Specify True, to send a Pay button (https://core.telegram.org/bots/api#payments).NOTE: // This type of button must always be the first button in the first row. Pay bool `json:"pay,omitempty"` }
InlineKeyboardButton - This object represents one button of an inline keyboard. You must use exactly one of the optional fields.
type InlineKeyboardMarkup ¶
type InlineKeyboardMarkup struct { // InlineKeyboard - Array of button rows, each represented by an Array of InlineKeyboardButton // (https://core.telegram.org/bots/api#inlinekeyboardbutton) objects InlineKeyboard [][]InlineKeyboardButton `json:"inline_keyboard"` }
InlineKeyboardMarkup - This object represents an inline keyboard (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating) that appears right next to the message it belongs to.
func (*InlineKeyboardMarkup) ReplyType ¶
func (i *InlineKeyboardMarkup) ReplyType() string
ReplyType - Returns InlineKeyboardMarkup type
type InlineQuery ¶
type InlineQuery struct { // ID - Unique identifier for this query ID string `json:"id"` // From - Sender From User `json:"from"` // Query - Text of the query (up to 256 characters) Query string `json:"query"` // Offset - Offset of the results to be returned, can be controlled by the bot Offset string `json:"offset"` // ChatType - 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"` // Location - Optional. Sender location, only for bots that request user location Location *Location `json:"location,omitempty"` }
InlineQuery - This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.
type InlineQueryResult ¶
type InlineQueryResult interface {
ResultType() string
}
InlineQueryResult - 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 - Type of the result, must be article Type string `json:"type"` // ID - Unique identifier for this result, 1-64 Bytes ID string `json:"id"` // Title - Title of the result Title string `json:"title"` // InputMessageContent - Content of the message to be sent InputMessageContent InputMessageContent `json:"input_message_content"` // ReplyMarkup - Optional. Inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating) attached to the message ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // URL - Optional. URL of the result URL string `json:"url,omitempty"` // HideURL - Optional. Pass True, if you don't want the URL to be shown in the message HideURL bool `json:"hide_url,omitempty"` // Description - Optional. Short description of the result Description string `json:"description,omitempty"` // ThumbURL - Optional. URL of the thumbnail for the result ThumbURL string `json:"thumb_url,omitempty"` // ThumbWidth - Optional. Thumbnail width ThumbWidth int `json:"thumb_width,omitempty"` // ThumbHeight - Optional. Thumbnail height ThumbHeight int `json:"thumb_height,omitempty"` }
InlineQueryResultArticle - Represents a link to an article or web page.
func (*InlineQueryResultArticle) ResultType ¶
func (i *InlineQueryResultArticle) ResultType() string
ResultType returns InlineQueryResult type
type InlineQueryResultAudio ¶
type InlineQueryResultAudio struct { // Type - Type of the result, must be audio Type string `json:"type"` // ID - Unique identifier for this result, 1-64 bytes ID string `json:"id"` // AudioURL - A valid URL for the audio file AudioURL string `json:"audio_url"` // Title - Title Title string `json:"title"` // Caption - Optional. Caption, 0-1024 characters after entities parsing Caption string `json:"caption,omitempty"` // ParseMode - Optional. Mode for parsing entities in the audio caption. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities - Optional. List of special entities that appear in the caption, which can be specified // instead of parse_mode CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // Performer - Optional. Performer Performer string `json:"performer,omitempty"` // AudioDuration - Optional. Audio duration in seconds AudioDuration int `json:"audio_duration,omitempty"` // ReplyMarkup - Optional. Inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating) attached to the message ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent - Optional. Content of the message to be sent instead of the audio InputMessageContent InputMessageContent `json:"input_message_content,omitempty"` }
InlineQueryResultAudio - Represents a link to an MP3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.
func (*InlineQueryResultAudio) ResultType ¶
func (i *InlineQueryResultAudio) ResultType() string
ResultType returns InlineQueryResult type
type InlineQueryResultCachedAudio ¶
type InlineQueryResultCachedAudio struct { // Type - Type of the result, must be audio Type string `json:"type"` // ID - Unique identifier for this result, 1-64 bytes ID string `json:"id"` // AudioFileID - A valid file identifier for the audio file AudioFileID string `json:"audio_file_id"` // Caption - Optional. Caption, 0-1024 characters after entities parsing Caption string `json:"caption,omitempty"` // ParseMode - Optional. Mode for parsing entities in the audio caption. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities - Optional. List of special entities that appear in the caption, which can be specified // instead of parse_mode CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // ReplyMarkup - Optional. Inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating) attached to the message ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent - Optional. Content of the message to be sent instead of the audio InputMessageContent InputMessageContent `json:"input_message_content,omitempty"` }
InlineQueryResultCachedAudio - Represents a link to an MP3 audio file stored on the Telegram servers. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.
func (*InlineQueryResultCachedAudio) ResultType ¶
func (i *InlineQueryResultCachedAudio) ResultType() string
ResultType returns InlineQueryResult type
type InlineQueryResultCachedDocument ¶
type InlineQueryResultCachedDocument struct { // Type - Type of the result, must be document Type string `json:"type"` // ID - Unique identifier for this result, 1-64 bytes ID string `json:"id"` // Title - Title for the result Title string `json:"title"` // DocumentFileID - A valid file identifier for the file DocumentFileID string `json:"document_file_id"` // Description - Optional. Short description of the result Description string `json:"description,omitempty"` // Caption - Optional. Caption of the document to be sent, 0-1024 characters after entities parsing Caption string `json:"caption,omitempty"` // ParseMode - Optional. Mode for parsing entities in the document caption. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities - Optional. List of special entities that appear in the caption, which can be specified // instead of parse_mode CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // ReplyMarkup - Optional. Inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating) attached to the message ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent - Optional. Content of the message to be sent instead of the file InputMessageContent InputMessageContent `json:"input_message_content,omitempty"` }
InlineQueryResultCachedDocument - Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file.
func (*InlineQueryResultCachedDocument) ResultType ¶
func (i *InlineQueryResultCachedDocument) ResultType() string
ResultType returns InlineQueryResult type
type InlineQueryResultCachedGif ¶
type InlineQueryResultCachedGif struct { // Type - Type of the result, must be gif Type string `json:"type"` // ID - Unique identifier for this result, 1-64 bytes ID string `json:"id"` // GifFileID - A valid file identifier for the GIF file GifFileID string `json:"gif_file_id"` // Title - Optional. Title for the result Title string `json:"title,omitempty"` // Caption - Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing Caption string `json:"caption,omitempty"` // ParseMode - Optional. Mode for parsing entities in the caption. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities - Optional. List of special entities that appear in the caption, which can be specified // instead of parse_mode CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // ReplyMarkup - Optional. Inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating) attached to the message ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent - Optional. Content of the message to be sent instead of the GIF animation InputMessageContent InputMessageContent `json:"input_message_content,omitempty"` }
InlineQueryResultCachedGif - Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with specified content instead of the animation.
func (*InlineQueryResultCachedGif) ResultType ¶
func (i *InlineQueryResultCachedGif) ResultType() string
ResultType returns InlineQueryResult type
type InlineQueryResultCachedMpeg4Gif ¶
type InlineQueryResultCachedMpeg4Gif struct { // Type - Type of the result, must be mpeg4_gif Type string `json:"type"` // ID - Unique identifier for this result, 1-64 bytes ID string `json:"id"` // Mpeg4FileID - A valid file identifier for the MP4 file Mpeg4FileID string `json:"mpeg4_file_id"` // Title - Optional. Title for the result Title string `json:"title,omitempty"` // Caption - Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing Caption string `json:"caption,omitempty"` // ParseMode - Optional. Mode for parsing entities in the caption. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities - Optional. List of special entities that appear in the caption, which can be specified // instead of parse_mode CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // ReplyMarkup - Optional. Inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating) attached to the message ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent - Optional. Content of the message to be sent instead of the video animation InputMessageContent InputMessageContent `json:"input_message_content,omitempty"` }
InlineQueryResultCachedMpeg4Gif - Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By default, this animated MPEG-4 file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.
func (*InlineQueryResultCachedMpeg4Gif) ResultType ¶
func (i *InlineQueryResultCachedMpeg4Gif) ResultType() string
ResultType returns InlineQueryResult type
type InlineQueryResultCachedPhoto ¶
type InlineQueryResultCachedPhoto struct { // Type - Type of the result, must be photo Type string `json:"type"` // ID - Unique identifier for this result, 1-64 bytes ID string `json:"id"` // PhotoFileID - A valid file identifier of the photo PhotoFileID string `json:"photo_file_id"` // Title - Optional. Title for the result Title string `json:"title,omitempty"` // Description - Optional. Short description of the result Description string `json:"description,omitempty"` // Caption - Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing Caption string `json:"caption,omitempty"` // ParseMode - Optional. Mode for parsing entities in the photo caption. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities - Optional. List of special entities that appear in the caption, which can be specified // instead of parse_mode CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // ReplyMarkup - Optional. Inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating) attached to the message ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent - Optional. Content of the message to be sent instead of the photo InputMessageContent InputMessageContent `json:"input_message_content,omitempty"` }
InlineQueryResultCachedPhoto - Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.
func (*InlineQueryResultCachedPhoto) ResultType ¶
func (i *InlineQueryResultCachedPhoto) ResultType() string
ResultType returns InlineQueryResult type
type InlineQueryResultCachedSticker ¶
type InlineQueryResultCachedSticker struct { // Type - Type of the result, must be sticker Type string `json:"type"` // ID - Unique identifier for this result, 1-64 bytes ID string `json:"id"` // StickerFileID - A valid file identifier of the sticker StickerFileID string `json:"sticker_file_id"` // ReplyMarkup - Optional. Inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating) attached to the message ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent - Optional. Content of the message to be sent instead of the sticker InputMessageContent InputMessageContent `json:"input_message_content,omitempty"` }
InlineQueryResultCachedSticker - Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the sticker.
func (*InlineQueryResultCachedSticker) ResultType ¶
func (i *InlineQueryResultCachedSticker) ResultType() string
ResultType returns InlineQueryResult type
type InlineQueryResultCachedVideo ¶
type InlineQueryResultCachedVideo struct { // Type - Type of the result, must be video Type string `json:"type"` // ID - Unique identifier for this result, 1-64 bytes ID string `json:"id"` // VideoFileID - A valid file identifier for the video file VideoFileID string `json:"video_file_id"` // Title - Title for the result Title string `json:"title"` // Description - Optional. Short description of the result Description string `json:"description,omitempty"` // Caption - Optional. Caption of the video to be sent, 0-1024 characters after entities parsing Caption string `json:"caption,omitempty"` // ParseMode - Optional. Mode for parsing entities in the video caption. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities - Optional. List of special entities that appear in the caption, which can be specified // instead of parse_mode CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // ReplyMarkup - Optional. Inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating) attached to the message ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent - Optional. Content of the message to be sent instead of the video InputMessageContent InputMessageContent `json:"input_message_content,omitempty"` }
InlineQueryResultCachedVideo - Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.
func (*InlineQueryResultCachedVideo) ResultType ¶
func (i *InlineQueryResultCachedVideo) ResultType() string
ResultType returns InlineQueryResult type
type InlineQueryResultCachedVoice ¶
type InlineQueryResultCachedVoice struct { // Type - Type of the result, must be voice Type string `json:"type"` // ID - Unique identifier for this result, 1-64 bytes ID string `json:"id"` // VoiceFileID - A valid file identifier for the voice message VoiceFileID string `json:"voice_file_id"` // Title - Voice message title Title string `json:"title"` // Caption - Optional. Caption, 0-1024 characters after entities parsing Caption string `json:"caption,omitempty"` // ParseMode - Optional. Mode for parsing entities in the voice message caption. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities - Optional. List of special entities that appear in the caption, which can be specified // instead of parse_mode CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // ReplyMarkup - Optional. Inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating) attached to the message ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent - Optional. Content of the message to be sent instead of the voice message InputMessageContent InputMessageContent `json:"input_message_content,omitempty"` }
InlineQueryResultCachedVoice - Represents a link to a voice message stored on the Telegram servers. By default, this voice message will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the voice message.
func (*InlineQueryResultCachedVoice) ResultType ¶
func (i *InlineQueryResultCachedVoice) ResultType() string
ResultType returns InlineQueryResult type
type InlineQueryResultContact ¶
type InlineQueryResultContact struct { // Type - Type of the result, must be contact Type string `json:"type"` // ID - Unique identifier for this result, 1-64 Bytes ID string `json:"id"` // PhoneNumber - Contact's phone number PhoneNumber string `json:"phone_number"` // FirstName - Contact's first name FirstName string `json:"first_name"` // LastName - Optional. Contact's last name LastName string `json:"last_name,omitempty"` // Vcard - Optional. Additional data about the contact in the form of a vCard // (https://en.wikipedia.org/wiki/VCard), 0-2048 bytes Vcard string `json:"vcard,omitempty"` // ReplyMarkup - Optional. Inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating) attached to the message ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent - Optional. Content of the message to be sent instead of the contact InputMessageContent InputMessageContent `json:"input_message_content,omitempty"` // ThumbURL - Optional. URL of the thumbnail for the result ThumbURL string `json:"thumb_url,omitempty"` // ThumbWidth - Optional. Thumbnail width ThumbWidth int `json:"thumb_width,omitempty"` // ThumbHeight - Optional. Thumbnail height ThumbHeight int `json:"thumb_height,omitempty"` }
InlineQueryResultContact - Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the contact.
func (*InlineQueryResultContact) ResultType ¶
func (i *InlineQueryResultContact) ResultType() string
ResultType returns InlineQueryResult type
type InlineQueryResultDocument ¶
type InlineQueryResultDocument struct { // Type - Type of the result, must be document Type string `json:"type"` // ID - Unique identifier for this result, 1-64 bytes ID string `json:"id"` // Title - Title for the result Title string `json:"title"` // Caption - Optional. Caption of the document to be sent, 0-1024 characters after entities parsing Caption string `json:"caption,omitempty"` // ParseMode - Optional. Mode for parsing entities in the document caption. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities - Optional. List of special entities that appear in the caption, which can be specified // instead of parse_mode CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // DocumentURL - A valid URL for the file DocumentURL string `json:"document_url"` // MimeType - Mime type of the content of the file, either “application/pdf” or “application/zip” MimeType string `json:"mime_type"` // Description - Optional. Short description of the result Description string `json:"description,omitempty"` // ReplyMarkup - Optional. Inline keyboard attached to the message ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent - Optional. Content of the message to be sent instead of the file InputMessageContent InputMessageContent `json:"input_message_content,omitempty"` // ThumbURL - Optional. URL of the thumbnail (jpeg only) for the file ThumbURL string `json:"thumb_url,omitempty"` // ThumbWidth - Optional. Thumbnail width ThumbWidth int `json:"thumb_width,omitempty"` // ThumbHeight - Optional. Thumbnail height ThumbHeight int `json:"thumb_height,omitempty"` }
InlineQueryResultDocument - Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file. Currently, only .PDF and .ZIP files can be sent using this method.
func (*InlineQueryResultDocument) ResultType ¶
func (i *InlineQueryResultDocument) ResultType() string
ResultType returns InlineQueryResult type
type InlineQueryResultGame ¶
type InlineQueryResultGame struct { // Type - Type of the result, must be game Type string `json:"type"` // ID - Unique identifier for this result, 1-64 bytes ID string `json:"id"` // GameShortName - Short name of the game GameShortName string `json:"game_short_name"` // ReplyMarkup - Optional. Inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating) attached to the message ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` }
InlineQueryResultGame - Represents a Game (https://core.telegram.org/bots/api#games).
func (*InlineQueryResultGame) ResultType ¶
func (i *InlineQueryResultGame) ResultType() string
ResultType returns InlineQueryResult type
type InlineQueryResultGif ¶
type InlineQueryResultGif struct { // Type - Type of the result, must be gif Type string `json:"type"` // ID - Unique identifier for this result, 1-64 bytes ID string `json:"id"` // GifURL - A valid URL for the GIF file. File size must not exceed 1MB GifURL string `json:"gif_url"` // GifWidth - Optional. Width of the GIF GifWidth int `json:"gif_width,omitempty"` // GifHeight - Optional. Height of the GIF GifHeight int `json:"gif_height,omitempty"` // GifDuration - Optional. Duration of the GIF GifDuration int `json:"gif_duration,omitempty"` // ThumbURL - URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result ThumbURL string `json:"thumb_url"` // ThumbMimeType - 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"` // Title - Optional. Title for the result Title string `json:"title,omitempty"` // Caption - Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing Caption string `json:"caption,omitempty"` // ParseMode - Optional. Mode for parsing entities in the caption. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities - Optional. List of special entities that appear in the caption, which can be specified // instead of parse_mode CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // ReplyMarkup - Optional. Inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating) attached to the message ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent - Optional. Content of the message to be sent instead of the GIF animation InputMessageContent InputMessageContent `json:"input_message_content,omitempty"` }
InlineQueryResultGif - Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.
func (*InlineQueryResultGif) ResultType ¶
func (i *InlineQueryResultGif) ResultType() string
ResultType returns InlineQueryResult type
type InlineQueryResultLocation ¶
type InlineQueryResultLocation struct { // Type - Type of the result, must be location Type string `json:"type"` // ID - Unique identifier for this result, 1-64 Bytes ID string `json:"id"` // Latitude - Location latitude in degrees Latitude float64 `json:"latitude"` // Longitude - Location longitude in degrees Longitude float64 `json:"longitude"` // Title - Location title Title string `json:"title"` // HorizontalAccuracy - Optional. The radius of uncertainty for the location, measured in meters; 0-1500 HorizontalAccuracy float64 `json:"horizontal_accuracy,omitempty"` // LivePeriod - Optional. Period in seconds for which the location can be updated, should be between 60 and // 86400. LivePeriod int `json:"live_period,omitempty"` // Heading - 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"` // ProximityAlertRadius - 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"` // ReplyMarkup - Optional. Inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating) attached to the message ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent - Optional. Content of the message to be sent instead of the location InputMessageContent InputMessageContent `json:"input_message_content,omitempty"` // ThumbURL - Optional. URL of the thumbnail for the result ThumbURL string `json:"thumb_url,omitempty"` // ThumbWidth - Optional. Thumbnail width ThumbWidth int `json:"thumb_width,omitempty"` // ThumbHeight - Optional. Thumbnail height ThumbHeight int `json:"thumb_height,omitempty"` }
InlineQueryResultLocation - Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the location.
func (*InlineQueryResultLocation) ResultType ¶
func (i *InlineQueryResultLocation) ResultType() string
ResultType returns InlineQueryResult type
type InlineQueryResultMpeg4Gif ¶
type InlineQueryResultMpeg4Gif struct { // Type - Type of the result, must be mpeg4_gif Type string `json:"type"` // ID - Unique identifier for this result, 1-64 bytes ID string `json:"id"` // Mpeg4URL - A valid URL for the MP4 file. File size must not exceed 1MB Mpeg4URL string `json:"mpeg4_url"` // Mpeg4Width - Optional. Video width Mpeg4Width int `json:"mpeg4_width,omitempty"` // Mpeg4Height - Optional. Video height Mpeg4Height int `json:"mpeg4_height,omitempty"` // Mpeg4Duration - Optional. Video duration Mpeg4Duration int `json:"mpeg4_duration,omitempty"` // ThumbURL - URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result ThumbURL string `json:"thumb_url"` // ThumbMimeType - 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"` // Title - Optional. Title for the result Title string `json:"title,omitempty"` // Caption - Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing Caption string `json:"caption,omitempty"` // ParseMode - Optional. Mode for parsing entities in the caption. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities - Optional. List of special entities that appear in the caption, which can be specified // instead of parse_mode CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // ReplyMarkup - Optional. Inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating) attached to the message ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent - Optional. Content of the message to be sent instead of the video animation InputMessageContent InputMessageContent `json:"input_message_content,omitempty"` }
InlineQueryResultMpeg4Gif - Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this animated MPEG-4 file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.
func (*InlineQueryResultMpeg4Gif) ResultType ¶
func (i *InlineQueryResultMpeg4Gif) ResultType() string
ResultType returns InlineQueryResult type
type InlineQueryResultPhoto ¶
type InlineQueryResultPhoto struct { // Type - Type of the result, must be photo Type string `json:"type"` // ID - Unique identifier for this result, 1-64 bytes ID string `json:"id"` // PhotoURL - A valid URL of the photo. Photo must be in jpeg format. Photo size must not exceed 5MB PhotoURL string `json:"photo_url"` // ThumbURL - URL of the thumbnail for the photo ThumbURL string `json:"thumb_url"` // PhotoWidth - Optional. Width of the photo PhotoWidth int `json:"photo_width,omitempty"` // PhotoHeight - Optional. Height of the photo PhotoHeight int `json:"photo_height,omitempty"` // Title - Optional. Title for the result Title string `json:"title,omitempty"` // Description - Optional. Short description of the result Description string `json:"description,omitempty"` // Caption - Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing Caption string `json:"caption,omitempty"` // ParseMode - Optional. Mode for parsing entities in the photo caption. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities - Optional. List of special entities that appear in the caption, which can be specified // instead of parse_mode CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // ReplyMarkup - Optional. Inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating) attached to the message ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent - Optional. Content of the message to be sent instead of the photo InputMessageContent InputMessageContent `json:"input_message_content,omitempty"` }
InlineQueryResultPhoto - Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.
func (*InlineQueryResultPhoto) ResultType ¶
func (i *InlineQueryResultPhoto) ResultType() string
ResultType returns InlineQueryResult type
type InlineQueryResultVenue ¶
type InlineQueryResultVenue struct { // Type - Type of the result, must be venue Type string `json:"type"` // ID - Unique identifier for this result, 1-64 Bytes ID string `json:"id"` // Latitude - Latitude of the venue location in degrees Latitude float64 `json:"latitude"` // Longitude - Longitude of the venue location in degrees Longitude float64 `json:"longitude"` // Title - Title of the venue Title string `json:"title"` // Address - Address of the venue Address string `json:"address"` // FoursquareID - Optional. Foursquare identifier of the venue if known FoursquareID string `json:"foursquare_id,omitempty"` // FoursquareType - 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"` // GooglePlaceID - Optional. Google Places identifier of the venue GooglePlaceID string `json:"google_place_id,omitempty"` // GooglePlaceType - Optional. Google Places type of the venue. (See supported types // (https://developers.google.com/places/web-service/supported_types).) GooglePlaceType string `json:"google_place_type,omitempty"` // ReplyMarkup - Optional. Inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating) attached to the message ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent - Optional. Content of the message to be sent instead of the venue InputMessageContent InputMessageContent `json:"input_message_content,omitempty"` // ThumbURL - Optional. URL of the thumbnail for the result ThumbURL string `json:"thumb_url,omitempty"` // ThumbWidth - Optional. Thumbnail width ThumbWidth int `json:"thumb_width,omitempty"` // ThumbHeight - Optional. Thumbnail height ThumbHeight int `json:"thumb_height,omitempty"` }
InlineQueryResultVenue - Represents a venue. By default, the venue will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the venue.
func (*InlineQueryResultVenue) ResultType ¶
func (i *InlineQueryResultVenue) ResultType() string
ResultType returns InlineQueryResult type
type InlineQueryResultVideo ¶
type InlineQueryResultVideo struct { // Type - Type of the result, must be video Type string `json:"type"` // ID - Unique identifier for this result, 1-64 bytes ID string `json:"id"` // VideoURL - A valid URL for the embedded video player or video file VideoURL string `json:"video_url"` // MimeType - Mime type of the content of video url, “text/html” or “video/mp4” MimeType string `json:"mime_type"` // ThumbURL - URL of the thumbnail (jpeg only) for the video ThumbURL string `json:"thumb_url"` // Title - Title for the result Title string `json:"title"` // Caption - Optional. Caption of the video to be sent, 0-1024 characters after entities parsing Caption string `json:"caption,omitempty"` // ParseMode - Optional. Mode for parsing entities in the video caption. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities - Optional. List of special entities that appear in the caption, which can be specified // instead of parse_mode CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // VideoWidth - Optional. Video width VideoWidth int `json:"video_width,omitempty"` // VideoHeight - Optional. Video height VideoHeight int `json:"video_height,omitempty"` // VideoDuration - Optional. Video duration in seconds VideoDuration int `json:"video_duration,omitempty"` // Description - Optional. Short description of the result Description string `json:"description,omitempty"` // ReplyMarkup - Optional. Inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating) attached to the message ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent - 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"` }
InlineQueryResultVideo - Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.
func (*InlineQueryResultVideo) ResultType ¶
func (i *InlineQueryResultVideo) ResultType() string
ResultType returns InlineQueryResult type
type InlineQueryResultVoice ¶
type InlineQueryResultVoice struct { // Type - Type of the result, must be voice Type string `json:"type"` // ID - Unique identifier for this result, 1-64 bytes ID string `json:"id"` // VoiceURL - A valid URL for the voice recording VoiceURL string `json:"voice_url"` // Title - Recording title Title string `json:"title"` // Caption - Optional. Caption, 0-1024 characters after entities parsing Caption string `json:"caption,omitempty"` // ParseMode - Optional. Mode for parsing entities in the voice message caption. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities - Optional. List of special entities that appear in the caption, which can be specified // instead of parse_mode CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // VoiceDuration - Optional. Recording duration in seconds VoiceDuration int `json:"voice_duration,omitempty"` // ReplyMarkup - Optional. Inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating) attached to the message ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent - Optional. Content of the message to be sent instead of the voice recording InputMessageContent InputMessageContent `json:"input_message_content,omitempty"` }
InlineQueryResultVoice - Represents a link to a voice recording in an .OGG container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the the voice message.
func (*InlineQueryResultVoice) ResultType ¶
func (i *InlineQueryResultVoice) ResultType() string
ResultType returns InlineQueryResult type
type InputContactMessageContent ¶
type InputContactMessageContent struct { // PhoneNumber - Contact's phone number PhoneNumber string `json:"phone_number"` // FirstName - Contact's first name FirstName string `json:"first_name"` // LastName - Optional. Contact's last name LastName string `json:"last_name,omitempty"` // Vcard - Optional. Additional data about the contact in the form of a vCard // (https://en.wikipedia.org/wiki/VCard), 0-2048 bytes Vcard string `json:"vcard,omitempty"` }
InputContactMessageContent - Represents the content (https://core.telegram.org/bots/api#inputmessagecontent) of a contact message to be sent as the result of an inline query.
func (*InputContactMessageContent) ContentType ¶
func (i *InputContactMessageContent) ContentType() string
ContentType returns InputMessageContent type
type InputFile ¶
type InputFile struct { File *os.File FileID string URL string // contains filtered or unexported fields }
InputFile - 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.
func (InputFile) MarshalJSON ¶
MarshalJSON return JSON representation of InputFile
type InputInvoiceMessageContent ¶
type InputInvoiceMessageContent struct { // Title - Product name, 1-32 characters Title string `json:"title"` // Description - Product description, 1-255 characters Description string `json:"description"` // Payload - Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your // internal processes. Payload string `json:"payload"` // ProviderToken - Payment provider token, obtained via Botfather (https://t.me/botfather) ProviderToken string `json:"provider_token"` // Currency - Three-letter ISO 4217 currency code, see more on currencies // (https://core.telegram.org/bots/payments#supported-currencies) Currency string `json:"currency"` // Prices - Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, // delivery cost, delivery tax, bonus, etc.) Prices []LabeledPrice `json:"prices"` // MaxTipAmount - 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 (https://core.telegram.org/bots/payments/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"` // SuggestedTipAmounts - 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"` // ProviderData - 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"` // PhotoURL - 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"` // PhotoSize - Optional. Photo size PhotoSize int `json:"photo_size,omitempty"` // PhotoWidth - Optional. Photo width PhotoWidth int `json:"photo_width,omitempty"` // PhotoHeight - Optional. Photo height PhotoHeight int `json:"photo_height,omitempty"` // NeedName - Optional. Pass True, if you require the user's full name to complete the order NeedName bool `json:"need_name,omitempty"` // NeedPhoneNumber - Optional. Pass True, if you require the user's phone number to complete the order NeedPhoneNumber bool `json:"need_phone_number,omitempty"` // NeedEmail - Optional. Pass True, if you require the user's email address to complete the order NeedEmail bool `json:"need_email,omitempty"` // NeedShippingAddress - Optional. Pass True, if you require the user's shipping address to complete the // order NeedShippingAddress bool `json:"need_shipping_address,omitempty"` // SendPhoneNumberToProvider - Optional. Pass True, if user's phone number should be sent to provider SendPhoneNumberToProvider bool `json:"send_phone_number_to_provider,omitempty"` // SendEmailToProvider - Optional. Pass True, if user's email address should be sent to provider SendEmailToProvider bool `json:"send_email_to_provider,omitempty"` // IsFlexible - Optional. Pass True, if the final price depends on the shipping method IsFlexible bool `json:"is_flexible,omitempty"` }
InputInvoiceMessageContent - Represents the content (https://core.telegram.org/bots/api#inputmessagecontent) of an invoice message to be sent as the result of an inline query.
func (*InputInvoiceMessageContent) ContentType ¶
func (i *InputInvoiceMessageContent) ContentType() string
ContentType returns InputMessageContent type
type InputLocationMessageContent ¶
type InputLocationMessageContent struct { // Latitude - Latitude of the location in degrees Latitude float64 `json:"latitude"` // Longitude - Longitude of the location in degrees Longitude float64 `json:"longitude"` // HorizontalAccuracy - Optional. The radius of uncertainty for the location, measured in meters; 0-1500 HorizontalAccuracy float64 `json:"horizontal_accuracy,omitempty"` // LivePeriod - Optional. Period in seconds for which the location can be updated, should be between 60 and // 86400. LivePeriod int `json:"live_period,omitempty"` // Heading - 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"` // ProximityAlertRadius - 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"` }
InputLocationMessageContent - Represents the content (https://core.telegram.org/bots/api#inputmessagecontent) of a location message to be sent as the result of an inline query.
func (*InputLocationMessageContent) ContentType ¶
func (i *InputLocationMessageContent) ContentType() string
ContentType returns InputMessageContent type
type InputMedia ¶
type InputMedia interface { MediaType() string // contains filtered or unexported methods }
InputMedia - 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 - Type of the result, must be animation Type string `json:"type"` // Media - 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 » // (https://core.telegram.org/bots/api#sending-files) Media InputFile `json:"media"` // Thumb - 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 » (https://core.telegram.org/bots/api#sending-files) Thumb *InputFile `json:"thumb,omitempty"` // Caption - Optional. Caption of the animation to be sent, 0-1024 characters after entities parsing Caption string `json:"caption,omitempty"` // ParseMode - Optional. Mode for parsing entities in the animation caption. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities - Optional. List of special entities that appear in the caption, which can be specified // instead of parse_mode CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // Width - Optional. Animation width Width int `json:"width,omitempty"` // Height - Optional. Animation height Height int `json:"height,omitempty"` // Duration - Optional. Animation duration Duration int `json:"duration,omitempty"` }
InputMediaAnimation - Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.
func (*InputMediaAnimation) MediaType ¶
func (i *InputMediaAnimation) MediaType() string
MediaType return InputMedia type
type InputMediaAudio ¶
type InputMediaAudio struct { // Type - Type of the result, must be audio Type string `json:"type"` // Media - 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 » // (https://core.telegram.org/bots/api#sending-files) Media InputFile `json:"media"` // Thumb - 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 » (https://core.telegram.org/bots/api#sending-files) Thumb *InputFile `json:"thumb,omitempty"` // Caption - Optional. Caption of the audio to be sent, 0-1024 characters after entities parsing Caption string `json:"caption,omitempty"` // ParseMode - Optional. Mode for parsing entities in the audio caption. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities - Optional. List of special entities that appear in the caption, which can be specified // instead of parse_mode CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // Duration - Optional. Duration of the audio in seconds Duration int `json:"duration,omitempty"` // Performer - Optional. Performer of the audio Performer string `json:"performer,omitempty"` // Title - Optional. Title of the audio Title string `json:"title,omitempty"` }
InputMediaAudio - Represents an audio file to be treated as music to be sent.
func (*InputMediaAudio) MediaType ¶
func (i *InputMediaAudio) MediaType() string
MediaType return InputMedia type
type InputMediaDocument ¶
type InputMediaDocument struct { // Type - Type of the result, must be document Type string `json:"type"` // Media - 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 » // (https://core.telegram.org/bots/api#sending-files) Media InputFile `json:"media"` // Thumb - 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 » (https://core.telegram.org/bots/api#sending-files) Thumb *InputFile `json:"thumb,omitempty"` // Caption - Optional. Caption of the document to be sent, 0-1024 characters after entities parsing Caption string `json:"caption,omitempty"` // ParseMode - Optional. Mode for parsing entities in the document caption. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities - Optional. List of special entities that appear in the caption, which can be specified // instead of parse_mode CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // DisableContentTypeDetection - 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"` }
InputMediaDocument - Represents a general file to be sent.
func (*InputMediaDocument) MediaType ¶
func (i *InputMediaDocument) MediaType() string
MediaType return InputMedia type
type InputMediaPhoto ¶
type InputMediaPhoto struct { // Type - Type of the result, must be photo Type string `json:"type"` // Media - 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 » // (https://core.telegram.org/bots/api#sending-files) Media InputFile `json:"media"` // Caption - Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing Caption string `json:"caption,omitempty"` // ParseMode - Optional. Mode for parsing entities in the photo caption. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities - Optional. List of special entities that appear in the caption, which can be specified // instead of parse_mode CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` }
InputMediaPhoto - Represents a photo to be sent.
func (*InputMediaPhoto) MediaType ¶
func (i *InputMediaPhoto) MediaType() string
MediaType return InputMedia type
type InputMediaVideo ¶
type InputMediaVideo struct { // Type - Type of the result, must be video Type string `json:"type"` // Media - 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 » // (https://core.telegram.org/bots/api#sending-files) Media InputFile `json:"media"` // Thumb - 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 » (https://core.telegram.org/bots/api#sending-files) Thumb *InputFile `json:"thumb,omitempty"` // Caption - Optional. Caption of the video to be sent, 0-1024 characters after entities parsing Caption string `json:"caption,omitempty"` // ParseMode - Optional. Mode for parsing entities in the video caption. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities - Optional. List of special entities that appear in the caption, which can be specified // instead of parse_mode CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // Width - Optional. Video width Width int `json:"width,omitempty"` // Height - Optional. Video height Height int `json:"height,omitempty"` // Duration - Optional. Video duration Duration int `json:"duration,omitempty"` // SupportsStreaming - Optional. Pass True, if the uploaded video is suitable for streaming SupportsStreaming bool `json:"supports_streaming,omitempty"` }
InputMediaVideo - Represents a video to be sent.
func (*InputMediaVideo) MediaType ¶
func (i *InputMediaVideo) MediaType() string
MediaType return InputMedia type
type InputMessageContent ¶
type InputMessageContent interface {
ContentType() string
}
InputMessageContent - This object represents the content of a message to be sent as a result of an inline query. Telegram clients currently support the following 5 types: InputTextMessageContent InputLocationMessageContent InputVenueMessageContent InputContactMessageContent InputInvoiceMessageContent
type InputTextMessageContent ¶
type InputTextMessageContent struct { // MessageText - Text of the message to be sent, 1-4096 characters MessageText string `json:"message_text"` // ParseMode - Optional. Mode for parsing entities in the message text. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // Entities - Optional. List of special entities that appear in message text, which can be specified instead // of parse_mode Entities []MessageEntity `json:"entities,omitempty"` // DisableWebPagePreview - Optional. Disables link previews for links in the sent message DisableWebPagePreview bool `json:"disable_web_page_preview,omitempty"` }
InputTextMessageContent - Represents the content (https://core.telegram.org/bots/api#inputmessagecontent) of a text message to be sent as the result of an inline query.
func (*InputTextMessageContent) ContentType ¶
func (i *InputTextMessageContent) ContentType() string
ContentType returns InputMessageContent type
type InputVenueMessageContent ¶
type InputVenueMessageContent struct { // Latitude - Latitude of the venue in degrees Latitude float64 `json:"latitude"` // Longitude - Longitude of the venue in degrees Longitude float64 `json:"longitude"` // Title - Name of the venue Title string `json:"title"` // Address - Address of the venue Address string `json:"address"` // FoursquareID - Optional. Foursquare identifier of the venue, if known FoursquareID string `json:"foursquare_id,omitempty"` // FoursquareType - 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"` // GooglePlaceID - Optional. Google Places identifier of the venue GooglePlaceID string `json:"google_place_id,omitempty"` // GooglePlaceType - Optional. Google Places type of the venue. (See supported types // (https://developers.google.com/places/web-service/supported_types).) GooglePlaceType string `json:"google_place_type,omitempty"` }
InputVenueMessageContent - Represents the content (https://core.telegram.org/bots/api#inputmessagecontent) of a venue message to be sent as the result of an inline query.
func (*InputVenueMessageContent) ContentType ¶
func (i *InputVenueMessageContent) ContentType() string
ContentType returns InputMessageContent type
type Invoice ¶
type Invoice struct { // Title - Product name Title string `json:"title"` // Description - Product description Description string `json:"description"` // StartParameter - Unique bot deep-linking parameter that can be used to generate this invoice StartParameter string `json:"start_parameter"` // Currency - Three-letter ISO 4217 currency (https://core.telegram.org/bots/payments#supported-currencies) // code Currency string `json:"currency"` // TotalAmount - 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 // (https://core.telegram.org/bots/payments/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"` }
Invoice - This object contains basic information about an invoice.
type KeyboardButton ¶
type KeyboardButton struct { // Text - 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"` // RequestContact - 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"` // RequestLocation - 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"` // RequestPoll - 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"` }
KeyboardButton - 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.
type KeyboardButtonPollType ¶
type KeyboardButtonPollType struct { // Type - 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"` }
KeyboardButtonPollType - This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.
type LabeledPrice ¶
type LabeledPrice struct { // Label - Portion label Label string `json:"label"` // Amount - Price of the product in the smallest units of the currency // (https://core.telegram.org/bots/payments#supported-currencies) (integer, not float/double). For example, for // a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json // (https://core.telegram.org/bots/payments/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"` }
LabeledPrice - This object represents a portion of the price for goods or services.
type LeaveChatParams ¶
type LeaveChatParams struct { // ChatID - Unique identifier for the target chat or username of the target supergroup or channel (in the // format @channelusername) ChatID ChatID `json:"chat_id"` }
LeaveChatParams - Represents parameters of leaveChat method.
type Location ¶
type Location struct { // Longitude - Longitude as defined by sender Longitude float64 `json:"longitude"` // Latitude - Latitude as defined by sender Latitude float64 `json:"latitude"` // HorizontalAccuracy - Optional. The radius of uncertainty for the location, measured in meters; 0-1500 HorizontalAccuracy float64 `json:"horizontal_accuracy,omitempty"` // LivePeriod - 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"` // Heading - Optional. The direction in which user is moving, in degrees; 1-360. For active live locations // only. Heading int `json:"heading,omitempty"` // ProximityAlertRadius - 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"` }
Location - This object represents a point on the map.
type Logger ¶
type Logger interface { Debug(args ...interface{}) Debugf(format string, args ...interface{}) Error(args ...interface{}) Errorf(format string, args ...interface{}) }
Logger - Represents logger used to debug or error information
type LoginURL ¶
type LoginURL struct { // URL - 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 // (https://core.telegram.org/widgets/login#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 (https://core.telegram.org/widgets/login#checking-authorization). URL string `json:"url"` // ForwardText - Optional. New text of the button in forwarded messages. ForwardText string `json:"forward_text,omitempty"` // BotUsername - Optional. Username of a bot, which will be used for user authorization. See Setting up a // bot (https://core.telegram.org/widgets/login#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 (https://core.telegram.org/widgets/login#linking-your-domain-to-the-bot) // for more details. BotUsername string `json:"bot_username,omitempty"` // RequestWriteAccess - Optional. Pass True to request the permission for your bot to send messages to the // user. RequestWriteAccess bool `json:"request_write_access,omitempty"` }
LoginURL - This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a great replacement for the Telegram Login Widget (https://core.telegram.org/widgets/login) 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: Image: https://core.telegram.org/file/811140015/1734/8VZFkwWXalM.97872/6127fa62d8a0bf2b3c Telegram apps support these buttons as of version 5.7. Sample bot: @discussbot
type MaskPosition ¶
type MaskPosition struct { // Point - The part of the face relative to which the mask should be placed. One of “forehead”, // “eyes”, “mouth”, or “chin”. Point string `json:"point"` // XShift - 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"` // YShift - 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"` // Scale - Mask scaling coefficient. For example, 2.0 means double size. Scale float64 `json:"scale"` }
MaskPosition - This object describes the position on faces where a mask should be placed by default.
type Message ¶
type Message struct { // MessageID - Unique message identifier inside this chat MessageID int `json:"message_id"` // From - Optional. Sender, empty for messages sent to channels From *User `json:"from,omitempty"` // SenderChat - 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 - Date the message was sent in Unix time Date int64 `json:"date"` // Chat - Conversation the message belongs to Chat Chat `json:"chat"` // ForwardFrom - Optional. For forwarded messages, sender of the original message ForwardFrom *User `json:"forward_from,omitempty"` // ForwardFromChat - Optional. For messages forwarded from channels or from anonymous administrators, // information about the original sender chat ForwardFromChat *Chat `json:"forward_from_chat,omitempty"` // ForwardFromMessageID - Optional. For messages forwarded from channels, identifier of the original message // in the channel ForwardFromMessageID int `json:"forward_from_message_id,omitempty"` // ForwardSignature - Optional. For messages forwarded from channels, signature of the post author if // present ForwardSignature string `json:"forward_signature,omitempty"` // ForwardSenderName - 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"` // ForwardDate - Optional. For forwarded messages, date the original message was sent in Unix time ForwardDate int64 `json:"forward_date,omitempty"` // ReplyToMessage - 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"` // ViaBot - Optional. Bot through which the message was sent ViaBot *User `json:"via_bot,omitempty"` // EditDate - Optional. Date the message was last edited in Unix time EditDate int64 `json:"edit_date,omitempty"` // MediaGroupID - Optional. The unique identifier of a media message group this message belongs to MediaGroupID string `json:"media_group_id,omitempty"` // AuthorSignature - 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"` // Text - Optional. For text messages, the actual UTF-8 text of the message, 0-4096 characters Text string `json:"text,omitempty"` // Entities - Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that // appear in the text Entities []MessageEntity `json:"entities,omitempty"` // Animation - 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"` // Audio - Optional. Message is an audio file, information about the file Audio *Audio `json:"audio,omitempty"` // Document - Optional. Message is a general file, information about the file Document *Document `json:"document,omitempty"` // Photo - Optional. Message is a photo, available sizes of the photo Photo []PhotoSize `json:"photo,omitempty"` // Sticker - Optional. Message is a sticker, information about the sticker Sticker *Sticker `json:"sticker,omitempty"` // Video - Optional. Message is a video, information about the video Video *Video `json:"video,omitempty"` // VideoNote - Optional. Message is a video note (https://telegram.org/blog/video-messages-and-telescope), // information about the video message VideoNote *VideoNote `json:"video_note,omitempty"` // Voice - Optional. Message is a voice message, information about the file Voice *Voice `json:"voice,omitempty"` // Caption - Optional. Caption for the animation, audio, document, photo, video or voice, 0-1024 characters Caption string `json:"caption,omitempty"` // CaptionEntities - 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"` // Contact - Optional. Message is a shared contact, information about the contact Contact *Contact `json:"contact,omitempty"` // Dice - Optional. Message is a dice with random value Dice *Dice `json:"dice,omitempty"` // Game - Optional. Message is a game, information about the game. More about games » // (https://core.telegram.org/bots/api#games) Game *Game `json:"game,omitempty"` // Poll - Optional. Message is a native poll, information about the poll Poll *Poll `json:"poll,omitempty"` // Venue - 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"` // Location - Optional. Message is a shared location, information about the location Location *Location `json:"location,omitempty"` // NewChatMembers - 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"` // LeftChatMember - 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"` // NewChatTitle - Optional. A chat title was changed to this value NewChatTitle string `json:"new_chat_title,omitempty"` // NewChatPhoto - Optional. A chat photo was change to this value NewChatPhoto []PhotoSize `json:"new_chat_photo,omitempty"` // DeleteChatPhoto - Optional. Service message: the chat photo was deleted DeleteChatPhoto bool `json:"delete_chat_photo,omitempty"` // GroupChatCreated - Optional. Service message: the group has been created GroupChatCreated bool `json:"group_chat_created,omitempty"` // SupergroupChatCreated - 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"` // ChannelChatCreated - 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"` // MessageAutoDeleteTimerChanged - Optional. Service message: auto-delete timer settings changed in the chat MessageAutoDeleteTimerChanged *MessageAutoDeleteTimerChanged `json:"message_auto_delete_timer_changed,omitempty"` // MigrateToChatID - Optional. The group has been migrated to a supergroup with the specified identifier. // This number may have more than 32 significant bits and some programming languages may have difficulty/silent // defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or // double-precision float type are safe for storing this identifier. MigrateToChatID int64 `json:"migrate_to_chat_id,omitempty"` // MigrateFromChatID - Optional. The supergroup has been migrated from a group with the specified // identifier. This number may have more than 32 significant bits and some programming languages may have // difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit // integer or double-precision float type are safe for storing this identifier. MigrateFromChatID int64 `json:"migrate_from_chat_id,omitempty"` // PinnedMessage - 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"` // Invoice - Optional. Message is an invoice for a payment (https://core.telegram.org/bots/api#payments), // information about the invoice. More about payments » (https://core.telegram.org/bots/api#payments) Invoice *Invoice `json:"invoice,omitempty"` // SuccessfulPayment - Optional. Message is a service message about a successful payment, information about // the payment. More about payments » (https://core.telegram.org/bots/api#payments) SuccessfulPayment *SuccessfulPayment `json:"successful_payment,omitempty"` // ConnectedWebsite - Optional. The domain name of the website on which the user has logged in. More about // Telegram Login » (https://core.telegram.org/widgets/login) ConnectedWebsite string `json:"connected_website,omitempty"` // PassportData - Optional. Telegram Passport data PassportData *PassportData `json:"passport_data,omitempty"` // ProximityAlertTriggered - 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"` // VoiceChatScheduled - Optional. Service message: voice chat scheduled VoiceChatScheduled *VoiceChatScheduled `json:"voice_chat_scheduled,omitempty"` // VoiceChatStarted - Optional. Service message: voice chat started VoiceChatStarted *VoiceChatStarted `json:"voice_chat_started,omitempty"` // VoiceChatEnded - Optional. Service message: voice chat ended VoiceChatEnded *VoiceChatEnded `json:"voice_chat_ended,omitempty"` // VoiceChatParticipantsInvited - Optional. Service message: new participants invited to a voice chat VoiceChatParticipantsInvited *VoiceChatParticipantsInvited `json:"voice_chat_participants_invited,omitempty"` // ReplyMarkup - Optional. Inline keyboard attached to the message. login_url buttons are represented as // ordinary URL buttons. ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` }
Message - This object represents a message.
type MessageAutoDeleteTimerChanged ¶
type MessageAutoDeleteTimerChanged struct { // MessageAutoDeleteTime - New auto-delete time for messages in the chat MessageAutoDeleteTime int `json:"message_auto_delete_time"` }
MessageAutoDeleteTimerChanged - This object represents a service message about a change in auto-delete timer settings.
type MessageEntity ¶
type MessageEntity struct { // Type - 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 (https://telegram.org/blog/edit#new-mentions)) Type string `json:"type"` // Offset - Offset in UTF-16 code units to the start of the entity Offset int `json:"offset"` // Length - Length of the entity in UTF-16 code units Length int `json:"length"` // URL - Optional. For “text_link” only, URL that will be opened after user taps on the text URL string `json:"url,omitempty"` // User - Optional. For “text_mention” only, the mentioned user User *User `json:"user,omitempty"` // Language - Optional. For “pre” only, the programming language of the entity text Language string `json:"language,omitempty"` }
MessageEntity - This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.
type MessageID ¶
type MessageID struct { // MessageID - Unique message identifier MessageID int `json:"message_id"` }
MessageID - This object represents a unique message identifier.
type OrderInfo ¶
type OrderInfo struct { // Name - Optional. User name Name string `json:"name,omitempty"` // PhoneNumber - Optional. User's phone number PhoneNumber string `json:"phone_number,omitempty"` // Email - Optional. User email Email string `json:"email,omitempty"` // ShippingAddress - Optional. User shipping address ShippingAddress *ShippingAddress `json:"shipping_address,omitempty"` }
OrderInfo - This object represents information about an order.
type PassportData ¶
type PassportData struct { // Data - Array with information about documents and other Telegram Passport elements that was shared with // the bot Data []EncryptedPassportElement `json:"data"` // Credentials - Encrypted credentials required to decrypt the data Credentials EncryptedCredentials `json:"credentials"` }
PassportData - Contains information about Telegram Passport data shared with the bot by the user.
type PassportElementError ¶
type PassportElementError interface {
ErrorSource() string
}
PassportElementError - 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 { // Source - Error source, must be data Source string `json:"source"` // Type - 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"` // FieldName - Name of the data field which has the error FieldName string `json:"field_name"` // DataHash - Base64-encoded data hash DataHash string `json:"data_hash"` // Message - Error message Message string `json:"message"` }
PassportElementErrorDataField - Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes.
func (*PassportElementErrorDataField) ErrorSource ¶
func (p *PassportElementErrorDataField) ErrorSource() string
ErrorSource returns PassportElementError source
type PassportElementErrorFile ¶
type PassportElementErrorFile struct { // Source - Error source, must be file Source string `json:"source"` // Type - 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"` // FileHash - Base64-encoded file hash FileHash string `json:"file_hash"` // Message - Error message Message string `json:"message"` }
PassportElementErrorFile - Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes.
func (*PassportElementErrorFile) ErrorSource ¶
func (p *PassportElementErrorFile) ErrorSource() string
ErrorSource returns PassportElementError source
type PassportElementErrorFiles ¶
type PassportElementErrorFiles struct { // Source - Error source, must be files Source string `json:"source"` // Type - 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"` // FileHashes - List of base64-encoded file hashes FileHashes []string `json:"file_hashes"` // Message - Error message Message string `json:"message"` }
PassportElementErrorFiles - Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.
func (*PassportElementErrorFiles) ErrorSource ¶
func (p *PassportElementErrorFiles) ErrorSource() string
ErrorSource returns PassportElementError source
type PassportElementErrorFrontSide ¶
type PassportElementErrorFrontSide struct { // Source - Error source, must be front_side Source string `json:"source"` // Type - 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"` // FileHash - Base64-encoded hash of the file with the front side of the document FileHash string `json:"file_hash"` // Message - Error message Message string `json:"message"` }
PassportElementErrorFrontSide - Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes.
func (*PassportElementErrorFrontSide) ErrorSource ¶
func (p *PassportElementErrorFrontSide) ErrorSource() string
ErrorSource returns PassportElementError source
type PassportElementErrorReverseSide ¶
type PassportElementErrorReverseSide struct { // Source - Error source, must be reverse_side Source string `json:"source"` // Type - The section of the user's Telegram Passport which has the issue, one of “driver_license”, // “identity_card” Type string `json:"type"` // FileHash - Base64-encoded hash of the file with the reverse side of the document FileHash string `json:"file_hash"` // Message - Error message Message string `json:"message"` }
PassportElementErrorReverseSide - Represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes.
func (*PassportElementErrorReverseSide) ErrorSource ¶
func (p *PassportElementErrorReverseSide) ErrorSource() string
ErrorSource returns PassportElementError source
type PassportElementErrorSelfie ¶
type PassportElementErrorSelfie struct { // Source - Error source, must be selfie Source string `json:"source"` // Type - 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"` // FileHash - Base64-encoded hash of the file with the selfie FileHash string `json:"file_hash"` // Message - Error message Message string `json:"message"` }
PassportElementErrorSelfie - Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes.
func (*PassportElementErrorSelfie) ErrorSource ¶
func (p *PassportElementErrorSelfie) ErrorSource() string
ErrorSource returns PassportElementError source
type PassportElementErrorTranslationFile ¶
type PassportElementErrorTranslationFile struct { // Source - Error source, must be translation_file Source string `json:"source"` // Type - 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"` // FileHash - Base64-encoded file hash FileHash string `json:"file_hash"` // Message - Error message Message string `json:"message"` }
PassportElementErrorTranslationFile - Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes.
func (*PassportElementErrorTranslationFile) ErrorSource ¶
func (p *PassportElementErrorTranslationFile) ErrorSource() string
ErrorSource returns PassportElementError source
type PassportElementErrorTranslationFiles ¶
type PassportElementErrorTranslationFiles struct { // Source - Error source, must be translation_files Source string `json:"source"` // Type - 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"` // FileHashes - List of base64-encoded file hashes FileHashes []string `json:"file_hashes"` // Message - Error message Message string `json:"message"` }
PassportElementErrorTranslationFiles - Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation change.
func (*PassportElementErrorTranslationFiles) ErrorSource ¶
func (p *PassportElementErrorTranslationFiles) ErrorSource() string
ErrorSource returns PassportElementError source
type PassportElementErrorUnspecified ¶
type PassportElementErrorUnspecified struct { // Source - Error source, must be unspecified Source string `json:"source"` // Type - Type of element of the user's Telegram Passport which has the issue Type string `json:"type"` // ElementHash - Base64-encoded element hash ElementHash string `json:"element_hash"` // Message - Error message Message string `json:"message"` }
PassportElementErrorUnspecified - Represents an issue in an unspecified place. The error is considered resolved when new data is added.
func (*PassportElementErrorUnspecified) ErrorSource ¶
func (p *PassportElementErrorUnspecified) ErrorSource() string
ErrorSource returns PassportElementError source
type PassportFile ¶
type PassportFile struct { // FileID - Identifier for this file, which can be used to download or reuse the file FileID string `json:"file_id"` // FileUniqueID - 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"` // FileSize - File size FileSize int `json:"file_size"` // FileDate - Unix time when the file was uploaded FileDate int64 `json:"file_date"` }
PassportFile - This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB.
type PhotoSize ¶
type PhotoSize struct { // FileID - Identifier for this file, which can be used to download or reuse the file FileID string `json:"file_id"` // FileUniqueID - 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"` // Width - Photo width Width int `json:"width"` // Height - Photo height Height int `json:"height"` // FileSize - Optional. File size FileSize int `json:"file_size,omitempty"` }
PhotoSize - This object represents one size of a photo or a file (https://core.telegram.org/bots/api#document) / sticker (https://core.telegram.org/bots/api#sticker) thumbnail.
type PinChatMessageParams ¶
type PinChatMessageParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // MessageID - Identifier of a message to pin MessageID int `json:"message_id"` // DisableNotification - 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"` }
PinChatMessageParams - Represents parameters of pinChatMessage method.
type Poll ¶
type Poll struct { // ID - Unique poll identifier ID string `json:"id"` // Question - Poll question, 1-300 characters Question string `json:"question"` // Options - List of poll options Options []PollOption `json:"options"` // TotalVoterCount - Total number of users that voted in the poll TotalVoterCount int `json:"total_voter_count"` // IsClosed - True, if the poll is closed IsClosed bool `json:"is_closed"` // IsAnonymous - True, if the poll is anonymous IsAnonymous bool `json:"is_anonymous"` // Type - Poll type, currently can be “regular” or “quiz” Type string `json:"type"` // AllowsMultipleAnswers - True, if the poll allows multiple answers AllowsMultipleAnswers bool `json:"allows_multiple_answers"` // CorrectOptionID - 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"` // Explanation - 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"` // ExplanationEntities - Optional. Special entities like usernames, URLs, bot commands, etc. that appear in // the explanation ExplanationEntities []MessageEntity `json:"explanation_entities,omitempty"` // OpenPeriod - Optional. Amount of time in seconds the poll will be active after creation OpenPeriod int `json:"open_period,omitempty"` // CloseDate - Optional. Point in time (Unix timestamp) when the poll will be automatically closed CloseDate int64 `json:"close_date,omitempty"` }
Poll - This object contains information about a poll.
type PollAnswer ¶
type PollAnswer struct { // PollID - Unique poll identifier PollID string `json:"poll_id"` // User - The user, who changed the answer to the poll User User `json:"user"` // OptionIDs - 0-based identifiers of answer options, chosen by the user. May be empty if the user retracted // their vote. OptionIDs []int `json:"option_ids"` }
PollAnswer - This object represents an answer of a user in a non-anonymous poll.
type PollOption ¶
type PollOption struct { // Text - Option text, 1-100 characters Text string `json:"text"` // VoterCount - Number of users that voted for this option VoterCount int `json:"voter_count"` }
PollOption - This object contains information about one answer option in a poll.
type PreCheckoutQuery ¶
type PreCheckoutQuery struct { // ID - Unique query identifier ID string `json:"id"` // From - User who sent the query From User `json:"from"` // Currency - Three-letter ISO 4217 currency (https://core.telegram.org/bots/payments#supported-currencies) // code Currency string `json:"currency"` // TotalAmount - 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 // (https://core.telegram.org/bots/payments/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"` // InvoicePayload - Bot specified invoice payload InvoicePayload string `json:"invoice_payload"` // ShippingOptionID - Optional. Identifier of the shipping option chosen by the user ShippingOptionID string `json:"shipping_option_id,omitempty"` // OrderInfo - Optional. Order info provided by the user OrderInfo *OrderInfo `json:"order_info,omitempty"` }
PreCheckoutQuery - This object contains information about an incoming pre-checkout query.
type PromoteChatMemberParams ¶
type PromoteChatMemberParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // UserID - Unique identifier of the target user UserID int64 `json:"user_id"` // IsAnonymous - Optional. Pass True, if the administrator's presence in the chat is hidden IsAnonymous bool `json:"is_anonymous,omitempty"` // CanManageChat - 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"` // CanPostMessages - Optional. Pass True, if the administrator can create channel posts, channels only CanPostMessages bool `json:"can_post_messages,omitempty"` // CanEditMessages - 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"` // CanDeleteMessages - Optional. Pass True, if the administrator can delete messages of other users CanDeleteMessages bool `json:"can_delete_messages,omitempty"` // CanManageVoiceChats - Optional. Pass True, if the administrator can manage voice chats CanManageVoiceChats bool `json:"can_manage_voice_chats,omitempty"` // CanRestrictMembers - Optional. Pass True, if the administrator can restrict, ban or unban chat members CanRestrictMembers bool `json:"can_restrict_members,omitempty"` // CanPromoteMembers - 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"` // CanChangeInfo - Optional. Pass True, if the administrator can change chat title, photo and other settings CanChangeInfo bool `json:"can_change_info,omitempty"` // CanInviteUsers - Optional. Pass True, if the administrator can invite new users to the chat CanInviteUsers bool `json:"can_invite_users,omitempty"` // CanPinMessages - Optional. Pass True, if the administrator can pin messages, supergroups only CanPinMessages bool `json:"can_pin_messages,omitempty"` }
PromoteChatMemberParams - Represents parameters of promoteChatMember method.
type ProximityAlertTriggered ¶
type ProximityAlertTriggered struct { // Traveler - User that triggered the alert Traveler User `json:"traveler"` // Watcher - User that set the alert Watcher User `json:"watcher"` // Distance - The distance between the users Distance int `json:"distance"` }
ProximityAlertTriggered - This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user.
type ReplyKeyboardMarkup ¶
type ReplyKeyboardMarkup struct { // Keyboard - Array of button rows, each represented by an Array of KeyboardButton // (https://core.telegram.org/bots/api#keyboardbutton) objects Keyboard [][]KeyboardButton `json:"keyboard"` // ResizeKeyboard - 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"` // OneTimeKeyboard - 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"` // InputFieldPlaceholder - Optional. The placeholder to be shown in the input field when the keyboard is // active; 1-64 characters InputFieldPlaceholder string `json:"input_field_placeholder,omitempty"` // Selective - 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 (https://core.telegram.org/bots/api#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"` }
ReplyKeyboardMarkup - This object represents a custom keyboard (https://core.telegram.org/bots#keyboards) with reply options (see Introduction to bots (https://core.telegram.org/bots#keyboards) for details and examples).
func (*ReplyKeyboardMarkup) ReplyType ¶
func (i *ReplyKeyboardMarkup) ReplyType() string
ReplyType - Returns ReplyKeyboardMarkup type
type ReplyKeyboardRemove ¶
type ReplyKeyboardRemove struct { // RemoveKeyboard - 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 (https://core.telegram.org/bots/api#replykeyboardmarkup)) RemoveKeyboard bool `json:"remove_keyboard"` // Selective - 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 (https://core.telegram.org/bots/api#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"` }
ReplyKeyboardRemove - Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup (https://core.telegram.org/bots/api#replykeyboardmarkup)).
func (*ReplyKeyboardRemove) ReplyType ¶
func (i *ReplyKeyboardRemove) ReplyType() string
ReplyType - Returns ReplyKeyboardRemove type
type ReplyMarkup ¶
type ReplyMarkup interface { // ReplyType - Returns type of reply ReplyType() string }
ReplyMarkup - Represents reply markup (inline keyboard, custom reply keyboard, etc.)
type RestrictChatMemberParams ¶
type RestrictChatMemberParams struct { // ChatID - Unique identifier for the target chat or username of the target supergroup (in the format // @supergroupusername) ChatID ChatID `json:"chat_id"` // UserID - Unique identifier of the target user UserID int64 `json:"user_id"` // Permissions - A JSON-serialized object for new user permissions Permissions ChatPermissions `json:"permissions"` // UntilDate - 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"` }
RestrictChatMemberParams - Represents parameters of restrictChatMember method.
type RevokeChatInviteLinkParams ¶
type RevokeChatInviteLinkParams struct { // ChatID - Unique identifier of the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // InviteLink - The invite link to revoke InviteLink string `json:"invite_link"` }
RevokeChatInviteLinkParams - Represents parameters of revokeChatInviteLink method.
type SendAnimationParams ¶
type SendAnimationParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // Animation - 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 » // (https://core.telegram.org/bots/api#sending-files) Animation InputFile `json:"animation"` // Duration - Optional. Duration of sent animation in seconds Duration int `json:"duration,omitempty"` // Width - Optional. Animation width Width int `json:"width,omitempty"` // Height - Optional. Animation height Height int `json:"height,omitempty"` // Thumb - 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 » (https://core.telegram.org/bots/api#sending-files) Thumb *InputFile `json:"thumb,omitempty"` // Caption - Optional. Animation caption (may also be used when resending animation by file_id), 0-1024 // characters after entities parsing Caption string `json:"caption,omitempty"` // ParseMode - Optional. Mode for parsing entities in the animation caption. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities - Optional. List of special entities that appear in the caption, which can be specified // instead of parse_mode CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // DisableNotification - Optional. Sends the message silently // (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. DisableNotification bool `json:"disable_notification,omitempty"` // ReplyToMessageID - Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // AllowSendingWithoutReply - 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"` // ReplyMarkup - Optional. Additional interface options. A JSON-serialized object for an inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating), custom reply keyboard // (https://core.telegram.org/bots#keyboards), instructions to remove reply keyboard or to force a reply from // the user. ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"` }
SendAnimationParams - Represents parameters of sendAnimation method.
type SendAudioParams ¶
type SendAudioParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // Audio - 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 » // (https://core.telegram.org/bots/api#sending-files) Audio InputFile `json:"audio"` // Caption - Optional. Audio caption, 0-1024 characters after entities parsing Caption string `json:"caption,omitempty"` // ParseMode - Optional. Mode for parsing entities in the audio caption. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities - Optional. List of special entities that appear in the caption, which can be specified // instead of parse_mode CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // Duration - Optional. Duration of the audio in seconds Duration int `json:"duration,omitempty"` // Performer - Optional. Performer Performer string `json:"performer,omitempty"` // Title - Optional. Track name Title string `json:"title,omitempty"` // Thumb - 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 » (https://core.telegram.org/bots/api#sending-files) Thumb *InputFile `json:"thumb,omitempty"` // DisableNotification - Optional. Sends the message silently // (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. DisableNotification bool `json:"disable_notification,omitempty"` // ReplyToMessageID - Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // AllowSendingWithoutReply - 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"` // ReplyMarkup - Optional. Additional interface options. A JSON-serialized object for an inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating), custom reply keyboard // (https://core.telegram.org/bots#keyboards), instructions to remove reply keyboard or to force a reply from // the user. ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"` }
SendAudioParams - Represents parameters of sendAudio method.
type SendChatActionParams ¶
type SendChatActionParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // Action - Type of action to broadcast. Choose one, depending on what the user is about to receive: typing // for text messages (https://core.telegram.org/bots/api#sendmessage), upload_photo for photos // (https://core.telegram.org/bots/api#sendphoto), record_video or upload_video for videos // (https://core.telegram.org/bots/api#sendvideo), record_voice or upload_voice for voice notes // (https://core.telegram.org/bots/api#sendvoice), upload_document for general files // (https://core.telegram.org/bots/api#senddocument), find_location for location data // (https://core.telegram.org/bots/api#sendlocation), record_video_note or upload_video_note for video notes // (https://core.telegram.org/bots/api#sendvideonote). Action string `json:"action"` }
SendChatActionParams - Represents parameters of sendChatAction method.
type SendContactParams ¶
type SendContactParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // PhoneNumber - Contact's phone number PhoneNumber string `json:"phone_number"` // FirstName - Contact's first name FirstName string `json:"first_name"` // LastName - Optional. Contact's last name LastName string `json:"last_name,omitempty"` // Vcard - Optional. Additional data about the contact in the form of a vCard // (https://en.wikipedia.org/wiki/VCard), 0-2048 bytes Vcard string `json:"vcard,omitempty"` // DisableNotification - Optional. Sends the message silently // (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. DisableNotification bool `json:"disable_notification,omitempty"` // ReplyToMessageID - Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // AllowSendingWithoutReply - 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"` // ReplyMarkup - Optional. Additional interface options. A JSON-serialized object for an inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating), custom reply keyboard // (https://core.telegram.org/bots#keyboards), instructions to remove keyboard or to force a reply from the // user. ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"` }
SendContactParams - Represents parameters of sendContact method.
type SendDiceParams ¶
type SendDiceParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // Emoji - 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"` // DisableNotification - Optional. Sends the message silently // (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. DisableNotification bool `json:"disable_notification,omitempty"` // ReplyToMessageID - Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // AllowSendingWithoutReply - 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"` // ReplyMarkup - Optional. Additional interface options. A JSON-serialized object for an inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating), custom reply keyboard // (https://core.telegram.org/bots#keyboards), instructions to remove reply keyboard or to force a reply from // the user. ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"` }
SendDiceParams - Represents parameters of sendDice method.
type SendDocumentParams ¶
type SendDocumentParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // Document - 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 » (https://core.telegram.org/bots/api#sending-files) Document InputFile `json:"document"` // Thumb - 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 » (https://core.telegram.org/bots/api#sending-files) Thumb *InputFile `json:"thumb,omitempty"` // Caption - Optional. Document caption (may also be used when resending documents by file_id), 0-1024 // characters after entities parsing Caption string `json:"caption,omitempty"` // ParseMode - Optional. Mode for parsing entities in the document caption. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities - Optional. List of special entities that appear in the caption, which can be specified // instead of parse_mode CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // DisableContentTypeDetection - Optional. Disables automatic server-side content type detection for files // uploaded using multipart/form-data DisableContentTypeDetection bool `json:"disable_content_type_detection,omitempty"` // DisableNotification - Optional. Sends the message silently // (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. DisableNotification bool `json:"disable_notification,omitempty"` // ReplyToMessageID - Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // AllowSendingWithoutReply - 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"` // ReplyMarkup - Optional. Additional interface options. A JSON-serialized object for an inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating), custom reply keyboard // (https://core.telegram.org/bots#keyboards), instructions to remove reply keyboard or to force a reply from // the user. ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"` }
SendDocumentParams - Represents parameters of sendDocument method.
type SendGameParams ¶
type SendGameParams struct { // ChatID - Unique identifier for the target chat ChatID int64 `json:"chat_id"` // GameShortName - Short name of the game, serves as the unique identifier for the game. Set up your games // via Botfather (https://t.me/botfather). GameShortName string `json:"game_short_name"` // DisableNotification - Optional. Sends the message silently // (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. DisableNotification bool `json:"disable_notification,omitempty"` // ReplyToMessageID - Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // AllowSendingWithoutReply - 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"` // ReplyMarkup - Optional. A JSON-serialized object for an inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating). 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"` }
SendGameParams - Represents parameters of sendGame method.
type SendInvoiceParams ¶
type SendInvoiceParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // Title - Product name, 1-32 characters Title string `json:"title"` // Description - Product description, 1-255 characters Description string `json:"description"` // Payload - Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your // internal processes. Payload string `json:"payload"` // ProviderToken - Payments provider token, obtained via Botfather (https://t.me/botfather) ProviderToken string `json:"provider_token"` // Currency - Three-letter ISO 4217 currency code, see more on currencies // (https://core.telegram.org/bots/payments#supported-currencies) Currency string `json:"currency"` // Prices - Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, // delivery cost, delivery tax, bonus, etc.) Prices []LabeledPrice `json:"prices"` // MaxTipAmount - 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 (https://core.telegram.org/bots/payments/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"` // SuggestedTipAmounts - 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"` // StartParameter - 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"` // ProviderData - 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"` // PhotoURL - 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"` // PhotoSize - Optional. Photo size PhotoSize int `json:"photo_size,omitempty"` // PhotoWidth - Optional. Photo width PhotoWidth int `json:"photo_width,omitempty"` // PhotoHeight - Optional. Photo height PhotoHeight int `json:"photo_height,omitempty"` // NeedName - Optional. Pass True, if you require the user's full name to complete the order NeedName bool `json:"need_name,omitempty"` // NeedPhoneNumber - Optional. Pass True, if you require the user's phone number to complete the order NeedPhoneNumber bool `json:"need_phone_number,omitempty"` // NeedEmail - Optional. Pass True, if you require the user's email address to complete the order NeedEmail bool `json:"need_email,omitempty"` // NeedShippingAddress - Optional. Pass True, if you require the user's shipping address to complete the // order NeedShippingAddress bool `json:"need_shipping_address,omitempty"` // SendPhoneNumberToProvider - Optional. Pass True, if user's phone number should be sent to provider SendPhoneNumberToProvider bool `json:"send_phone_number_to_provider,omitempty"` // SendEmailToProvider - Optional. Pass True, if user's email address should be sent to provider SendEmailToProvider bool `json:"send_email_to_provider,omitempty"` // IsFlexible - Optional. Pass True, if the final price depends on the shipping method IsFlexible bool `json:"is_flexible,omitempty"` // DisableNotification - Optional. Sends the message silently // (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. DisableNotification bool `json:"disable_notification,omitempty"` // ReplyToMessageID - Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // AllowSendingWithoutReply - 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"` // ReplyMarkup - Optional. A JSON-serialized object for an inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating). 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"` }
SendInvoiceParams - Represents parameters of sendInvoice method.
type SendLocationParams ¶
type SendLocationParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // Latitude - Latitude of the location Latitude float64 `json:"latitude"` // Longitude - Longitude of the location Longitude float64 `json:"longitude"` // HorizontalAccuracy - Optional. The radius of uncertainty for the location, measured in meters; 0-1500 HorizontalAccuracy float64 `json:"horizontal_accuracy,omitempty"` // LivePeriod - Optional. Period in seconds for which the location will be updated (see Live Locations // (https://telegram.org/blog/live-locations), should be between 60 and 86400. LivePeriod int `json:"live_period,omitempty"` // Heading - 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"` // ProximityAlertRadius - 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"` // DisableNotification - Optional. Sends the message silently // (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. DisableNotification bool `json:"disable_notification,omitempty"` // ReplyToMessageID - Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // AllowSendingWithoutReply - 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"` // ReplyMarkup - Optional. Additional interface options. A JSON-serialized object for an inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating), custom reply keyboard // (https://core.telegram.org/bots#keyboards), instructions to remove reply keyboard or to force a reply from // the user. ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"` }
SendLocationParams - Represents parameters of sendLocation method.
type SendMediaGroupParams ¶
type SendMediaGroupParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // Media - A JSON-serialized array describing messages to be sent, must include 2-10 items Media []InputMedia `json:"media"` // DisableNotification - Optional. Sends messages silently // (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. DisableNotification bool `json:"disable_notification,omitempty"` // ReplyToMessageID - Optional. If the messages are a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // AllowSendingWithoutReply - 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"` }
SendMediaGroupParams - Represents parameters of sendMediaGroup method.
type SendMessageParams ¶
type SendMessageParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // Text - Text of the message to be sent, 1-4096 characters after entities parsing Text string `json:"text"` // ParseMode - Optional. Mode for parsing entities in the message text. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // Entities - Optional. List of special entities that appear in message text, which can be specified instead // of parse_mode Entities []MessageEntity `json:"entities,omitempty"` // DisableWebPagePreview - Optional. Disables link previews for links in this message DisableWebPagePreview bool `json:"disable_web_page_preview,omitempty"` // DisableNotification - Optional. Sends the message silently // (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. DisableNotification bool `json:"disable_notification,omitempty"` // ReplyToMessageID - Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // AllowSendingWithoutReply - 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"` // ReplyMarkup - Optional. Additional interface options. A JSON-serialized object for an inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating), custom reply keyboard // (https://core.telegram.org/bots#keyboards), instructions to remove reply keyboard or to force a reply from // the user. ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"` }
SendMessageParams - Represents parameters of sendMessage method.
type SendPhotoParams ¶
type SendPhotoParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // Photo - 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 » // (https://core.telegram.org/bots/api#sending-files) Photo InputFile `json:"photo"` // Caption - Optional. Photo caption (may also be used when resending photos by file_id), 0-1024 characters // after entities parsing Caption string `json:"caption,omitempty"` // ParseMode - Optional. Mode for parsing entities in the photo caption. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities - Optional. List of special entities that appear in the caption, which can be specified // instead of parse_mode CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // DisableNotification - Optional. Sends the message silently // (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. DisableNotification bool `json:"disable_notification,omitempty"` // ReplyToMessageID - Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // AllowSendingWithoutReply - 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"` // ReplyMarkup - Optional. Additional interface options. A JSON-serialized object for an inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating), custom reply keyboard // (https://core.telegram.org/bots#keyboards), instructions to remove reply keyboard or to force a reply from // the user. ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"` }
SendPhotoParams - Represents parameters of sendPhoto method.
type SendPollParams ¶
type SendPollParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // Question - Poll question, 1-300 characters Question string `json:"question"` // Options - A JSON-serialized list of answer options, 2-10 strings 1-100 characters each Options []string `json:"options"` // IsAnonymous - Optional. True, if the poll needs to be anonymous, defaults to True IsAnonymous bool `json:"is_anonymous,omitempty"` // Type - Optional. Poll type, “quiz” or “regular”, defaults to “regular” Type string `json:"type,omitempty"` // AllowsMultipleAnswers - Optional. True, if the poll allows multiple answers, ignored for polls in quiz // mode, defaults to False AllowsMultipleAnswers bool `json:"allows_multiple_answers,omitempty"` // CorrectOptionID - Optional. 0-based identifier of the correct answer option, required for polls in quiz // mode CorrectOptionID int `json:"correct_option_id,omitempty"` // Explanation - 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"` // ExplanationParseMode - Optional. Mode for parsing entities in the explanation. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ExplanationParseMode string `json:"explanation_parse_mode,omitempty"` // ExplanationEntities - 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"` // OpenPeriod - 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"` // CloseDate - 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"` // IsClosed - Optional. Pass True, if the poll needs to be immediately closed. This can be useful for poll // preview. IsClosed bool `json:"is_closed,omitempty"` // DisableNotification - Optional. Sends the message silently // (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. DisableNotification bool `json:"disable_notification,omitempty"` // ReplyToMessageID - Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // AllowSendingWithoutReply - 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"` // ReplyMarkup - Optional. Additional interface options. A JSON-serialized object for an inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating), custom reply keyboard // (https://core.telegram.org/bots#keyboards), instructions to remove reply keyboard or to force a reply from // the user. ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"` }
SendPollParams - Represents parameters of sendPoll method.
type SendStickerParams ¶
type SendStickerParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // Sticker - 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 » // (https://core.telegram.org/bots/api#sending-files) Sticker InputFile `json:"sticker"` // DisableNotification - Optional. Sends the message silently // (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. DisableNotification bool `json:"disable_notification,omitempty"` // ReplyToMessageID - Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // AllowSendingWithoutReply - 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"` // ReplyMarkup - Optional. Additional interface options. A JSON-serialized object for an inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating), custom reply keyboard // (https://core.telegram.org/bots#keyboards), instructions to remove reply keyboard or to force a reply from // the user. ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"` }
SendStickerParams - Represents parameters of sendSticker method.
type SendVenueParams ¶
type SendVenueParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // Latitude - Latitude of the venue Latitude float64 `json:"latitude"` // Longitude - Longitude of the venue Longitude float64 `json:"longitude"` // Title - Name of the venue Title string `json:"title"` // Address - Address of the venue Address string `json:"address"` // FoursquareID - Optional. Foursquare identifier of the venue FoursquareID string `json:"foursquare_id,omitempty"` // FoursquareType - 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"` // GooglePlaceID - Optional. Google Places identifier of the venue GooglePlaceID string `json:"google_place_id,omitempty"` // GooglePlaceType - Optional. Google Places type of the venue. (See supported types // (https://developers.google.com/places/web-service/supported_types).) GooglePlaceType string `json:"google_place_type,omitempty"` // DisableNotification - Optional. Sends the message silently // (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. DisableNotification bool `json:"disable_notification,omitempty"` // ReplyToMessageID - Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // AllowSendingWithoutReply - 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"` // ReplyMarkup - Optional. Additional interface options. A JSON-serialized object for an inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating), custom reply keyboard // (https://core.telegram.org/bots#keyboards), instructions to remove reply keyboard or to force a reply from // the user. ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"` }
SendVenueParams - Represents parameters of sendVenue method.
type SendVideoNoteParams ¶
type SendVideoNoteParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // VideoNote - 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 » // (https://core.telegram.org/bots/api#sending-files). Sending video notes by a URL is currently unsupported VideoNote InputFile `json:"video_note"` // Duration - Optional. Duration of sent video in seconds Duration int `json:"duration,omitempty"` // Length - Optional. Video width and height, i.e. diameter of the video message Length int `json:"length,omitempty"` // Thumb - 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 » (https://core.telegram.org/bots/api#sending-files) Thumb *InputFile `json:"thumb,omitempty"` // DisableNotification - Optional. Sends the message silently // (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. DisableNotification bool `json:"disable_notification,omitempty"` // ReplyToMessageID - Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // AllowSendingWithoutReply - 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"` // ReplyMarkup - Optional. Additional interface options. A JSON-serialized object for an inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating), custom reply keyboard // (https://core.telegram.org/bots#keyboards), instructions to remove reply keyboard or to force a reply from // the user. ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"` }
SendVideoNoteParams - Represents parameters of sendVideoNote method.
type SendVideoParams ¶
type SendVideoParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // Video - 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 » // (https://core.telegram.org/bots/api#sending-files) Video InputFile `json:"video"` // Duration - Optional. Duration of sent video in seconds Duration int `json:"duration,omitempty"` // Width - Optional. Video width Width int `json:"width,omitempty"` // Height - Optional. Video height Height int `json:"height,omitempty"` // Thumb - 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 » (https://core.telegram.org/bots/api#sending-files) Thumb *InputFile `json:"thumb,omitempty"` // Caption - Optional. Video caption (may also be used when resending videos by file_id), 0-1024 characters // after entities parsing Caption string `json:"caption,omitempty"` // ParseMode - Optional. Mode for parsing entities in the video caption. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities - Optional. List of special entities that appear in the caption, which can be specified // instead of parse_mode CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // SupportsStreaming - Optional. Pass True, if the uploaded video is suitable for streaming SupportsStreaming bool `json:"supports_streaming,omitempty"` // DisableNotification - Optional. Sends the message silently // (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. DisableNotification bool `json:"disable_notification,omitempty"` // ReplyToMessageID - Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // AllowSendingWithoutReply - 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"` // ReplyMarkup - Optional. Additional interface options. A JSON-serialized object for an inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating), custom reply keyboard // (https://core.telegram.org/bots#keyboards), instructions to remove reply keyboard or to force a reply from // the user. ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"` }
SendVideoParams - Represents parameters of sendVideo method.
type SendVoiceParams ¶
type SendVoiceParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // Voice - 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 » (https://core.telegram.org/bots/api#sending-files) Voice InputFile `json:"voice"` // Caption - Optional. Voice message caption, 0-1024 characters after entities parsing Caption string `json:"caption,omitempty"` // ParseMode - Optional. Mode for parsing entities in the voice message caption. See formatting options // (https://core.telegram.org/bots/api#formatting-options) for more details. ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities - Optional. List of special entities that appear in the caption, which can be specified // instead of parse_mode CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // Duration - Optional. Duration of the voice message in seconds Duration int `json:"duration,omitempty"` // DisableNotification - Optional. Sends the message silently // (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound. DisableNotification bool `json:"disable_notification,omitempty"` // ReplyToMessageID - Optional. If the message is a reply, ID of the original message ReplyToMessageID int `json:"reply_to_message_id,omitempty"` // AllowSendingWithoutReply - 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"` // ReplyMarkup - Optional. Additional interface options. A JSON-serialized object for an inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating), custom reply keyboard // (https://core.telegram.org/bots#keyboards), instructions to remove reply keyboard or to force a reply from // the user. ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"` }
SendVoiceParams - Represents parameters of sendVoice method.
type SetChatAdministratorCustomTitleParams ¶
type SetChatAdministratorCustomTitleParams struct { // ChatID - Unique identifier for the target chat or username of the target supergroup (in the format // @supergroupusername) ChatID ChatID `json:"chat_id"` // UserID - Unique identifier of the target user UserID int64 `json:"user_id"` // CustomTitle - New custom title for the administrator; 0-16 characters, emoji are not allowed CustomTitle string `json:"custom_title"` }
SetChatAdministratorCustomTitleParams - Represents parameters of setChatAdministratorCustomTitle method.
type SetChatDescriptionParams ¶
type SetChatDescriptionParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // Description - Optional. New chat description, 0-255 characters Description string `json:"description,omitempty"` }
SetChatDescriptionParams - Represents parameters of setChatDescription method.
type SetChatPermissionsParams ¶
type SetChatPermissionsParams struct { // ChatID - Unique identifier for the target chat or username of the target supergroup (in the format // @supergroupusername) ChatID ChatID `json:"chat_id"` // Permissions - New default chat permissions Permissions ChatPermissions `json:"permissions"` }
SetChatPermissionsParams - Represents parameters of setChatPermissions method.
type SetChatPhotoParams ¶
type SetChatPhotoParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // Photo - New chat photo, uploaded using multipart/form-data Photo InputFile `json:"photo"` }
SetChatPhotoParams - Represents parameters of setChatPhoto method.
type SetChatStickerSetParams ¶
type SetChatStickerSetParams struct { // ChatID - Unique identifier for the target chat or username of the target supergroup (in the format // @supergroupusername) ChatID ChatID `json:"chat_id"` // StickerSetName - Name of the sticker set to be set as the group sticker set StickerSetName string `json:"sticker_set_name"` }
SetChatStickerSetParams - Represents parameters of setChatStickerSet method.
type SetChatTitleParams ¶
type SetChatTitleParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // Title - New chat title, 1-255 characters Title string `json:"title"` }
SetChatTitleParams - Represents parameters of setChatTitle method.
type SetGameScoreParams ¶
type SetGameScoreParams struct { // UserID - User identifier UserID int64 `json:"user_id"` // Score - New score, must be non-negative Score int `json:"score"` // Force - 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"` // DisableEditMessage - Optional. Pass True, if the game message should not be automatically edited to // include the current scoreboard DisableEditMessage bool `json:"disable_edit_message,omitempty"` // ChatID - Optional. Required if inline_message_id is not specified. Unique identifier for the target chat ChatID int64 `json:"chat_id,omitempty"` // MessageID - Optional. Required if inline_message_id is not specified. Identifier of the sent message MessageID int `json:"message_id,omitempty"` // InlineMessageID - Optional. Required if chat_id and message_id are not specified. Identifier of the inline // message InlineMessageID string `json:"inline_message_id,omitempty"` }
SetGameScoreParams - Represents parameters of setGameScore method.
type SetMyCommandsParams ¶
type SetMyCommandsParams struct { // Commands - 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"` // Scope - Optional. A JSON-serialized object, describing scope of users for which the commands are relevant. // Defaults to BotCommandScopeDefault (https://core.telegram.org/bots/api#botcommandscopedefault). Scope BotCommandScope `json:"scope,omitempty"` // LanguageCode - Optional. A two-letter ISO 639-1 language code. If empty, commands will be applied to all // users from the given scope, for whose language there are no dedicated commands LanguageCode string `json:"language_code,omitempty"` }
SetMyCommandsParams - Represents parameters of setMyCommands method.
type SetPassportDataErrorsParams ¶
type SetPassportDataErrorsParams struct { // UserID - User identifier UserID int64 `json:"user_id"` // Errors - A JSON-serialized array describing the errors Errors []PassportElementError `json:"errors"` }
SetPassportDataErrorsParams - Represents parameters of setPassportDataErrors method.
type SetStickerPositionInSetParams ¶
type SetStickerPositionInSetParams struct { // Sticker - File identifier of the sticker Sticker string `json:"sticker"` // Position - New sticker position in the set, zero-based Position int `json:"position"` }
SetStickerPositionInSetParams - Represents parameters of setStickerPositionInSet method.
type SetStickerSetThumbParams ¶
type SetStickerSetThumbParams struct { // Name - Sticker set name Name string `json:"name"` // UserID - User identifier of the sticker set owner UserID int64 `json:"user_id"` // Thumb - 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 // (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 » (https://core.telegram.org/bots/api#sending-files). // Animated sticker set thumbnail can't be uploaded via HTTP URL. Thumb *InputFile `json:"thumb,omitempty"` }
SetStickerSetThumbParams - Represents parameters of setStickerSetThumb method.
type SetWebhookParams ¶
type SetWebhookParams struct { // URL - HTTPS URL to send updates to. Use an empty string to remove webhook integration URL string `json:"url"` // Certificate - Optional. Upload your public key certificate so that the root certificate in use can be // checked. See our self-signed guide (https://core.telegram.org/bots/self-signed) for details. // Please upload as File, sending a FileID or URL will not work. Certificate *InputFile `json:"certificate,omitempty"` // IPAddress - 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"` // MaxConnections - 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"` // AllowedUpdates - 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 (https://core.telegram.org/bots/api#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"` // DropPendingUpdates - Optional. Pass True to drop all pending updates DropPendingUpdates bool `json:"drop_pending_updates,omitempty"` }
SetWebhookParams - Represents parameters of setWebhook method.
type ShippingAddress ¶
type ShippingAddress struct { // CountryCode - ISO 3166-1 alpha-2 country code CountryCode string `json:"country_code"` // State - State, if applicable State string `json:"state"` // City - City City string `json:"city"` // StreetLine1 - First line for the address StreetLine1 string `json:"street_line1"` // StreetLine2 - Second line for the address StreetLine2 string `json:"street_line2"` // PostCode - Address post code PostCode string `json:"post_code"` }
ShippingAddress - This object represents a shipping address.
type ShippingOption ¶
type ShippingOption struct { // ID - Shipping option identifier ID string `json:"id"` // Title - Option title Title string `json:"title"` // Prices - List of price portions Prices []LabeledPrice `json:"prices"` }
ShippingOption - This object represents one shipping option.
type ShippingQuery ¶
type ShippingQuery struct { // ID - Unique query identifier ID string `json:"id"` // From - User who sent the query From User `json:"from"` // InvoicePayload - Bot specified invoice payload InvoicePayload string `json:"invoice_payload"` // ShippingAddress - User specified shipping address ShippingAddress ShippingAddress `json:"shipping_address"` }
ShippingQuery - This object contains information about an incoming shipping query.
type Sticker ¶
type Sticker struct { // FileID - Identifier for this file, which can be used to download or reuse the file FileID string `json:"file_id"` // FileUniqueID - 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"` // Width - Sticker width Width int `json:"width"` // Height - Sticker height Height int `json:"height"` // IsAnimated - True, if the sticker is animated (https://telegram.org/blog/animated-stickers) IsAnimated bool `json:"is_animated"` // Thumb - Optional. Sticker thumbnail in the .WEBP or .JPG format Thumb *PhotoSize `json:"thumb,omitempty"` // Emoji - Optional. Emoji associated with the sticker Emoji string `json:"emoji,omitempty"` // SetName - Optional. Name of the sticker set to which the sticker belongs SetName string `json:"set_name,omitempty"` // MaskPosition - Optional. For mask stickers, the position where the mask should be placed MaskPosition *MaskPosition `json:"mask_position,omitempty"` // FileSize - Optional. File size FileSize int `json:"file_size,omitempty"` }
Sticker - This object represents a sticker.
type StickerSet ¶
type StickerSet struct { // Name - Sticker set name Name string `json:"name"` // Title - Sticker set title Title string `json:"title"` // IsAnimated - True, if the sticker set contains animated stickers // (https://telegram.org/blog/animated-stickers) IsAnimated bool `json:"is_animated"` // ContainsMasks - True, if the sticker set contains masks ContainsMasks bool `json:"contains_masks"` // Stickers - List of all set stickers Stickers []Sticker `json:"stickers"` // Thumb - Optional. Sticker set thumbnail in the .WEBP or .TGS format Thumb *PhotoSize `json:"thumb,omitempty"` }
StickerSet - This object represents a sticker set.
type StopMessageLiveLocationParams ¶
type StopMessageLiveLocationParams struct { // ChatID - 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 ChatID `json:"chat_id,omitempty"` // MessageID - Optional. Required if inline_message_id is not specified. Identifier of the message with live // location to stop MessageID int `json:"message_id,omitempty"` // InlineMessageID - Optional. Required if chat_id and message_id are not specified. Identifier of the inline // message InlineMessageID string `json:"inline_message_id,omitempty"` // ReplyMarkup - Optional. A JSON-serialized object for a new inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating). ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` }
StopMessageLiveLocationParams - Represents parameters of stopMessageLiveLocation method.
type StopPollParams ¶
type StopPollParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // MessageID - Identifier of the original message with the poll MessageID int `json:"message_id"` // ReplyMarkup - Optional. A JSON-serialized object for a new message inline keyboard // (https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating). ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` }
StopPollParams - Represents parameters of stopPoll method.
type SuccessfulPayment ¶
type SuccessfulPayment struct { // Currency - Three-letter ISO 4217 currency (https://core.telegram.org/bots/payments#supported-currencies) // code Currency string `json:"currency"` // TotalAmount - 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 // (https://core.telegram.org/bots/payments/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"` // InvoicePayload - Bot specified invoice payload InvoicePayload string `json:"invoice_payload"` // ShippingOptionID - Optional. Identifier of the shipping option chosen by the user ShippingOptionID string `json:"shipping_option_id,omitempty"` // OrderInfo - Optional. Order info provided by the user OrderInfo *OrderInfo `json:"order_info,omitempty"` // TelegramPaymentChargeID - Telegram payment identifier TelegramPaymentChargeID string `json:"telegram_payment_charge_id"` // ProviderPaymentChargeID - Provider payment identifier ProviderPaymentChargeID string `json:"provider_payment_charge_id"` }
SuccessfulPayment - This object contains basic information about a successful payment.
type UnbanChatMemberParams ¶
type UnbanChatMemberParams struct { // ChatID - Unique identifier for the target group or username of the target supergroup or channel (in the // format @username) ChatID ChatID `json:"chat_id"` // UserID - Unique identifier of the target user UserID int64 `json:"user_id"` // OnlyIfBanned - Optional. Do nothing if the user is not banned OnlyIfBanned bool `json:"only_if_banned,omitempty"` }
UnbanChatMemberParams - Represents parameters of unbanChatMember method.
type UnpinAllChatMessagesParams ¶
type UnpinAllChatMessagesParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` }
UnpinAllChatMessagesParams - Represents parameters of unpinAllChatMessages method.
type UnpinChatMessageParams ¶
type UnpinChatMessageParams struct { // ChatID - Unique identifier for the target chat or username of the target channel (in the format // @channelusername) ChatID ChatID `json:"chat_id"` // MessageID - 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"` }
UnpinChatMessageParams - Represents parameters of unpinChatMessage method.
type Update ¶
type Update struct { // UpdateID - 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 // (https://core.telegram.org/bots/api#setwebhook), 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"` // Message - Optional. New incoming message of any kind — text, photo, sticker, etc. Message *Message `json:"message,omitempty"` // EditedMessage - Optional. New version of a message that is known to the bot and was edited EditedMessage *Message `json:"edited_message,omitempty"` // ChannelPost - Optional. New incoming channel post of any kind — text, photo, sticker, etc. ChannelPost *Message `json:"channel_post,omitempty"` // EditedChannelPost - Optional. New version of a channel post that is known to the bot and was edited EditedChannelPost *Message `json:"edited_channel_post,omitempty"` // InlineQuery - Optional. New incoming inline (https://core.telegram.org/bots/api#inline-mode) query InlineQuery *InlineQuery `json:"inline_query,omitempty"` // ChosenInlineResult - Optional. The result of an inline (https://core.telegram.org/bots/api#inline-mode) // query that was chosen by a user and sent to their chat partner. Please see our documentation on the feedback // collecting (https://core.telegram.org/bots/inline#collecting-feedback) for details on how to enable these // updates for your bot. ChosenInlineResult *ChosenInlineResult `json:"chosen_inline_result,omitempty"` // CallbackQuery - Optional. New incoming callback query CallbackQuery *CallbackQuery `json:"callback_query,omitempty"` // ShippingQuery - Optional. New incoming shipping query. Only for invoices with flexible price ShippingQuery *ShippingQuery `json:"shipping_query,omitempty"` // PreCheckoutQuery - Optional. New incoming pre-checkout query. Contains full information about checkout PreCheckoutQuery *PreCheckoutQuery `json:"pre_checkout_query,omitempty"` // Poll - Optional. New poll state. Bots receive only updates about stopped polls and polls, which are sent // by the bot Poll *Poll `json:"poll,omitempty"` // PollAnswer - 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"` // MyChatMember - 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"` // ChatMember - 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"` }
Update - This object (https://core.telegram.org/bots/api#available-types) represents an incoming update.At most one of the optional parameters can be present in any given update.
type UploadStickerFileParams ¶
type UploadStickerFileParams struct { // UserID - User identifier of sticker file owner UserID int64 `json:"user_id"` // PngSticker - 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 » // (https://core.telegram.org/bots/api#sending-files) PngSticker InputFile `json:"png_sticker"` }
UploadStickerFileParams - Represents parameters of uploadStickerFile method.
type User ¶
type User struct { // ID - Unique identifier for this user or bot. This number may have more than 32 significant bits and some // programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 // significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. ID int64 `json:"id"` // IsBot - True, if this user is a bot IsBot bool `json:"is_bot"` // FirstName - User's or bot's first name FirstName string `json:"first_name"` // LastName - Optional. User's or bot's last name LastName string `json:"last_name,omitempty"` // Username - Optional. User's or bot's username Username string `json:"username,omitempty"` // LanguageCode - Optional. IETF language tag (https://en.wikipedia.org/wiki/IETF_language_tag) of the // user's language LanguageCode string `json:"language_code,omitempty"` // CanJoinGroups - Optional. True, if the bot can be invited to groups. Returned only in getMe // (https://core.telegram.org/bots/api#getme). CanJoinGroups bool `json:"can_join_groups,omitempty"` // CanReadAllGroupMessages - Optional. True, if privacy mode (https://core.telegram.org/bots#privacy-mode) // is disabled for the bot. Returned only in getMe (https://core.telegram.org/bots/api#getme). CanReadAllGroupMessages bool `json:"can_read_all_group_messages,omitempty"` // SupportsInlineQueries - Optional. True, if the bot supports inline queries. Returned only in getMe // (https://core.telegram.org/bots/api#getme). SupportsInlineQueries bool `json:"supports_inline_queries,omitempty"` }
User - This object represents a Telegram user or bot.
type UserProfilePhotos ¶
type UserProfilePhotos struct { // TotalCount - Total number of profile pictures the target user has TotalCount int `json:"total_count"` // Photos - Requested profile pictures (in up to 4 sizes each) Photos [][]PhotoSize `json:"photos"` }
UserProfilePhotos - This object represent a user's profile pictures.
type Venue ¶
type Venue struct { // Location - Venue location. Can't be a live location Location Location `json:"location"` // Title - Name of the venue Title string `json:"title"` // Address - Address of the venue Address string `json:"address"` // FoursquareID - Optional. Foursquare identifier of the venue FoursquareID string `json:"foursquare_id,omitempty"` // FoursquareType - Optional. Foursquare type of the venue. (For example, “arts_entertainment/default”, // “arts_entertainment/aquarium” or “food/icecream”.) FoursquareType string `json:"foursquare_type,omitempty"` // GooglePlaceID - Optional. Google Places identifier of the venue GooglePlaceID string `json:"google_place_id,omitempty"` // GooglePlaceType - Optional. Google Places type of the venue. (See supported types // (https://developers.google.com/places/web-service/supported_types).) GooglePlaceType string `json:"google_place_type,omitempty"` }
Venue - This object represents a venue.
type Video ¶
type Video struct { // FileID - Identifier for this file, which can be used to download or reuse the file FileID string `json:"file_id"` // FileUniqueID - 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"` // Width - Video width as defined by sender Width int `json:"width"` // Height - Video height as defined by sender Height int `json:"height"` // Duration - Duration of the video in seconds as defined by sender Duration int `json:"duration"` // Thumb - Optional. Video thumbnail Thumb *PhotoSize `json:"thumb,omitempty"` // FileName - Optional. Original filename as defined by sender FileName string `json:"file_name,omitempty"` // MimeType - Optional. Mime type of a file as defined by sender MimeType string `json:"mime_type,omitempty"` // FileSize - Optional. File size FileSize int `json:"file_size,omitempty"` }
Video - This object represents a video file.
type VideoNote ¶
type VideoNote struct { // FileID - Identifier for this file, which can be used to download or reuse the file FileID string `json:"file_id"` // FileUniqueID - 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"` // Length - Video width and height (diameter of the video message) as defined by sender Length int `json:"length"` // Duration - Duration of the video in seconds as defined by sender Duration int `json:"duration"` // Thumb - Optional. Video thumbnail Thumb *PhotoSize `json:"thumb,omitempty"` // FileSize - Optional. File size FileSize int `json:"file_size,omitempty"` }
VideoNote - This object represents a video message (https://telegram.org/blog/video-messages-and-telescope) (available in Telegram apps as of v.4.0 (https://telegram.org/blog/video-messages-and-telescope)).
type Voice ¶
type Voice struct { // FileID - Identifier for this file, which can be used to download or reuse the file FileID string `json:"file_id"` // FileUniqueID - 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 - Duration of the audio in seconds as defined by sender Duration int `json:"duration"` // MimeType - Optional. MIME type of the file as defined by sender MimeType string `json:"mime_type,omitempty"` // FileSize - Optional. File size FileSize int `json:"file_size,omitempty"` }
Voice - This object represents a voice note.
type VoiceChatEnded ¶
type VoiceChatEnded struct { // Duration - Voice chat duration; in seconds Duration int `json:"duration"` }
VoiceChatEnded - This object represents a service message about a voice chat ended in the chat.
type VoiceChatParticipantsInvited ¶
type VoiceChatParticipantsInvited struct { // Users - Optional. New members that were invited to the voice chat Users []User `json:"users,omitempty"` }
VoiceChatParticipantsInvited - This object represents a service message about new members invited to a voice chat.
type VoiceChatScheduled ¶
type VoiceChatScheduled struct { // StartDate - Point in time (Unix timestamp) when the voice chat is supposed to be started by a chat // administrator StartDate int64 `json:"start_date"` }
VoiceChatScheduled - This object represents a service message about a voice chat scheduled in the chat.
type VoiceChatStarted ¶
type VoiceChatStarted struct{}
VoiceChatStarted - This object represents a service message about a voice chat started in the chat. Currently holds no information.
type WebhookInfo ¶
type WebhookInfo struct { // URL - Webhook URL, may be empty if webhook is not set up URL string `json:"url"` // HasCustomCertificate - True, if a custom certificate was provided for webhook certificate checks HasCustomCertificate bool `json:"has_custom_certificate"` // PendingUpdateCount - Number of updates awaiting delivery PendingUpdateCount int `json:"pending_update_count"` // IPAddress - Optional. Currently used webhook IP address IPAddress string `json:"ip_address,omitempty"` // LastErrorDate - Optional. Unix time for the most recent error that happened when trying to deliver an // update via webhook LastErrorDate int64 `json:"last_error_date,omitempty"` // LastErrorMessage - 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"` // MaxConnections - Optional. Maximum allowed number of simultaneous HTTPS connections to the webhook for // update delivery MaxConnections int `json:"max_connections,omitempty"` // AllowedUpdates - 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"` }
WebhookInfo - Contains information about the current status of a webhook.