Documentation ¶
Overview ¶
Package tgbotapi has functions and types used for interacting with the Telegram Bot API.
Index ¶
- Constants
- func EscapeText(parseMode string, text string) string
- func SetLogger(logger BotLogger) error
- func ValidateWebAppData(token, telegramInitData string) (bool, error)
- func WriteToHTTPResponse(w http.ResponseWriter, c Chattable) error
- type APIResponse
- type AddStickerConfig
- type Animation
- type AnimationConfig
- type AnswerWebAppQueryConfig
- type ApproveChatJoinRequestConfig
- type Audio
- type AudioConfig
- type BanChatMemberConfig
- type BanChatSenderChatConfig
- type BaseChat
- type BaseChatMessage
- type BaseChatMessages
- type BaseEdit
- type BaseFile
- type BaseForum
- type BaseInputMedia
- type BaseSpoiler
- type BotAPI
- func (bot *BotAPI) AnswerWebAppQuery(config AnswerWebAppQueryConfig) (SentWebAppMessage, error)
- func (bot *BotAPI) CopyMessage(config CopyMessageConfig) (MessageID, error)
- func (bot *BotAPI) GetChat(config ChatInfoConfig) (Chat, error)
- func (bot *BotAPI) GetChatAdministrators(config ChatAdministratorsConfig) ([]ChatMember, error)
- func (bot *BotAPI) GetChatMember(config GetChatMemberConfig) (ChatMember, error)
- func (bot *BotAPI) GetChatMembersCount(config ChatMemberCountConfig) (int, error)
- func (bot *BotAPI) GetFile(config FileConfig) (File, error)
- func (bot *BotAPI) GetFileDirectURL(fileID string) (string, error)
- func (bot *BotAPI) GetGameHighScores(config GetGameHighScoresConfig) ([]GameHighScore, error)
- func (bot *BotAPI) GetInviteLink(config ChatInviteLinkConfig) (string, error)
- func (bot *BotAPI) GetMe() (User, error)
- func (bot *BotAPI) GetMyCommands() ([]BotCommand, error)
- func (bot *BotAPI) GetMyCommandsWithConfig(config GetMyCommandsConfig) ([]BotCommand, error)
- func (bot *BotAPI) GetMyDefaultAdministratorRights(config GetMyDefaultAdministratorRightsConfig) (ChatAdministratorRights, error)
- func (bot *BotAPI) GetStickerSet(config GetStickerSetConfig) (StickerSet, error)
- func (bot *BotAPI) GetUpdates(config UpdateConfig) ([]Update, error)
- func (bot *BotAPI) GetUpdatesChan(config UpdateConfig) UpdatesChannel
- func (bot *BotAPI) GetUserProfilePhotos(config UserProfilePhotosConfig) (UserProfilePhotos, error)
- func (bot *BotAPI) GetWebhookInfo() (WebhookInfo, error)
- func (bot *BotAPI) HandleUpdate(r *http.Request) (*Update, error)
- func (bot *BotAPI) IsMessageToMe(message Message) bool
- func (bot *BotAPI) ListenForWebhook(pattern string) UpdatesChannel
- func (bot *BotAPI) ListenForWebhookRespReqFormat(w http.ResponseWriter, r *http.Request) UpdatesChannel
- func (bot *BotAPI) MakeRequest(endpoint string, params Params) (*APIResponse, error)
- func (bot *BotAPI) Request(c Chattable) (*APIResponse, error)
- func (bot *BotAPI) Send(c Chattable) (Message, error)
- func (bot *BotAPI) SendMediaGroup(config MediaGroupConfig) ([]Message, error)
- func (bot *BotAPI) SetAPIEndpoint(apiEndpoint string)
- func (bot *BotAPI) StopPoll(config StopPollConfig) (Poll, error)
- func (bot *BotAPI) StopReceivingUpdates()
- func (bot *BotAPI) UploadFiles(endpoint string, params Params, files []RequestFile) (*APIResponse, error)
- type BotCommand
- type BotCommandScope
- func NewBotCommandScopeAllChatAdministrators() BotCommandScope
- func NewBotCommandScopeAllGroupChats() BotCommandScope
- func NewBotCommandScopeAllPrivateChats() BotCommandScope
- func NewBotCommandScopeChat(chatID int64) BotCommandScope
- func NewBotCommandScopeChatAdministrators(chatID int64) BotCommandScope
- func NewBotCommandScopeChatMember(chatID, userID int64) BotCommandScope
- func NewBotCommandScopeDefault() BotCommandScope
- type BotDescription
- type BotLogger
- type BotName
- type BotShortDescription
- type CallbackConfig
- type CallbackGame
- type CallbackQuery
- type Chat
- type ChatActionConfig
- type ChatAdministratorRights
- type ChatAdministratorsConfig
- type ChatBoost
- type ChatBoostRemoved
- type ChatBoostSource
- type ChatBoostUpdated
- type ChatConfig
- type ChatConfigWithUser
- type ChatInfoConfig
- type ChatInviteLink
- type ChatInviteLinkConfig
- type ChatJoinRequest
- type ChatLocation
- type ChatMember
- type ChatMemberConfig
- type ChatMemberCountConfig
- type ChatMemberUpdated
- type ChatPermissions
- type ChatPhoto
- type ChatShared
- type Chattable
- type ChosenInlineResult
- type CloseConfig
- type CloseForumTopicConfig
- type CloseGeneralForumTopicConfig
- type Contact
- type ContactConfig
- type CopyMessageConfig
- type CopyMessagesConfig
- type CreateChatInviteLinkConfig
- type CreateForumTopicConfig
- type Credentials
- type DataCredentials
- type DeclineChatJoinRequest
- type DeleteChatPhotoConfig
- type DeleteChatStickerSetConfig
- type DeleteForumTopicConfig
- type DeleteMessageConfig
- type DeleteMessagesConfig
- type DeleteMyCommandsConfig
- type DeleteStickerConfig
- type DeleteStickerSetConfig
- type DeleteWebhookConfig
- type Dice
- type DiceConfig
- type Document
- type DocumentConfig
- type EditChatInviteLinkConfig
- type EditForumTopicConfig
- type EditGeneralForumTopicConfig
- type EditMessageCaptionConfig
- type EditMessageLiveLocationConfig
- type EditMessageMediaConfig
- type EditMessageReplyMarkupConfig
- type EditMessageTextConfig
- type EncryptedCredentials
- type EncryptedPassportElement
- type Error
- type ExternalReplyInfo
- type File
- type FileBytes
- type FileConfig
- type FileCredentials
- type FileID
- type FilePath
- type FileReader
- type FileURL
- type Fileable
- type ForceReply
- type ForumTopic
- type ForumTopicClosed
- type ForumTopicCreated
- type ForumTopicEdited
- type ForumTopicReopened
- type ForwardConfig
- type ForwardMessagesConfig
- type Game
- type GameConfig
- type GameHighScore
- type GeneralForumTopicHidden
- type GeneralForumTopicUnhidden
- type GetChatMemberConfig
- type GetChatMenuButtonConfig
- type GetCustomEmojiStickersConfig
- type GetForumTopicIconStickersConfig
- type GetGameHighScoresConfig
- type GetMyCommandsConfig
- type GetMyDefaultAdministratorRightsConfig
- type GetMyDescriptionConfig
- type GetMyNameConfig
- type GetMyShortDescriptionConfig
- type GetStickerSetConfig
- type GetUserChatBoostsConfig
- type Giveaway
- type GiveawayCompleted
- type GiveawayCreated
- type GiveawayWinners
- type HTTPClient
- type HideGeneralForumTopicConfig
- type IDDocumentData
- type InaccessibleMessage
- type InlineConfig
- type InlineKeyboardButton
- func NewInlineKeyboardButtonData(text, data string) InlineKeyboardButton
- func NewInlineKeyboardButtonLoginURL(text string, loginURL LoginURL) InlineKeyboardButton
- func NewInlineKeyboardButtonSwitch(text, sw string) InlineKeyboardButton
- func NewInlineKeyboardButtonSwitchInlineQueryChoosenChat(text string, switchInlineQueryChosenChat SwitchInlineQueryChosenChat) InlineKeyboardButton
- func NewInlineKeyboardButtonURL(text, url string) InlineKeyboardButton
- func NewInlineKeyboardButtonWebApp(text string, webapp WebAppInfo) InlineKeyboardButton
- func NewInlineKeyboardRow(buttons ...InlineKeyboardButton) []InlineKeyboardButton
- type InlineKeyboardMarkup
- type InlineQuery
- type InlineQueryResultArticle
- func NewInlineQueryResultArticle(id, title, messageText string) InlineQueryResultArticle
- func NewInlineQueryResultArticleHTML(id, title, messageText string) InlineQueryResultArticle
- func NewInlineQueryResultArticleMarkdown(id, title, messageText string) InlineQueryResultArticle
- func NewInlineQueryResultArticleMarkdownV2(id, title, messageText string) InlineQueryResultArticle
- type InlineQueryResultAudio
- type InlineQueryResultCachedAudio
- type InlineQueryResultCachedDocument
- type InlineQueryResultCachedGIF
- type InlineQueryResultCachedMPEG4GIF
- type InlineQueryResultCachedPhoto
- type InlineQueryResultCachedSticker
- type InlineQueryResultCachedVideo
- type InlineQueryResultCachedVoice
- type InlineQueryResultContact
- type InlineQueryResultDocument
- type InlineQueryResultGIF
- type InlineQueryResultGame
- type InlineQueryResultLocation
- type InlineQueryResultMPEG4GIF
- type InlineQueryResultPhoto
- type InlineQueryResultVenue
- type InlineQueryResultVideo
- type InlineQueryResultVoice
- type InlineQueryResultsButton
- type InputContactMessageContent
- type InputInvoiceMessageContent
- type InputLocationMessageContent
- type InputMediaAnimation
- type InputMediaAudio
- type InputMediaDocument
- type InputMediaPhoto
- type InputMediaVideo
- type InputSticker
- type InputTextMessageContent
- type InputVenueMessageContent
- type Invoice
- type InvoiceConfig
- type InvoiceLinkConfig
- type KeyboardButton
- func NewKeyboardButton(text string) KeyboardButton
- func NewKeyboardButtonContact(text string) KeyboardButton
- func NewKeyboardButtonLocation(text string) KeyboardButton
- func NewKeyboardButtonRow(buttons ...KeyboardButton) []KeyboardButton
- func NewKeyboardButtonWebApp(text string, webapp WebAppInfo) KeyboardButton
- type KeyboardButtonPollType
- type KeyboardButtonRequestChat
- type KeyboardButtonRequestUsers
- type KickChatMemberConfig
- type LabeledPrice
- type LeaveChatConfig
- type LinkPreviewOptions
- type Location
- type LocationConfig
- type LogOutConfig
- type LoginURL
- type MaskPosition
- type MediaGroupConfig
- type MenuButton
- type Message
- type MessageAutoDeleteTimerChanged
- type MessageConfig
- type MessageEntity
- func (e MessageEntity) IsBold() bool
- func (e MessageEntity) IsCode() bool
- func (e MessageEntity) IsCommand() bool
- func (e MessageEntity) IsEmail() bool
- func (e MessageEntity) IsHashtag() bool
- func (e MessageEntity) IsItalic() bool
- func (e MessageEntity) IsMention() bool
- func (e MessageEntity) IsPre() bool
- func (e MessageEntity) IsTextLink() bool
- func (e MessageEntity) IsTextMention() bool
- func (e MessageEntity) IsURL() bool
- func (e MessageEntity) ParseURL() (*url.URL, error)
- type MessageID
- type MessageOrigin
- type MessageReactionCountUpdated
- type MessageReactionUpdated
- type NewStickerSetConfig
- type OrderInfo
- type Params
- func (p Params) AddBool(key string, value bool)
- func (p Params) AddFirstValid(key string, args ...interface{}) error
- func (p Params) AddInterface(key string, value interface{}) error
- func (p Params) AddNonEmpty(key, value string)
- func (p Params) AddNonZero(key string, value int)
- func (p Params) AddNonZero64(key string, value int64)
- func (p Params) AddNonZeroFloat(key string, value float64)
- func (p *Params) Merge(p1 Params)
- type PassportData
- type PassportElementError
- type PassportElementErrorDataField
- type PassportElementErrorFile
- type PassportElementErrorFiles
- type PassportElementErrorFrontSide
- type PassportElementErrorReverseSide
- type PassportElementErrorSelfie
- type PassportFile
- type PassportRequestInfoConfig
- type PassportScope
- type PassportScopeElement
- type PassportScopeElementOne
- type PassportScopeElementOneOfSeveral
- type PersonalDetails
- type PhotoConfig
- type PhotoSize
- type PinChatMessageConfig
- type Poll
- type PollAnswer
- type PollOption
- type PreCheckoutConfig
- type PreCheckoutQuery
- type PromoteChatMemberConfig
- type ProximityAlertTriggered
- type ReactionCount
- type ReactionType
- type ReopenForumTopicConfig
- type ReopenGeneralForumTopicConfig
- type ReplyKeyboardMarkup
- type ReplyKeyboardRemove
- type ReplyParameters
- type RequestFile
- type RequestFileData
- type ResponseParameters
- type RestrictChatMemberConfig
- type RevokeChatInviteLinkConfig
- type SecureData
- type SecureValue
- type SendPollConfig
- type SentWebAppMessage
- type SetChatAdministratorCustomTitle
- type SetChatDescriptionConfig
- type SetChatMenuButtonConfig
- type SetChatPermissionsConfig
- type SetChatPhotoConfig
- type SetChatStickerSetConfig
- type SetChatTitleConfig
- type SetCustomEmojiStickerSetThumbnailConfig
- type SetGameScoreConfig
- type SetMessageReactionConfig
- type SetMyCommandsConfig
- type SetMyDefaultAdministratorRightsConfig
- type SetMyDescriptionConfig
- type SetMyNameConfig
- type SetMyShortDescriptionConfig
- type SetStickerEmojiListConfig
- type SetStickerKeywordsConfig
- type SetStickerMaskPositionConfig
- type SetStickerPositionConfig
- type SetStickerSetThumbConfig
- type SetStickerSetTitleConfig
- type ShippingAddress
- type ShippingConfig
- type ShippingOption
- type ShippingQuery
- type Sticker
- type StickerConfig
- type StickerSet
- type StopMessageLiveLocationConfig
- type StopPollConfig
- type Story
- type SuccessfulPayment
- type SwitchInlineQueryChosenChat
- type TextQuote
- type UnbanChatMemberConfig
- type UnbanChatSenderChatConfig
- type UnhideGeneralForumTopicConfig
- type UnpinAllChatMessagesConfig
- type UnpinAllForumTopicMessagesConfig
- type UnpinAllGeneralForumTopicMessagesConfig
- type UnpinChatMessageConfig
- type Update
- type UpdateConfig
- type UpdatesChannel
- type UploadStickerConfig
- type User
- type UserChatBoosts
- type UserProfilePhotos
- type UserProfilePhotosConfig
- type UsersShared
- type Venue
- type VenueConfig
- type Video
- type VideoChatEnded
- type VideoChatParticipantsInvited
- type VideoChatScheduled
- type VideoChatStarted
- type VideoConfig
- type VideoNote
- type VideoNoteConfig
- type Voice
- type VoiceConfig
- type WebAppData
- type WebAppInfo
- type WebhookConfig
- type WebhookInfo
- type WriteAccessAllowed
Examples ¶
Constants ¶
const ( // APIEndpoint is the endpoint for all API methods, // with formatting for Sprintf. APIEndpoint = "https://api.telegram.org/bot%s/%s" // FileEndpoint is the endpoint for downloading a file from Telegram. FileEndpoint = "https://api.telegram.org/file/bot%s/%s" )
Telegram constants
const ( ChatTyping = "typing" ChatUploadPhoto = "upload_photo" ChatRecordVideo = "record_video" ChatUploadVideo = "upload_video" ChatRecordVoice = "record_voice" ChatUploadVoice = "upload_voice" ChatUploadDocument = "upload_document" ChatChooseSticker = "choose_sticker" ChatFindLocation = "find_location" ChatRecordVideoNote = "record_video_note" ChatUploadVideoNote = "upload_video_note" )
Constant values for ChatActions
const ( ModeMarkdown = "Markdown" ModeMarkdownV2 = "MarkdownV2" ModeHTML = "HTML" )
Constant values for ParseMode in MessageConfig
const ( // UpdateTypeMessage is new incoming message of any kind — text, photo, sticker, etc. UpdateTypeMessage = "message" // UpdateTypeEditedMessage is new version of a message that is known to the bot and was edited UpdateTypeEditedMessage = "edited_message" // UpdateTypeChannelPost is new incoming channel post of any kind — text, photo, sticker, etc. UpdateTypeChannelPost = "channel_post" // UpdateTypeEditedChannelPost is new version of a channel post that is known to the bot and was edited UpdateTypeEditedChannelPost = "edited_channel_post" // UpdateTypeMessageReactionis is a reaction to a message was changed by a user UpdateTypeMessageReaction = "message_reaction" // UpdateTypeMessageReactionCount are reactions to a message with anonymous reactions were changed UpdateTypeMessageReactionCount = "message_reaction_count" // UpdateTypeInlineQuery is new incoming inline query UpdateTypeInlineQuery = "inline_query" // UpdateTypeChosenInlineResult i the result of an inline query that was chosen by a user and sent to their // chat partner. Please see the documentation on the feedback collecting for // details on how to enable these updates for your bot. UpdateTypeChosenInlineResult = "chosen_inline_result" // UpdateTypeCallbackQuery is new incoming callback query UpdateTypeCallbackQuery = "callback_query" // UpdateTypeShippingQuery is new incoming shipping query. Only for invoices with flexible price UpdateTypeShippingQuery = "shipping_query" // UpdateTypePreCheckoutQuery is new incoming pre-checkout query. Contains full information about checkout UpdateTypePreCheckoutQuery = "pre_checkout_query" // UpdateTypePoll is new poll state. Bots receive only updates about stopped polls and polls // which are sent by the bot UpdateTypePoll = "poll" // UpdateTypePollAnswer is when user changed their answer in a non-anonymous poll. Bots receive new votes // only in polls that were sent by the bot itself. UpdateTypePollAnswer = "poll_answer" // UpdateTypeMyChatMember is when 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. UpdateTypeMyChatMember = "my_chat_member" // UpdateTypeChatMember is when the bot must be an administrator in the chat and must explicitly specify // this update in the list of allowed_updates to receive these updates. UpdateTypeChatMember = "chat_member" // UpdateTypeChatJoinRequest is request to join the chat has been sent. // The bot must have the can_invite_users administrator right in the chat to receive these updates. UpdateTypeChatJoinRequest = "chat_join_request" // UpdateTypeChatBoost is chat boost was added or changed. // The bot must be an administrator in the chat to receive these updates. UpdateTypeChatBoost = "chat_boost" // UpdateTypeRemovedChatBoost is boost was removed from a chat. // The bot must be an administrator in the chat to receive these updates. UpdateTypeRemovedChatBoost = "removed_chat_boost" )
Constant values for update types
const ( MessageOriginUser = "user" MessageOriginHiddenUser = "hidden_user" MessageOriginChat = "chat" MessageOriginChannel = "channel" )
const ( ReactionTypeEmoji = "emoji" ReactionTypeCustomEmoji = "custom_emoji" )
const ( ChatBoostSourcePremium = "premium" ChatBoostSourceGiftCode = "gift_code" ChatBoostSourceGiveaway = "giveaway" )
const ( StickerTypeRegular = "regular" StickerTypeMask = "mask" StickerTypeCustomEmoji = "custom_emoji" )
Constant values for sticker types
const (
// ErrAPIForbidden happens when a token is bad
ErrAPIForbidden = "forbidden"
)
API errors
const (
ErrBadURL = "bad or empty url"
)
Library errors
Variables ¶
This section is empty.
Functions ¶
func EscapeText ¶
EscapeText takes an input text and escape Telegram markup symbols. In this way we can send a text without being afraid of having to escape the characters manually. Note that you don't have to include the formatting style in the input text, or it will be escaped too. If there is an error, an empty string will be returned.
parseMode is the text formatting mode (ModeMarkdown, ModeMarkdownV2 or ModeHTML) text is the input string that will be escaped
func ValidateWebAppData ¶
ValidateWebAppData validate data received via the Web App https://core.telegram.org/bots/webapps#validating-data-received-via-the-web-app
func WriteToHTTPResponse ¶
func WriteToHTTPResponse(w http.ResponseWriter, c Chattable) error
WriteToHTTPResponse writes the request to the HTTP ResponseWriter.
It doesn't support uploading files.
See https://core.telegram.org/bots/api#making-requests-when-getting-updates for details.
Types ¶
type APIResponse ¶
type APIResponse struct { Ok bool `json:"ok"` Result json.RawMessage `json:"result,omitempty"` ErrorCode int `json:"error_code,omitempty"` Description string `json:"description,omitempty"` Parameters *ResponseParameters `json:"parameters,omitempty"` }
APIResponse is a response from the Telegram API with the result stored raw.
type AddStickerConfig ¶
type AddStickerConfig struct { UserID int64 Name string Sticker InputSticker }
AddStickerConfig allows you to add a sticker to a set.
type Animation ¶
type Animation struct { // FileID is the identifier for this file, which can be used to download or reuse // the file FileID string `json:"file_id"` // FileUniqueID is the 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 of the video in seconds as defined by sender Duration int `json:"duration"` // Thumbnail animation thumbnail as defined by sender // // optional Thumbnail *PhotoSize `json:"thumbnail,omitempty"` // FileName original animation filename as defined by sender // // optional FileName string `json:"file_name,omitempty"` // MimeType of the file as defined by sender // // optional MimeType string `json:"mime_type,omitempty"` // FileSize file size // // optional FileSize int64 `json:"file_size,omitempty"` }
Animation represents an animation file.
type AnimationConfig ¶
type AnimationConfig struct { BaseFile BaseSpoiler Duration int Thumb RequestFileData Caption string ParseMode string CaptionEntities []MessageEntity }
AnimationConfig contains information about a SendAnimation request.
func NewAnimation ¶
func NewAnimation(chatID int64, file RequestFileData) AnimationConfig
NewAnimation creates a new sendAnimation request.
type AnswerWebAppQueryConfig ¶
type AnswerWebAppQueryConfig struct { // WebAppQueryID is the unique identifier for the query to be answered. WebAppQueryID string `json:"web_app_query_id"` // Result is an InlineQueryResult object describing the message to be sent. Result interface{} `json:"result"` }
AnswerWebAppQueryConfig is used to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated.
type ApproveChatJoinRequestConfig ¶
type ApproveChatJoinRequestConfig struct { ChatConfig UserID int64 }
ApproveChatJoinRequestConfig allows you to approve a chat join request.
type Audio ¶
type Audio struct { // FileID is an identifier for this file, which can be used to download or // reuse the file FileID string `json:"file_id"` // FileUniqueID is the unique identifier for this file, which is supposed to // be the same over time and for different bots. Can't be used to download // or reuse the file. FileUniqueID string `json:"file_unique_id"` // Duration of the audio in seconds as defined by sender Duration int `json:"duration"` // Performer of the audio as defined by sender or by audio tags // // optional Performer string `json:"performer,omitempty"` // Title of the audio as defined by sender or by audio tags // // optional Title string `json:"title,omitempty"` // FileName is the original filename as defined by sender // // optional FileName string `json:"file_name,omitempty"` // MimeType of the file as defined by sender // // optional MimeType string `json:"mime_type,omitempty"` // FileSize file size // // optional FileSize int64 `json:"file_size,omitempty"` // Thumbnail is the album cover to which the music file belongs // // optional Thumbnail *PhotoSize `json:"thumbnail,omitempty"` }
Audio represents an audio file to be treated as music by the Telegram clients.
type AudioConfig ¶
type AudioConfig struct { BaseFile Thumb RequestFileData Caption string ParseMode string CaptionEntities []MessageEntity Duration int Performer string Title string }
AudioConfig contains information about a SendAudio request.
func NewAudio ¶
func NewAudio(chatID int64, file RequestFileData) AudioConfig
NewAudio creates a new sendAudio request.
type BanChatMemberConfig ¶
type BanChatMemberConfig struct { ChatMemberConfig UntilDate int64 RevokeMessages bool }
BanChatMemberConfig contains extra fields to kick user.
type BanChatSenderChatConfig ¶
type BanChatSenderChatConfig struct { ChatConfig SenderChatID int64 UntilDate int }
BanChatSenderChatConfig bans a channel chat in a supergroup or a channel. The owner of the chat will not be able to send messages and join live streams on behalf of the chat, unless it is unbanned first. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights.
type BaseChat ¶
type BaseChat struct { ChatConfig MessageThreadID int ProtectContent bool ReplyMarkup interface{} DisableNotification bool ReplyParameters ReplyParameters }
BaseChat is base type for all chat config types.
type BaseChatMessage ¶
type BaseChatMessage struct { ChatConfig MessageID int }
BaseChatMessage is a base type for all messages in chats.
type BaseChatMessages ¶
type BaseChatMessages struct { ChatConfig MessageIDs []int }
BaseChatMessages is a base type for all messages in chats.
type BaseEdit ¶
type BaseEdit struct { BaseChatMessage InlineMessageID string ReplyMarkup *InlineKeyboardMarkup }
BaseEdit is base type of all chat edits.
type BaseFile ¶
type BaseFile struct { BaseChat File RequestFileData }
BaseFile is a base type for all file config types.
type BaseForum ¶
type BaseForum struct { ChatConfig MessageThreadID int }
type BaseInputMedia ¶
type BaseInputMedia struct { // Type of the result. 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. Media RequestFileData `json:"media"` // Caption of the video to be sent, 0-1024 characters after entities parsing. // // optional Caption string `json:"caption,omitempty"` // ParseMode mode for parsing entities in the video caption. // See formatting options for more details // (https://core.telegram.org/bots/api#formatting-options). // // optional ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities is a list of special entities that appear in the caption, // which can be specified instead of parse_mode // // optional CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // HasSpoiler pass True, if the photo needs to be covered with a spoiler animation // // optional HasSpoiler bool `json:"has_spoiler,omitempty"` }
BaseInputMedia is a base type for the InputMedia types.
type BaseSpoiler ¶
type BaseSpoiler struct {
HasSpoiler bool
}
BaseSpoiler is base type of structures with spoilers.
type BotAPI ¶
type BotAPI struct { Token string `json:"token"` Debug bool `json:"debug"` Buffer int `json:"buffer"` Self User `json:"-"` Client HTTPClient `json:"-"` // contains filtered or unexported fields }
BotAPI allows you to interact with the Telegram Bot API.
func NewBotAPI ¶
NewBotAPI creates a new BotAPI instance.
It requires a token, provided by @BotFather on Telegram.
Example ¶
bot, err := NewBotAPI("MyAwesomeBotToken") if err != nil { panic(err) } bot.Debug = true log.Printf("Authorized on account %s", bot.Self.UserName) u := NewUpdate(0) u.Timeout = 60 updates := bot.GetUpdatesChan(u) // Optional: wait for updates and clear them if you don't want to handle // a large backlog of old messages time.Sleep(time.Millisecond * 500) updates.Clear() for update := range updates { if update.Message == nil { continue } log.Printf("[%s] %s", update.Message.From.UserName, update.Message.Text) msg := NewMessage(update.Message.Chat.ID, update.Message.Text) msg.ReplyParameters.MessageID = update.Message.MessageID bot.Send(msg) }
Output:
func NewBotAPIWithAPIEndpoint ¶
NewBotAPIWithAPIEndpoint creates a new BotAPI instance and allows you to pass API endpoint.
It requires a token, provided by @BotFather on Telegram and API endpoint.
func NewBotAPIWithClient ¶
func NewBotAPIWithClient(token, apiEndpoint string, client HTTPClient) (*BotAPI, error)
NewBotAPIWithClient creates a new BotAPI instance and allows you to pass a http.Client.
It requires a token, provided by @BotFather on Telegram and API endpoint.
func (*BotAPI) AnswerWebAppQuery ¶
func (bot *BotAPI) AnswerWebAppQuery(config AnswerWebAppQueryConfig) (SentWebAppMessage, error)
AnswerWebAppQuery sets the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated.
func (*BotAPI) CopyMessage ¶
func (bot *BotAPI) CopyMessage(config CopyMessageConfig) (MessageID, error)
CopyMessage copy messages of any kind. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageID of the sent message on success.
func (*BotAPI) GetChat ¶
func (bot *BotAPI) GetChat(config ChatInfoConfig) (Chat, error)
GetChat gets information about a chat.
func (*BotAPI) GetChatAdministrators ¶
func (bot *BotAPI) GetChatAdministrators(config ChatAdministratorsConfig) ([]ChatMember, error)
GetChatAdministrators gets a list of administrators in the chat.
If none have been appointed, only the creator will be returned. Bots are not shown, even if they are an administrator.
func (*BotAPI) GetChatMember ¶
func (bot *BotAPI) GetChatMember(config GetChatMemberConfig) (ChatMember, error)
GetChatMember gets a specific chat member.
func (*BotAPI) GetChatMembersCount ¶
func (bot *BotAPI) GetChatMembersCount(config ChatMemberCountConfig) (int, error)
GetChatMembersCount gets the number of users in a chat.
func (*BotAPI) GetFile ¶
func (bot *BotAPI) GetFile(config FileConfig) (File, error)
GetFile returns a File which can download a file from Telegram.
Requires FileID.
func (*BotAPI) GetFileDirectURL ¶
GetFileDirectURL returns direct URL to file
It requires the FileID.
func (*BotAPI) GetGameHighScores ¶
func (bot *BotAPI) GetGameHighScores(config GetGameHighScoresConfig) ([]GameHighScore, error)
GetGameHighScores allows you to get the high scores for a game.
func (*BotAPI) GetInviteLink ¶
func (bot *BotAPI) GetInviteLink(config ChatInviteLinkConfig) (string, error)
GetInviteLink get InviteLink for a chat
func (*BotAPI) GetMe ¶
GetMe fetches the currently authenticated bot.
This method is called upon creation to validate the token, and so you may get this data from BotAPI.Self without the need for another request.
func (*BotAPI) GetMyCommands ¶
func (bot *BotAPI) GetMyCommands() ([]BotCommand, error)
GetMyCommands gets the currently registered commands.
func (*BotAPI) GetMyCommandsWithConfig ¶
func (bot *BotAPI) GetMyCommandsWithConfig(config GetMyCommandsConfig) ([]BotCommand, error)
GetMyCommandsWithConfig gets the currently registered commands with a config.
func (*BotAPI) GetMyDefaultAdministratorRights ¶
func (bot *BotAPI) GetMyDefaultAdministratorRights(config GetMyDefaultAdministratorRightsConfig) (ChatAdministratorRights, error)
GetMyDefaultAdministratorRights gets the current default administrator rights of the bot.
func (*BotAPI) GetStickerSet ¶
func (bot *BotAPI) GetStickerSet(config GetStickerSetConfig) (StickerSet, error)
GetStickerSet returns a StickerSet.
func (*BotAPI) GetUpdates ¶
func (bot *BotAPI) GetUpdates(config UpdateConfig) ([]Update, error)
GetUpdates fetches updates. If a WebHook is set, this will not return any data!
Offset, Limit, Timeout, and AllowedUpdates are optional. To avoid stale items, set Offset to one higher than the previous item. Set Timeout to a large number to reduce requests, so you can get updates instantly instead of having to wait between requests.
func (*BotAPI) GetUpdatesChan ¶
func (bot *BotAPI) GetUpdatesChan(config UpdateConfig) UpdatesChannel
GetUpdatesChan starts and returns a channel for getting updates.
func (*BotAPI) GetUserProfilePhotos ¶
func (bot *BotAPI) GetUserProfilePhotos(config UserProfilePhotosConfig) (UserProfilePhotos, error)
GetUserProfilePhotos gets a user's profile photos.
It requires UserID. Offset and Limit are optional.
func (*BotAPI) GetWebhookInfo ¶
func (bot *BotAPI) GetWebhookInfo() (WebhookInfo, error)
GetWebhookInfo allows you to fetch information about a webhook and if one currently is set, along with pending update count and error messages.
func (*BotAPI) HandleUpdate ¶
HandleUpdate parses and returns update received via webhook
func (*BotAPI) IsMessageToMe ¶
IsMessageToMe returns true if message directed to this bot.
It requires the Message.
func (*BotAPI) ListenForWebhook ¶
func (bot *BotAPI) ListenForWebhook(pattern string) UpdatesChannel
ListenForWebhook registers a http handler for a webhook.
func (*BotAPI) ListenForWebhookRespReqFormat ¶
func (bot *BotAPI) ListenForWebhookRespReqFormat(w http.ResponseWriter, r *http.Request) UpdatesChannel
ListenForWebhookRespReqFormat registers a http handler for a single incoming webhook.
func (*BotAPI) MakeRequest ¶
func (bot *BotAPI) MakeRequest(endpoint string, params Params) (*APIResponse, error)
MakeRequest makes a request to a specific endpoint with our token.
func (*BotAPI) Request ¶
func (bot *BotAPI) Request(c Chattable) (*APIResponse, error)
Request sends a Chattable to Telegram, and returns the APIResponse.
func (*BotAPI) Send ¶
Send will send a Chattable item to Telegram and provides the returned Message.
func (*BotAPI) SendMediaGroup ¶
func (bot *BotAPI) SendMediaGroup(config MediaGroupConfig) ([]Message, error)
SendMediaGroup sends a media group and returns the resulting messages.
func (*BotAPI) SetAPIEndpoint ¶
SetAPIEndpoint changes the Telegram Bot API endpoint used by the instance.
func (*BotAPI) StopPoll ¶
func (bot *BotAPI) StopPoll(config StopPollConfig) (Poll, error)
StopPoll stops a poll and returns the result.
func (*BotAPI) StopReceivingUpdates ¶
func (bot *BotAPI) StopReceivingUpdates()
StopReceivingUpdates stops the go routine which receives updates
func (*BotAPI) UploadFiles ¶
func (bot *BotAPI) UploadFiles(endpoint string, params Params, files []RequestFile) (*APIResponse, error)
UploadFiles makes a request to the API with files.
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 of the command, 3-256 characters. Description string `json:"description"` }
BotCommand represents a bot command.
type BotCommandScope ¶
type BotCommandScope struct { Type string `json:"type"` ChatID int64 `json:"chat_id,omitempty"` UserID int64 `json:"user_id,omitempty"` }
BotCommandScope represents the scope to which bot commands are applied.
It contains the fields for all types of scopes, different types only support specific (or no) fields.
func NewBotCommandScopeAllChatAdministrators ¶
func NewBotCommandScopeAllChatAdministrators() BotCommandScope
NewBotCommandScopeAllChatAdministrators represents the scope of bot commands, covering all group and supergroup chat administrators.
func NewBotCommandScopeAllGroupChats ¶
func NewBotCommandScopeAllGroupChats() BotCommandScope
NewBotCommandScopeAllGroupChats represents the scope of bot commands, covering all group and supergroup chats.
func NewBotCommandScopeAllPrivateChats ¶
func NewBotCommandScopeAllPrivateChats() BotCommandScope
NewBotCommandScopeAllPrivateChats represents the scope of bot commands, covering all private chats.
func NewBotCommandScopeChat ¶
func NewBotCommandScopeChat(chatID int64) BotCommandScope
NewBotCommandScopeChat represents the scope of bot commands, covering a specific chat.
func NewBotCommandScopeChatAdministrators ¶
func NewBotCommandScopeChatAdministrators(chatID int64) BotCommandScope
NewBotCommandScopeChatAdministrators represents the scope of bot commands, covering all administrators of a specific group or supergroup chat.
func NewBotCommandScopeChatMember ¶
func NewBotCommandScopeChatMember(chatID, userID int64) BotCommandScope
NewBotCommandScopeChatMember represents the scope of bot commands, covering a specific member of a group or supergroup chat.
func NewBotCommandScopeDefault ¶
func NewBotCommandScopeDefault() BotCommandScope
NewBotCommandScopeDefault represents the default scope of bot commands.
type BotDescription ¶
type BotDescription struct {
Description string `json:"description"`
}
BotDescription represents the bot's description.
type BotLogger ¶
type BotLogger interface { Println(v ...interface{}) Printf(format string, v ...interface{}) }
BotLogger is an interface that represents the required methods to log data.
Instead of requiring the standard logger, we can just specify the methods we use and allow users to pass anything that implements these.
type BotShortDescription ¶
type BotShortDescription struct {
ShortDescription string `json:"short_description"`
}
BotShortDescription represents the bot's short description
type CallbackConfig ¶
type CallbackConfig struct { CallbackQueryID string `json:"callback_query_id"` Text string `json:"text"` ShowAlert bool `json:"show_alert"` URL string `json:"url"` CacheTime int `json:"cache_time"` }
CallbackConfig contains information on making a CallbackQuery response.
func NewCallback ¶
func NewCallback(id, text string) CallbackConfig
NewCallback creates a new callback message.
func NewCallbackWithAlert ¶
func NewCallbackWithAlert(id, text string) CallbackConfig
NewCallbackWithAlert creates a new callback message that alerts the user.
type CallbackGame ¶
type CallbackGame struct{}
CallbackGame is for starting a game in an inline keyboard button.
type CallbackQuery ¶
type CallbackQuery struct { // ID unique identifier for this query ID string `json:"id"` // From sender From *User `json:"from"` // Message sent by the bot with the callback button that originated the query // // optional Message *Message `json:"message,omitempty"` // InlineMessageID identifier of the message sent via the bot in inline // mode, that originated the query. // // optional 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. ChatInstance string `json:"chat_instance"` // Data associated with the callback button. Be aware that // a bad client can send arbitrary data in this field. // // optional Data string `json:"data,omitempty"` // GameShortName short name of a Game to be returned, serves as the unique identifier for the game. // // optional GameShortName string `json:"game_short_name,omitempty"` }
CallbackQuery represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field message will be present. If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present.
func (CallbackQuery) GetInaccessibleMessage ¶
func (c CallbackQuery) GetInaccessibleMessage() InaccessibleMessage
func (CallbackQuery) IsInaccessibleMessage ¶
func (c CallbackQuery) IsInaccessibleMessage() bool
IsInaccessibleMessage method that shows whether message is inaccessible
type Chat ¶
type Chat struct { // ID is a unique identifier for this chat ID int64 `json:"id"` // Type of chat, can be either “private”, “group”, “supergroup” or “channel” Type string `json:"type"` // Title for supergroups, channels and group chats // // optional Title string `json:"title,omitempty"` // UserName for private chats, supergroups and channels if available // // optional UserName string `json:"username,omitempty"` // FirstName of the other party in a private chat // // optional FirstName string `json:"first_name,omitempty"` // LastName of the other party in a private chat // // optional LastName string `json:"last_name,omitempty"` // IsForum is true if the supergroup chat is a forum (has topics enabled) // // optional IsForum bool `json:"is_forum,omitempty"` // Photo is a chat photo Photo *ChatPhoto `json:"photo"` // If non-empty, the list of all active chat usernames; // for private chats, supergroups and channels. Returned only in getChat. // // optional ActiveUsernames []string `json:"active_usernames,omitempty"` // AvailableReactions is a list of available reactions allowed in the chat. // If omitted, then all emoji reactions are allowed. Returned only in getChat. // // optional AvailableReactions []ReactionType `json:"available_reactions,omitempty"` // AccentColorID is an identifier of the accent color for the chat name and backgrounds of // the chat photo, reply header, and link preview. // See accent colors for more details. Returned only in getChat. // Always returned in getChat. // // optional AccentColorID int `json:"accent_color_id,omitempty"` // BackgroundCustomEmojiID is a custom emoji identifier of emoji chosen by // the chat for the reply header and link preview background. // Returned only in getChat. // // optional BackgroundCustomEmojiID string `json:"background_custom_emoji_id,omitempty"` // ProfileAccentColorID is ani dentifier of the accent color for the chat's profile background. // See profile accent colors for more details. Returned only in getChat. // // optional ProfileAccentColorID int `json:"profile_accent_color_id,omitempty"` // ProfileBackgroundCustomEmojiID is a custom emoji identifier of the emoji chosen by // the chat for its profile background. Returned only in getChat. // // optional ProfileBackgroundCustomEmojiID string `json:"profile_background_custom_emoji_id,omitempty"` // EmojiStatusCustomEmojiID is a custom emoji identifier of emoji status of the other party // in a private chat. Returned only in getChat. // // optional EmojiStatusCustomEmojiID string `json:"emoji_status_custom_emoji_id,omitempty"` // EmojiStatusExpirationDate is a date of the emoji status of the chat or the other party // in a private chat, in Unix time, if any. Returned only in getChat. // // optional EmojiStatusExpirationDate int64 `json:"emoji_status_expiration_date,omitempty"` // Bio is the bio of the other party in a private chat. Returned only in // getChat // // optional Bio string `json:"bio,omitempty"` // HasPrivateForwards is true if privacy settings of the other party in the // private chat allows to use tg://user?id=<user_id> links only in chats // with the user. Returned only in getChat. // // optional HasPrivateForwards bool `json:"has_private_forwards,omitempty"` // HasRestrictedVoiceAndVideoMessages if the privacy settings of the other party // restrict sending voice and video note messages // in the private chat. Returned only in getChat. // // optional HasRestrictedVoiceAndVideoMessages bool `json:"has_restricted_voice_and_video_messages,omitempty"` // JoinToSendMessages is true, if users need to join the supergroup // before they can send messages. // Returned only in getChat // // optional JoinToSendMessages bool `json:"join_to_send_messages,omitempty"` // JoinByRequest is true, if all users directly joining the supergroup // need to be approved by supergroup administrators. // Returned only in getChat. // // optional JoinByRequest bool `json:"join_by_request,omitempty"` // Description for groups, supergroups and channel chats // // optional Description string `json:"description,omitempty"` // InviteLink is a chat invite link, for groups, supergroups and channel chats. // Each administrator in a chat generates their own invite links, // so the bot must first generate the link using exportChatInviteLink // // optional InviteLink string `json:"invite_link,omitempty"` // PinnedMessage is the pinned message, for groups, supergroups and channels // // optional PinnedMessage *Message `json:"pinned_message,omitempty"` // Permissions are default chat member permissions, for groups and // supergroups. Returned only in getChat. // // optional Permissions *ChatPermissions `json:"permissions,omitempty"` // SlowModeDelay is for supergroups, the minimum allowed delay between // consecutive messages sent by each unprivileged user. Returned only in // getChat. // // optional SlowModeDelay int `json:"slow_mode_delay,omitempty"` // MessageAutoDeleteTime is the time after which all messages sent to the // chat will be automatically deleted; in seconds. Returned only in getChat. // // optional MessageAutoDeleteTime int `json:"message_auto_delete_time,omitempty"` // HasAggressiveAntiSpamEnabled is true if aggressive anti-spam checks are enabled // in the supergroup. The field is only available to chat administrators. // Returned only in getChat. // // optional HasAggressiveAntiSpamEnabled bool `json:"has_aggressive_anti_spam_enabled,omitempty"` // HasHiddenMembers is true if non-administrators can only get // the list of bots and administrators in the chat. // // optional HasHiddenMembers bool `json:"has_hidden_members,omitempty"` // HasProtectedContent is true if messages from the chat can't be forwarded // to other chats. Returned only in getChat. // // optional HasProtectedContent bool `json:"has_protected_content,omitempty"` // HasVisibleHistory is True, if new chat members will have access to old messages; // available only to chat administrators. Returned only in getChat. // // optional HasVisibleHistory bool `json:"has_visible_history,omitempty"` // StickerSetName is for supergroups, name of group sticker set.Returned // only in getChat. // // optional StickerSetName string `json:"sticker_set_name,omitempty"` // CanSetStickerSet is true, if the bot can change the group sticker set. // Returned only in getChat. // // optional CanSetStickerSet bool `json:"can_set_sticker_set,omitempty"` // LinkedChatID is a unique identifier for the linked chat, i.e. the // discussion group identifier for a channel and vice versa; for supergroups // and channel chats. // // optional LinkedChatID int64 `json:"linked_chat_id,omitempty"` // Location is for supergroups, the location to which the supergroup is // connected. Returned only in getChat. // // optional Location *ChatLocation `json:"location,omitempty"` }
Chat represents a chat.
func (Chat) ChatConfig ¶
func (c Chat) ChatConfig() ChatConfig
ChatConfig returns a ChatConfig struct for chat related methods.
func (Chat) IsSuperGroup ¶
IsSuperGroup returns if the Chat is a supergroup.
type ChatActionConfig ¶
ChatActionConfig contains information about a SendChatAction request.
func NewChatAction ¶
func NewChatAction(chatID int64, action string) ChatActionConfig
NewChatAction sets a chat action. Actions last for 5 seconds, or until your next action.
chatID is where to send it, action should be set via Chat constants.
type ChatAdministratorRights ¶
type ChatAdministratorRights struct { IsAnonymous bool `json:"is_anonymous"` CanManageChat bool `json:"can_manage_chat"` CanDeleteMessages bool `json:"can_delete_messages"` CanManageVideoChats bool `json:"can_manage_video_chats"` CanRestrictMembers bool `json:"can_restrict_members"` CanPromoteMembers bool `json:"can_promote_members"` CanChangeInfo bool `json:"can_change_info"` CanInviteUsers bool `json:"can_invite_users"` CanPostMessages bool `json:"can_post_messages"` CanEditMessages bool `json:"can_edit_messages"` CanPinMessages bool `json:"can_pin_messages"` CanPostStories bool `json:"can_post_stories"` CanEditStories bool `json:"can_edit_stories"` CanDeleteStories bool `json:"can_delete_stories"` CanManageTopics bool `json:"can_manage_topics"` }
type ChatAdministratorsConfig ¶
type ChatAdministratorsConfig struct {
ChatConfig
}
ChatAdministratorsConfig contains information about getting chat administrators.
type ChatBoost ¶
type ChatBoost struct { // BoostID is an unique identifier of the boost BoostID string `json:"boost_id"` // AddDate is a point in time (Unix timestamp) when the chat was boosted AddDate int64 `json:"add_date"` // ExpirationDate is a point in time (Unix timestamp) when the boost will // automatically expire, unless the booster's Telegram Premium subscription is prolonged ExpirationDate int64 `json:"expiration_date"` // Source of the added boost Source ChatBoostSource `json:"source"` }
ChatBoost contains information about a chat boost.
type ChatBoostRemoved ¶
type ChatBoostRemoved struct { // Chat which was boosted Chat Chat `json:"chat"` // BoostID unique identifier of the boost BoostID string `json:"boost_id"` // RemoveDate point in time (Unix timestamp) when the boost was removed RemoveDate int64 `json:"remove_date"` // Source of the removed boost Source ChatBoostSource `json:"source"` }
ChatBoostRemoved represents a boost removed from a chat.
type ChatBoostSource ¶
type ChatBoostSource struct { // Source of the boost, It can be one of: // "premium", "gift_code", "giveaway" Source string `json:"source"` // For "premium": User that boosted the chat // For "gift_code": User for which the gift code was created // Optional for "giveaway": User that won the prize in the giveaway if any User *User `json:"user,omitempty"` // GiveawayMessageID "giveaway" only. // Is an identifier of a message in the chat with the giveaway; // the message could have been deleted already. May be 0 if the message isn't sent yet. GiveawayMessageID int `json:"giveaway_message_id,omitempty"` // IsUnclaimed "giveaway" only. // True, if the giveaway was completed, but there was no user to win the prize // // optional IsUnclaimed bool `json:"is_unclaimed,omitempty"` }
ChatBoostSource describes the source of a chat boost
func (ChatBoostSource) IsGiftCode ¶
func (c ChatBoostSource) IsGiftCode() bool
func (ChatBoostSource) IsGiveaway ¶
func (c ChatBoostSource) IsGiveaway() bool
func (ChatBoostSource) IsPremium ¶
func (c ChatBoostSource) IsPremium() bool
type ChatBoostUpdated ¶
type ChatBoostUpdated struct { // Chat which was boosted Chat Chat `json:"chat"` // Boost infomation about the chat boost Boost ChatBoost `json:"boost"` }
ChatBoostUpdated represents a boost added to a chat or changed.
type ChatConfig ¶
ChatConfig is a base type for all chat identifiers
type ChatConfigWithUser ¶
type ChatConfigWithUser struct { ChatConfig UserID int64 }
ChatConfigWithUser contains information about a chat and a user.
type ChatInfoConfig ¶
type ChatInfoConfig struct {
ChatConfig
}
ChatInfoConfig contains information about getting chat information.
type ChatInviteLink ¶
type ChatInviteLink struct { // InviteLink is the invite link. If the link was created by another chat // administrator, then the second part of the link will be replaced with “…”. InviteLink string `json:"invite_link"` // Creator of the link. Creator User `json:"creator"` // CreatesJoinRequest is true if users joining the chat via the link need to // be approved by chat administrators. // // optional CreatesJoinRequest bool `json:"creates_join_request,omitempty"` // IsPrimary is true, if the link is primary. IsPrimary bool `json:"is_primary"` // IsRevoked is true, if the link is revoked. IsRevoked bool `json:"is_revoked"` // Name is the name of the invite link. // // optional Name string `json:"name,omitempty"` // ExpireDate is the point in time (Unix timestamp) when the link will // expire or has been expired. // // optional ExpireDate int `json:"expire_date,omitempty"` // MemberLimit is the maximum number of users that can be members of the // chat simultaneously after joining the chat via this invite link; 1-99999. // // optional MemberLimit int `json:"member_limit,omitempty"` // PendingJoinRequestCount is the number of pending join requests created // using this link. // // optional PendingJoinRequestCount int `json:"pending_join_request_count,omitempty"` }
ChatInviteLink represents an invite link for a chat.
type ChatInviteLinkConfig ¶
type ChatInviteLinkConfig struct {
ChatConfig
}
ChatInviteLinkConfig contains information about getting a chat link.
Note that generating a new link will revoke any previous links.
type ChatJoinRequest ¶
type ChatJoinRequest struct { // Chat to which the request was sent. Chat Chat `json:"chat"` // User that sent the join request. From User `json:"from"` // UserChatID identifier of a private chat with the user who sent the join request. UserChatID int64 `json:"user_chat_id"` // Date the request was sent in Unix time. Date int `json:"date"` // Bio of the user. // // optional Bio string `json:"bio,omitempty"` // InviteLink is the link that was used by the user to send the join request. // // optional InviteLink *ChatInviteLink `json:"invite_link,omitempty"` }
ChatJoinRequest represents a join request sent to a chat.
type ChatLocation ¶
type ChatLocation struct { // Location is the location to which the supergroup is connected. Can't be a // live location. Location Location `json:"location"` // Address is the 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 ¶
type ChatMember struct { // User information about the user User *User `json:"user"` // Status the member's status in the chat. // Can be // “creator”, // “administrator”, // “member”, // “restricted”, // “left” or // “kicked” Status string `json:"status"` // CustomTitle owner and administrators only. Custom title for this user // // optional CustomTitle string `json:"custom_title,omitempty"` // IsAnonymous owner and administrators only. True, if the user's presence // in the chat is hidden // // optional IsAnonymous bool `json:"is_anonymous,omitempty"` // UntilDate restricted and kicked only. // Date when restrictions will be lifted for this user; // unix time. // // optional UntilDate int64 `json:"until_date,omitempty"` // CanBeEdited administrators only. // True, if the bot is allowed to edit administrator privileges of that user. // // optional CanBeEdited bool `json:"can_be_edited,omitempty"` // CanManageChat administrators only. // True, if the administrator can access the chat event log, chat // statistics, message statistics in channels, see channel members, see // anonymous administrators in supergroups and ignore slow mode. Implied by // any other administrator privilege. // // optional CanManageChat bool `json:"can_manage_chat,omitempty"` // CanPostMessages administrators only. // True, if the administrator can post in the channel; // channels only. // // optional CanPostMessages bool `json:"can_post_messages,omitempty"` // CanEditMessages administrators only. // True, if the administrator can edit messages of other users and can pin messages; // channels only. // // optional CanEditMessages bool `json:"can_edit_messages,omitempty"` // CanDeleteMessages administrators only. // True, if the administrator can delete messages of other users. // // optional CanDeleteMessages bool `json:"can_delete_messages,omitempty"` // CanManageVideoChats administrators only. // True, if the administrator can manage video chats. // // optional CanManageVideoChats bool `json:"can_manage_video_chats,omitempty"` // CanRestrictMembers administrators only. // True, if the administrator can restrict, ban or unban chat members. // // optional CanRestrictMembers bool `json:"can_restrict_members,omitempty"` // CanPromoteMembers administrators only. // True, if the administrator can add new administrators // with a subset of their own privileges or demote administrators that he has promoted, // directly or indirectly (promoted by administrators that were appointed by the user). // // optional CanPromoteMembers bool `json:"can_promote_members,omitempty"` // CanChangeInfo administrators and restricted only. // True, if the user is allowed to change the chat title, photo and other settings. // // optional CanChangeInfo bool `json:"can_change_info,omitempty"` // CanInviteUsers administrators and restricted only. // True, if the user is allowed to invite new users to the chat. // // optional CanInviteUsers bool `json:"can_invite_users,omitempty"` // CanPinMessages administrators and restricted only. // True, if the user is allowed to pin messages; groups and supergroups only // // optional CanPinMessages bool `json:"can_pin_messages,omitempty"` // CanPostStories administrators only. // True, if the administrator can post stories in the channel; channels only // // optional CanPostStories bool `json:"can_post_stories,omitempty"` // CanEditStories administrators only. // True, if the administrator can edit stories posted by other users; channels only // // optional CanEditStories bool `json:"can_edit_stories,omitempty"` // CanDeleteStories administrators only. // True, if the administrator can delete stories posted by other users; channels only // // optional CanDeleteStories bool `json:"can_delete_stories,omitempty"` // CanManageTopics administrators and restricted only. // True, if the user is allowed to create, rename, // close, and reopen forum topics; supergroups only // // optional CanManageTopics bool `json:"can_manage_topics,omitempty"` // IsMember is true, if the user is a member of the chat at the moment of // the request IsMember bool `json:"is_member"` // CanSendMessages // // optional CanSendMessages bool `json:"can_send_messages,omitempty"` // CanSendAudios restricted only. // True, if the user is allowed to send audios // // optional CanSendAudios bool // CanSendDocuments restricted only. // True, if the user is allowed to send documents // // optional CanSendDocuments bool // CanSendPhotos is restricted only. // True, if the user is allowed to send photos // // optional CanSendPhotos bool // CanSendVideos restricted only. // True, if the user is allowed to send videos // // optional CanSendVideos bool // CanSendVideoNotes restricted only. // True, if the user is allowed to send video notes // // optional CanSendVideoNotes bool // CanSendVoiceNotes restricted only. // True, if the user is allowed to send voice notes // // optional CanSendVoiceNotes bool // CanSendPolls restricted only. // True, if the user is allowed to send polls // // optional CanSendPolls bool `json:"can_send_polls,omitempty"` // CanSendOtherMessages restricted only. // True, if the user is allowed to send audios, documents, // photos, videos, video notes and voice notes. // // optional CanSendOtherMessages bool `json:"can_send_other_messages,omitempty"` // CanAddWebPagePreviews restricted only. // True, if the user is allowed to add web page previews to their messages. // // optional CanAddWebPagePreviews bool `json:"can_add_web_page_previews,omitempty"` }
ChatMember contains information about one member of a chat.
func (*ChatMember) CanSendMediaMessages ¶
func (chat *ChatMember) CanSendMediaMessages() bool
CanSendMediaMessages method to replace field "can_send_media_messages". It returns true if CanSendAudio and CanSendDocuments and CanSendPhotos and CanSendVideos and CanSendVideoNotes and CanSendVoiceNotes are true.
func (ChatMember) HasLeft ¶
func (chat ChatMember) HasLeft() bool
HasLeft returns if the ChatMember left the chat.
func (ChatMember) IsAdministrator ¶
func (chat ChatMember) IsAdministrator() bool
IsAdministrator returns if the ChatMember is a chat administrator.
func (ChatMember) IsCreator ¶
func (chat ChatMember) IsCreator() bool
IsCreator returns if the ChatMember was the creator of the chat.
func (*ChatMember) SetCanSendMediaMessages ¶
func (chat *ChatMember) SetCanSendMediaMessages(b bool)
SetCanSendMediaMessages is a method to replace field "can_send_media_messages". It sets CanSendAudio, CanSendDocuments, CanSendPhotos, CanSendVideos, CanSendVideoNotes, CanSendVoiceNotes to passed value.
func (ChatMember) WasKicked ¶
func (chat ChatMember) WasKicked() bool
WasKicked returns if the ChatMember was kicked from the chat.
type ChatMemberConfig ¶
type ChatMemberConfig struct { ChatConfig UserID int64 }
ChatMemberConfig contains information about a user in a chat for use with administrative functions such as kicking or unbanning a user.
func NewChatMember ¶
func NewChatMember(chatID, userID int64) ChatMemberConfig
type ChatMemberCountConfig ¶
type ChatMemberCountConfig struct {
ChatConfig
}
ChatMemberCountConfig contains information about getting the number of users in a chat.
type ChatMemberUpdated ¶
type ChatMemberUpdated struct { // Chat the user belongs to. Chat Chat `json:"chat"` // From is the performer of the action, which resulted in the change. From User `json:"from"` // Date the change was done in Unix time. Date int `json:"date"` // Previous information about the chat member. OldChatMember ChatMember `json:"old_chat_member"` // New information about the chat member. NewChatMember ChatMember `json:"new_chat_member"` // InviteLink is the link which was used by the user to join the chat; // for joining by invite link events only. // // optional InviteLink *ChatInviteLink `json:"invite_link,omitempty"` // ViaChatFolderInviteLink is True, if the user joined the chat // via a chat folder invite link // // optional ViaChatFolderInviteLink bool `json:"via_chat_folder_invite_link,omitempty"` }
ChatMemberUpdated represents changes in the status of a chat member.
type ChatPermissions ¶
type ChatPermissions struct { // CanSendMessages is true, if the user is allowed to send text messages, // contacts, locations and venues // // optional CanSendMessages bool `json:"can_send_messages,omitempty"` // CanSendAudios is true, if the user is allowed to send audios // // optional CanSendAudios bool // CanSendDocuments is true, if the user is allowed to send documents // // optional CanSendDocuments bool // CanSendPhotos is true, if the user is allowed to send photos // // optional CanSendPhotos bool // CanSendVideos is true, if the user is allowed to send videos // // optional CanSendVideos bool // CanSendVideoNotes is true, if the user is allowed to send video notes // // optional CanSendVideoNotes bool // CanSendVoiceNotes is true, if the user is allowed to send voice notes // // optional CanSendVoiceNotes bool // CanSendPolls is true, if the user is allowed to send polls, implies // can_send_messages // // optional CanSendPolls bool `json:"can_send_polls,omitempty"` // CanSendOtherMessages is true, if the user is allowed to send animations, // games, stickers and use inline bots, implies can_send_media_messages // // optional CanSendOtherMessages bool `json:"can_send_other_messages,omitempty"` // CanAddWebPagePreviews is true, if the user is allowed to add web page // previews to their messages, implies can_send_media_messages // // optional CanAddWebPagePreviews bool `json:"can_add_web_page_previews,omitempty"` // CanChangeInfo is true, if the user is allowed to change the chat title, // photo and other settings. Ignored in public supergroups // // optional CanChangeInfo bool `json:"can_change_info,omitempty"` // CanInviteUsers is true, if the user is allowed to invite new users to the // chat // // optional CanInviteUsers bool `json:"can_invite_users,omitempty"` // CanPinMessages is true, if the user is allowed to pin messages. Ignored // in public supergroups // // optional CanPinMessages bool `json:"can_pin_messages,omitempty"` // CanManageTopics is true, if the user is allowed to create forum topics. // If omitted defaults to the value of can_pin_messages // // optional CanManageTopics bool `json:"can_manage_topics,omitempty"` }
ChatPermissions describes actions that a non-administrator user is allowed to take in a chat. All fields are optional.
func (*ChatPermissions) CanSendMediaMessages ¶
func (c *ChatPermissions) CanSendMediaMessages() bool
CanSendMediaMessages method to replace field "can_send_media_messages". It returns true if CanSendAudio and CanSendDocuments and CanSendPhotos and CanSendVideos and CanSendVideoNotes and CanSendVoiceNotes are true.
func (*ChatPermissions) SetCanSendMediaMessages ¶
func (c *ChatPermissions) SetCanSendMediaMessages(b bool)
SetCanSendMediaMessages is a method to replace field "can_send_media_messages". It sets CanSendAudio, CanSendDocuments, CanSendPhotos, CanSendVideos, CanSendVideoNotes, CanSendVoiceNotes to passed value.
type ChatPhoto ¶
type ChatPhoto struct { // SmallFileID is a 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 is a 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 is a 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 is a 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 represents a chat photo.
type ChatShared ¶
ChatShared contains information about the chat whose identifier was shared with the bot using a KeyboardButtonRequestChat button.
type Chattable ¶
type Chattable interface {
// contains filtered or unexported methods
}
Chattable is any config type that can be sent.
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 sender location, only for bots that require user location // // optional Location *Location `json:"location,omitempty"` // InlineMessageID identifier of the sent inline message. // Available only if there is an inline keyboard attached to the message. // Will be also received in callback queries and can be used to edit the message. // // optional InlineMessageID string `json:"inline_message_id,omitempty"` // Query the query that was used to obtain the result Query string `json:"query"` }
ChosenInlineResult is an inline query result chosen by a User
type CloseConfig ¶
type CloseConfig struct{}
CloseConfig is a request to close the bot instance on a local server.
Note that you may not close an instance for the first 10 minutes after the bot has started.
type CloseForumTopicConfig ¶
type CloseForumTopicConfig struct{ BaseForum }
CloseForumTopicConfig allows you to close an open topic in a forum supergroup chat.
type CloseGeneralForumTopicConfig ¶
type CloseGeneralForumTopicConfig struct{ BaseForum }
CloseGeneralForumTopicConfig allows you to to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
type 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 contact's last name // // optional LastName string `json:"last_name,omitempty"` // UserID contact's user identifier in Telegram // // optional UserID int64 `json:"user_id,omitempty"` // VCard is additional data about the contact in the form of a vCard. // // optional VCard string `json:"vcard,omitempty"` }
Contact represents a phone contact.
Note that LastName and UserID may be empty.
type ContactConfig ¶
type ContactConfig struct { BaseChat PhoneNumber string FirstName string LastName string VCard string }
ContactConfig allows you to send a contact.
func NewContact ¶
func NewContact(chatID int64, phoneNumber, firstName string) ContactConfig
NewContact allows you to send a shared contact.
type CopyMessageConfig ¶
type CopyMessageConfig struct { BaseChat FromChat ChatConfig MessageID int Caption string ParseMode string CaptionEntities []MessageEntity }
CopyMessageConfig contains information about a copyMessage request.
func NewCopyMessage ¶
func NewCopyMessage(chatID int64, fromChatID int64, messageID int) CopyMessageConfig
NewCopyMessage creates a new copy message.
chatID is where to send it, fromChatID is the source chat, and messageID is the ID of the original message.
type CopyMessagesConfig ¶
type CopyMessagesConfig struct { BaseChat FromChat ChatConfig MessageIDs []int RemoveCaption bool }
CopyMessagesConfig contains information about a copyMessages request.
type CreateChatInviteLinkConfig ¶
type CreateChatInviteLinkConfig struct { ChatConfig Name string ExpireDate int MemberLimit int CreatesJoinRequest bool }
CreateChatInviteLinkConfig allows you 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 RevokeChatInviteLinkConfig.
type CreateForumTopicConfig ¶
type CreateForumTopicConfig struct { ChatConfig Name string IconColor int IconCustomEmojiID string }
CreateForumTopicConfig allows you to create a topic in a forum supergroup chat.
type Credentials ¶
type Credentials struct { Data SecureData `json:"secure_data"` // Nonce the same nonce given in the request Nonce string `json:"nonce"` }
Credentials contains encrypted data.
type DataCredentials ¶
type DataCredentials struct { // DataHash checksum of encrypted data DataHash string `json:"data_hash"` // Secret of encrypted data Secret string `json:"secret"` }
DataCredentials contains information required to decrypt data.
type DeclineChatJoinRequest ¶
type DeclineChatJoinRequest struct { ChatConfig UserID int64 }
DeclineChatJoinRequest allows you to decline a chat join request.
type DeleteChatPhotoConfig ¶
type DeleteChatPhotoConfig struct {
ChatConfig
}
DeleteChatPhotoConfig allows you to delete a group, supergroup, or channel's photo.
func NewDeleteChatPhoto ¶
func NewDeleteChatPhoto(chatID int64) DeleteChatPhotoConfig
NewDeleteChatPhoto allows you to delete the photo for a chat.
type DeleteChatStickerSetConfig ¶
type DeleteChatStickerSetConfig struct {
ChatConfig
}
DeleteChatStickerSetConfig allows you to remove a supergroup's sticker set.
type DeleteForumTopicConfig ¶
type DeleteForumTopicConfig struct{ BaseForum }
DeleteForumTopicConfig allows you to delete a forum topic along with all its messages in a forum supergroup chat.
type DeleteMessageConfig ¶
type DeleteMessageConfig struct {
BaseChatMessage
}
DeleteMessageConfig contains information of a message in a chat to delete.
func NewDeleteMessage ¶
func NewDeleteMessage(chatID int64, messageID int) DeleteMessageConfig
NewDeleteMessage creates a request to delete a message.
type DeleteMessagesConfig ¶
type DeleteMessagesConfig struct {
BaseChatMessages
}
DeleteMessageConfig contains information of a messages in a chat to delete.
type DeleteMyCommandsConfig ¶
type DeleteMyCommandsConfig struct { Scope *BotCommandScope LanguageCode string }
func NewDeleteMyCommands ¶
func NewDeleteMyCommands() DeleteMyCommandsConfig
NewDeleteMyCommands allows you to delete the registered commands.
func NewDeleteMyCommandsWithScope ¶
func NewDeleteMyCommandsWithScope(scope BotCommandScope) DeleteMyCommandsConfig
NewDeleteMyCommandsWithScope allows you to delete the registered commands for a given scope.
func NewDeleteMyCommandsWithScopeAndLanguage ¶
func NewDeleteMyCommandsWithScopeAndLanguage(scope BotCommandScope, languageCode string) DeleteMyCommandsConfig
NewDeleteMyCommandsWithScopeAndLanguage allows you to delete the registered commands for a given scope and language code.
type DeleteStickerConfig ¶
type DeleteStickerConfig struct {
Sticker string
}
DeleteStickerConfig allows you to delete a sticker from a set.
type DeleteStickerSetConfig ¶
type DeleteStickerSetConfig struct {
Name string
}
DeleteStickerSetConfig allows you to delete a sticker set that was created by the bot.
func NewDeleteStickerSet ¶
func NewDeleteStickerSet(name, title string) DeleteStickerSetConfig
NewDeleteStickerSet creates a new deleteStickerSet request
type DeleteWebhookConfig ¶
type DeleteWebhookConfig struct {
DropPendingUpdates bool
}
DeleteWebhookConfig is a helper to delete a webhook.
type Dice ¶
type Dice struct { // Emoji on which the dice throw animation is based Emoji string `json:"emoji"` // Value of the dice Value int `json:"value"` }
Dice represents an animated emoji that displays a random value.
type DiceConfig ¶
type DiceConfig struct { BaseChat // 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 }
DiceConfig contains information about a sendDice request.
func NewDiceWithEmoji ¶
func NewDiceWithEmoji(chatID int64, emoji string) DiceConfig
NewDiceWithEmoji allows you to send a random roll of one of many types.
Emoji may be 🎲 (1-6), 🎯 (1-6), or 🏀 (1-5).
type Document ¶
type Document struct { // FileID is an identifier for this file, which can be used to download or // reuse the file FileID string `json:"file_id"` // FileUniqueID is the 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"` // Thumbnail document thumbnail as defined by sender // // optional Thumbnail *PhotoSize `json:"thumbnail,omitempty"` // FileName original filename as defined by sender // // optional FileName string `json:"file_name,omitempty"` // MimeType of the file as defined by sender // // optional MimeType string `json:"mime_type,omitempty"` // FileSize file size // // optional FileSize int64 `json:"file_size,omitempty"` }
Document represents a general file.
type DocumentConfig ¶
type DocumentConfig struct { BaseFile Thumb RequestFileData Caption string ParseMode string CaptionEntities []MessageEntity DisableContentTypeDetection bool }
DocumentConfig contains information about a SendDocument request.
func NewDocument ¶
func NewDocument(chatID int64, file RequestFileData) DocumentConfig
NewDocument creates a new sendDocument request.
type EditChatInviteLinkConfig ¶
type EditChatInviteLinkConfig struct { ChatConfig InviteLink string Name string ExpireDate int MemberLimit int CreatesJoinRequest bool }
EditChatInviteLinkConfig allows you 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.
type EditForumTopicConfig ¶
EditForumTopicConfig allows you to edit name and icon of a topic in a forum supergroup chat.
type EditGeneralForumTopicConfig ¶
UnpinAllForumTopicMessagesConfig allows you to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.
type EditMessageCaptionConfig ¶
type EditMessageCaptionConfig struct { BaseEdit Caption string ParseMode string CaptionEntities []MessageEntity }
EditMessageCaptionConfig allows you to modify the caption of a message.
func NewEditMessageCaption ¶
func NewEditMessageCaption(chatID int64, messageID int, caption string) EditMessageCaptionConfig
NewEditMessageCaption allows you to edit the caption of a message.
type EditMessageLiveLocationConfig ¶
type EditMessageLiveLocationConfig struct { BaseEdit Latitude float64 // required Longitude float64 // required HorizontalAccuracy float64 // optional Heading int // optional ProximityAlertRadius int // optional }
EditMessageLiveLocationConfig allows you to update a live location.
type EditMessageMediaConfig ¶
type EditMessageMediaConfig struct { BaseEdit Media interface{} }
EditMessageMediaConfig allows you to make an editMessageMedia request.
type EditMessageReplyMarkupConfig ¶
type EditMessageReplyMarkupConfig struct {
BaseEdit
}
EditMessageReplyMarkupConfig allows you to modify the reply markup of a message.
func NewEditMessageReplyMarkup ¶
func NewEditMessageReplyMarkup(chatID int64, messageID int, replyMarkup InlineKeyboardMarkup) EditMessageReplyMarkupConfig
NewEditMessageReplyMarkup allows you to edit the inline keyboard markup.
type EditMessageTextConfig ¶
type EditMessageTextConfig struct { BaseEdit Text string ParseMode string Entities []MessageEntity LinkPreviewOptions LinkPreviewOptions }
EditMessageTextConfig allows you to modify the text in a message.
func NewEditMessageText ¶
func NewEditMessageText(chatID int64, messageID int, text string) EditMessageTextConfig
NewEditMessageText allows you to edit the text of a message.
func NewEditMessageTextAndMarkup ¶
func NewEditMessageTextAndMarkup(chatID int64, messageID int, text string, replyMarkup InlineKeyboardMarkup) EditMessageTextConfig
NewEditMessageTextAndMarkup allows you to edit the text and reply markup of a message.
type EncryptedCredentials ¶
type EncryptedCredentials struct { // Base64-encoded encrypted JSON-serialized data with unique user's // payload, data hashes and secrets required for EncryptedPassportElement // decryption and authentication Data string `json:"data"` // Base64-encoded data hash for data authentication Hash string `json:"hash"` // Base64-encoded secret, encrypted with the bot's public RSA key, // required for data decryption Secret string `json:"secret"` }
EncryptedCredentials contains data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.
type EncryptedPassportElement ¶
type EncryptedPassportElement struct { // Element type. Type string `json:"type"` // Base64-encoded encrypted Telegram Passport element data provided by // the user, available for "personal_details", "passport", // "driver_license", "identity_card", "identity_passport" and "address" // types. Can be decrypted and verified using the accompanying // EncryptedCredentials. Data string `json:"data,omitempty"` // User's verified phone number, available only for "phone_number" type PhoneNumber string `json:"phone_number,omitempty"` // User's verified email address, available only for "email" type Email string `json:"email,omitempty"` // Array of encrypted files with documents provided by the user, // available for "utility_bill", "bank_statement", "rental_agreement", // "passport_registration" and "temporary_registration" types. Files can // be decrypted and verified using the accompanying EncryptedCredentials. Files []PassportFile `json:"files,omitempty"` // Encrypted file with the front side of the document, provided by the // user. Available for "passport", "driver_license", "identity_card" and // "internal_passport". The file can be decrypted and verified using the // accompanying EncryptedCredentials. FrontSide *PassportFile `json:"front_side,omitempty"` // Encrypted file with the reverse side of the document, provided by the // user. Available for "driver_license" and "identity_card". The file can // be decrypted and verified using the accompanying EncryptedCredentials. ReverseSide *PassportFile `json:"reverse_side,omitempty"` // Encrypted file with the selfie of the user holding a document, // provided by the user; available for "passport", "driver_license", // "identity_card" and "internal_passport". The file can be decrypted // and verified using the accompanying EncryptedCredentials. Selfie *PassportFile `json:"selfie,omitempty"` }
EncryptedPassportElement contains information about documents or other Telegram Passport elements shared with the bot by the user.
type Error ¶
type Error struct { Code int Message string ResponseParameters }
Error is an error containing extra information returned by the Telegram API.
type ExternalReplyInfo ¶
type ExternalReplyInfo struct { // Origin of the message replied to by the given message Origin MessageOrigin `json:"origin"` // Chat is the conversation the message belongs to Chat *Chat `json:"chat"` // MessageID is a unique message identifier inside this chat MessageID int `json:"message_id"` // LinkPreviewOptions used for link preview generation for the original message, // if it is a text message // // Optional LinkPreviewOptions *LinkPreviewOptions `json:"link_preview_options,omitempty"` // Animation message is an animation, information about the animation. // For backward compatibility, when this field is set, the document field will also be set; // // optional Animation *Animation `json:"animation,omitempty"` // Audio message is an audio file, information about the file; // // optional Audio *Audio `json:"audio,omitempty"` // Document message is a general file, information about the file; // // optional Document *Document `json:"document,omitempty"` // Photo message is a photo, available sizes of the photo; // // optional Photo []PhotoSize `json:"photo,omitempty"` // Sticker message is a sticker, information about the sticker; // // optional Sticker *Sticker `json:"sticker,omitempty"` // Story message is a forwarded story; // // optional Story *Story `json:"story,omitempty"` // Video message is a video, information about the video; // // optional Video *Video `json:"video,omitempty"` // VideoNote message is a video note, information about the video message; // // optional VideoNote *VideoNote `json:"video_note,omitempty"` // Voice message is a voice message, information about the file; // // optional Voice *Voice `json:"voice,omitempty"` // HasMediaSpoiler True, if the message media is covered by a spoiler animation // // optional HasMediaSpoiler bool `json:"has_media_spoiler,omitempty"` // Contact message is a shared contact, information about the contact; // // optional Contact *Contact `json:"contact,omitempty"` // Dice is a dice with random value; // // optional Dice *Dice `json:"dice,omitempty"` // Game message is a game, information about the game; // // optional Game *Game `json:"game,omitempty"` // Giveaway is information about the giveaway // // optional Giveaway *Giveaway `json:"giveaway,omitempty"` // GiveawayWinners a giveaway with public winners was completed // // optional GiveawayWinners *GiveawayWinners `json:"giveaway_winners,omitempty"` // Invoice message is an invoice for a payment; // // optional Invoice *Invoice `json:"invoice,omitempty"` // Location message is a shared location, information about the location; // // optional Location *Location `json:"location,omitempty"` // Poll is a native poll, information about the poll; // // optional Poll *Poll `json:"poll,omitempty"` // Venue message is a venue, information about the venue. // For backward compatibility, when this field is set, the location field // will also be set; // // optional Venue *Venue `json:"venue,omitempty"` }
ExternalReplyInfo contains information about a message that is being replied to, which may come from another chat or forum topic.
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 is the 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, if known // // optional FileSize int64 `json:"file_size,omitempty"` // FilePath file path // // optional FilePath string `json:"file_path,omitempty"` }
File contains information about a file to download from Telegram.
type FileBytes ¶
FileBytes contains information about a set of bytes to upload as a File.
func (FileBytes) NeedsUpload ¶
type FileConfig ¶
type FileConfig struct {
FileID string
}
FileConfig has information about a file hosted on Telegram.
type FileCredentials ¶
type FileCredentials struct { // FileHash checksum of encrypted data FileHash string `json:"file_hash"` // Secret of encrypted data Secret string `json:"secret"` }
FileCredentials contains information required to decrypt files.
type FileID ¶
type FileID string
FileID is an ID of a file already uploaded to Telegram.
func (FileID) NeedsUpload ¶
type FilePath ¶
type FilePath string
FilePath is a path to a local file.
func (FilePath) NeedsUpload ¶
type FileReader ¶
FileReader contains information about a reader to upload as a File.
func (FileReader) NeedsUpload ¶
func (fr FileReader) NeedsUpload() bool
func (FileReader) SendData ¶
func (fr FileReader) SendData() string
func (FileReader) UploadData ¶
func (fr FileReader) UploadData() (string, io.Reader, error)
type FileURL ¶
type FileURL string
FileURL is a URL to use as a file for a request.
func (FileURL) NeedsUpload ¶
type Fileable ¶
type Fileable interface { Chattable // contains filtered or unexported methods }
Fileable is any config type that can be sent that includes a file.
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 is the placeholder to be shown in the input field when // the reply is active; 1-64 characters. // // optional InputFieldPlaceholder string `json:"input_field_placeholder,omitempty"` // Selective use this parameter if you want to force reply from specific users only. // Targets: // 1) users that are @mentioned in the text of the Message object; // 2) if the bot's message is a reply (has Message.ReplyToMessage not nil), sender of the original message. // // optional Selective bool `json:"selective,omitempty"` }
ForceReply when 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.
type ForumTopic ¶
type ForumTopic struct { // MessageThreadID is the unique identifier of the forum topic MessageThreadID int `json:"message_thread_id"` // Name is the name of the topic Name string `json:"name"` // IconColor is the color of the topic icon in RGB format IconColor int `json:"icon_color"` // IconCustomEmojiID is the unique identifier of the custom emoji // shown as the topic icon // // optional IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"` }
ForumTopic represents a forum topic.
type ForumTopicClosed ¶
type ForumTopicClosed struct { }
ForumTopicClosed represents a service message about a forum topic closed in the chat. Currently holds no information.
type ForumTopicCreated ¶
type ForumTopicCreated struct { // Name is the name of topic Name string `json:"name"` // IconColor is the color of the topic icon in RGB format IconColor int `json:"icon_color"` // IconCustomEmojiID is the unique identifier of the custom emoji // shown as the topic icon // // optional IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"` }
ForumTopicCreated represents a service message about a new forum topic created in the chat.
type ForumTopicEdited ¶
type ForumTopicEdited struct { // Name is the new name of the topic, if it was edited // // optional Name string `json:"name,omitempty"` // IconCustomEmojiID is the new identifier of the custom emoji // shown as the topic icon, if it was edited; // an empty string if the icon was removed // // optional IconCustomEmojiID *string `json:"icon_custom_emoji_id,omitempty"` }
ForumTopicEdited object represents a service message about an edited forum topic.
type ForumTopicReopened ¶
type ForumTopicReopened struct { }
ForumTopicReopened represents a service message about a forum topic reopened in the chat. Currently holds no information.
type ForwardConfig ¶
type ForwardConfig struct { BaseChat FromChat ChatConfig MessageID int // required }
ForwardConfig contains information about a ForwardMessage request.
func NewForward ¶
func NewForward(chatID int64, fromChatID int64, messageID int) ForwardConfig
NewForward creates a new forward.
chatID is where to send it, fromChatID is the source chat, and messageID is the ID of the original message.
type ForwardMessagesConfig ¶
type ForwardMessagesConfig struct { BaseChat FromChat ChatConfig MessageIDs []int // required }
ForwardMessagesConfig contains information about a ForwardMessages request.
type Game ¶
type Game struct { // Title of the game Title string `json:"title"` // Description of the game Description string `json:"description"` // Photo that will be displayed in the game message in chats. Photo []PhotoSize `json:"photo"` // Text a brief description of the game or high scores included in the game message. // Can be automatically edited to include current high scores for the game // when the bot calls setGameScore, or manually edited using editMessageText. 0-4096 characters. // // optional Text string `json:"text,omitempty"` // TextEntities special entities that appear in text, such as usernames, URLs, bot commands, etc. // // optional TextEntities []MessageEntity `json:"text_entities,omitempty"` // Animation is an animation that will be displayed in the game message in chats. // Upload via BotFather (https://t.me/botfather). // // optional Animation Animation `json:"animation,omitempty"` }
Game represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.
type GameConfig ¶
GameConfig allows you to send a game.
type GameHighScore ¶
type GameHighScore struct { // 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 is a user's score and position on the leaderboard.
type GeneralForumTopicHidden ¶
type GeneralForumTopicHidden struct { }
GeneralForumTopicHidden represents a service message about General forum topic hidden in the chat. Currently holds no information.
type GeneralForumTopicUnhidden ¶
type GeneralForumTopicUnhidden struct { }
GeneralForumTopicUnhidden represents a service message about General forum topic unhidden in the chat. Currently holds no information.
type GetChatMemberConfig ¶
type GetChatMemberConfig struct {
ChatConfigWithUser
}
GetChatMemberConfig is information about getting a specific member in a chat.
func NewGetChatMember ¶
func NewGetChatMember(chatID, userID int64) GetChatMemberConfig
type GetChatMenuButtonConfig ¶
type GetChatMenuButtonConfig struct {
ChatConfig
}
type GetCustomEmojiStickersConfig ¶
type GetCustomEmojiStickersConfig struct {
CustomEmojiIDs []string
}
GetCustomEmojiStickersConfig get information about custom emoji stickers by their identifiers.
type GetForumTopicIconStickersConfig ¶
type GetForumTopicIconStickersConfig struct{}
GetForumTopicIconStickersConfig allows you to get custom emoji stickers, which can be used as a forum topic icon by any user.
type GetGameHighScoresConfig ¶
type GetGameHighScoresConfig struct { BaseChatMessage UserID int64 InlineMessageID string }
GetGameHighScoresConfig allows you to fetch the high scores for a game.
type GetMyCommandsConfig ¶
type GetMyCommandsConfig struct { Scope *BotCommandScope LanguageCode string }
GetMyCommandsConfig gets a list of the currently registered commands.
func NewGetMyCommandsWithScope ¶
func NewGetMyCommandsWithScope(scope BotCommandScope) GetMyCommandsConfig
NewGetMyCommandsWithScope allows you to set the registered commands for a given scope.
func NewGetMyCommandsWithScopeAndLanguage ¶
func NewGetMyCommandsWithScopeAndLanguage(scope BotCommandScope, languageCode string) GetMyCommandsConfig
NewGetMyCommandsWithScopeAndLanguage allows you to set the registered commands for a given scope and language code.
type GetMyDefaultAdministratorRightsConfig ¶
type GetMyDefaultAdministratorRightsConfig struct {
ForChannels bool
}
type GetMyDescriptionConfig ¶
type GetMyDescriptionConfig struct {
LanguageCode string
}
GetMyDescriptionConfig get the current bot description for the given user language
func NewGetMyDescription ¶
func NewGetMyDescription(languageCode string) GetMyDescriptionConfig
NewGetMyDescription returns the current bot description for the given user language
type GetMyNameConfig ¶
type GetMyNameConfig struct {
LanguageCode string
}
func NewGetMyName ¶
func NewGetMyName(languageCode string) GetMyNameConfig
NewGetMyName get the current bot name for the given user language
type GetMyShortDescriptionConfig ¶
type GetMyShortDescriptionConfig struct {
LanguageCode string
}
GetMyShortDescriptionConfig get the current bot short description for the given user language
func NewGetMyShortDescription ¶
func NewGetMyShortDescription(languageCode string) GetMyShortDescriptionConfig
NewGetMyShortDescription returns the current bot short description for the given user language.
type GetStickerSetConfig ¶
type GetStickerSetConfig struct {
Name string
}
GetStickerSetConfig allows you to get the stickers in a set.
type GetUserChatBoostsConfig ¶
type GetUserChatBoostsConfig struct { ChatConfig UserID int64 }
type Giveaway ¶
type Giveaway struct { // Chats is the list of chats which the user must join to participate in the giveaway Chats []Chat `json:"chats"` // WinnersSelectionDate is point in time (Unix timestamp) when // winners of the giveaway will be selected WinnersSelectionDate int64 `json:"winners_selection_date"` // WinnerCount is the number of users which are supposed // to be selected as winners of the giveaway WinnerCount int `json:"winner_count"` // OnlyNewMembers True, if only users who join the chats after // the giveaway started should be eligible to win // // optional OnlyNewMembers bool `json:"only_new_members,omitempty"` // HasPublicWinners True, if the list of giveaway winners will be visible to everyone // // optional HasPublicWinners bool `json:"has_public_winners,omitempty"` // PrizeDescription is description of additional giveaway prize // // optional PrizeDescription string `json:"prize_description,omitempty"` // CountryCodes is a list of two-letter ISO 3166-1 alpha-2 country codes // indicating the countries from which eligible users for the giveaway must come. // If empty, then all users can participate in the giveaway. // // optional CountryCodes []string `json:"country_codes,omitempty"` // PremiumSubscriptionMonthCount the number of months the Telegram Premium // subscription won from the giveaway will be active for // // optional PremiumSubscriptionMonthCount int `json:"premium_subscription_month_count,omitempty"` }
Giveaway represents a message about a scheduled giveaway.
type GiveawayCompleted ¶
type GiveawayCompleted struct { // Number of winners in the giveaway WinnerCount int `json:"winner_count"` // Number of undistributed prizes // // optional UnclaimedPrizeCount int `json:"unclaimed_prize_count,omitempty"` // Message with the giveaway that was completed, if it wasn't deleted // // optional GiveawayMessage *Message `json:"giveaway_message,omitempty"` }
This object represents a service message about the completion of a giveaway without public winners.
type GiveawayCreated ¶
type GiveawayCreated struct{}
This object represents a service message about the creation of a scheduled giveaway. Currently holds no information.
type GiveawayWinners ¶
type GiveawayWinners struct { // Chat that created the giveaway Chat Chat `json:"chat"` // GiveawayMessageID is the identifier of the messsage with the giveaway in the chat GiveawayMessageID int `json:"giveaway_message_id"` // WinnersSelectionDate is point in time (Unix timestamp) when // winners of the giveaway will be selected WinnersSelectionDate int64 `json:"winners_selection_date"` // WinnerCount is the number of users which are supposed // to be selected as winners of the giveaway WinnerCount int `json:"winner_count"` // Winners is a list of up to 100 winners of the giveaway Winners []User `json:"winners"` // AdditionalChatCount is the number of other chats // the user had to join in order to be eligible for the giveaway // // optional AdditionalChatCount int `json:"additional_chat_count,omitempty"` // PremiumSubscriptionMonthCount the number of months the Telegram Premium // subscription won from the giveaway will be active for // // optional PremiumSubscriptionMonthCount int `json:"premium_subscription_month_count,omitempty"` // UnclaimedPrizeCount is the number of undistributed prizes // // optional UnclaimedPrizeCount int `json:"unclaimed_prize_count,omitempty"` // OnlyNewMembers True, if only users who join the chats after // the giveaway started should be eligible to win // // optional OnlyNewMembers bool `json:"only_new_members,omitempty"` // WasRefunded True, if the giveaway was canceled because the payment for it was refunded // // optional WasRefunded bool `json:"was_refunded,omitempty"` // PrizeDescription is description of additional giveaway prize // // optional PrizeDescription string `json:"prize_description,omitempty"` }
Giveaway represents a message about a scheduled giveaway.
type HTTPClient ¶
HTTPClient is the type needed for the bot to perform HTTP requests.
type HideGeneralForumTopicConfig ¶
type HideGeneralForumTopicConfig struct{ BaseForum }
HideGeneralForumTopicConfig allows you to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.
type IDDocumentData ¶
type IDDocumentData struct { DocumentNumber string `json:"document_no"` ExpiryDate string `json:"expiry_date"` }
IDDocumentData https://core.telegram.org/passport#iddocumentdata
type InaccessibleMessage ¶
type InaccessibleMessage struct { // Chat the message belonged to Chat Chat `json:"chat"` // MessageID is unique message identifier inside the chat MessageID int `json:"message_id"` // Date is always 0. The field can be used to differentiate regular and inaccessible messages. Date int `json:"date"` }
InaccessibleMessage describes a message that was deleted or is otherwise inaccessible to the bot.
type InlineConfig ¶
type InlineConfig struct { InlineQueryID string `json:"inline_query_id"` Results []interface{} `json:"results"` CacheTime int `json:"cache_time"` IsPersonal bool `json:"is_personal"` NextOffset string `json:"next_offset"` Button *InlineQueryResultsButton `json:"button,omitempty"` }
InlineConfig contains information on making an InlineQuery response.
Example ¶
bot, err := NewBotAPI("MyAwesomeBotToken") // create new bot if err != nil { panic(err) } log.Printf("Authorized on account %s", bot.Self.UserName) u := NewUpdate(0) u.Timeout = 60 updates := bot.GetUpdatesChan(u) for update := range updates { if update.InlineQuery == nil { // if no inline query, ignore it continue } article := NewInlineQueryResultArticle(update.InlineQuery.ID, "Echo", update.InlineQuery.Query) article.Description = update.InlineQuery.Query inlineConf := InlineConfig{ InlineQueryID: update.InlineQuery.ID, IsPersonal: true, CacheTime: 0, Results: []interface{}{article}, } if _, err := bot.Request(inlineConf); err != nil { log.Println(err) } }
Output:
type InlineKeyboardButton ¶
type InlineKeyboardButton struct { // Text label text on the button Text string `json:"text"` // URL HTTP or tg:// url to be opened when button is pressed. // // optional URL *string `json:"url,omitempty"` // LoginURL is an HTTP URL used to automatically authorize the user. Can be // used as a replacement for the Telegram Login Widget // // optional LoginURL *LoginURL `json:"login_url,omitempty"` // CallbackData data to be sent in a callback query to the bot when button is pressed, 1-64 bytes. // // optional CallbackData *string `json:"callback_data,omitempty"` // WebApp is the Description of the Web App that will be launched when the user presses the button. // The Web App will be able to send an arbitrary message on behalf of the user using the method // answerWebAppQuery. Available only in private chats between a user and the bot. // // optional WebApp *WebAppInfo `json:"web_app,omitempty"` // SwitchInlineQuery 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. // // This offers an easy way for users to start using your bot // in inline mode when they are currently in a private chat with it. // Especially useful when combined with switch_pm… actions – in this case // the user will be automatically returned to the chat they switched from, // skipping the chat selection screen. // // optional SwitchInlineQuery *string `json:"switch_inline_query,omitempty"` // SwitchInlineQueryCurrentChat 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. // // optional SwitchInlineQueryCurrentChat *string `json:"switch_inline_query_current_chat,omitempty"` //SwitchInlineQueryChosenChat If set, pressing the button will prompt the user to //select one of their chats of the specified type, open that chat and insert the bot's //username and the specified inline query in the input field // //optional SwitchInlineQueryChosenChat *SwitchInlineQueryChosenChat `json:"switch_inline_query_chosen_chat,omitempty"` // CallbackGame description of the game that will be launched when the user presses the button. // // optional CallbackGame *CallbackGame `json:"callback_game,omitempty"` // Pay specify True, to send a Pay button. // // NOTE: This type of button must always be the first button in the first row. // // optional Pay bool `json:"pay,omitempty"` }
InlineKeyboardButton represents one button of an inline keyboard. You must use exactly one of the optional fields.
Note that some values are references as even an empty string will change behavior.
CallbackGame, if set, MUST be first button in first row.
func NewInlineKeyboardButtonData ¶
func NewInlineKeyboardButtonData(text, data string) InlineKeyboardButton
NewInlineKeyboardButtonData creates an inline keyboard button with text and data for a callback.
func NewInlineKeyboardButtonLoginURL ¶
func NewInlineKeyboardButtonLoginURL(text string, loginURL LoginURL) InlineKeyboardButton
NewInlineKeyboardButtonLoginURL creates an inline keyboard button with text which goes to a LoginURL.
func NewInlineKeyboardButtonSwitch ¶
func NewInlineKeyboardButtonSwitch(text, sw string) InlineKeyboardButton
NewInlineKeyboardButtonSwitch creates an inline keyboard button with text which allows the user to switch to a chat or return to a chat.
func NewInlineKeyboardButtonSwitchInlineQueryChoosenChat ¶
func NewInlineKeyboardButtonSwitchInlineQueryChoosenChat(text string, switchInlineQueryChosenChat SwitchInlineQueryChosenChat) InlineKeyboardButton
NewInlineKeyboardButtonSwitchInlineQueryChoosenChat creates an inline keyboard button with text which goes to a SwitchInlineQueryChosenChat.
func NewInlineKeyboardButtonURL ¶
func NewInlineKeyboardButtonURL(text, url string) InlineKeyboardButton
NewInlineKeyboardButtonURL creates an inline keyboard button with text which goes to a URL.
func NewInlineKeyboardButtonWebApp ¶
func NewInlineKeyboardButtonWebApp(text string, webapp WebAppInfo) InlineKeyboardButton
NewInlineKeyboardButtonWebApp creates an inline keyboard button with text which goes to a WebApp.
func NewInlineKeyboardRow ¶
func NewInlineKeyboardRow(buttons ...InlineKeyboardButton) []InlineKeyboardButton
NewInlineKeyboardRow creates an inline keyboard row with buttons.
type InlineKeyboardMarkup ¶
type InlineKeyboardMarkup struct { // InlineKeyboard array of button rows, each represented by an Array of // InlineKeyboardButton objects InlineKeyboard [][]InlineKeyboardButton `json:"inline_keyboard"` }
InlineKeyboardMarkup represents an inline keyboard that appears right next to the message it belongs to.
func NewInlineKeyboardMarkup ¶
func NewInlineKeyboardMarkup(rows ...[]InlineKeyboardButton) InlineKeyboardMarkup
NewInlineKeyboardMarkup creates a new inline keyboard.
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 of the results to be returned, can be controlled by the bot. Offset string `json:"offset"` // 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 // // optional ChatType string `json:"chat_type,omitempty"` // Location sender location, only for bots that request user location. // // optional Location *Location `json:"location,omitempty"` }
InlineQuery is a Query from Telegram for an inline request.
type InlineQueryResultArticle ¶
type InlineQueryResultArticle struct { // 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 of the result Title string `json:"title"` // InputMessageContent content of the message to be sent. InputMessageContent interface{} `json:"input_message_content,omitempty"` // ReplyMarkup Inline keyboard attached to the message. // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // URL of the result. // // optional URL string `json:"url,omitempty"` // HideURL pass True, if you don't want the URL to be shown in the message. // // optional HideURL bool `json:"hide_url,omitempty"` // Description short description of the result. // // optional Description string `json:"description,omitempty"` // ThumbURL url of the thumbnail for the result // // optional ThumbURL string `json:"thumbnail_url,omitempty"` // ThumbWidth thumbnail width // // optional ThumbWidth int `json:"thumbnail_width,omitempty"` // ThumbHeight thumbnail height // // optional ThumbHeight int `json:"thumbnail_height,omitempty"` }
InlineQueryResultArticle represents a link to an article or web page.
func NewInlineQueryResultArticle ¶
func NewInlineQueryResultArticle(id, title, messageText string) InlineQueryResultArticle
NewInlineQueryResultArticle creates a new inline query article.
func NewInlineQueryResultArticleHTML ¶
func NewInlineQueryResultArticleHTML(id, title, messageText string) InlineQueryResultArticle
NewInlineQueryResultArticleHTML creates a new inline query article with HTML parsing.
func NewInlineQueryResultArticleMarkdown ¶
func NewInlineQueryResultArticleMarkdown(id, title, messageText string) InlineQueryResultArticle
NewInlineQueryResultArticleMarkdown creates a new inline query article with Markdown parsing.
func NewInlineQueryResultArticleMarkdownV2 ¶
func NewInlineQueryResultArticleMarkdownV2(id, title, messageText string) InlineQueryResultArticle
NewInlineQueryResultArticleMarkdownV2 creates a new inline query article with MarkdownV2 parsing.
type InlineQueryResultAudio ¶
type InlineQueryResultAudio struct { // Type of the result, must be audio Type string `json:"type"` // ID unique identifier for this result, 1-64 bytes ID string `json:"id"` // URL a valid url for the audio file URL string `json:"audio_url"` // Title is a title Title string `json:"title"` // Caption 0-1024 characters after entities parsing // // optional Caption string `json:"caption,omitempty"` // ParseMode mode for parsing entities in the video caption. // See formatting options for more details // (https://core.telegram.org/bots/api#formatting-options). // // optional ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities is a list of special entities that appear in the caption, // which can be specified instead of parse_mode // // optional CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // Performer is a performer // // optional Performer string `json:"performer,omitempty"` // Duration audio duration in seconds // // optional Duration int `json:"audio_duration,omitempty"` // ReplyMarkup inline keyboard attached to the message // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the audio // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` }
InlineQueryResultAudio is an inline query response audio.
func NewInlineQueryResultAudio ¶
func NewInlineQueryResultAudio(id, url, title string) InlineQueryResultAudio
NewInlineQueryResultAudio creates a new inline query audio.
type InlineQueryResultCachedAudio ¶
type InlineQueryResultCachedAudio struct { // Type of the result, must be audio Type string `json:"type"` // ID unique identifier for this result, 1-64 bytes ID string `json:"id"` // AudioID a valid file identifier for the audio file AudioID string `json:"audio_file_id"` // Caption 0-1024 characters after entities parsing // // optional Caption string `json:"caption,omitempty"` // ParseMode mode for parsing entities in the video caption. // See formatting options for more details // (https://core.telegram.org/bots/api#formatting-options). // // optional ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities is a list of special entities that appear in the caption, // which can be specified instead of parse_mode // // optional CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // ReplyMarkup inline keyboard attached to the message // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the audio // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` }
InlineQueryResultCachedAudio is an inline query response with cached audio.
func NewInlineQueryResultCachedAudio ¶
func NewInlineQueryResultCachedAudio(id, audioID string) InlineQueryResultCachedAudio
NewInlineQueryResultCachedAudio create a new inline query with cached photo.
type InlineQueryResultCachedDocument ¶
type InlineQueryResultCachedDocument struct { // Type of the result, must be a document Type string `json:"type"` // ID unique identifier for this result, 1-64 bytes ID string `json:"id"` // DocumentID a valid file identifier for the file DocumentID string `json:"document_file_id"` // Title for the result // // optional Title string `json:"title,omitempty"` // Caption of the document to be sent, 0-1024 characters after entities parsing // // optional Caption string `json:"caption,omitempty"` // Description short description of the result // // optional Description string `json:"description,omitempty"` // ParseMode mode for parsing entities in the video caption. // // See formatting options for more details // // (https://core.telegram.org/bots/api#formatting-options). // // optional ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities is a list of special entities that appear in the caption, // which can be specified instead of parse_mode // // optional CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // ReplyMarkup inline keyboard attached to the message // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the file // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` }
InlineQueryResultCachedDocument is an inline query response with cached document.
func NewInlineQueryResultCachedDocument ¶
func NewInlineQueryResultCachedDocument(id, documentID, title string) InlineQueryResultCachedDocument
NewInlineQueryResultCachedDocument create a new inline query with cached photo.
type InlineQueryResultCachedGIF ¶
type InlineQueryResultCachedGIF struct { // Type of the result, must be gif. Type string `json:"type"` // ID unique identifier for this result, 1-64 bytes. ID string `json:"id"` // GifID a valid file identifier for the GIF file. GIFID string `json:"gif_file_id"` // Title for the result // // optional Title string `json:"title,omitempty"` // Caption of the GIF file to be sent, 0-1024 characters after entities parsing. // // optional Caption string `json:"caption,omitempty"` // ParseMode mode for parsing entities in the caption. // See formatting options for more details // (https://core.telegram.org/bots/api#formatting-options). // // optional ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities is a list of special entities that appear in the caption, // which can be specified instead of parse_mode // // optional CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // ReplyMarkup inline keyboard attached to the message. // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the GIF animation. // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` }
InlineQueryResultCachedGIF is an inline query response with cached gif.
func NewInlineQueryResultCachedGIF ¶
func NewInlineQueryResultCachedGIF(id, gifID string) InlineQueryResultCachedGIF
NewInlineQueryResultCachedGIF create a new inline query with cached photo.
type InlineQueryResultCachedMPEG4GIF ¶
type InlineQueryResultCachedMPEG4GIF struct { // 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 for the result // // optional Title string `json:"title,omitempty"` // Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing. // // optional Caption string `json:"caption,omitempty"` // ParseMode mode for parsing entities in the caption. // See formatting options for more details // (https://core.telegram.org/bots/api#formatting-options). // // optional ParseMode string `json:"parse_mode,omitempty"` // ParseMode mode for parsing entities in the video caption. // See formatting options for more details // (https://core.telegram.org/bots/api#formatting-options). // // optional CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // ReplyMarkup inline keyboard attached to the message. // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the video animation. // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` }
InlineQueryResultCachedMPEG4GIF is an inline query response with cached H.264/MPEG-4 AVC video without sound gif.
func NewInlineQueryResultCachedMPEG4GIF ¶
func NewInlineQueryResultCachedMPEG4GIF(id, MPEG4GIFID string) InlineQueryResultCachedMPEG4GIF
NewInlineQueryResultCachedMPEG4GIF create a new inline query with cached MPEG4 GIF.
type InlineQueryResultCachedPhoto ¶
type InlineQueryResultCachedPhoto struct { // Type of the result, must be a photo. Type string `json:"type"` // ID unique identifier for this result, 1-64 bytes. ID string `json:"id"` // PhotoID a valid file identifier of the photo. PhotoID string `json:"photo_file_id"` // Title for the result. // // optional Title string `json:"title,omitempty"` // Description short description of the result. // // optional Description string `json:"description,omitempty"` // Caption of the photo to be sent, 0-1024 characters after entities parsing. // // optional Caption string `json:"caption,omitempty"` // ParseMode mode for parsing entities in the photo caption. // See formatting options for more details // (https://core.telegram.org/bots/api#formatting-options). // // optional ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities is a list of special entities that appear in the caption, // which can be specified instead of parse_mode // // optional CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // ReplyMarkup inline keyboard attached to the message. // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the photo. // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` }
InlineQueryResultCachedPhoto is an inline query response with cached photo.
func NewInlineQueryResultCachedPhoto ¶
func NewInlineQueryResultCachedPhoto(id, photoID string) InlineQueryResultCachedPhoto
NewInlineQueryResultCachedPhoto create a new inline query with cached photo.
type InlineQueryResultCachedSticker ¶
type InlineQueryResultCachedSticker struct { // Type of the result, must be a sticker Type string `json:"type"` // ID unique identifier for this result, 1-64 bytes ID string `json:"id"` // StickerID a valid file identifier of the sticker StickerID string `json:"sticker_file_id"` // Title is a title Title string `json:"title"` // ReplyMarkup inline keyboard attached to the message // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the sticker // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` }
InlineQueryResultCachedSticker is an inline query response with cached sticker.
func NewInlineQueryResultCachedSticker ¶
func NewInlineQueryResultCachedSticker(id, stickerID, title string) InlineQueryResultCachedSticker
NewInlineQueryResultCachedSticker create a new inline query with cached sticker.
type InlineQueryResultCachedVideo ¶
type InlineQueryResultCachedVideo struct { // Type of the result, must be video Type string `json:"type"` // ID unique identifier for this result, 1-64 bytes ID string `json:"id"` // VideoID a valid file identifier for the video file VideoID string `json:"video_file_id"` // Title for the result Title string `json:"title"` // Description short description of the result // // optional Description string `json:"description,omitempty"` // Caption of the video to be sent, 0-1024 characters after entities parsing // // optional Caption string `json:"caption,omitempty"` // ParseMode mode for parsing entities in the video caption. // See formatting options for more details // (https://core.telegram.org/bots/api#formatting-options). // // optional ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities is a list of special entities that appear in the caption, // which can be specified instead of parse_mode // // optional CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // ReplyMarkup inline keyboard attached to the message // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the video // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` }
InlineQueryResultCachedVideo is an inline query response with cached video.
func NewInlineQueryResultCachedVideo ¶
func NewInlineQueryResultCachedVideo(id, videoID, title string) InlineQueryResultCachedVideo
NewInlineQueryResultCachedVideo create a new inline query with cached video.
type InlineQueryResultCachedVoice ¶
type InlineQueryResultCachedVoice struct { // Type of the result, must be voice Type string `json:"type"` // ID unique identifier for this result, 1-64 bytes ID string `json:"id"` // VoiceID a valid file identifier for the voice message VoiceID string `json:"voice_file_id"` // Title voice message title Title string `json:"title"` // Caption 0-1024 characters after entities parsing // // optional Caption string `json:"caption,omitempty"` // ParseMode mode for parsing entities in the video caption. // See formatting options for more details // (https://core.telegram.org/bots/api#formatting-options). // // optional ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities is a list of special entities that appear in the caption, // which can be specified instead of parse_mode // // optional CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // ReplyMarkup inline keyboard attached to the message // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the voice message // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` }
InlineQueryResultCachedVoice is an inline query response with cached voice.
func NewInlineQueryResultCachedVoice ¶
func NewInlineQueryResultCachedVoice(id, voiceID, title string) InlineQueryResultCachedVoice
NewInlineQueryResultCachedVoice create a new inline query with cached photo.
type InlineQueryResultContact ¶
type InlineQueryResultContact struct { Type string `json:"type"` // required ID string `json:"id"` // required PhoneNumber string `json:"phone_number"` // required FirstName string `json:"first_name"` // required LastName string `json:"last_name"` VCard string `json:"vcard"` ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` InputMessageContent interface{} `json:"input_message_content,omitempty"` ThumbURL string `json:"thumbnail_url"` ThumbWidth int `json:"thumbnail_width"` ThumbHeight int `json:"thumbnail_height"` }
InlineQueryResultContact is an inline query response contact.
type InlineQueryResultDocument ¶
type InlineQueryResultDocument struct { // Type of the result, must be a document Type string `json:"type"` // ID unique identifier for this result, 1-64 bytes ID string `json:"id"` // Title for the result Title string `json:"title"` // Caption of the document to be sent, 0-1024 characters after entities parsing // // optional Caption string `json:"caption,omitempty"` // URL a valid url for the file URL string `json:"document_url"` // MimeType of the content of the file, either “application/pdf” or “application/zip” MimeType string `json:"mime_type"` // Description short description of the result // // optional Description string `json:"description,omitempty"` // ReplyMarkup inline keyboard attached to the message // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the file // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` // ThumbURL url of the thumbnail (jpeg only) for the file // // optional ThumbURL string `json:"thumbnail_url,omitempty"` // ThumbWidth thumbnail width // // optional ThumbWidth int `json:"thumbnail_width,omitempty"` // ThumbHeight thumbnail height // // optional ThumbHeight int `json:"thumbnail_height,omitempty"` }
InlineQueryResultDocument is an inline query response document.
func NewInlineQueryResultDocument ¶
func NewInlineQueryResultDocument(id, url, title, mimeType string) InlineQueryResultDocument
NewInlineQueryResultDocument creates a new inline query document.
type InlineQueryResultGIF ¶
type InlineQueryResultGIF struct { // Type of the result, must be gif. Type string `json:"type"` // ID unique identifier for this result, 1-64 bytes. ID string `json:"id"` // URL a valid URL for the GIF file. File size must not exceed 1MB. URL string `json:"gif_url"` // ThumbURL url of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result. ThumbURL string `json:"thumbnail_url"` // MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg” ThumbMimeType string `json:"thumbnail_mime_type,omitempty"` // Width of the GIF // // optional Width int `json:"gif_width,omitempty"` // Height of the GIF // // optional Height int `json:"gif_height,omitempty"` // Duration of the GIF // // optional Duration int `json:"gif_duration,omitempty"` // Title for the result // // optional Title string `json:"title,omitempty"` // Caption of the GIF file to be sent, 0-1024 characters after entities parsing. // // optional Caption string `json:"caption,omitempty"` // ParseMode mode for parsing entities in the video caption. // See formatting options for more details // (https://core.telegram.org/bots/api#formatting-options). // // optional ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities is a list of special entities that appear in the caption, // which can be specified instead of parse_mode // // optional CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // ReplyMarkup inline keyboard attached to the message // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the GIF animation. // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` }
InlineQueryResultGIF is an inline query response GIF.
func NewInlineQueryResultGIF ¶
func NewInlineQueryResultGIF(id, url string) InlineQueryResultGIF
NewInlineQueryResultGIF creates a new inline query GIF.
type InlineQueryResultGame ¶
type InlineQueryResultGame struct { // 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 inline keyboard attached to the message // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` }
InlineQueryResultGame is an inline query response game.
type InlineQueryResultLocation ¶
type InlineQueryResultLocation struct { // 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 of the location in degrees Latitude float64 `json:"latitude"` // Longitude of the location in degrees Longitude float64 `json:"longitude"` // Title of the location Title string `json:"title"` // HorizontalAccuracy is the radius of uncertainty for the location, // measured in meters; 0-1500 // // optional HorizontalAccuracy float64 `json:"horizontal_accuracy,omitempty"` // LivePeriod is the period in seconds for which the location can be // updated, should be between 60 and 86400. // // optional LivePeriod int `json:"live_period,omitempty"` // Heading is for live locations, a direction in which the user is moving, // in degrees. Must be between 1 and 360 if specified. // // optional Heading int `json:"heading,omitempty"` // ProximityAlertRadius is for live locations, a maximum distance for // proximity alerts about approaching another chat member, in meters. Must // be between 1 and 100000 if specified. // // optional ProximityAlertRadius int `json:"proximity_alert_radius,omitempty"` // ReplyMarkup inline keyboard attached to the message // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the location // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` // ThumbURL url of the thumbnail for the result // // optional ThumbURL string `json:"thumbnail_url,omitempty"` // ThumbWidth thumbnail width // // optional ThumbWidth int `json:"thumbnail_width,omitempty"` // ThumbHeight thumbnail height // // optional ThumbHeight int `json:"thumbnail_height,omitempty"` }
InlineQueryResultLocation is an inline query response location.
func NewInlineQueryResultLocation ¶
func NewInlineQueryResultLocation(id, title string, latitude, longitude float64) InlineQueryResultLocation
NewInlineQueryResultLocation creates a new inline query location.
type InlineQueryResultMPEG4GIF ¶
type InlineQueryResultMPEG4GIF struct { // 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"` // URL a valid URL for the MP4 file. File size must not exceed 1MB URL string `json:"mpeg4_url"` // Width video width // // optional Width int `json:"mpeg4_width,omitempty"` // Height vVideo height // // optional Height int `json:"mpeg4_height,omitempty"` // Duration video duration // // optional Duration int `json:"mpeg4_duration,omitempty"` // ThumbURL url of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result. ThumbURL string `json:"thumbnail_url"` // MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg” ThumbMimeType string `json:"thumbnail_mime_type,omitempty"` // Title for the result // // optional Title string `json:"title,omitempty"` // Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing. // // optional Caption string `json:"caption,omitempty"` // ParseMode mode for parsing entities in the video caption. // See formatting options for more details // (https://core.telegram.org/bots/api#formatting-options). // // optional ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities is a list of special entities that appear in the caption, // which can be specified instead of parse_mode // // optional CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // ReplyMarkup inline keyboard attached to the message // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the video animation // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` }
InlineQueryResultMPEG4GIF is an inline query response MPEG4 GIF.
func NewInlineQueryResultMPEG4GIF ¶
func NewInlineQueryResultMPEG4GIF(id, url string) InlineQueryResultMPEG4GIF
NewInlineQueryResultMPEG4GIF creates a new inline query MPEG4 GIF.
type InlineQueryResultPhoto ¶
type InlineQueryResultPhoto struct { // Type of the result, must be article. Type string `json:"type"` // ID unique identifier for this result, 1-64 Bytes. ID string `json:"id"` // URL a valid URL of the photo. Photo must be in jpeg format. // Photo size must not exceed 5MB. URL string `json:"photo_url"` // MimeType MimeType string `json:"mime_type"` // Width of the photo // // optional Width int `json:"photo_width,omitempty"` // Height of the photo // // optional Height int `json:"photo_height,omitempty"` // ThumbURL url of the thumbnail for the photo. // // optional ThumbURL string `json:"thumbnail_url,omitempty"` // Title for the result // // optional Title string `json:"title,omitempty"` // Description short description of the result // // optional Description string `json:"description,omitempty"` // Caption of the photo to be sent, 0-1024 characters after entities parsing. // // optional Caption string `json:"caption,omitempty"` // ParseMode mode for parsing entities in the photo caption. // See formatting options for more details // (https://core.telegram.org/bots/api#formatting-options). // // optional ParseMode string `json:"parse_mode,omitempty"` // ReplyMarkup inline keyboard attached to the message. // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // CaptionEntities is a list of special entities that appear in the caption, // which can be specified instead of parse_mode // // optional CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // InputMessageContent content of the message to be sent instead of the photo. // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` }
InlineQueryResultPhoto is an inline query response photo.
func NewInlineQueryResultPhoto ¶
func NewInlineQueryResultPhoto(id, url string) InlineQueryResultPhoto
NewInlineQueryResultPhoto creates a new inline query photo.
func NewInlineQueryResultPhotoWithThumb ¶
func NewInlineQueryResultPhotoWithThumb(id, url, thumb string) InlineQueryResultPhoto
NewInlineQueryResultPhotoWithThumb creates a new inline query photo.
type InlineQueryResultVenue ¶
type InlineQueryResultVenue struct { // 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 of the venue location in degrees Latitude float64 `json:"latitude"` // Longitude of the venue location in degrees Longitude float64 `json:"longitude"` // Title of the venue Title string `json:"title"` // Address of the venue Address string `json:"address"` // FoursquareID foursquare identifier of the venue if known // // optional FoursquareID string `json:"foursquare_id,omitempty"` // FoursquareType foursquare type of the venue, if known. // (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.) // // optional FoursquareType string `json:"foursquare_type,omitempty"` // GooglePlaceID is the Google Places identifier of the venue // // optional GooglePlaceID string `json:"google_place_id,omitempty"` // GooglePlaceType is the Google Places type of the venue // // optional GooglePlaceType string `json:"google_place_type,omitempty"` // ReplyMarkup inline keyboard attached to the message // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the venue // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` // ThumbURL url of the thumbnail for the result // // optional ThumbURL string `json:"thumbnail_url,omitempty"` // ThumbWidth thumbnail width // // optional ThumbWidth int `json:"thumbnail_width,omitempty"` // ThumbHeight thumbnail height // // optional ThumbHeight int `json:"thumbnail_height,omitempty"` }
InlineQueryResultVenue is an inline query response venue.
func NewInlineQueryResultVenue ¶
func NewInlineQueryResultVenue(id, title, address string, latitude, longitude float64) InlineQueryResultVenue
NewInlineQueryResultVenue creates a new inline query venue.
type InlineQueryResultVideo ¶
type InlineQueryResultVideo struct { // Type of the result, must be video Type string `json:"type"` // ID unique identifier for this result, 1-64 bytes ID string `json:"id"` // URL a valid url for the embedded video player or video file URL string `json:"video_url"` // MimeType 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 // optional ThumbURL string `json:"thumbnail_url,omitempty"` // Title for the result Title string `json:"title"` // Caption of the video to be sent, 0-1024 characters after entities parsing // // optional Caption string `json:"caption,omitempty"` // Width video width // // optional Width int `json:"video_width,omitempty"` // Height video height // // optional Height int `json:"video_height,omitempty"` // Duration video duration in seconds // // optional Duration int `json:"video_duration,omitempty"` // Description short description of the result // // optional Description string `json:"description,omitempty"` // ReplyMarkup inline keyboard attached to the message // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent 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). // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` }
InlineQueryResultVideo is an inline query response video.
func NewInlineQueryResultVideo ¶
func NewInlineQueryResultVideo(id, url string) InlineQueryResultVideo
NewInlineQueryResultVideo creates a new inline query video.
type InlineQueryResultVoice ¶
type InlineQueryResultVoice struct { // Type of the result, must be voice Type string `json:"type"` // ID unique identifier for this result, 1-64 bytes ID string `json:"id"` // URL a valid URL for the voice recording URL string `json:"voice_url"` // Title recording title Title string `json:"title"` // Caption 0-1024 characters after entities parsing // // optional Caption string `json:"caption,omitempty"` // ParseMode mode for parsing entities in the video caption. // See formatting options for more details // (https://core.telegram.org/bots/api#formatting-options). // // optional ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities is a list of special entities that appear in the caption, // which can be specified instead of parse_mode // // optional CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // Duration recording duration in seconds // // optional Duration int `json:"voice_duration,omitempty"` // ReplyMarkup inline keyboard attached to the message // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the voice recording // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` }
InlineQueryResultVoice is an inline query response voice.
func NewInlineQueryResultVoice ¶
func NewInlineQueryResultVoice(id, url, title string) InlineQueryResultVoice
NewInlineQueryResultVoice creates a new inline query voice.
type InlineQueryResultsButton ¶
type InlineQueryResultsButton struct { //Label text on the button Text string `json:"text"` //Description of the Web App that will be launched when the user presses the button. The Web App will be able to switch back to the inline mode using the method switchInlineQuery inside the Web App. // //Optional WebApp *WebAppInfo `json:"web_app,omitempty"` // Deep-linking parameter for the /start message sent to the bot when a user presses the button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed. // //Optional StartParam string `json:"start_parameter,omitempty"` }
InlineQueryResultsButton represents a button to be shown above inline query results. You must use exactly one of the optional fields.
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 contact's last name // // optional LastName string `json:"last_name,omitempty"` // Additional data about the contact in the form of a vCard // // optional VCard string `json:"vcard,omitempty"` }
InputContactMessageContent contains a contact for displaying as an inline query result.
type InputInvoiceMessageContent ¶
type InputInvoiceMessageContent struct { // Product name, 1-32 characters Title string `json:"title"` // Product description, 1-255 characters Description string `json:"description"` // Bot-defined invoice payload, 1-128 bytes. This will not be displayed to // the user, use for your internal processes. Payload string `json:"payload"` // Payment provider token, obtained via Botfather ProviderToken string `json:"provider_token"` // Three-letter ISO 4217 currency code Currency string `json:"currency"` // Price breakdown, a JSON-serialized list of components (e.g. product // price, tax, discount, delivery cost, delivery tax, bonus, etc.) Prices []LabeledPrice `json:"prices"` // The maximum accepted amount for tips in the smallest units of the // currency (integer, not float/double). // // optional MaxTipAmount int `json:"max_tip_amount,omitempty"` // An 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. // // optional SuggestedTipAmounts []int `json:"suggested_tip_amounts,omitempty"` // 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. // // optional ProviderData string `json:"provider_data,omitempty"` // URL of the product photo for the invoice. Can be a photo of the goods or // a marketing image for a service. People like it better when they see what // they are paying for. // // optional PhotoURL string `json:"photo_url,omitempty"` // Photo size // // optional PhotoSize int `json:"photo_size,omitempty"` // Photo width // // optional PhotoWidth int `json:"photo_width,omitempty"` // Photo height // // optional PhotoHeight int `json:"photo_height,omitempty"` // Pass True, if you require the user's full name to complete the order // // optional NeedName bool `json:"need_name,omitempty"` // Pass True, if you require the user's phone number to complete the order // // optional NeedPhoneNumber bool `json:"need_phone_number,omitempty"` // Pass True, if you require the user's email address to complete the order // // optional NeedEmail bool `json:"need_email,omitempty"` // Pass True, if you require the user's shipping address to complete the order // // optional NeedShippingAddress bool `json:"need_shipping_address,omitempty"` // Pass True, if user's phone number should be sent to provider // // optional SendPhoneNumberToProvider bool `json:"send_phone_number_to_provider,omitempty"` // Pass True, if user's email address should be sent to provider // // optional SendEmailToProvider bool `json:"send_email_to_provider,omitempty"` // Pass True, if the final price depends on the shipping method // // optional IsFlexible bool `json:"is_flexible,omitempty"` }
InputInvoiceMessageContent represents the content of an invoice message to be sent as the result of an inline query.
type InputLocationMessageContent ¶
type InputLocationMessageContent struct { // Latitude of the location in degrees Latitude float64 `json:"latitude"` // Longitude of the location in degrees Longitude float64 `json:"longitude"` // HorizontalAccuracy is the radius of uncertainty for the location, // measured in meters; 0-1500 // // optional HorizontalAccuracy float64 `json:"horizontal_accuracy,omitempty"` // LivePeriod is the period in seconds for which the location can be // updated, should be between 60 and 86400 // // optional LivePeriod int `json:"live_period,omitempty"` // Heading is for live locations, a direction in which the user is moving, // in degrees. Must be between 1 and 360 if specified. // // optional Heading int `json:"heading,omitempty"` // ProximityAlertRadius is for live locations, a maximum distance for // proximity alerts about approaching another chat member, in meters. Must // be between 1 and 100000 if specified. // // optional ProximityAlertRadius int `json:"proximity_alert_radius,omitempty"` }
InputLocationMessageContent contains a location for displaying as an inline query result.
type InputMediaAnimation ¶
type InputMediaAnimation struct { BaseInputMedia // Thumbnail of the file sent; can be ignored if thumbnail generation for // the file is supported server-side. // // optional Thumb RequestFileData `json:"thumbnail,omitempty"` // Width video width // // optional Width int `json:"width,omitempty"` // Height video height // // optional Height int `json:"height,omitempty"` // Duration video duration // // optional Duration int `json:"duration,omitempty"` // HasSpoiler pass True, if the photo needs to be covered with a spoiler animation // // optional HasSpoiler bool `json:"has_spoiler,omitempty"` }
InputMediaAnimation is an animation to send as part of a media group.
func NewInputMediaAnimation ¶
func NewInputMediaAnimation(media RequestFileData) InputMediaAnimation
NewInputMediaAnimation creates a new InputMediaAnimation.
type InputMediaAudio ¶
type InputMediaAudio struct { BaseInputMedia // Thumbnail of the file sent; can be ignored if thumbnail generation for // the file is supported server-side. // // optional Thumb RequestFileData `json:"thumbnail,omitempty"` // Duration of the audio in seconds // // optional Duration int `json:"duration,omitempty"` // Performer of the audio // // optional Performer string `json:"performer,omitempty"` // Title of the audio // // optional Title string `json:"title,omitempty"` }
InputMediaAudio is an audio to send as part of a media group.
func NewInputMediaAudio ¶
func NewInputMediaAudio(media RequestFileData) InputMediaAudio
NewInputMediaAudio creates a new InputMediaAudio.
type InputMediaDocument ¶
type InputMediaDocument struct { BaseInputMedia // Thumbnail of the file sent; can be ignored if thumbnail generation for // the file is supported server-side. // // optional Thumb RequestFileData `json:"thumbnail,omitempty"` // DisableContentTypeDetection 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 // // optional DisableContentTypeDetection bool `json:"disable_content_type_detection,omitempty"` }
InputMediaDocument is a general file to send as part of a media group.
func NewInputMediaDocument ¶
func NewInputMediaDocument(media RequestFileData) InputMediaDocument
NewInputMediaDocument creates a new InputMediaDocument.
type InputMediaPhoto ¶
type InputMediaPhoto struct {
BaseInputMedia
}
InputMediaPhoto is a photo to send as part of a media group.
func NewInputMediaPhoto ¶
func NewInputMediaPhoto(media RequestFileData) InputMediaPhoto
NewInputMediaPhoto creates a new InputMediaPhoto.
type InputMediaVideo ¶
type InputMediaVideo struct { BaseInputMedia // Thumbnail of the file sent; can be ignored if thumbnail generation for // the file is supported server-side. // // optional Thumb RequestFileData `json:"thumbnail,omitempty"` // Width video width // // optional Width int `json:"width,omitempty"` // Height video height // // optional Height int `json:"height,omitempty"` // Duration video duration // // optional Duration int `json:"duration,omitempty"` // SupportsStreaming pass True, if the uploaded video is suitable for streaming. // // optional SupportsStreaming bool `json:"supports_streaming,omitempty"` // HasSpoiler pass True, if the video needs to be covered with a spoiler animation // // optional HasSpoiler bool `json:"has_spoiler,omitempty"` }
InputMediaVideo is a video to send as part of a media group.
func NewInputMediaVideo ¶
func NewInputMediaVideo(media RequestFileData) InputMediaVideo
NewInputMediaVideo creates a new InputMediaVideo.
type InputSticker ¶
type InputSticker struct { // The added sticker. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, upload a new one using multipart/form-data, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. Animated and video stickers can't be uploaded via HTTP URL. Sticker RequestFile `json:"sticker"` // List of 1-20 emoji associated with the sticker EmojiList []string `json:"emoji_list"` // Position where the mask should be placed on faces. For “mask” stickers only. // // optional MaskPosition *MaskPosition `json:"mask_position"` // List of 0-20 search keywords for the sticker with total length of up to 64 characters. For “regular” and “custom_emoji” stickers only. // // optional Keywords []string `json:"keywords"` }
InputSticker describes a sticker to be added to a sticker set.
type InputTextMessageContent ¶
type InputTextMessageContent struct { // Text of the message to be sent, 1-4096 characters Text string `json:"message_text"` // ParseMode mode for parsing entities in the message text. // See formatting options for more details // (https://core.telegram.org/bots/api#formatting-options). // // optional ParseMode string `json:"parse_mode,omitempty"` // Entities is a list of special entities that appear in message text, which // can be specified instead of parse_mode // // optional Entities []MessageEntity `json:"entities,omitempty"` // LinkPreviewOptions used for link preview generation for the original message // // Optional LinkPreviewOptions *LinkPreviewOptions `json:"link_preview_options,omitempty"` }
InputTextMessageContent contains text for displaying as an inline query result.
type InputVenueMessageContent ¶
type InputVenueMessageContent struct { // Latitude of the venue in degrees Latitude float64 `json:"latitude"` // Longitude of the venue in degrees Longitude float64 `json:"longitude"` // Title name of the venue Title string `json:"title"` // Address of the venue Address string `json:"address"` // FoursquareID foursquare identifier of the venue, if known // // optional FoursquareID string `json:"foursquare_id,omitempty"` // FoursquareType Foursquare type of the venue, if known // // optional FoursquareType string `json:"foursquare_type,omitempty"` // GooglePlaceID is the Google Places identifier of the venue // // optional GooglePlaceID string `json:"google_place_id,omitempty"` // GooglePlaceType is the Google Places type of the venue // // optional GooglePlaceType string `json:"google_place_type,omitempty"` }
InputVenueMessageContent contains a venue for displaying as an inline query result.
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 code // (see https://core.telegram.org/bots/payments#supported-currencies) 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 contains basic information about an invoice.
type InvoiceConfig ¶
type InvoiceConfig struct { BaseChat Title string // required Description string // required Payload string // required ProviderToken string // required Currency string // required Prices []LabeledPrice // required MaxTipAmount int SuggestedTipAmounts []int StartParameter string ProviderData string PhotoURL string PhotoSize int PhotoWidth int PhotoHeight int NeedName bool NeedPhoneNumber bool NeedEmail bool NeedShippingAddress bool SendPhoneNumberToProvider bool SendEmailToProvider bool IsFlexible bool }
InvoiceConfig contains information for sendInvoice request.
func NewInvoice ¶
func NewInvoice(chatID int64, title, description, payload, providerToken, startParameter, currency string, prices []LabeledPrice) InvoiceConfig
NewInvoice creates a new Invoice request to the user.
type InvoiceLinkConfig ¶
type InvoiceLinkConfig struct { Title string //Required Description string //Required Payload string //Required ProviderToken string //Required Currency string //Required Prices []LabeledPrice //Required MaxTipAmount int SuggestedTipAmounts []int ProviderData string PhotoURL string PhotoSize int PhotoWidth int PhotoHeight int NeedName bool NeedPhoneNumber bool NeedEmail bool NeedShippingAddress bool SendPhoneNumberToProvider bool SendEmailToProvider bool IsFlexible bool }
InvoiceLinkConfig contains information for createInvoiceLink method
type KeyboardButton ¶
type KeyboardButton struct { // Text of the button. If none of the optional fields are used, // it will be sent as a message when the button is pressed. Text string `json:"text"` // RequestUsers if specified, pressing the button will open // a list of suitable users. Tapping on any user will send // their identifier to the bot in a "user_shared" service message. // Available in private chats only. // // optional RequestUsers *KeyboardButtonRequestUsers `json:"request_users,omitempty"` // RequestChat if specified, pressing the button will open // a list of suitable chats. Tapping on a chat will send // its identifier to the bot in a "chat_shared" service message. // Available in private chats only. // // optional RequestChat *KeyboardButtonRequestChat `json:"request_chat,omitempty"` // RequestContact if True, the user's phone number will be sent // as a contact when the button is pressed. // Available in private chats only. // // optional RequestContact bool `json:"request_contact,omitempty"` // RequestLocation if True, the user's current location will be sent when // the button is pressed. // Available in private chats only. // // optional RequestLocation bool `json:"request_location,omitempty"` // RequestPoll 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 // // optional RequestPoll *KeyboardButtonPollType `json:"request_poll,omitempty"` // WebApp if specified, the described Web App will be launched when the button // is pressed. The Web App will be able to send a “web_app_data” service // message. Available in private chats only. // // optional WebApp *WebAppInfo `json:"web_app,omitempty"` }
KeyboardButton 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.
func NewKeyboardButton ¶
func NewKeyboardButton(text string) KeyboardButton
NewKeyboardButton creates a regular keyboard button.
func NewKeyboardButtonContact ¶
func NewKeyboardButtonContact(text string) KeyboardButton
NewKeyboardButtonContact creates a keyboard button that requests user contact information upon click.
func NewKeyboardButtonLocation ¶
func NewKeyboardButtonLocation(text string) KeyboardButton
NewKeyboardButtonLocation creates a keyboard button that requests user location information upon click.
func NewKeyboardButtonRow ¶
func NewKeyboardButtonRow(buttons ...KeyboardButton) []KeyboardButton
NewKeyboardButtonRow creates a row of keyboard buttons.
func NewKeyboardButtonWebApp ¶
func NewKeyboardButtonWebApp(text string, webapp WebAppInfo) KeyboardButton
NewKeyboardButtonWebApp creates a keyboard button with text which goes to a WebApp.
type KeyboardButtonPollType ¶
type KeyboardButtonPollType struct { // Type is 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"` }
KeyboardButtonPollType represents type of poll, which is allowed to be created and sent when the corresponding button is pressed.
type KeyboardButtonRequestChat ¶
type KeyboardButtonRequestChat struct { // RequestID is a signed 32-bit identifier of the request. RequestID int `json:"request_id"` // ChatIsChannel pass True to request a channel chat, // pass False to request a group or a supergroup chat. ChatIsChannel bool `json:"chat_is_channel"` // ChatIsForum pass True to request a forum supergroup, // pass False to request a non-forum chat. // If not specified, no additional restrictions are applied. // // optional ChatIsForum bool `json:"chat_is_forum,omitempty"` // ChatHasUsername pass True to request a supergroup or a channel with a username, // pass False to request a chat without a username. // If not specified, no additional restrictions are applied. // // optional ChatHasUsername bool `json:"chat_has_username,omitempty"` // ChatIsCreated pass True to request a chat owned by the user. // Otherwise, no additional restrictions are applied. // // optional ChatIsCreated bool `json:"chat_is_created,omitempty"` // UserAdministratorRights is a JSON-serialized object listing // the required administrator rights of the user in the chat. // If not specified, no additional restrictions are applied. // // optional UserAdministratorRights *ChatAdministratorRights `json:"user_administrator_rights,omitempty"` // BotAdministratorRights is a JSON-serialized object listing // the required administrator rights of the bot in the chat. // The rights must be a subset of user_administrator_rights. // If not specified, no additional restrictions are applied. // // optional BotAdministratorRights *ChatAdministratorRights `json:"bot_administrator_rights,omitempty"` // BotIsMember pass True to request a chat with the bot as a member. // Otherwise, no additional restrictions are applied. // // optional BotIsMember bool `json:"bot_is_member,omitempty"` }
KeyboardButtonRequestChat defines the criteria used to request a suitable chat. The identifier of the selected chat will be shared with the bot when the corresponding button is pressed.
type KeyboardButtonRequestUsers ¶
type KeyboardButtonRequestUsers struct { // RequestID is a signed 32-bit identifier of the request. RequestID int `json:"request_id"` // UserIsBot pass True to request a bot, // pass False to request a regular user. // If not specified, no additional restrictions are applied. // // optional UserIsBot *bool `json:"user_is_bot,omitempty"` // UserIsPremium pass True to request a premium user, // pass False to request a non-premium user. // If not specified, no additional restrictions are applied. // // optional UserIsPremium *bool `json:"user_is_premium,omitempty"` // MaxQuantity is the maximum number of users to be selected. // 1-10. Defaults to 1 // // optional MaxQuantity int `json:"max_quantity,omitempty"` }
KeyboardButtonRequestUsers defines the criteria used to request a suitable user. The identifier of the selected user will be shared with the bot when the corresponding button is pressed.
type KickChatMemberConfig ¶
type KickChatMemberConfig = BanChatMemberConfig
KickChatMemberConfig contains extra fields to ban user.
This was renamed to BanChatMember in later versions of the Telegram Bot API.
type LabeledPrice ¶
type LabeledPrice struct { // Label portion label Label string `json:"label"` // Amount price of the product in the smallest units of the currency (integer, not float/double). // For example, for a price of US$ 1.45 pass amount = 145. // See the exp parameter in currencies.json // (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 represents a portion of the price for goods or services.
type LeaveChatConfig ¶
type LeaveChatConfig struct {
ChatConfig
}
LeaveChatConfig allows you to leave a chat.
type LinkPreviewOptions ¶
type LinkPreviewOptions struct { // IsDisabled True, if the link preview is disabled // // optional IsDisabled bool `json:"is_disabled,omitempty"` // URL to use for the link preview. If empty, // then the first URL found in the message text will be used // // optional URL string `json:"url,omitempty"` // PreferSmallMedia True, if the media in the link preview is suppposed // to be shrunk; ignored if the URL isn't explicitly specified // or media size change isn't supported for the preview // // optional PreferSmallMedia bool `json:"prefer_small_media,omitempty"` // PreferLargeMedia True, if the media in the link preview is suppposed // to be enlarged; ignored if the URL isn't explicitly specified // or media size change isn't supported for the preview // // optional PreferLargeMedia bool `json:"prefer_large_media,omitempty"` // ShowAboveText True, if the link preview must be shown above the message text; // otherwise, the link preview will be shown below the message text // // optional ShowAboveText bool `json:"show_above_text,omitempty"` }
LinkPreviewOptions describes the options used for link preview generation.
type Location ¶
type Location struct { // Longitude as defined by sender Longitude float64 `json:"longitude"` // Latitude as defined by sender Latitude float64 `json:"latitude"` // HorizontalAccuracy is the radius of uncertainty for the location, // measured in meters; 0-1500 // // optional HorizontalAccuracy float64 `json:"horizontal_accuracy,omitempty"` // LivePeriod is time relative to the message sending date, during which the // location can be updated, in seconds. For active live locations only. // // optional LivePeriod int `json:"live_period,omitempty"` // Heading is the direction in which user is moving, in degrees; 1-360. For // active live locations only. // // optional Heading int `json:"heading,omitempty"` // ProximityAlertRadius is the maximum distance for proximity alerts about // approaching another chat member, in meters. For sent live locations only. // // optional ProximityAlertRadius int `json:"proximity_alert_radius,omitempty"` }
Location represents a point on the map.
type LocationConfig ¶
type LocationConfig struct { BaseChat Latitude float64 // required Longitude float64 // required HorizontalAccuracy float64 // optional LivePeriod int // optional Heading int // optional ProximityAlertRadius int // optional }
LocationConfig contains information about a SendLocation request.
func NewLocation ¶
func NewLocation(chatID int64, latitude float64, longitude float64) LocationConfig
NewLocation shares your location.
chatID is where to send it, latitude and longitude are coordinates.
type LogOutConfig ¶
type LogOutConfig struct{}
LogOutConfig is a request to log out of the cloud Bot API server.
Note that you may not log back in for at least 10 minutes.
type LoginURL ¶
type LoginURL struct { // URL is an HTTP URL to be opened with user authorization data added to the // query string when the button is pressed. If the user refuses to provide // authorization data, the original URL without information about the user // will be opened. The data added is the same as described in Receiving // authorization data. // // NOTE: You must always check the hash of the received data to verify the // authentication and the integrity of the data as described in Checking // authorization. URL string `json:"url"` // ForwardText is the new text of the button in forwarded messages // // optional ForwardText string `json:"forward_text,omitempty"` // BotUsername is the username of a bot, which will be used for user // authorization. See Setting up a bot for more details. If not specified, // the current bot's username will be assumed. The url's domain must be the // same as the domain linked with the bot. See Linking your domain to the // bot for more details. // // optional BotUsername string `json:"bot_username,omitempty"` // RequestWriteAccess if true requests permission for your bot to send // messages to the user // // optional RequestWriteAccess bool `json:"request_write_access,omitempty"` }
LoginURL represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a great replacement for the Telegram Login Widget when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in.
type MaskPosition ¶
type MaskPosition struct { // The part of the face relative to which the mask should be placed. // One of “forehead”, “eyes”, “mouth”, or “chin”. Point string `json:"point"` // Shift by X-axis measured in widths of the mask scaled to the face size, // from left to right. For example, choosing -1.0 will place mask just to // the left of the default mask position. XShift float64 `json:"x_shift"` // Shift by Y-axis measured in heights of the mask scaled to the face size, // from top to bottom. For example, 1.0 will place the mask just below the // default mask position. YShift float64 `json:"y_shift"` // Mask scaling coefficient. For example, 2.0 means double size. Scale float64 `json:"scale"` }
MaskPosition describes the position on faces where a mask should be placed by default.
type MediaGroupConfig ¶
type MediaGroupConfig struct { BaseChat Media []interface{} }
MediaGroupConfig allows you to send a group of media.
Media consist of InputMedia items (InputMediaPhoto, InputMediaVideo).
func NewMediaGroup ¶
func NewMediaGroup(chatID int64, files []interface{}) MediaGroupConfig
NewMediaGroup creates a new media group. Files should be an array of two to ten InputMediaPhoto or InputMediaVideo.
type MenuButton ¶
type MenuButton struct { // Type is the type of menu button, must be one of: // - `commands` // - `web_app` // - `default` Type string `json:"type"` // Text is the text on the button, for `web_app` type. Text string `json:"text,omitempty"` // WebApp is the description of the Web App that will be launched when the // user presses the button for the `web_app` type. WebApp *WebAppInfo `json:"web_app,omitempty"` }
MenuButton describes the bot's menu button in a private chat.
type Message ¶
type Message struct { // MessageID is a unique message identifier inside this chat MessageID int `json:"message_id"` // Unique identifier of a message thread to which the message belongs; // for supergroups only // // optional MessageThreadID int `json:"message_thread_id,omitempty"` // From is a sender, empty for messages sent to channels; // // optional From *User `json:"from,omitempty"` // SenderChat is the 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 // // optional SenderChat *Chat `json:"sender_chat,omitempty"` // Date of the message was sent in Unix time Date int `json:"date"` // Chat is the conversation the message belongs to Chat Chat `json:"chat"` // ForwardOrigin is information about the original message for forwarded messages // // optional ForwardOrigin *MessageOrigin `json:"forward_origin,omitempty"` // IsTopicMessage true if the message is sent to a forum topic // // optional IsTopicMessage bool `json:"is_topic_message,omitempty"` // IsAutomaticForward is true if the message is a channel post that was // automatically forwarded to the connected discussion group. // // optional IsAutomaticForward bool `json:"is_automatic_forward,omitempty"` // ReplyToMessage for replies, the original message. // Note that the Message object in this field will not contain further ReplyToMessage fields // even if it itself is a reply; // // optional ReplyToMessage *Message `json:"reply_to_message,omitempty"` // ExternalReply is an information about the message that is being replied to, // which may come from another chat or forum topic. // // optional ExternalReply *ExternalReplyInfo `json:"external_reply,omitempty"` // Quote for replies that quote part of the original message, the quoted part of the message // // optional Quote *TextQuote `json:"text_quote,omitempty"` // ViaBot through which the message was sent; // // optional ViaBot *User `json:"via_bot,omitempty"` // EditDate of the message was last edited in Unix time; // // optional EditDate int `json:"edit_date,omitempty"` // HasProtectedContent is true if the message can't be forwarded. // // optional HasProtectedContent bool `json:"has_protected_content,omitempty"` // MediaGroupID is the unique identifier of a media message group this message belongs to; // // optional MediaGroupID string `json:"media_group_id,omitempty"` // AuthorSignature is the signature of the post author for messages in channels; // // optional AuthorSignature string `json:"author_signature,omitempty"` // Text is for text messages, the actual UTF-8 text of the message, 0-4096 characters; // // optional Text string `json:"text,omitempty"` // Entities are for text messages, special entities like usernames, // URLs, bot commands, etc. that appear in the text; // // optional Entities []MessageEntity `json:"entities,omitempty"` // LinkPreviewOptions are options used for link preview generation for the message, // if it is a text message and link preview options were changed // // Optional LinkPreviewOptions *LinkPreviewOptions `json:"link_preview_options,omitempty"` // Animation message is an animation, information about the animation. // For backward compatibility, when this field is set, the document field will also be set; // // optional Animation *Animation `json:"animation,omitempty"` // PremiumAnimation message is an animation, information about the animation. // For backward compatibility, when this field is set, the document field will also be set; // // optional PremiumAnimation *Animation `json:"premium_animation,omitempty"` // Audio message is an audio file, information about the file; // // optional Audio *Audio `json:"audio,omitempty"` // Document message is a general file, information about the file; // // optional Document *Document `json:"document,omitempty"` // Photo message is a photo, available sizes of the photo; // // optional Photo []PhotoSize `json:"photo,omitempty"` // Sticker message is a sticker, information about the sticker; // // optional Sticker *Sticker `json:"sticker,omitempty"` // Story message is a forwarded story; // // optional Story *Story `json:"story,omitempty"` // Video message is a video, information about the video; // // optional Video *Video `json:"video,omitempty"` // VideoNote message is a video note, information about the video message; // // optional VideoNote *VideoNote `json:"video_note,omitempty"` // Voice message is a voice message, information about the file; // // optional Voice *Voice `json:"voice,omitempty"` // Caption for the animation, audio, document, photo, video or voice, 0-1024 characters; // // optional Caption string `json:"caption,omitempty"` // CaptionEntities; // // optional CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // HasSpoiler True, if the message media is covered by a spoiler animation // // optional HasMediaSpoiler bool `json:"has_media_spoiler,omitempty"` // Contact message is a shared contact, information about the contact; // // optional Contact *Contact `json:"contact,omitempty"` // Dice is a dice with random value; // // optional Dice *Dice `json:"dice,omitempty"` // Game message is a game, information about the game; // // optional Game *Game `json:"game,omitempty"` // Poll is a native poll, information about the poll; // // optional Poll *Poll `json:"poll,omitempty"` // Venue message is a venue, information about the venue. // For backward compatibility, when this field is set, the location field // will also be set; // // optional Venue *Venue `json:"venue,omitempty"` // Location message is a shared location, information about the location; // // optional Location *Location `json:"location,omitempty"` // NewChatMembers that were added to the group or supergroup // and information about them (the bot itself may be one of these members); // // optional NewChatMembers []User `json:"new_chat_members,omitempty"` // LeftChatMember is a member was removed from the group, // information about them (this member may be the bot itself); // // optional LeftChatMember *User `json:"left_chat_member,omitempty"` // NewChatTitle is a chat title was changed to this value; // // optional NewChatTitle string `json:"new_chat_title,omitempty"` // NewChatPhoto is a chat photo was change to this value; // // optional NewChatPhoto []PhotoSize `json:"new_chat_photo,omitempty"` // DeleteChatPhoto is a service message: the chat photo was deleted; // // optional DeleteChatPhoto bool `json:"delete_chat_photo,omitempty"` // GroupChatCreated is a service message: the group has been created; // // optional GroupChatCreated bool `json:"group_chat_created,omitempty"` // SuperGroupChatCreated is a 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 ReplyToMessage if someone replies to a very first message // in a directly created supergroup; // // optional SuperGroupChatCreated bool `json:"supergroup_chat_created,omitempty"` // ChannelChatCreated is a 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 ReplyToMessage // if someone replies to a very first message in a channel; // // optional ChannelChatCreated bool `json:"channel_chat_created,omitempty"` // MessageAutoDeleteTimerChanged is a service message: auto-delete timer // settings changed in the chat. // // optional MessageAutoDeleteTimerChanged *MessageAutoDeleteTimerChanged `json:"message_auto_delete_timer_changed,omitempty"` // MigrateToChatID is the group has been migrated to a supergroup with the specified identifier. // This number 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; // // optional MigrateToChatID int64 `json:"migrate_to_chat_id,omitempty"` // MigrateFromChatID is the supergroup has been migrated from a group with the specified identifier. // This number 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; // // optional MigrateFromChatID int64 `json:"migrate_from_chat_id,omitempty"` // Specified message was pinned. // Note that the Message object in this field will not contain // further reply_to_message fields even if it itself is a reply. // // optional PinnedMessage *Message `json:"pinned_message,omitempty"` // Invoice message is an invoice for a payment; // // optional Invoice *Invoice `json:"invoice,omitempty"` // SuccessfulPayment message is a service message about a successful payment, // information about the payment; // // optional SuccessfulPayment *SuccessfulPayment `json:"successful_payment,omitempty"` // // optional UsersShared *UsersShared `json:"users_shared,omitempty"` // // optional ChatShared *ChatShared `json:"chat_shared,omitempty"` // ConnectedWebsite is the domain name of the website on which the user has // logged in; // // optional ConnectedWebsite string `json:"connected_website,omitempty"` // WriteAccessAllowed is a service message: the user allowed the bot // added to the attachment menu to write messages // // optional WriteAccessAllowed *WriteAccessAllowed `json:"write_access_allowed,omitempty"` // PassportData is a Telegram Passport data; // // optional PassportData *PassportData `json:"passport_data,omitempty"` // ProximityAlertTriggered is a service message. A user in the chat // triggered another user's proximity alert while sharing Live Location // // optional ProximityAlertTriggered *ProximityAlertTriggered `json:"proximity_alert_triggered,omitempty"` // ForumTopicCreated is a service message: forum topic created // // optional ForumTopicCreated *ForumTopicCreated `json:"forum_topic_created,omitempty"` // ForumTopicClosed is a service message: forum topic edited // // optional ForumTopicEdited *ForumTopicEdited `json:"forum_topic_edited,omitempty"` // ForumTopicClosed is a service message: forum topic closed // // optional ForumTopicClosed *ForumTopicClosed `json:"forum_topic_closed,omitempty"` // ForumTopicReopened is a service message: forum topic reopened // // optional ForumTopicReopened *ForumTopicReopened `json:"forum_topic_reopened,omitempty"` // GeneralForumTopicHidden is a service message: the 'General' forum topic hidden // // optional GeneralForumTopicHidden *GeneralForumTopicHidden `json:"general_forum_topic_hidden,omitempty"` // // optional GeneralForumTopicUnhidden *GeneralForumTopicUnhidden `json:"general_forum_topic_unhidden,omitempty"` // GiveawayCreated is as service message: a scheduled giveaway was created // // optional GiveawayCreated *GiveawayCreated `json:"giveaway_created,omitempty"` // Giveaway is a scheduled giveaway message // // optional Giveaway *Giveaway `json:"giveaway,omitempty"` // GiveawayWinners is a giveaway with public winners was completed // // optional GiveawayWinners *GiveawayWinners `json:"giveaway_winners,omitempty"` // GiveawayCompleted is a service message: a giveaway without public winners was completed // // optional GiveawayCompleted *GiveawayCompleted `json:"giveaway_completed,omitempty"` // VideoChatScheduled is a service message: video chat scheduled. // // optional VideoChatScheduled *VideoChatScheduled `json:"video_chat_scheduled,omitempty"` // VideoChatStarted is a service message: video chat started. // // optional VideoChatStarted *VideoChatStarted `json:"video_chat_started,omitempty"` // VideoChatEnded is a service message: video chat ended. // // optional VideoChatEnded *VideoChatEnded `json:"video_chat_ended,omitempty"` // VideoChatParticipantsInvited is a service message: new participants // invited to a video chat. // // optional VideoChatParticipantsInvited *VideoChatParticipantsInvited `json:"video_chat_participants_invited,omitempty"` // WebAppData is a service message: data sent by a Web App. // // optional WebAppData *WebAppData `json:"web_app_data,omitempty"` // ReplyMarkup is the Inline keyboard attached to the message. // login_url buttons are represented as ordinary url buttons. // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` }
Message represents a message.
func (*Message) Command ¶
Command checks if the message was a command and if it was, returns the command. If the Message was not a command, it returns an empty string.
If the command contains the at name syntax, it is removed. Use CommandWithAt() if you do not want that.
func (*Message) CommandArguments ¶
CommandArguments checks if the message was a command and if it was, returns all text after the command name. If the Message was not a command, it returns an empty string.
Note: The first character after the command name is omitted: - "/foo bar baz" yields "bar baz", not " bar baz" - "/foo-bar baz" yields "bar baz", too Even though the latter is not a command conforming to the spec, the API marks "/foo" as command entity.
func (*Message) CommandWithAt ¶
CommandWithAt checks if the message was a command and if it was, returns the command. If the Message was not a command, it returns an empty string.
If the command contains the at name syntax, it is not removed. Use Command() if you want that.
type MessageAutoDeleteTimerChanged ¶
type MessageAutoDeleteTimerChanged struct { // New auto-delete time for messages in the chat. MessageAutoDeleteTime int `json:"message_auto_delete_time"` }
MessageAutoDeleteTimerChanged represents a service message about a change in auto-delete timer settings.
type MessageConfig ¶
type MessageConfig struct { BaseChat Text string ParseMode string Entities []MessageEntity LinkPreviewOptions LinkPreviewOptions }
MessageConfig contains information about a SendMessage request.
func NewMessage ¶
func NewMessage(chatID int64, text string) MessageConfig
NewMessage creates a new Message.
chatID is where to send it, text is the message text.
func NewMessageToChannel ¶
func NewMessageToChannel(username string, text string) MessageConfig
NewMessageToChannel creates a new Message that is sent to a channel by username.
username is the username of the channel, text is the message text, and the username should be in the form of `@username`.
type MessageEntity ¶
type MessageEntity struct { // Type of the entity. // Can be: // “mention” (@username), // “hashtag” (#hashtag), // “cashtag” ($USD), // “bot_command” (/start@jobs_bot), // “url” (https://telegram.org), // “email” (do-not-reply@telegram.org), // “phone_number” (+1-212-555-0123), // “bold” (bold text), // “italic” (italic text), // “underline” (underlined text), // “strikethrough” (strikethrough text), // "spoiler" (spoiler message), // “blockquote” (block quotation), // “code” (monowidth string), // “pre” (monowidth block), // “text_link” (for clickable text URLs), // “text_mention” (for users without usernames) // “text_mention” (for inline custom emoji stickers) Type string `json:"type"` // Offset in UTF-16 code units to the start of the entity Offset int `json:"offset"` // Length Length int `json:"length"` // URL for “text_link” only, url that will be opened after user taps on the text // // optional URL string `json:"url,omitempty"` // User for “text_mention” only, the mentioned user // // optional User *User `json:"user,omitempty"` // Language for “pre” only, the programming language of the entity text // // optional Language string `json:"language,omitempty"` // CustomEmojiID for “custom_emoji” only, unique identifier of the custom emoji // // optional CustomEmojiID string `json:"custom_emoji_id"` }
MessageEntity represents one special entity in a text message.
func (MessageEntity) IsBold ¶
func (e MessageEntity) IsBold() bool
IsBold returns true if the type of the message entity is "bold" (bold text).
func (MessageEntity) IsCode ¶
func (e MessageEntity) IsCode() bool
IsCode returns true if the type of the message entity is "code" (monowidth string).
func (MessageEntity) IsCommand ¶
func (e MessageEntity) IsCommand() bool
IsCommand returns true if the type of the message entity is "bot_command".
func (MessageEntity) IsEmail ¶
func (e MessageEntity) IsEmail() bool
IsEmail returns true if the type of the message entity is "email".
func (MessageEntity) IsHashtag ¶
func (e MessageEntity) IsHashtag() bool
IsHashtag returns true if the type of the message entity is "hashtag".
func (MessageEntity) IsItalic ¶
func (e MessageEntity) IsItalic() bool
IsItalic returns true if the type of the message entity is "italic" (italic text).
func (MessageEntity) IsMention ¶
func (e MessageEntity) IsMention() bool
IsMention returns true if the type of the message entity is "mention" (@username).
func (MessageEntity) IsPre ¶
func (e MessageEntity) IsPre() bool
IsPre returns true if the type of the message entity is "pre" (monowidth block).
func (MessageEntity) IsTextLink ¶
func (e MessageEntity) IsTextLink() bool
IsTextLink returns true if the type of the message entity is "text_link" (clickable text URL).
func (MessageEntity) IsTextMention ¶
func (e MessageEntity) IsTextMention() bool
IsTextMention returns true if the type of the message entity is "text_mention" (At this time, the user field exists, and occurs when tagging a member without a username)
func (MessageEntity) IsURL ¶
func (e MessageEntity) IsURL() bool
IsURL returns true if the type of the message entity is "url".
type MessageID ¶
type MessageID struct {
MessageID int `json:"message_id"`
}
MessageID represents a unique message identifier.
type MessageOrigin ¶
type MessageOrigin struct { // Type of the message origin. Type string `json:"type"` // Date the message was sent originally in Unix time Date int64 `json:"date"` // SenderUser "user" only. // Is a user that sent the message originally SenderUser *User `json:"sender_user,omitempty"` // SenderUserName "hidden_user" only. // Name of the user that sent the message originally SenderUserName string `json:"sender_user_name,omitempty"` // SenderChat "chat" and "channel". // For "chat": Chat that sent the message originally // For "channel": Channel chat to which the message was originally sent SenderChat *Chat `json:"sender_chat,omitempty"` // AuthorSignature "chat" and "channel". // For "chat": For messages originally sent by an anonymous chat administrator, // original message author signature. // For "channel": Signature of the original post author // // Optional AuthorSignature string `json:"author_signature,omitempty"` // MessageID "channel" only. // Unique message identifier inside the chat // // Optional MessageID int `json:"message_id,omitempty"` }
MessageOrigin describes the origin of a message. It can be one of: "user", "hidden_user", "origin_chat", "origin_channel"
func (MessageOrigin) IsChannel ¶
func (m MessageOrigin) IsChannel() bool
func (MessageOrigin) IsChat ¶
func (m MessageOrigin) IsChat() bool
func (MessageOrigin) IsHiddenUser ¶
func (m MessageOrigin) IsHiddenUser() bool
func (MessageOrigin) IsUser ¶
func (m MessageOrigin) IsUser() bool
type MessageReactionCountUpdated ¶
type MessageReactionCountUpdated struct { // Chat containing the message. Chat Chat `json:"chat"` // MessageID unique identifier of the message inside the chat. MessageID int `json:"message_id"` // Date of the change in Unix time. Date int64 `json:"date"` // Reactions is a list of reactions that are present on the message. Reactions []ReactionCount `json:"reactions"` }
MessageReactionCountUpdated represents reaction changes on a message with anonymous reactions.
type MessageReactionUpdated ¶
type MessageReactionUpdated struct { // Chat containing the message the user reacted to. Chat Chat `json:"chat"` // MessageID unique identifier of the message inside the chat. MessageID int `json:"message_id"` // User that changed the reaction, if the user isn't anonymous. // // optional User *User `json:"user"` // ActorChat the chat on behalf of which the reaction was changed, // if the user is anonymous. // // optional ActorChat *Chat `json:"actor_chat"` // Date of the change in Unix time. Date int64 `json:"date"` // OldReaction is a previous list of reaction types that were set by the user. OldReaction []ReactionType `json:"old_reaction"` // NewReaction is a new list of reaction types that have been set by the user. NewReaction []ReactionType `json:"new_reaction"` }
MessageReactionUpdated represents a change of a reaction on a message performed by a user.
type NewStickerSetConfig ¶
type NewStickerSetConfig struct { UserID int64 Name string Title string Stickers []InputSticker StickerFormat string StickerType string NeedsRepainting bool //optional; Pass True if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only }
NewStickerSetConfig allows creating a new sticker set.
type OrderInfo ¶
type OrderInfo struct { // Name user name // // optional Name string `json:"name,omitempty"` // PhoneNumber user's phone number // // optional PhoneNumber string `json:"phone_number,omitempty"` // Email user email // // optional Email string `json:"email,omitempty"` // ShippingAddress user shipping address // // optional ShippingAddress *ShippingAddress `json:"shipping_address,omitempty"` }
OrderInfo represents information about an order.
type Params ¶
Params represents a set of parameters that gets passed to a request.
func (Params) AddFirstValid ¶
AddFirstValid attempts to add the first item that is not a default value.
For example, AddFirstValid(0, "", "test") would add "test".
func (Params) AddInterface ¶
AddInterface adds an interface if it is not nil and can be JSON marshalled.
func (Params) AddNonEmpty ¶
AddNonEmpty adds a value if it not an empty string.
func (Params) AddNonZero ¶
AddNonZero adds a value if it is not zero.
func (Params) AddNonZero64 ¶
AddNonZero64 is the same as AddNonZero except uses an int64.
func (Params) AddNonZeroFloat ¶
AddNonZeroFloat adds a floating point value that is not zero.
type PassportData ¶
type PassportData struct { // Array with information about documents and other Telegram Passport // elements that was shared with the bot Data []EncryptedPassportElement `json:"data"` // Encrypted credentials required to decrypt the data Credentials *EncryptedCredentials `json:"credentials"` }
PassportData contains information about Telegram Passport data shared with the bot by the user.
type PassportElementError ¶
type PassportElementError interface{}
PassportElementError represents an error in the Telegram Passport element which was submitted that should be resolved by the user.
type PassportElementErrorDataField ¶
type PassportElementErrorDataField struct { // Error source, must be data Source string `json:"source"` // The section of the user's Telegram Passport which has the error, one // of "personal_details", "passport", "driver_license", "identity_card", // "internal_passport", "address" Type string `json:"type"` // Name of the data field which has the error FieldName string `json:"field_name"` // Base64-encoded data hash DataHash string `json:"data_hash"` // Error message Message string `json:"message"` }
PassportElementErrorDataField represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes.
type PassportElementErrorFile ¶
type PassportElementErrorFile struct { // Error source, must be a file Source string `json:"source"` // The section of the user's Telegram Passport which has the issue, one // of "utility_bill", "bank_statement", "rental_agreement", // "passport_registration", "temporary_registration" Type string `json:"type"` // Base64-encoded file hash FileHash string `json:"file_hash"` // Error message Message string `json:"message"` }
PassportElementErrorFile represents an issue with a document scan. The error is considered resolved when the file with the document scan changes.
type PassportElementErrorFiles ¶
type PassportElementErrorFiles struct { // Error source, must be files Source string `json:"source"` // The section of the user's Telegram Passport which has the issue, one // of "utility_bill", "bank_statement", "rental_agreement", // "passport_registration", "temporary_registration" Type string `json:"type"` // List of base64-encoded file hashes FileHashes []string `json:"file_hashes"` // Error message Message string `json:"message"` }
PassportElementErrorFiles represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.
type PassportElementErrorFrontSide ¶
type PassportElementErrorFrontSide struct { // Error source, must be front_side Source string `json:"source"` // The section of the user's Telegram Passport which has the issue, one // of "passport", "driver_license", "identity_card", "internal_passport" Type string `json:"type"` // Base64-encoded hash of the file with the front side of the document FileHash string `json:"file_hash"` // Error message Message string `json:"message"` }
PassportElementErrorFrontSide represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes.
type PassportElementErrorReverseSide ¶
type PassportElementErrorReverseSide struct { // Error source, must be reverse_side Source string `json:"source"` // The section of the user's Telegram Passport which has the issue, one // of "driver_license", "identity_card" Type string `json:"type"` // Base64-encoded hash of the file with the reverse side of the document FileHash string `json:"file_hash"` // Error message Message string `json:"message"` }
PassportElementErrorReverseSide represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes.
type PassportElementErrorSelfie ¶
type PassportElementErrorSelfie struct { // Error source, must be selfie Source string `json:"source"` // The section of the user's Telegram Passport which has the issue, one // of "passport", "driver_license", "identity_card", "internal_passport" Type string `json:"type"` // Base64-encoded hash of the file with the selfie FileHash string `json:"file_hash"` // Error message Message string `json:"message"` }
PassportElementErrorSelfie represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes.
type PassportFile ¶
type PassportFile struct { // Unique identifier for this file FileID string `json:"file_id"` FileUniqueID string `json:"file_unique_id"` // File size FileSize int `json:"file_size"` // Unix time when the file was uploaded FileDate int64 `json:"file_date"` }
PassportFile represents a file uploaded to Telegram Passport. Currently, all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB.
type PassportRequestInfoConfig ¶
type PassportRequestInfoConfig struct { BotID int `json:"bot_id"` Scope *PassportScope `json:"scope"` Nonce string `json:"nonce"` PublicKey string `json:"public_key"` }
PassportRequestInfoConfig allows you to request passport info
type PassportScope ¶
type PassportScope struct { V int `json:"v"` Data []PassportScopeElement `json:"data"` }
PassportScope is the requested scopes of data.
type PassportScopeElement ¶
type PassportScopeElement interface {
ScopeType() string
}
PassportScopeElement supports using one or one of several elements.
type PassportScopeElementOne ¶
type PassportScopeElementOne struct { Type string `json:"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” Selfie bool `json:"selfie"` Translation bool `json:"translation"` NativeNames bool `json:"native_name"` }
PassportScopeElementOne requires the specified element be provided.
func (*PassportScopeElementOne) ScopeType ¶
func (eo *PassportScopeElementOne) ScopeType() string
ScopeType is the scope type.
type PassportScopeElementOneOfSeveral ¶
type PassportScopeElementOneOfSeveral struct { }
PassportScopeElementOneOfSeveral allows you to request any one of the requested documents.
func (*PassportScopeElementOneOfSeveral) ScopeType ¶
func (eo *PassportScopeElementOneOfSeveral) ScopeType() string
ScopeType is the scope type.
type PersonalDetails ¶
type PersonalDetails struct { FirstName string `json:"first_name"` LastName string `json:"last_name"` MiddleName string `json:"middle_name"` BirthDate string `json:"birth_date"` Gender string `json:"gender"` CountryCode string `json:"country_code"` ResidenceCountryCode string `json:"residence_country_code"` FirstNameNative string `json:"first_name_native"` LastNameNative string `json:"last_name_native"` MiddleNameNative string `json:"middle_name_native"` }
PersonalDetails https://core.telegram.org/passport#personaldetails
type PhotoConfig ¶
type PhotoConfig struct { BaseFile BaseSpoiler Thumb RequestFileData Caption string ParseMode string CaptionEntities []MessageEntity }
PhotoConfig contains information about a SendPhoto request.
func NewPhoto ¶
func NewPhoto(chatID int64, file RequestFileData) PhotoConfig
NewPhoto creates a new sendPhoto request.
chatID is where to send it, file is a string path to the file, FileReader, or FileBytes.
Note that you must send animated GIFs as a document.
func NewPhotoToChannel ¶
func NewPhotoToChannel(username string, file RequestFileData) PhotoConfig
NewPhotoToChannel creates a new photo uploader to send a photo to a channel.
Note that you must send animated GIFs as a document.
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 is the 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 file size // // optional FileSize int `json:"file_size,omitempty"` }
PhotoSize represents one size of a photo or a file / sticker thumbnail.
type PinChatMessageConfig ¶
type PinChatMessageConfig struct { BaseChatMessage DisableNotification bool }
PinChatMessageConfig contains information of a message in a chat to pin.
func NewPinChatMessage ¶
func NewPinChatMessage(chatID int64, messageID int, disableNotification bool) PinChatMessageConfig
type Poll ¶
type Poll struct { // ID is the unique poll identifier ID string `json:"id"` // Question is the poll question, 1-255 characters Question string `json:"question"` // Options is the list of poll options Options []PollOption `json:"options"` // TotalVoterCount is the total numbers of users who voted in the poll TotalVoterCount int `json:"total_voter_count"` // IsClosed is if the poll is closed IsClosed bool `json:"is_closed"` // IsAnonymous is if the poll is anonymous IsAnonymous bool `json:"is_anonymous"` // Type is the poll type, currently can be "regular" or "quiz" Type string `json:"type"` // AllowsMultipleAnswers is true, if the poll allows multiple answers AllowsMultipleAnswers bool `json:"allows_multiple_answers"` // CorrectOptionID is the 0-based identifier of the correct answer option. // Available only for polls in quiz mode, which are closed, or was sent (not // forwarded) by the bot or to the private chat with the bot. // // optional CorrectOptionID int `json:"correct_option_id,omitempty"` // Explanation is 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 // // optional Explanation string `json:"explanation,omitempty"` // ExplanationEntities are special entities like usernames, URLs, bot // commands, etc. that appear in the explanation // // optional ExplanationEntities []MessageEntity `json:"explanation_entities,omitempty"` // OpenPeriod is the amount of time in seconds the poll will be active // after creation // // optional OpenPeriod int `json:"open_period,omitempty"` // CloseDate is the point in time (unix timestamp) when the poll will be // automatically closed // // optional CloseDate int `json:"close_date,omitempty"` }
Poll contains information about a poll.
type PollAnswer ¶
type PollAnswer struct { // PollID is the unique poll identifier PollID string `json:"poll_id"` // Chat that changed the answer to the poll, if the voter is anonymous. // // Optional VoterChat *Chat `json:"voter_chat,omitempty"` // User who changed the answer to the poll, if the voter isn't anonymous // For backward compatibility, the field user in such objects // will contain the user 136817688 (@Channel_Bot). // // Optional User *User `json:"user,omitempty"` // OptionIDs is the 0-based identifiers of poll options chosen by the user. // May be empty if user retracted vote. OptionIDs []int `json:"option_ids"` }
PollAnswer represents an answer of a user in a non-anonymous poll.
type PollOption ¶
type PollOption struct { // Text is the option text, 1-100 characters Text string `json:"text"` // VoterCount is the number of users that voted for this option VoterCount int `json:"voter_count"` }
PollOption contains information about one answer option in a poll.
type PreCheckoutConfig ¶
type PreCheckoutConfig struct { PreCheckoutQueryID string // required OK bool // required ErrorMessage string }
PreCheckoutConfig contains information for answerPreCheckoutQuery request.
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 code // // (see https://core.telegram.org/bots/payments#supported-currencies) 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 identifier of the shipping option chosen by the user // // optional ShippingOptionID string `json:"shipping_option_id,omitempty"` // OrderInfo order info provided by the user // // optional OrderInfo *OrderInfo `json:"order_info,omitempty"` }
PreCheckoutQuery contains information about an incoming pre-checkout query.
type PromoteChatMemberConfig ¶
type PromoteChatMemberConfig struct { ChatMemberConfig IsAnonymous bool CanManageChat bool CanChangeInfo bool CanPostMessages bool CanEditMessages bool CanDeleteMessages bool CanManageVideoChats bool CanInviteUsers bool CanRestrictMembers bool CanPinMessages bool CanPromoteMembers bool CanPostStories bool CanEditStories bool CanDeleteStories bool CanManageTopics bool }
PromoteChatMemberConfig contains fields to promote members of chat
type ProximityAlertTriggered ¶
type ProximityAlertTriggered struct { // Traveler is the user that triggered the alert Traveler User `json:"traveler"` // Watcher is the user that set the alert Watcher User `json:"watcher"` // Distance is the distance between the users Distance int `json:"distance"` }
ProximityAlertTriggered represents a service message sent when a user in the chat triggers a proximity alert sent by another user.
type ReactionCount ¶
type ReactionCount struct { // Type of the reaction Type ReactionType `json:"type"` // TotalCount number of times the reaction was added TotalCount int `json:"total_count"` }
ReactionCount represents a reaction added to a message along with the number of times it was added.
type ReactionType ¶
type ReactionType struct { // Type of the reaction. Can be "emoji", "custom_emoji" Type string `json:"type"` // Emoji type "emoji" only. Is a reaction emoji. Emoji string `json:"emoji"` // CustomEmoji type "custom_emoji" only. Is a custom emoji identifier. CustomEmoji string `json:"custom_emoji"` }
ReactionType describes the type of a reaction. Currently, it can be one of: "emoji", "custom_emoji"
func (ReactionType) IsCustomEmoji ¶
func (r ReactionType) IsCustomEmoji() bool
func (ReactionType) IsEmoji ¶
func (r ReactionType) IsEmoji() bool
type ReopenForumTopicConfig ¶
type ReopenForumTopicConfig struct{ BaseForum }
ReopenForumTopicConfig allows you to reopen an closed topic in a forum supergroup chat.
type ReopenGeneralForumTopicConfig ¶
type ReopenGeneralForumTopicConfig struct{ BaseForum }
CloseGeneralForumTopicConfig allows you to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.
type ReplyKeyboardMarkup ¶
type ReplyKeyboardMarkup struct { // Keyboard is an array of button rows, each represented by an Array of KeyboardButton objects Keyboard [][]KeyboardButton `json:"keyboard"` // IsPersistent requests clients to always show the keyboard // when the regular keyboard is hidden. // Defaults to false, in which case the custom keyboard can be hidden // and opened with a keyboard icon. // // optional IsPersistent bool `json:"is_persistent"` // ResizeKeyboard 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. // // optional ResizeKeyboard bool `json:"resize_keyboard,omitempty"` // OneTimeKeyboard 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. // // optional OneTimeKeyboard bool `json:"one_time_keyboard,omitempty"` // InputFieldPlaceholder is the placeholder to be shown in the input field when // the keyboard is active; 1-64 characters. // // optional InputFieldPlaceholder string `json:"input_field_placeholder,omitempty"` // Selective use this parameter if you want to show the keyboard to specific users only. // Targets: // 1) users that are @mentioned in the text of the Message object; // 2) if the bot's message is a reply (has Message.ReplyToMessage not nil), 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. // // optional Selective bool `json:"selective,omitempty"` }
ReplyKeyboardMarkup represents a custom keyboard with reply options.
func NewOneTimeReplyKeyboard ¶
func NewOneTimeReplyKeyboard(rows ...[]KeyboardButton) ReplyKeyboardMarkup
NewOneTimeReplyKeyboard creates a new one time keyboard.
func NewReplyKeyboard ¶
func NewReplyKeyboard(rows ...[]KeyboardButton) ReplyKeyboardMarkup
NewReplyKeyboard creates a new regular keyboard with sane defaults.
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). RemoveKeyboard bool `json:"remove_keyboard"` // Selective use this parameter if you want to remove the keyboard for specific users only. // Targets: // 1) users that are @mentioned in the text of the Message object; // 2) if the bot's message is a reply (has Message.ReplyToMessage not nil), 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. // // optional 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.
func NewRemoveKeyboard ¶
func NewRemoveKeyboard(selective bool) ReplyKeyboardRemove
NewRemoveKeyboard hides the keyboard, with the option for being selective or hiding for everyone.
type ReplyParameters ¶
type ReplyParameters struct { // MessageID identifier of the message that will be replied to in // the current chat, or in the chat chat_id if it is specified MessageID int `json:"message_id"` // ChatID if the message to be replied to is from a different chat, // unique identifier for the chat or username of the channel (in the format @channelusername) // // optional ChatID interface{} `json:"chat_id,omitempty"` // AllowSendingWithoutReply true if the message should be sent even // if the specified message to be replied to is not found; // can be used only for replies in the same chat and forum topic. // // optional AllowSendingWithoutReply bool `json:"allow_sending_without_reply,omitempty"` // Quote is a quoted part of the message to be replied to; // 0-1024 characters after entities parsing. The quote must be // an exact substring of the message to be replied to, // including bold, italic, underline, strikethrough, spoiler, and custom_emoji entities. // The message will fail to send if the quote isn't found in the original message. // // optional Quote string `json:"quote,omitempty"` // QuoteParseMode mode for parsing entities in the quote. // // optional QuoteParseMode string `json:"quote_parse_mode,omitempty"` // QuoteEntities a JSON-serialized list of special entities that appear in the quote. // It can be specified instead of quote_parse_mode. // // optional QuoteEntities []MessageEntity `json:"quote_entities,omitempty"` // QuotePosition is a position of the quote in the original message in UTF-16 code units // // optional QuotePosition int `json:"quote_position,omitempty"` }
ReplyParameters describes reply parameters for the message that is being sent.
type RequestFile ¶
type RequestFile struct { // The file field name. Name string // The file data to include. Data RequestFileData }
RequestFile represents a file associated with a field name.
type RequestFileData ¶
type RequestFileData interface { // NeedsUpload shows if the file needs to be uploaded. NeedsUpload() bool // UploadData gets the file name and an `io.Reader` for the file to be uploaded. This // must only be called when the file needs to be uploaded. UploadData() (string, io.Reader, error) // SendData gets the file data to send when a file does not need to be uploaded. This // must only be called when the file does not need to be uploaded. SendData() string }
RequestFileData represents the data to be used for a file.
type ResponseParameters ¶
type ResponseParameters struct { // The group has been migrated to a supergroup with the specified identifier. // // optional MigrateToChatID int64 `json:"migrate_to_chat_id,omitempty"` // In case of exceeding flood control, the number of seconds left to wait // before the request can be repeated. // // optional RetryAfter int `json:"retry_after,omitempty"` }
ResponseParameters are various errors that can be returned in APIResponse.
type RestrictChatMemberConfig ¶
type RestrictChatMemberConfig struct { ChatMemberConfig UntilDate int64 UseIndependentChatPermissions bool Permissions *ChatPermissions }
RestrictChatMemberConfig contains fields to restrict members of chat
type RevokeChatInviteLinkConfig ¶
type RevokeChatInviteLinkConfig struct { ChatConfig InviteLink string }
RevokeChatInviteLinkConfig allows you 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.
type SecureData ¶
type SecureData map[string]*SecureValue
SecureData is a map of the fields and their encrypted values.
type SecureValue ¶
type SecureValue struct { Data *DataCredentials `json:"data"` FrontSide *FileCredentials `json:"front_side"` ReverseSide *FileCredentials `json:"reverse_side"` Selfie *FileCredentials `json:"selfie"` Translation []*FileCredentials `json:"translation"` Files []*FileCredentials `json:"files"` }
SecureValue contains encrypted values for a SecureData item.
type SendPollConfig ¶
type SendPollConfig struct { BaseChat Question string Options []string IsAnonymous bool Type string AllowsMultipleAnswers bool CorrectOptionID int64 Explanation string ExplanationParseMode string ExplanationEntities []MessageEntity OpenPeriod int CloseDate int IsClosed bool }
SendPollConfig allows you to send a poll.
type SentWebAppMessage ¶
type SentWebAppMessage struct { // Identifier of the sent inline message. Available only if there is an inline // keyboard attached to the message. // // optional InlineMessageID string `json:"inline_message_id,omitempty"` }
SentWebAppMessage contains information about an inline message sent by a Web App on behalf of a user.
type SetChatAdministratorCustomTitle ¶
type SetChatAdministratorCustomTitle struct { ChatMemberConfig CustomTitle string }
SetChatAdministratorCustomTitle sets the title of an administrative user promoted by the bot for a chat.
type SetChatDescriptionConfig ¶
type SetChatDescriptionConfig struct { ChatConfig Description string }
SetChatDescriptionConfig allows you to set the description of a supergroup or channel.
func NewChatDescription ¶
func NewChatDescription(chatID int64, description string) SetChatDescriptionConfig
NewChatDescription allows you to update the description of a chat.
type SetChatMenuButtonConfig ¶
type SetChatMenuButtonConfig struct { ChatConfig MenuButton *MenuButton }
SetChatMenuButtonConfig changes the bot's menu button in a private chat, or the default menu button.
type SetChatPermissionsConfig ¶
type SetChatPermissionsConfig struct { ChatConfig UseIndependentChatPermissions bool Permissions *ChatPermissions }
SetChatPermissionsConfig allows you to set default permissions for the members in a group. The bot must be an administrator and have rights to restrict members.
type SetChatPhotoConfig ¶
type SetChatPhotoConfig struct {
BaseFile
}
SetChatPhotoConfig allows you to set a group, supergroup, or channel's photo.
func NewChatPhoto ¶
func NewChatPhoto(chatID int64, photo RequestFileData) SetChatPhotoConfig
NewChatPhoto allows you to update the photo for a chat.
type SetChatStickerSetConfig ¶
type SetChatStickerSetConfig struct { ChatConfig StickerSetName string }
SetChatStickerSetConfig allows you to set the sticker set for a supergroup.
type SetChatTitleConfig ¶
type SetChatTitleConfig struct { ChatConfig Title string }
SetChatTitleConfig allows you to set the title of something other than a private chat.
func NewChatTitle ¶
func NewChatTitle(chatID int64, title string) SetChatTitleConfig
NewChatTitle allows you to update the title of a chat.
type SetCustomEmojiStickerSetThumbnailConfig ¶
SetCustomEmojiStickerSetThumbnailConfig allows you to set the thumbnail of a custom emoji sticker set
func NewCustomEmojiStickerSetThumbnal ¶
func NewCustomEmojiStickerSetThumbnal(name, customEmojiID string) SetCustomEmojiStickerSetThumbnailConfig
NewCustomEmojiStickerSetThumbnal creates a new setCustomEmojiStickerSetThumbnal request
type SetGameScoreConfig ¶
type SetGameScoreConfig struct { BaseChatMessage UserID int64 Score int Force bool DisableEditMessage bool InlineMessageID string }
SetGameScoreConfig allows you to update the game score in a chat.
type SetMessageReactionConfig ¶
type SetMessageReactionConfig struct { BaseChatMessage Reaction []ReactionType IsBig bool }
SetMessageReactionConfig changes reactions on a message. Returns true on success.
type SetMyCommandsConfig ¶
type SetMyCommandsConfig struct { Commands []BotCommand Scope *BotCommandScope LanguageCode string }
SetMyCommandsConfig sets a list of commands the bot understands.
func NewSetMyCommands ¶
func NewSetMyCommands(commands ...BotCommand) SetMyCommandsConfig
NewSetMyCommands allows you to set the registered commands.
func NewSetMyCommandsWithScope ¶
func NewSetMyCommandsWithScope(scope BotCommandScope, commands ...BotCommand) SetMyCommandsConfig
NewSetMyCommandsWithScope allows you to set the registered commands for a given scope.
func NewSetMyCommandsWithScopeAndLanguage ¶
func NewSetMyCommandsWithScopeAndLanguage(scope BotCommandScope, languageCode string, commands ...BotCommand) SetMyCommandsConfig
NewSetMyCommandsWithScopeAndLanguage allows you to set the registered commands for a given scope and language code.
type SetMyDefaultAdministratorRightsConfig ¶
type SetMyDefaultAdministratorRightsConfig struct { Rights ChatAdministratorRights ForChannels bool }
type SetMyDescriptionConfig ¶
type SetMyDescriptionConfig struct { // Pass an empty string to remove the dedicated description for the given language. Description string //If empty, the description will be applied to all users for whose language there is no dedicated description. LanguageCode string }
SetMyDescroptionConfig sets the bot's description, which is shown in the chat with the bot if the chat is empty
func NewSetMyDescription ¶
func NewSetMyDescription(description, languageCode string) SetMyDescriptionConfig
NewSetMyDescription allows you to change the bot's description, which is shown in the chat with the bot if the chat is empty.
type SetMyNameConfig ¶
SetMyNameConfig change the bot's name
func NewSetMyName ¶
func NewSetMyName(languageCode, name string) SetMyNameConfig
NewSetMyName change the bot's name
type SetMyShortDescriptionConfig ¶
type SetMyShortDescriptionConfig struct { // New short description for the bot; 0-120 characters. // //Pass an empty string to remove the dedicated short description for the given language. ShortDescription string //A two-letter ISO 639-1 language code. // //If empty, the short description will be applied to all users for whose language there is no dedicated short description. LanguageCode string }
SetMyDescroptionConfig sets the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot.
func NewSetMyShortDescription ¶
func NewSetMyShortDescription(shortDescription, languageCode string) SetMyShortDescriptionConfig
NewSetMyShortDescription allows you change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot.
type SetStickerEmojiListConfig ¶
SetStickerEmojiListConfig allows you to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot
type SetStickerKeywordsConfig ¶
SetStickerKeywordsConfig allows you to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot.
type SetStickerMaskPositionConfig ¶
type SetStickerMaskPositionConfig struct { Sticker string MaskPosition *MaskPosition }
SetStickerMaskPositionConfig allows you to change the mask position of a mask sticker. The sticker must belong to a sticker set that was created by the bot
type SetStickerPositionConfig ¶
SetStickerPositionConfig allows you to change the position of a sticker in a set.
type SetStickerSetThumbConfig ¶
type SetStickerSetThumbConfig struct { Name string UserID int64 Thumb RequestFileData }
SetStickerSetThumbConfig allows you to set the thumbnail for a sticker set.
type SetStickerSetTitleConfig ¶
SetStickerSetTitle allows you to set the title of a created sticker set
func NewStickerSetTitle ¶
func NewStickerSetTitle(name, title string) SetStickerSetTitleConfig
NewStickerSetTitle creates a new setStickerSetTitle request
type ShippingAddress ¶
type ShippingAddress struct { // CountryCode ISO 3166-1 alpha-2 country code CountryCode string `json:"country_code"` // 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 represents a shipping address.
type ShippingConfig ¶
type ShippingConfig struct { ShippingQueryID string // required OK bool // required ShippingOptions []ShippingOption ErrorMessage string }
ShippingConfig contains information for answerShippingQuery request.
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 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 contains information about an incoming shipping query.
type Sticker ¶
type Sticker struct { // FileID is an identifier for this file, which can be used to download or // reuse the file FileID string `json:"file_id"` // FileUniqueID is a unique identifier for this file, // which is supposed to be the same over time and for different bots. // Can't be used to download or reuse the file. FileUniqueID string `json:"file_unique_id"` // Type is a type of the sticker, currently one of “regular”, // “mask”, “custom_emoji”. The type of the sticker is independent // from its format, which is determined by the fields is_animated and is_video. Type string `json:"type"` // Width sticker width Width int `json:"width"` // Height sticker height Height int `json:"height"` // IsAnimated true, if the sticker is animated // // optional IsAnimated bool `json:"is_animated,omitempty"` // IsVideo true, if the sticker is a video sticker // // optional IsVideo bool `json:"is_video,omitempty"` // Thumbnail sticker thumbnail in the .WEBP or .JPG format // // optional Thumbnail *PhotoSize `json:"thumbnail,omitempty"` // Emoji associated with the sticker // // optional Emoji string `json:"emoji,omitempty"` // SetName of the sticker set to which the sticker belongs // // optional SetName string `json:"set_name,omitempty"` // PremiumAnimation for premium regular stickers, premium animation for the sticker // // optional PremiumAnimation *File `json:"premium_animation,omitempty"` // MaskPosition is for mask stickers, the position where the mask should be // placed // // optional MaskPosition *MaskPosition `json:"mask_position,omitempty"` // CustomEmojiID for custom emoji stickers, unique identifier of the custom emoji // // optional CustomEmojiID string `json:"custom_emoji_id,omitempty"` // NeedsRepainting True, if the sticker must be repainted to a text color in messages, the color of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in other places // //optional NeedsRepainting bool `json:"needs_reainting,omitempty"` // FileSize // // optional FileSize int `json:"file_size,omitempty"` }
Sticker represents a sticker.
func (Sticker) IsCustomEmoji ¶
IsCustomEmoji returns if the Sticker is custom emoji
type StickerConfig ¶
type StickerConfig struct { //Emoji associated with the sticker; only for just uploaded stickers Emoji string BaseFile }
StickerConfig contains information about a SendSticker request.
func NewSticker ¶
func NewSticker(chatID int64, file RequestFileData) StickerConfig
NewSticker creates a new sendSticker request.
type StickerSet ¶
type StickerSet struct { // Name sticker set name Name string `json:"name"` // Title sticker set title Title string `json:"title"` // StickerType of stickers in the set, currently one of “regular”, “mask”, “custom_emoji” StickerType string `json:"sticker_type"` // IsAnimated true, if the sticker set contains animated stickers IsAnimated bool `json:"is_animated"` // IsVideo true, if the sticker set contains video stickers IsVideo bool `json:"is_video"` // ContainsMasks true, if the sticker set contains masks // // deprecated. Use sticker_type instead ContainsMasks bool `json:"contains_masks"` // Stickers list of all set stickers Stickers []Sticker `json:"stickers"` // Thumb is the sticker set thumbnail in the .WEBP or .TGS format Thumbnail *PhotoSize `json:"thumbnail"` }
StickerSet represents a sticker set.
func (StickerSet) IsCustomEmoji ¶
func (s StickerSet) IsCustomEmoji() bool
IsCustomEmoji returns if the StickerSet is custom emoji
func (StickerSet) IsMask ¶
func (s StickerSet) IsMask() bool
IsMask returns if the StickerSet is mask
func (StickerSet) IsRegular ¶
func (s StickerSet) IsRegular() bool
IsRegular returns if the StickerSet is regular
type StopMessageLiveLocationConfig ¶
type StopMessageLiveLocationConfig struct {
BaseEdit
}
StopMessageLiveLocationConfig stops updating a live location.
type StopPollConfig ¶
type StopPollConfig struct {
BaseEdit
}
StopPollConfig allows you to stop a poll sent by the bot.
func NewStopPoll ¶
func NewStopPoll(chatID int64, messageID int) StopPollConfig
NewStopPoll allows you to stop a poll.
type SuccessfulPayment ¶
type SuccessfulPayment struct { // Currency three-letter ISO 4217 currency code // (see https://core.telegram.org/bots/payments#supported-currencies) 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 identifier of the shipping option chosen by the user // // optional ShippingOptionID string `json:"shipping_option_id,omitempty"` // OrderInfo order info provided by the user // // optional 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 contains basic information about a successful payment.
type SwitchInlineQueryChosenChat ¶
type SwitchInlineQueryChosenChat struct { // Query is default inline query to be inserted in the input field. // If left empty, only the bot's username will be inserted // // optional Query string `json:"query,omitempty"` // AllowUserChats is True, if private chats with users can be chosen // // optional AllowUserChats bool `json:"allow_user_chats,omitempty"` // AllowBotChats is True, if private chats with bots can be chosen // // optional AllowBotChats bool `json:"allow_bot_chats,omitempty"` // AllowGroupChats is True, if group and supergroup chats can be chosen // // optional AllowGroupChats bool `json:"allow_group_chats,omitempty"` // AllowChannelChats is True, if channel chats can be chosen // // optional AllowChannelChats bool `json:"allow_channel_chats,omitempty"` }
SwitchInlineQueryChosenChat represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query.
type TextQuote ¶
type TextQuote struct { // Text of the quoted part of a message that is replied to by the given message Text string `json:"text"` // Entities special entities that appear in the quote. // Currently, only bold, italic, underline, strikethrough, spoiler, // and custom_emoji entities are kept in quotes. // // optional Entities []MessageEntity `json:"entities,omitempty"` // Position is approximate quote position in the original message // in UTF-16 code units as specified by the sender Position int `json:"position"` // IsManual True, if the quote was chosen manually by the message sender. // Otherwise, the quote was added automatically by the server. // // optional IsManual bool `json:"is_manual,omitempty"` }
TextQuote contains information about the quoted part of a message that is replied to by the given message
type UnbanChatMemberConfig ¶
type UnbanChatMemberConfig struct { ChatMemberConfig OnlyIfBanned bool }
UnbanChatMemberConfig allows you to unban a user.
type UnbanChatSenderChatConfig ¶
type UnbanChatSenderChatConfig struct { ChatConfig SenderChatID int64 }
UnbanChatSenderChatConfig unbans a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights.
type UnhideGeneralForumTopicConfig ¶
type UnhideGeneralForumTopicConfig struct{ BaseForum }
UnhideGeneralForumTopicConfig allows you to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
type UnpinAllChatMessagesConfig ¶
type UnpinAllChatMessagesConfig struct {
ChatConfig
}
UnpinAllChatMessagesConfig contains information of all messages to unpin in a chat.
type UnpinAllForumTopicMessagesConfig ¶
type UnpinAllForumTopicMessagesConfig struct{ BaseForum }
UnpinAllForumTopicMessagesConfig allows you to clear the list of pinned messages in a forum topic.
type UnpinAllGeneralForumTopicMessagesConfig ¶
type UnpinAllGeneralForumTopicMessagesConfig struct{ BaseForum }
UnpinAllGeneralForumTopicMessagesConfig allows you to to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.
type UnpinChatMessageConfig ¶
type UnpinChatMessageConfig struct {
BaseChatMessage
}
UnpinChatMessageConfig contains information of a chat message to unpin.
If MessageID is not specified, it will unpin the most recent pin.
func NewUnpinChatMessage ¶
func NewUnpinChatMessage(chatID int64, messageID int) UnpinChatMessageConfig
type Update ¶
type Update struct { // UpdateID is the update's unique identifier. // Update identifiers start from a certain positive number and increase // sequentially. // This ID becomes especially handy if you're using Webhooks, // since it allows you to ignore repeated updates or to restore // the correct update sequence, should they get out of order. // If there are no new updates for at least a week, then identifier // of the next update will be chosen randomly instead of sequentially. UpdateID int `json:"update_id"` // Message new incoming message of any kind — text, photo, sticker, etc. // // optional Message *Message `json:"message,omitempty"` // EditedMessage new version of a message that is known to the bot and was // edited // // optional EditedMessage *Message `json:"edited_message,omitempty"` // ChannelPost new version of a message that is known to the bot and was // edited // // optional ChannelPost *Message `json:"channel_post,omitempty"` // EditedChannelPost new incoming channel post of any kind — text, photo, // sticker, etc. // // optional EditedChannelPost *Message `json:"edited_channel_post,omitempty"` // MessageReaction is a reaction to a message was changed by a user. // // optional MessageReaction *MessageReactionUpdated `json:"message_reaction,omitempty"` // MessageReactionCount reactions to a message with anonymous reactions were changed. // // optional MessageReactionCount *MessageReactionCountUpdated `json:"message_reaction_count,omitempty"` // InlineQuery new incoming inline query // // optional InlineQuery *InlineQuery `json:"inline_query,omitempty"` // ChosenInlineResult is the result of an inline query // that was chosen by a user and sent to their chat partner. // Please see our documentation on the feedback collecting // for details on how to enable these updates for your bot. // // optional ChosenInlineResult *ChosenInlineResult `json:"chosen_inline_result,omitempty"` // CallbackQuery new incoming callback query // // optional CallbackQuery *CallbackQuery `json:"callback_query,omitempty"` // ShippingQuery new incoming shipping query. Only for invoices with // flexible price // // optional ShippingQuery *ShippingQuery `json:"shipping_query,omitempty"` // PreCheckoutQuery new incoming pre-checkout query. Contains full // information about checkout // // optional PreCheckoutQuery *PreCheckoutQuery `json:"pre_checkout_query,omitempty"` // Pool new poll state. Bots receive only updates about stopped polls and // polls, which are sent by the bot // // optional Poll *Poll `json:"poll,omitempty"` // PollAnswer user changed their answer in a non-anonymous poll. Bots // receive new votes only in polls that were sent by the bot itself. // // optional PollAnswer *PollAnswer `json:"poll_answer,omitempty"` // MyChatMember is 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. // // optional MyChatMember *ChatMemberUpdated `json:"my_chat_member,omitempty"` // ChatMember is 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. // // optional ChatMember *ChatMemberUpdated `json:"chat_member,omitempty"` // ChatJoinRequest is a request to join the chat has been sent. The bot must // have the can_invite_users administrator right in the chat to receive // these updates. // // optional ChatJoinRequest *ChatJoinRequest `json:"chat_join_request,omitempty"` }
Update is an update response, from GetUpdates.
func (*Update) CallbackData ¶
CallbackData returns the callback query data, if it exists.
type UpdateConfig ¶
UpdateConfig contains information about a GetUpdates request.
func NewUpdate ¶
func NewUpdate(offset int) UpdateConfig
NewUpdate gets updates since the last Offset.
offset is the last Update ID to include. You likely want to set this to the last Update ID plus 1.
type UpdatesChannel ¶
type UpdatesChannel <-chan Update
UpdatesChannel is the channel for getting updates.
func (UpdatesChannel) Clear ¶
func (ch UpdatesChannel) Clear()
Clear discards all unprocessed incoming updates.
type UploadStickerConfig ¶
type UploadStickerConfig struct { UserID int64 Sticker RequestFile StickerFormat string }
UploadStickerConfig allows you to upload a sticker for use in a set later.
type User ¶
type User struct { // ID is a unique identifier for this user or bot ID int64 `json:"id"` // IsBot true, if this user is a bot // // optional IsBot bool `json:"is_bot,omitempty"` // IsPremium true, if user has Telegram Premium // // optional IsPremium bool `json:"is_premium,omitempty"` // AddedToAttachmentMenu true, if this user added the bot to the attachment menu // // optional AddedToAttachmentMenu bool `json:"added_to_attachment_menu,omitempty"` // FirstName user's or bot's first name FirstName string `json:"first_name"` // LastName user's or bot's last name // // optional LastName string `json:"last_name,omitempty"` // UserName user's or bot's username // // optional UserName string `json:"username,omitempty"` // LanguageCode IETF language tag of the user's language // more info: https://en.wikipedia.org/wiki/IETF_language_tag // // optional LanguageCode string `json:"language_code,omitempty"` // CanJoinGroups is true, if the bot can be invited to groups. // Returned only in getMe. // // optional CanJoinGroups bool `json:"can_join_groups,omitempty"` // CanReadAllGroupMessages is true, if privacy mode is disabled for the bot. // Returned only in getMe. // // optional CanReadAllGroupMessages bool `json:"can_read_all_group_messages,omitempty"` // SupportsInlineQueries is true, if the bot supports inline queries. // Returned only in getMe. // // optional SupportsInlineQueries bool `json:"supports_inline_queries,omitempty"` }
User represents a Telegram user or bot.
type UserChatBoosts ¶
type UserChatBoosts struct { // Boosts is the list of boosts added to the chat by the user Boosts []ChatBoost `json:"boosts"` }
UserChatBoosts represents a list of boosts added to a chat by a user.
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 contains a set of user profile photos.
type UserProfilePhotosConfig ¶
UserProfilePhotosConfig contains information about a GetUserProfilePhotos request.
func NewUserProfilePhotos ¶
func NewUserProfilePhotos(userID int64) UserProfilePhotosConfig
NewUserProfilePhotos gets user profile photos.
userID is the ID of the user you wish to get profile photos from.
type UsersShared ¶
UsersShared object contains information about the user whose identifier was shared with the bot using a KeyboardButtonRequestUser button.
type Venue ¶
type Venue struct { // Location is the venue location Location Location `json:"location"` // Title is the name of the venue Title string `json:"title"` // Address of the venue Address string `json:"address"` // FoursquareID is the foursquare identifier of the venue // // optional FoursquareID string `json:"foursquare_id,omitempty"` // FoursquareType is the foursquare type of the venue // // optional FoursquareType string `json:"foursquare_type,omitempty"` // GooglePlaceID is the Google Places identifier of the venue // // optional GooglePlaceID string `json:"google_place_id,omitempty"` // GooglePlaceType is the Google Places type of the venue // // optional GooglePlaceType string `json:"google_place_type,omitempty"` }
Venue represents a venue.
type VenueConfig ¶
type VenueConfig struct { BaseChat Latitude float64 // required Longitude float64 // required Title string // required Address string // required FoursquareID string FoursquareType string GooglePlaceID string GooglePlaceType string }
VenueConfig contains information about a SendVenue request.
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 is the 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 of the video in seconds as defined by sender Duration int `json:"duration"` // Thumbnail video thumbnail // // optional Thumbnail *PhotoSize `json:"thumbnail,omitempty"` // FileName is the original filename as defined by sender // // optional FileName string `json:"file_name,omitempty"` // MimeType of a file as defined by sender // // optional MimeType string `json:"mime_type,omitempty"` // FileSize file size // // optional FileSize int64 `json:"file_size,omitempty"` }
Video represents a video file.
type VideoChatEnded ¶
type VideoChatEnded struct { // Voice chat duration; in seconds. Duration int `json:"duration"` }
VideoChatEnded represents a service message about a voice chat ended in the chat.
type VideoChatParticipantsInvited ¶
type VideoChatParticipantsInvited struct { // New members that were invited to the voice chat. // // optional Users []User `json:"users,omitempty"` }
VideoChatParticipantsInvited represents a service message about new members invited to a voice chat.
type VideoChatScheduled ¶
type VideoChatScheduled struct { // Point in time (Unix timestamp) when the voice chat is supposed to be // started by a chat administrator StartDate int `json:"start_date"` }
VideoChatScheduled represents a service message about a voice chat scheduled in the chat.
func (*VideoChatScheduled) Time ¶
func (m *VideoChatScheduled) Time() time.Time
Time converts the scheduled start date into a Time.
type VideoChatStarted ¶
type VideoChatStarted struct{}
VideoChatStarted represents a service message about a voice chat started in the chat.
type VideoConfig ¶
type VideoConfig struct { BaseFile BaseSpoiler Thumb RequestFileData Duration int Caption string ParseMode string CaptionEntities []MessageEntity SupportsStreaming bool }
VideoConfig contains information about a SendVideo request.
func NewVideo ¶
func NewVideo(chatID int64, file RequestFileData) VideoConfig
NewVideo creates a new sendVideo request.
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 is the 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 of the video in seconds as defined by sender Duration int `json:"duration"` // Thumbnail video thumbnail // // optional Thumbnail *PhotoSize `json:"thumbnail,omitempty"` // FileSize file size // // optional FileSize int `json:"file_size,omitempty"` }
VideoNote object represents a video message.
type VideoNoteConfig ¶
type VideoNoteConfig struct { BaseFile Thumb RequestFileData Duration int Length int }
VideoNoteConfig contains information about a SendVideoNote request.
func NewVideoNote ¶
func NewVideoNote(chatID int64, length int, file RequestFileData) VideoNoteConfig
NewVideoNote creates a new sendVideoNote request.
chatID is where to send it, file is a string path to the file, FileReader, or FileBytes.
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 is the unique identifier for this file, which is supposed to // be the same over time and for different bots. Can't be used to download // or reuse the file. FileUniqueID string `json:"file_unique_id"` // Duration of the audio in seconds as defined by sender Duration int `json:"duration"` // MimeType of the file as defined by sender // // optional MimeType string `json:"mime_type,omitempty"` // FileSize file size // // optional FileSize int64 `json:"file_size,omitempty"` }
Voice represents a voice note.
type VoiceConfig ¶
type VoiceConfig struct { BaseFile Thumb RequestFileData Caption string ParseMode string CaptionEntities []MessageEntity Duration int }
VoiceConfig contains information about a SendVoice request.
func NewVoice ¶
func NewVoice(chatID int64, file RequestFileData) VoiceConfig
NewVoice creates a new sendVoice request.
type WebAppData ¶
type WebAppData struct { // Data is the data. Be aware that a bad client can send arbitrary data in this field. Data string `json:"data"` // ButtonText is the text of the web_app keyboard button, from which the Web App // was opened. Be aware that a bad client can send arbitrary data in this field. ButtonText string `json:"button_text"` }
WebAppData Contains data sent from a Web App to the bot.
type WebAppInfo ¶
type WebAppInfo struct { // URL is the HTTPS URL of a Web App to be opened with additional data as // specified in Initializing Web Apps. URL string `json:"url"` }
WebAppInfo contains information about a Web App.
type WebhookConfig ¶
type WebhookConfig struct { URL *url.URL Certificate RequestFileData IPAddress string MaxConnections int AllowedUpdates []string DropPendingUpdates bool SecretToken string }
WebhookConfig contains information about a SetWebhook request.
func NewWebhook ¶
func NewWebhook(link string) (WebhookConfig, error)
NewWebhook creates a new webhook.
link is the url parsable link you wish to get the updates.
Example ¶
bot, err := NewBotAPI("MyAwesomeBotToken") if err != nil { panic(err) } bot.Debug = true log.Printf("Authorized on account %s", bot.Self.UserName) wh, err := NewWebhookWithCert("https://www.google.com:8443/"+bot.Token, FilePath("cert.pem")) if err != nil { panic(err) } _, err = bot.Request(wh) if err != nil { panic(err) } info, err := bot.GetWebhookInfo() if err != nil { panic(err) } if info.LastErrorDate != 0 { log.Printf("failed to set webhook: %s", info.LastErrorMessage) } updates := bot.ListenForWebhook("/" + bot.Token) go http.ListenAndServeTLS("0.0.0.0:8443", "cert.pem", "key.pem", nil) for update := range updates { log.Printf("%+v\n", update) }
Output:
func NewWebhookWithCert ¶
func NewWebhookWithCert(link string, file RequestFileData) (WebhookConfig, error)
NewWebhookWithCert creates a new webhook with a certificate.
link is the url you wish to get webhooks, file contains a string to a file, FileReader, or FileBytes.
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 is the currently used webhook IP address // // optional IPAddress string `json:"ip_address,omitempty"` // LastErrorDate unix time for the most recent error // that happened when trying to deliver an update via webhook. // // optional LastErrorDate int `json:"last_error_date,omitempty"` // LastErrorMessage error message in human-readable format for the most recent error // that happened when trying to deliver an update via webhook. // // optional LastErrorMessage string `json:"last_error_message,omitempty"` // LastSynchronizationErrorDate is the unix time of the most recent error that // happened when trying to synchronize available updates with Telegram datacenters. LastSynchronizationErrorDate int `json:"last_synchronization_error_date,omitempty"` // MaxConnections maximum allowed number of simultaneous // HTTPS connections to the webhook for update delivery. // // optional MaxConnections int `json:"max_connections,omitempty"` // AllowedUpdates is a list of update types the bot is subscribed to. // Defaults to all update types // // optional AllowedUpdates []string `json:"allowed_updates,omitempty"` }
WebhookInfo is information about a currently set webhook.
func (WebhookInfo) IsSet ¶
func (info WebhookInfo) IsSet() bool
IsSet returns true if a webhook is currently set.
type WriteAccessAllowed ¶
type WriteAccessAllowed struct { // FromRequest is true, if the access was granted after // the user accepted an explicit request from a Web App // sent by the method requestWriteAccess. // // Optional FromRequest bool `json:"from_request,omitempty"` // Name of the Web App which was launched from a link // // Optional WebAppName string `json:"web_app_name,omitempty"` // FromAttachmentMenu is true, if the access was granted when // the bot was added to the attachment or side menu // // Optional FromAttachmentMenu bool `json:"from_attachment_menu,omitempty"` }
WriteAccessAllowed represents a service message about a user allowing a bot to write messages after adding the bot to the attachment menu or launching a Web App from a link.