Parse https://core.telegram.org/bots/api page and generate a Kotlin class "DocSection" with "DocType" and "DocMethod"
Last update: Telegram Bot API 7.9
Example in:
| Format | Generator | Output |
|---|---|---|
| Kotlin (data class only) | GeneratorKotlin.kt | TelegramModelsOnly.kt |
| Kotlin (Kotlin/Serialization + Ktor client) | GeneratorKotlin.kt | TelegramModels.kt + TelegramClient.kt |
| Rust (data class only) | GeneratorRust.kt | TelegramModels.rs |
| Json | GeneratorJson.kt | telegram.json |
| Markdown | GeneratorReadmeExample.kt | telegram.md or telegram_full.md or telegram_tiny.md |
| Build your own ... |
Libraries build with this tool
| Language | Repo |
|---|---|
| Kotlin | https://github.com/omarmiatello/telegram |
class TelegramClient(apiKey: String, httpClient: HttpClient) {
// ...
/**
* <p>Use this method to receive incoming updates using long polling (<a href="http://en.wikipedia.org/wiki/Push_technology#Long_polling">wiki</a>). An Array of <a href="#update">Update</a> objects is returned.</p><blockquote>
* <p><strong>Notes</strong><br><strong>1.</strong> This method will not work if an outgoing webhook is set up.<br><strong>2.</strong> In order to avoid getting duplicate updates, recalculate <em>offset</em> after each server response.</p>
* </blockquote>
*
* @property offset Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as <a href="#getupdates">getUpdates</a> is called with an <em>offset</em> higher than its <em>update_id</em>. The negative offset can be specified to retrieve updates starting from <em>-offset</em> update from the end of the updates queue. All previous updates will forgotten.
* @property limit Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100.
* @property timeout Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only.
* @property allowed_updates List the types of updates you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See <a href="#update">Update</a> for a complete list of available update types. Specify an empty list to receive all updates regardless of type (default). If not specified, the previous setting will be used.<br><br>Please note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time.
*
* @return [List<Update>]
* */
fun getUpdates(
offset: Int? = null,
limit: Int? = null,
timeout: Int? = null,
allowed_updates: List<String>? = null
) = telegram(
"$basePath/getUpdates",
TelegramRequest.GetUpdatesRequest(
offset,
limit,
timeout,
allowed_updates
).toJsonForRequest(),
ListSerializer(Update.serializer())
)
// ...
}// Getting updates
/**
* <p>This <a href="#available-types">object</a> represents an incoming update.<br>At most <strong>one</strong> of the optional parameters can be present in any given update.</p>
*
* @property update_id 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 <a href="#setwebhook">Webhooks</a>, 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.
* @property message <em>Optional</em>. New incoming message of any kind — text, photo, sticker, etc.
* @property edited_message <em>Optional</em>. New version of a message that is known to the bot and was edited
* @property channel_post <em>Optional</em>. New incoming channel post of any kind — text, photo, sticker, etc.
* @property edited_channel_post <em>Optional</em>. New version of a channel post that is known to the bot and was edited
* @property inline_query <em>Optional</em>. New incoming <a href="#inline-mode">inline</a> query
* @property chosen_inline_result <em>Optional</em>. The result of an <a href="#inline-mode">inline</a> query that was chosen by a user and sent to their chat partner. Please see our documentation on the <a href="/bots/inline#collecting-feedback">feedback collecting</a> for details on how to enable these updates for your bot.
* @property callback_query <em>Optional</em>. New incoming callback query
* @property shipping_query <em>Optional</em>. New incoming shipping query. Only for invoices with flexible price
* @property pre_checkout_query <em>Optional</em>. New incoming pre-checkout query. Contains full information about checkout
* @property poll <em>Optional</em>. New poll state. Bots receive only updates about stopped polls and polls, which are sent by the bot
* @property poll_answer <em>Optional</em>. A user changed their answer in a non-anonymous poll. Bots receive new votes only in polls that were sent by the bot itself.
* @property my_chat_member <em>Optional</em>. 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.
* @property chat_member <em>Optional</em>. 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 <em>allowed_updates</em> to receive these updates.
* @property chat_join_request <em>Optional</em>. A request to join the chat has been sent. The bot must have the <em>can_invite_users</em> administrator right in the chat to receive these updates.
*
* @constructor Creates a [Update].
* */
@Serializable
data class Update(
val update_id: Long,
val message: Message? = null,
val edited_message: Message? = null,
val channel_post: Message? = null,
val edited_channel_post: Message? = null,
val inline_query: InlineQuery? = null,
val chosen_inline_result: ChosenInlineResult? = null,
val callback_query: CallbackQuery? = null,
val shipping_query: ShippingQuery? = null,
val pre_checkout_query: PreCheckoutQuery? = null,
val poll: Poll? = null,
val poll_answer: PollAnswer? = null,
val my_chat_member: ChatMemberUpdated? = null,
val chat_member: ChatMemberUpdated? = null,
val chat_join_request: ChatJoinRequest? = null,
) : TelegramModel() {
override fun toJson() = json.encodeToString(serializer(), this)
companion object {
fun fromJson(string: String) = json.decodeFromString(serializer(), string)
}
}
// ...Below an example generated with GeneratorReadmeExample.kt
Update(update_id: Integer, message: Message, edited_message: Message, channel_post: Message, edited_channel_post: Message, inline_query: InlineQuery, chosen_inline_result: ChosenInlineResult, callback_query: CallbackQuery, shipping_query: ShippingQuery, pre_checkout_query: PreCheckoutQuery, poll: Poll, poll_answer: PollAnswer, my_chat_member: ChatMemberUpdated, chat_member: ChatMemberUpdated, chat_join_request: ChatJoinRequest)
This object represents an incoming update.
At most one of the optional parameters can be present in any given update.
| name | type | required | description |
|---|---|---|---|
| update_id | Integer | true | 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. |
| message | Message | false | Optional. New incoming message of any kind — text, photo, sticker, etc. |
| edited_message | Message | false | Optional. New version of a message that is known to the bot and was edited |
| channel_post | Message | false | Optional. New incoming channel post of any kind — text, photo, sticker, etc. |
| edited_channel_post | Message | false | Optional. New version of a channel post that is known to the bot and was edited |
| inline_query | InlineQuery | false | Optional. New incoming inline query |
| chosen_inline_result | ChosenInlineResult | false | Optional. The result of an inline query that was chosen by a user and sent to their chat partner. Please see our documentation on the feedback collecting for details on how to enable these updates for your bot. |
| callback_query | CallbackQuery | false | Optional. New incoming callback query |
| shipping_query | ShippingQuery | false | Optional. New incoming shipping query. Only for invoices with flexible price |
| pre_checkout_query | PreCheckoutQuery | false | Optional. New incoming pre-checkout query. Contains full information about checkout |
| poll | Poll | false | Optional. New poll state. Bots receive only updates about stopped polls and polls, which are sent by the bot |
| poll_answer | PollAnswer | false | Optional. A user changed their answer in a non-anonymous poll. Bots receive new votes only in polls that were sent by the bot itself. |
| my_chat_member | ChatMemberUpdated | false | Optional. The bot's chat member status was updated in a chat. For private chats, this update is received only when the bot is blocked or unblocked by the user. |
| chat_member | ChatMemberUpdated | false | Optional. A chat member's status was updated in a chat. The bot must be an administrator in the chat and must explicitly specify “chat_member” in the list of allowed_updates to receive these updates. |
| chat_join_request | ChatJoinRequest | false | Optional. A request to join the chat has been sent. The bot must have the can_invite_users administrator right in the chat to receive these updates. |
WebhookInfo(url: String, has_custom_certificate: Boolean, pending_update_count: Integer, ip_address: String, last_error_date: Integer, last_error_message: String, max_connections: Integer, allowed_updates: List<String>)
Contains information about the current status of a webhook.
| name | type | required | description |
|---|---|---|---|
| url | String | true | Webhook URL, may be empty if webhook is not set up |
| has_custom_certificate | Boolean | true | True, if a custom certificate was provided for webhook certificate checks |
| pending_update_count | Integer | true | Number of updates awaiting delivery |
| ip_address | String | false | Optional. Currently used webhook IP address |
| last_error_date | Integer | false | Optional. Unix time for the most recent error that happened when trying to deliver an update via webhook |
| last_error_message | String | false | Optional. Error message in human-readable format for the most recent error that happened when trying to deliver an update via webhook |
| max_connections | Integer | false | Optional. Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery |
| allowed_updates | List | false | Optional. A list of update types the bot is subscribed to. Defaults to all update types except chat_member |
getUpdates(offset: Integer, limit: Integer, timeout: Integer, allowed_updates: List<String>)
Use this method to receive incoming updates using long polling (wiki). An Array of Update objects is returned.
Notes
1. This method will not work if an outgoing webhook is set up.
2. In order to avoid getting duplicate updates, recalculate offset after each server response.
| name | type | required | description |
|---|---|---|---|
| offset | Integer | false | Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will forgotten. |
| limit | Integer | false | Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100. |
| timeout | Integer | false | Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only. |
| allowed_updates | List | false | A JSON-serialized list of the update types you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member (default). If not specified, the previous setting will be used. Please note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time. |
setWebhook(url: String, certificate: InputFile, ip_address: String, max_connections: Integer, allowed_updates: List<String>, drop_pending_updates: Boolean)
Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.
If you'd like to make sure that the Webhook request comes from Telegram, we recommend using a secret path in the URL, e.g. https://www.example.com/<token>. Since nobody else knows your bot's token, you can be pretty sure it's us.
Notes
1. You will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up.
2. To use a self-signed certificate, you need to upload your public key certificate using certificate parameter. Please upload as InputFile, sending a String will not work.
3. Ports currently supported for Webhooks: 443, 80, 88, 8443.NEW! If you're having any trouble setting up webhooks, please check out this amazing guide to Webhooks.
| name | type | required | description |
|---|---|---|---|
| url | String | true | HTTPS url to send updates to. Use an empty string to remove webhook integration |
| certificate | InputFile | false | Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details. |
| ip_address | String | false | The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS |
| max_connections | Integer | false | Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput. |
| allowed_updates | List | false | A JSON-serialized list of the update types you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member (default). If not specified, the previous setting will be used. Please note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time. |
| drop_pending_updates | Boolean | false | Pass True to drop all pending updates |
deleteWebhook(drop_pending_updates: Boolean)
Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success.
| name | type | required | description |
|---|---|---|---|
| drop_pending_updates | Boolean | false | Pass True to drop all pending updates |
getWebhookInfo()
Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.
User(id: Integer, is_bot: Boolean, first_name: String, last_name: String, username: String, language_code: String, can_join_groups: Boolean, can_read_all_group_messages: Boolean, supports_inline_queries: Boolean)
This object represents a Telegram user or bot.
| name | type | required | description |
|---|---|---|---|
| id | Integer | true | Unique identifier for this user or bot. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. |
| is_bot | Boolean | true | True, if this user is a bot |
| first_name | String | true | User's or bot's first name |
| last_name | String | false | Optional. User's or bot's last name |
| username | String | false | Optional. User's or bot's username |
| language_code | String | false | Optional. IETF language tag of the user's language |
| can_join_groups | Boolean | false | Optional. True, if the bot can be invited to groups. Returned only in getMe. |
| can_read_all_group_messages | Boolean | false | Optional. True, if privacy mode is disabled for the bot. Returned only in getMe. |
| supports_inline_queries | Boolean | false | Optional. True, if the bot supports inline queries. Returned only in getMe. |
Chat(id: Integer, type: String, title: String, username: String, first_name: String, last_name: String, photo: ChatPhoto, bio: String, has_private_forwards: Boolean, description: String, invite_link: String, pinned_message: Message, permissions: ChatPermissions, slow_mode_delay: Integer, message_auto_delete_time: Integer, has_protected_content: Boolean, sticker_set_name: String, can_set_sticker_set: Boolean, linked_chat_id: Integer, location: ChatLocation)
This object represents a chat.
| name | type | required | description |
|---|---|---|---|
| id | Integer | true | Unique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier. |
| type | String | true | Type of chat, can be either “private”, “group”, “supergroup” or “channel” |
| title | String | false | Optional. Title, for supergroups, channels and group chats |
| username | String | false | Optional. Username, for private chats, supergroups and channels if available |
| first_name | String | false | Optional. First name of the other party in a private chat |
| last_name | String | false | Optional. Last name of the other party in a private chat |
| photo | ChatPhoto | false | Optional. Chat photo. Returned only in getChat. |
| bio | String | false | Optional. Bio of the other party in a private chat. Returned only in getChat. |
| has_private_forwards | Boolean | false | Optional. True, if privacy settings of the other party in the private chat allows to use tg://user?id=<user_id> links only in chats with the user. Returned only in getChat. |
| description | String | false | Optional. Description, for groups, supergroups and channel chats. Returned only in getChat. |
| invite_link | String | false | Optional. Primary invite link, for groups, supergroups and channel chats. Returned only in getChat. |
| pinned_message | Message | false | Optional. The most recent pinned message (by sending date). Returned only in getChat. |
| permissions | ChatPermissions | false | Optional. Default chat member permissions, for groups and supergroups. Returned only in getChat. |
| slow_mode_delay | Integer | false | Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unpriviledged user; in seconds. Returned only in getChat. |
| message_auto_delete_time | Integer | false | Optional. The time after which all messages sent to the chat will be automatically deleted; in seconds. Returned only in getChat. |
| has_protected_content | Boolean | false | Optional. True, if messages from the chat can't be forwarded to other chats. Returned only in getChat. |
| sticker_set_name | String | false | Optional. For supergroups, name of group sticker set. Returned only in getChat. |
| can_set_sticker_set | Boolean | false | Optional. True, if the bot can change the group sticker set. Returned only in getChat. |
| linked_chat_id | Integer | false | Optional. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. Returned only in getChat. |
| location | ChatLocation | false | Optional. For supergroups, the location to which the supergroup is connected. Returned only in getChat. |
Message(message_id: Integer, from: User, sender_chat: Chat, date: Integer, chat: Chat, forward_from: User, forward_from_chat: Chat, forward_from_message_id: Integer, forward_signature: String, forward_sender_name: String, forward_date: Integer, is_automatic_forward: Boolean, reply_to_message: Message, via_bot: User, edit_date: Integer, has_protected_content: Boolean, media_group_id: String, author_signature: String, text: String, entities: List<MessageEntity>, animation: Animation, audio: Audio, document: Document, photo: List<PhotoSize>, sticker: Sticker, video: Video, video_note: VideoNote, voice: Voice, caption: String, caption_entities: List<MessageEntity>, contact: Contact, dice: Dice, game: Game, poll: Poll, venue: Venue, location: Location, new_chat_members: List<User>, left_chat_member: User, new_chat_title: String, new_chat_photo: List<PhotoSize>, delete_chat_photo: Boolean, group_chat_created: Boolean, supergroup_chat_created: Boolean, channel_chat_created: Boolean, message_auto_delete_timer_changed: MessageAutoDeleteTimerChanged, migrate_to_chat_id: Integer, migrate_from_chat_id: Integer, pinned_message: Message, invoice: Invoice, successful_payment: SuccessfulPayment, connected_website: String, passport_data: PassportData, proximity_alert_triggered: ProximityAlertTriggered, voice_chat_scheduled: VoiceChatScheduled, voice_chat_started: VoiceChatStarted, voice_chat_ended: VoiceChatEnded, voice_chat_participants_invited: VoiceChatParticipantsInvited, reply_markup: InlineKeyboardMarkup)
This object represents a message.
| name | type | required | description |
|---|---|---|---|
| message_id | Integer | true | Unique message identifier inside this chat |
| from | User | false | Optional. Sender of the message; empty for messages sent to channels. For backward compatibility, the field contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat. |
| sender_chat | Chat | false | Optional. Sender of the message, sent on behalf of a chat. For example, the channel itself for channel posts, the supergroup itself for messages from anonymous group administrators, the linked channel for messages automatically forwarded to the discussion group. For backward compatibility, the field from contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat. |
| date | Integer | true | Date the message was sent in Unix time |
| chat | Chat | true | Conversation the message belongs to |
| forward_from | User | false | Optional. For forwarded messages, sender of the original message |
| forward_from_chat | Chat | false | Optional. For messages forwarded from channels or from anonymous administrators, information about the original sender chat |
| forward_from_message_id | Integer | false | Optional. For messages forwarded from channels, identifier of the original message in the channel |
| forward_signature | String | false | Optional. For forwarded messages that were originally sent in channels or by an anonymous chat administrator, signature of the message sender if present |
| forward_sender_name | String | false | Optional. Sender's name for messages forwarded from users who disallow adding a link to their account in forwarded messages |
| forward_date | Integer | false | Optional. For forwarded messages, date the original message was sent in Unix time |
| is_automatic_forward | Boolean | false | Optional. True, if the message is a channel post that was automatically forwarded to the connected discussion group |
| reply_to_message | Message | false | Optional. For replies, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply. |
| via_bot | User | false | Optional. Bot through which the message was sent |
| edit_date | Integer | false | Optional. Date the message was last edited in Unix time |
| has_protected_content | Boolean | false | Optional. True, if the message can't be forwarded |
| media_group_id | String | false | Optional. The unique identifier of a media message group this message belongs to |
| author_signature | String | false | Optional. Signature of the post author for messages in channels, or the custom title of an anonymous group administrator |
| text | String | false | Optional. For text messages, the actual UTF-8 text of the message, 0-4096 characters |
| entities | List | false | Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text |
| animation | Animation | false | Optional. Message is an animation, information about the animation. For backward compatibility, when this field is set, the document field will also be set |
| audio | Audio | false | Optional. Message is an audio file, information about the file |
| document | Document | false | Optional. Message is a general file, information about the file |
| photo | List | false | Optional. Message is a photo, available sizes of the photo |
| sticker | Sticker | false | Optional. Message is a sticker, information about the sticker |
| video | Video | false | Optional. Message is a video, information about the video |
| video_note | VideoNote | false | Optional. Message is a video note, information about the video message |
| voice | Voice | false | Optional. Message is a voice message, information about the file |
| caption | String | false | Optional. Caption for the animation, audio, document, photo, video or voice, 0-1024 characters |
| caption_entities | List | false | Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption |
| contact | Contact | false | Optional. Message is a shared contact, information about the contact |
| dice | Dice | false | Optional. Message is a dice with random value |
| game | Game | false | Optional. Message is a game, information about the game. More about games » |
| poll | Poll | false | Optional. Message is a native poll, information about the poll |
| venue | Venue | false | Optional. Message is a venue, information about the venue. For backward compatibility, when this field is set, the location field will also be set |
| location | Location | false | Optional. Message is a shared location, information about the location |
| new_chat_members | List | false | Optional. New members that were added to the group or supergroup and information about them (the bot itself may be one of these members) |
| left_chat_member | User | false | Optional. A member was removed from the group, information about them (this member may be the bot itself) |
| new_chat_title | String | false | Optional. A chat title was changed to this value |
| new_chat_photo | List | false | Optional. A chat photo was change to this value |
| delete_chat_photo | Boolean | false | Optional. Service message: the chat photo was deleted |
| group_chat_created | Boolean | false | Optional. Service message: the group has been created |
| supergroup_chat_created | Boolean | false | Optional. Service message: the supergroup has been created. This field can't be received in a message coming through updates, because bot can't be a member of a supergroup when it is created. It can only be found in reply_to_message if someone replies to a very first message in a directly created supergroup. |
| channel_chat_created | Boolean | false | Optional. Service message: the channel has been created. This field can't be received in a message coming through updates, because bot can't be a member of a channel when it is created. It can only be found in reply_to_message if someone replies to a very first message in a channel. |
| message_auto_delete_timer_changed | MessageAutoDeleteTimerChanged | false | Optional. Service message: auto-delete timer settings changed in the chat |
| migrate_to_chat_id | Integer | false | Optional. The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier. |
| migrate_from_chat_id | Integer | false | Optional. The supergroup has been migrated from a group with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier. |
| pinned_message | Message | false | Optional. Specified message was pinned. Note that the Message object in this field will not contain further reply_to_message fields even if it is itself a reply. |
| invoice | Invoice | false | Optional. Message is an invoice for a payment, information about the invoice. More about payments » |
| successful_payment | SuccessfulPayment | false | Optional. Message is a service message about a successful payment, information about the payment. More about payments » |
| connected_website | String | false | Optional. The domain name of the website on which the user has logged in. More about Telegram Login » |
| passport_data | PassportData | false | Optional. Telegram Passport data |
| proximity_alert_triggered | ProximityAlertTriggered | false | Optional. Service message. A user in the chat triggered another user's proximity alert while sharing Live Location. |
| voice_chat_scheduled | VoiceChatScheduled | false | Optional. Service message: voice chat scheduled |
| voice_chat_started | VoiceChatStarted | false | Optional. Service message: voice chat started |
| voice_chat_ended | VoiceChatEnded | false | Optional. Service message: voice chat ended |
| voice_chat_participants_invited | VoiceChatParticipantsInvited | false | Optional. Service message: new participants invited to a voice chat |
| reply_markup | InlineKeyboardMarkup | false | Optional. Inline keyboard attached to the message. login_url buttons are represented as ordinary url buttons. |
MessageId(message_id: Integer)
This object represents a unique message identifier.
| name | type | required | description |
|---|---|---|---|
| message_id | Integer | true | Unique message identifier |
MessageEntity(type: String, offset: Integer, length: Integer, url: String, user: User, language: String)
This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Type of the entity. Currently, 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), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames) |
| offset | Integer | true | Offset in UTF-16 code units to the start of the entity |
| length | Integer | true | Length of the entity in UTF-16 code units |
| url | String | false | Optional. For “text_link” only, url that will be opened after user taps on the text |
| user | User | false | Optional. For “text_mention” only, the mentioned user |
| language | String | false | Optional. For “pre” only, the programming language of the entity text |
PhotoSize(file_id: String, file_unique_id: String, width: Integer, height: Integer, file_size: Integer)
This object represents one size of a photo or a file / sticker thumbnail.
| name | type | required | description |
|---|---|---|---|
| file_id | String | true | Identifier for this file, which can be used to download or reuse the file |
| file_unique_id | String | true | 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. |
| width | Integer | true | Photo width |
| height | Integer | true | Photo height |
| file_size | Integer | false | Optional. File size in bytes |
Animation(file_id: String, file_unique_id: String, width: Integer, height: Integer, duration: Integer, thumb: PhotoSize, file_name: String, mime_type: String, file_size: Integer)
This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).
| name | type | required | description |
|---|---|---|---|
| file_id | String | true | Identifier for this file, which can be used to download or reuse the file |
| file_unique_id | String | true | 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. |
| width | Integer | true | Video width as defined by sender |
| height | Integer | true | Video height as defined by sender |
| duration | Integer | true | Duration of the video in seconds as defined by sender |
| thumb | PhotoSize | false | Optional. Animation thumbnail as defined by sender |
| file_name | String | false | Optional. Original animation filename as defined by sender |
| mime_type | String | false | Optional. MIME type of the file as defined by sender |
| file_size | Integer | false | Optional. File size in bytes |
Audio(file_id: String, file_unique_id: String, duration: Integer, performer: String, title: String, file_name: String, mime_type: String, file_size: Integer, thumb: PhotoSize)
This object represents an audio file to be treated as music by the Telegram clients.
| name | type | required | description |
|---|---|---|---|
| file_id | String | true | Identifier for this file, which can be used to download or reuse the file |
| file_unique_id | String | true | 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. |
| duration | Integer | true | Duration of the audio in seconds as defined by sender |
| performer | String | false | Optional. Performer of the audio as defined by sender or by audio tags |
| title | String | false | Optional. Title of the audio as defined by sender or by audio tags |
| file_name | String | false | Optional. Original filename as defined by sender |
| mime_type | String | false | Optional. MIME type of the file as defined by sender |
| file_size | Integer | false | Optional. File size in bytes |
| thumb | PhotoSize | false | Optional. Thumbnail of the album cover to which the music file belongs |
Document(file_id: String, file_unique_id: String, thumb: PhotoSize, file_name: String, mime_type: String, file_size: Integer)
This object represents a general file (as opposed to photos, voice messages and audio files).
| name | type | required | description |
|---|---|---|---|
| file_id | String | true | Identifier for this file, which can be used to download or reuse the file |
| file_unique_id | String | true | 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. |
| thumb | PhotoSize | false | Optional. Document thumbnail as defined by sender |
| file_name | String | false | Optional. Original filename as defined by sender |
| mime_type | String | false | Optional. MIME type of the file as defined by sender |
| file_size | Integer | false | Optional. File size in bytes |
Video(file_id: String, file_unique_id: String, width: Integer, height: Integer, duration: Integer, thumb: PhotoSize, file_name: String, mime_type: String, file_size: Integer)
This object represents a video file.
| name | type | required | description |
|---|---|---|---|
| file_id | String | true | Identifier for this file, which can be used to download or reuse the file |
| file_unique_id | String | true | 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. |
| width | Integer | true | Video width as defined by sender |
| height | Integer | true | Video height as defined by sender |
| duration | Integer | true | Duration of the video in seconds as defined by sender |
| thumb | PhotoSize | false | Optional. Video thumbnail |
| file_name | String | false | Optional. Original filename as defined by sender |
| mime_type | String | false | Optional. Mime type of a file as defined by sender |
| file_size | Integer | false | Optional. File size in bytes |
VideoNote(file_id: String, file_unique_id: String, length: Integer, duration: Integer, thumb: PhotoSize, file_size: Integer)
This object represents a video message (available in Telegram apps as of v.4.0).
| name | type | required | description |
|---|---|---|---|
| file_id | String | true | Identifier for this file, which can be used to download or reuse the file |
| file_unique_id | String | true | 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. |
| length | Integer | true | Video width and height (diameter of the video message) as defined by sender |
| duration | Integer | true | Duration of the video in seconds as defined by sender |
| thumb | PhotoSize | false | Optional. Video thumbnail |
| file_size | Integer | false | Optional. File size in bytes |
Voice(file_id: String, file_unique_id: String, duration: Integer, mime_type: String, file_size: Integer)
This object represents a voice note.
| name | type | required | description |
|---|---|---|---|
| file_id | String | true | Identifier for this file, which can be used to download or reuse the file |
| file_unique_id | String | true | 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. |
| duration | Integer | true | Duration of the audio in seconds as defined by sender |
| mime_type | String | false | Optional. MIME type of the file as defined by sender |
| file_size | Integer | false | Optional. File size in bytes |
Contact(phone_number: String, first_name: String, last_name: String, user_id: Integer, vcard: String)
This object represents a phone contact.
| name | type | required | description |
|---|---|---|---|
| phone_number | String | true | Contact's phone number |
| first_name | String | true | Contact's first name |
| last_name | String | false | Optional. Contact's last name |
| user_id | Integer | false | Optional. Contact's user identifier in Telegram. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. |
| vcard | String | false | Optional. Additional data about the contact in the form of a vCard |
Dice(emoji: String, value: Integer)
This object represents an animated emoji that displays a random value.
| name | type | required | description |
|---|---|---|---|
| emoji | String | true | Emoji on which the dice throw animation is based |
| value | Integer | true | Value of the dice, 1-6 for “ |
PollOption(text: String, voter_count: Integer)
This object contains information about one answer option in a poll.
| name | type | required | description |
|---|---|---|---|
| text | String | true | Option text, 1-100 characters |
| voter_count | Integer | true | Number of users that voted for this option |
PollAnswer(poll_id: String, user: User, option_ids: List<Integer>)
This object represents an answer of a user in a non-anonymous poll.
| name | type | required | description |
|---|---|---|---|
| poll_id | String | true | Unique poll identifier |
| user | User | true | The user, who changed the answer to the poll |
| option_ids | List | true | 0-based identifiers of answer options, chosen by the user. May be empty if the user retracted their vote. |
Poll(id: String, question: String, options: List<PollOption>, total_voter_count: Integer, is_closed: Boolean, is_anonymous: Boolean, type: String, allows_multiple_answers: Boolean, correct_option_id: Integer, explanation: String, explanation_entities: List<MessageEntity>, open_period: Integer, close_date: Integer)
This object contains information about a poll.
| name | type | required | description |
|---|---|---|---|
| id | String | true | Unique poll identifier |
| question | String | true | Poll question, 1-300 characters |
| options | List | true | List of poll options |
| total_voter_count | Integer | true | Total number of users that voted in the poll |
| is_closed | Boolean | true | True, if the poll is closed |
| is_anonymous | Boolean | true | True, if the poll is anonymous |
| type | String | true | Poll type, currently can be “regular” or “quiz” |
| allows_multiple_answers | Boolean | true | True, if the poll allows multiple answers |
| correct_option_id | Integer | false | Optional. 0-based identifier of the correct answer option. Available only for polls in the quiz mode, which are closed, or was sent (not forwarded) by the bot or to the private chat with the bot. |
| explanation | String | false | Optional. Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters |
| explanation_entities | List | false | Optional. Special entities like usernames, URLs, bot commands, etc. that appear in the explanation |
| open_period | Integer | false | Optional. Amount of time in seconds the poll will be active after creation |
| close_date | Integer | false | Optional. Point in time (Unix timestamp) when the poll will be automatically closed |
Location(longitude: Float, latitude: Float, horizontal_accuracy: Float, live_period: Integer, heading: Integer, proximity_alert_radius: Integer)
This object represents a point on the map.
| name | type | required | description |
|---|---|---|---|
| longitude | Float | true | Longitude as defined by sender |
| latitude | Float | true | Latitude as defined by sender |
| horizontal_accuracy | Float | false | Optional. The radius of uncertainty for the location, measured in meters; 0-1500 |
| live_period | Integer | false | Optional. Time relative to the message sending date, during which the location can be updated; in seconds. For active live locations only. |
| heading | Integer | false | Optional. The direction in which user is moving, in degrees; 1-360. For active live locations only. |
| proximity_alert_radius | Integer | false | Optional. Maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only. |
Venue(location: Location, title: String, address: String, foursquare_id: String, foursquare_type: String, google_place_id: String, google_place_type: String)
This object represents a venue.
| name | type | required | description |
|---|---|---|---|
| location | Location | true | Venue location. Can't be a live location |
| title | String | true | Name of the venue |
| address | String | true | Address of the venue |
| foursquare_id | String | false | Optional. Foursquare identifier of the venue |
| foursquare_type | String | false | Optional. Foursquare type of the venue. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.) |
| google_place_id | String | false | Optional. Google Places identifier of the venue |
| google_place_type | String | false | Optional. Google Places type of the venue. (See supported types.) |
ProximityAlertTriggered(traveler: User, watcher: User, distance: Integer)
This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user.
| name | type | required | description |
|---|---|---|---|
| traveler | User | true | User that triggered the alert |
| watcher | User | true | User that set the alert |
| distance | Integer | true | The distance between the users |
MessageAutoDeleteTimerChanged(message_auto_delete_time: Integer)
This object represents a service message about a change in auto-delete timer settings.
| name | type | required | description |
|---|---|---|---|
| message_auto_delete_time | Integer | true | New auto-delete time for messages in the chat; in seconds |
VoiceChatScheduled(start_date: Integer)
This object represents a service message about a voice chat scheduled in the chat.
| name | type | required | description |
|---|---|---|---|
| start_date | Integer | true | Point in time (Unix timestamp) when the voice chat is supposed to be started by a chat administrator |
VoiceChatEnded(duration: Integer)
This object represents a service message about a voice chat ended in the chat.
| name | type | required | description |
|---|---|---|---|
| duration | Integer | true | Voice chat duration in seconds |
VoiceChatParticipantsInvited(users: List<User>)
This object represents a service message about new members invited to a voice chat.
| name | type | required | description |
|---|---|---|---|
| users | List | false | Optional. New members that were invited to the voice chat |
UserProfilePhotos(total_count: Integer, photos: List<List<PhotoSize>>)
This object represent a user's profile pictures.
| name | type | required | description |
|---|---|---|---|
| total_count | Integer | true | Total number of profile pictures the target user has |
| photos | List<List> | true | Requested profile pictures (in up to 4 sizes each) |
File(file_id: String, file_unique_id: String, file_size: Integer, file_path: String)
This object represents a file ready to be downloaded. The file can be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile.
Maximum file size to download is 20 MB
| name | type | required | description |
|---|---|---|---|
| file_id | String | true | Identifier for this file, which can be used to download or reuse the file |
| file_unique_id | String | true | 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. |
| file_size | Integer | false | Optional. File size in bytes, if known |
| file_path | String | false | Optional. File path. Use https://api.telegram.org/file/bot<token>/<file_path> to get the file. |
ReplyKeyboardMarkup(keyboard: List<List<KeyboardButton>>, resize_keyboard: Boolean, one_time_keyboard: Boolean, input_field_placeholder: String, selective: Boolean)
This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).
| name | type | required | description |
|---|---|---|---|
| keyboard | List<List> | true | Array of button rows, each represented by an Array of KeyboardButton objects |
| resize_keyboard | Boolean | false | Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard. |
| one_time_keyboard | Boolean | false | Optional. Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat – the user can press a special button in the input field to see the custom keyboard again. Defaults to false. |
| input_field_placeholder | String | false | Optional. The placeholder to be shown in the input field when the keyboard is active; 1-64 characters |
| selective | Boolean | false | Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message. Example: A user requests to change the bot's language, bot replies to the request with a keyboard to select the new language. Other users in the group don't see the keyboard. |
KeyboardButton(text: String, request_contact: Boolean, request_location: Boolean, request_poll: KeyboardButtonPollType)
This object represents one button of the reply keyboard. For simple text buttons String can be used instead of this object to specify text of the button. Optional fields request_contact, request_location, and request_poll are mutually exclusive.
Note: request_contact and request_location options will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message.
Note: request_poll option will only work in Telegram versions released after 23 January, 2020. Older clients will display unsupported message.
| name | type | required | description |
|---|---|---|---|
| text | String | true | Text of the button. If none of the optional fields are used, it will be sent as a message when the button is pressed |
| request_contact | Boolean | false | Optional. If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only |
| request_location | Boolean | false | Optional. If True, the user's current location will be sent when the button is pressed. Available in private chats only |
| request_poll | KeyboardButtonPollType | false | Optional. If specified, the user will be asked to create a poll and send it to the bot when the button is pressed. Available in private chats only |
KeyboardButtonPollType(type: String)
This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.
| name | type | required | description |
|---|---|---|---|
| type | String | false | Optional. If quiz is passed, the user will be allowed to create only polls in the quiz mode. If regular is passed, only regular polls will be allowed. Otherwise, the user will be allowed to create a poll of any type. |
ReplyKeyboardRemove(remove_keyboard: Boolean, selective: Boolean)
Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup).
| name | type | required | description |
|---|---|---|---|
| remove_keyboard | Boolean | true | 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) |
| selective | Boolean | false | Optional. Use this parameter if you want to remove the keyboard for specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message. Example: A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet. |
InlineKeyboardMarkup(inline_keyboard: List<List<InlineKeyboardButton>>)
This object represents an inline keyboard that appears right next to the message it belongs to.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message.
| name | type | required | description |
|---|---|---|---|
| inline_keyboard | List<List> | true | Array of button rows, each represented by an Array of InlineKeyboardButton objects |
InlineKeyboardButton(text: String, url: String, login_url: LoginUrl, callback_data: String, switch_inline_query: String, switch_inline_query_current_chat: String, callback_game: CallbackGame, pay: Boolean)
This object represents one button of an inline keyboard. You must use exactly one of the optional fields.
| name | type | required | description |
|---|---|---|---|
| text | String | true | Label text on the button |
| url | String | false | Optional. HTTP or tg:// url to be opened when the button is pressed. Links tg://user?id=<user_id> can be used to mention a user by their ID without using a username, if this is allowed by their privacy settings. |
| login_url | LoginUrl | false | Optional. An HTTP URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget. |
| callback_data | String | false | Optional. Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes |
| switch_inline_query | String | false | Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. Can be empty, in which case just the bot's username will be inserted. Note: This offers an easy way for users to start using your bot in inline mode when they are currently in a private chat with it. Especially useful when combined with switch_pm… actions – in this case the user will be automatically returned to the chat they switched from, skipping the chat selection screen. |
| switch_inline_query_current_chat | String | false | Optional. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. Can be empty, in which case only the bot's username will be inserted. This offers a quick way for the user to open your bot in inline mode in the same chat – good for selecting something from multiple options. |
| callback_game | CallbackGame | false | Optional. Description of the game that will be launched when the user presses the button. NOTE: This type of button must always be the first button in the first row. |
| pay | Boolean | false | Optional. Specify True, to send a Pay button. NOTE: This type of button must always be the first button in the first row and can only be used in invoice messages. |
LoginUrl(url: String, forward_text: String, bot_username: String, request_write_access: Boolean)
This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a great replacement for the Telegram Login Widget when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in:
Telegram apps support these buttons as of version 5.7.
Sample bot: @discussbot
| name | type | required | description |
|---|---|---|---|
| url | String | true | 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. |
| forward_text | String | false | Optional. New text of the button in forwarded messages. |
| bot_username | String | false | Optional. Username of a bot, which will be used for user authorization. See Setting up a bot for more details. If not specified, the current bot's username will be assumed. The url's domain must be the same as the domain linked with the bot. See Linking your domain to the bot for more details. |
| request_write_access | Boolean | false | Optional. Pass True to request the permission for your bot to send messages to the user. |
CallbackQuery(id: String, from: User, message: Message, inline_message_id: String, chat_instance: String, data: String, game_short_name: String)
This object represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field message will be present. If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present.
NOTE: After the user presses a callback button, Telegram clients will display a progress bar until you call answerCallbackQuery. It is, therefore, necessary to react by calling answerCallbackQuery even if no notification to the user is needed (e.g., without specifying any of the optional parameters).
| name | type | required | description |
|---|---|---|---|
| id | String | true | Unique identifier for this query |
| from | User | true | Sender |
| message | Message | false | Optional. Message with the callback button that originated the query. Note that message content and message date will not be available if the message is too old |
| inline_message_id | String | false | Optional. Identifier of the message sent via the bot in inline mode, that originated the query. |
| chat_instance | String | true | Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games. |
| data | String | false | Optional. Data associated with the callback button. Be aware that a bad client can send arbitrary data in this field. |
| game_short_name | String | false | Optional. Short name of a Game to be returned, serves as the unique identifier for the game |
ForceReply(force_reply: Boolean, input_field_placeholder: String, selective: Boolean)
Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.
Example: A poll bot for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll:
- Explain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish.
- Guide the user through a step-by-step process. 'Please send me your question', 'Cool, now let's add the first answer option', 'Great. Keep adding answer options, then send /done when you're ready'.
The last option is definitely more attractive. And if you use ForceReply in your bot's questions, it will receive the user's answers even if it only receives replies, commands and mentions — without any extra work for the user.
| name | type | required | description |
|---|---|---|---|
| force_reply | Boolean | true | Shows reply interface to the user, as if they manually selected the bot's message and tapped 'Reply' |
| input_field_placeholder | String | false | Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters |
| selective | Boolean | false | Optional. Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message. |
ChatPhoto(small_file_id: String, small_file_unique_id: String, big_file_id: String, big_file_unique_id: String)
This object represents a chat photo.
| name | type | required | description |
|---|---|---|---|
| small_file_id | String | true | 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. |
| small_file_unique_id | String | true | 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. |
| big_file_id | String | true | 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. |
| big_file_unique_id | String | true | Unique file identifier of big (640x640) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. |
ChatInviteLink(invite_link: String, creator: User, creates_join_request: Boolean, is_primary: Boolean, is_revoked: Boolean, name: String, expire_date: Integer, member_limit: Integer, pending_join_request_count: Integer)
Represents an invite link for a chat.
| name | type | required | description |
|---|---|---|---|
| invite_link | String | true | The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with “…”. |
| creator | User | true | Creator of the link |
| creates_join_request | Boolean | true | True, if users joining the chat via the link need to be approved by chat administrators |
| is_primary | Boolean | true | True, if the link is primary |
| is_revoked | Boolean | true | True, if the link is revoked |
| name | String | false | Optional. Invite link name |
| expire_date | Integer | false | Optional. Point in time (Unix timestamp) when the link will expire or has been expired |
| member_limit | Integer | false | Optional. Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999 |
| pending_join_request_count | Integer | false | Optional. Number of pending join requests created using this link |
ChatMemberOwner(status: String, user: User, is_anonymous: Boolean, custom_title: String)
Represents a chat member that owns the chat and has all administrator privileges.
| name | type | required | description |
|---|---|---|---|
| status | String | true | The member's status in the chat, always “creator” |
| user | User | true | Information about the user |
| is_anonymous | Boolean | true | True, if the user's presence in the chat is hidden |
| custom_title | String | false | Optional. Custom title for this user |
ChatMemberAdministrator(status: String, user: User, can_be_edited: Boolean, is_anonymous: Boolean, can_manage_chat: Boolean, can_delete_messages: Boolean, can_manage_voice_chats: Boolean, can_restrict_members: Boolean, can_promote_members: Boolean, can_change_info: Boolean, can_invite_users: Boolean, can_post_messages: Boolean, can_edit_messages: Boolean, can_pin_messages: Boolean, custom_title: String)
Represents a chat member that has some additional privileges.
| name | type | required | description |
|---|---|---|---|
| status | String | true | The member's status in the chat, always “administrator” |
| user | User | true | Information about the user |
| can_be_edited | Boolean | true | True, if the bot is allowed to edit administrator privileges of that user |
| is_anonymous | Boolean | true | True, if the user's presence in the chat is hidden |
| can_manage_chat | Boolean | true | 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 |
| can_delete_messages | Boolean | true | True, if the administrator can delete messages of other users |
| can_manage_voice_chats | Boolean | true | True, if the administrator can manage voice chats |
| can_restrict_members | Boolean | true | True, if the administrator can restrict, ban or unban chat members |
| can_promote_members | Boolean | true | 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) |
| can_change_info | Boolean | true | True, if the user is allowed to change the chat title, photo and other settings |
| can_invite_users | Boolean | true | True, if the user is allowed to invite new users to the chat |
| can_post_messages | Boolean | false | Optional. True, if the administrator can post in the channel; channels only |
| can_edit_messages | Boolean | false | Optional. True, if the administrator can edit messages of other users and can pin messages; channels only |
| can_pin_messages | Boolean | false | Optional. True, if the user is allowed to pin messages; groups and supergroups only |
| custom_title | String | false | Optional. Custom title for this user |
ChatMemberMember(status: String, user: User)
Represents a chat member that has no additional privileges or restrictions.
| name | type | required | description |
|---|---|---|---|
| status | String | true | The member's status in the chat, always “member” |
| user | User | true | Information about the user |
ChatMemberRestricted(status: String, user: User, is_member: Boolean, can_change_info: Boolean, can_invite_users: Boolean, can_pin_messages: Boolean, can_send_messages: Boolean, can_send_media_messages: Boolean, can_send_polls: Boolean, can_send_other_messages: Boolean, can_add_web_page_previews: Boolean, until_date: Integer)
Represents a chat member that is under certain restrictions in the chat. Supergroups only.
| name | type | required | description |
|---|---|---|---|
| status | String | true | The member's status in the chat, always “restricted” |
| user | User | true | Information about the user |
| is_member | Boolean | true | True, if the user is a member of the chat at the moment of the request |
| can_change_info | Boolean | true | True, if the user is allowed to change the chat title, photo and other settings |
| can_invite_users | Boolean | true | True, if the user is allowed to invite new users to the chat |
| can_pin_messages | Boolean | true | True, if the user is allowed to pin messages |
| can_send_messages | Boolean | true | True, if the user is allowed to send text messages, contacts, locations and venues |
| can_send_media_messages | Boolean | true | True, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes |
| can_send_polls | Boolean | true | True, if the user is allowed to send polls |
| can_send_other_messages | Boolean | true | True, if the user is allowed to send animations, games, stickers and use inline bots |
| can_add_web_page_previews | Boolean | true | True, if the user is allowed to add web page previews to their messages |
| until_date | Integer | true | Date when restrictions will be lifted for this user; unix time. If 0, then the user is restricted forever |
ChatMemberLeft(status: String, user: User)
Represents a chat member that isn't currently a member of the chat, but may join it themselves.
| name | type | required | description |
|---|---|---|---|
| status | String | true | The member's status in the chat, always “left” |
| user | User | true | Information about the user |
ChatMemberBanned(status: String, user: User, until_date: Integer)
Represents a chat member that was banned in the chat and can't return to the chat or view chat messages.
| name | type | required | description |
|---|---|---|---|
| status | String | true | The member's status in the chat, always “kicked” |
| user | User | true | Information about the user |
| until_date | Integer | true | Date when restrictions will be lifted for this user; unix time. If 0, then the user is banned forever |
ChatMemberUpdated(chat: Chat, from: User, date: Integer, old_chat_member: ChatMember, new_chat_member: ChatMember, invite_link: ChatInviteLink)
This object represents changes in the status of a chat member.
| name | type | required | description |
|---|---|---|---|
| chat | Chat | true | Chat the user belongs to |
| from | User | true | Performer of the action, which resulted in the change |
| date | Integer | true | Date the change was done in Unix time |
| old_chat_member | ChatMember | true | Previous information about the chat member |
| new_chat_member | ChatMember | true | New information about the chat member |
| invite_link | ChatInviteLink | false | Optional. Chat invite link, which was used by the user to join the chat; for joining by invite link events only. |
ChatJoinRequest(chat: Chat, from: User, date: Integer, bio: String, invite_link: ChatInviteLink)
Represents a join request sent to a chat.
| name | type | required | description |
|---|---|---|---|
| chat | Chat | true | Chat to which the request was sent |
| from | User | true | User that sent the join request |
| date | Integer | true | Date the request was sent in Unix time |
| bio | String | false | Optional. Bio of the user. |
| invite_link | ChatInviteLink | false | Optional. Chat invite link that was used by the user to send the join request |
ChatPermissions(can_send_messages: Boolean, can_send_media_messages: Boolean, can_send_polls: Boolean, can_send_other_messages: Boolean, can_add_web_page_previews: Boolean, can_change_info: Boolean, can_invite_users: Boolean, can_pin_messages: Boolean)
Describes actions that a non-administrator user is allowed to take in a chat.
| name | type | required | description |
|---|---|---|---|
| can_send_messages | Boolean | false | Optional. True, if the user is allowed to send text messages, contacts, locations and venues |
| can_send_media_messages | Boolean | false | Optional. True, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages |
| can_send_polls | Boolean | false | Optional. True, if the user is allowed to send polls, implies can_send_messages |
| can_send_other_messages | Boolean | false | Optional. True, if the user is allowed to send animations, games, stickers and use inline bots, implies can_send_media_messages |
| can_add_web_page_previews | Boolean | false | Optional. True, if the user is allowed to add web page previews to their messages, implies can_send_media_messages |
| can_change_info | Boolean | false | Optional. True, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups |
| can_invite_users | Boolean | false | Optional. True, if the user is allowed to invite new users to the chat |
| can_pin_messages | Boolean | false | Optional. True, if the user is allowed to pin messages. Ignored in public supergroups |
ChatLocation(location: Location, address: String)
Represents a location to which a chat is connected.
| name | type | required | description |
|---|---|---|---|
| location | Location | true | The location to which the supergroup is connected. Can't be a live location. |
| address | String | true | Location address; 1-64 characters, as defined by the chat owner |
BotCommand(command: String, description: String)
This object represents a bot command.
| name | type | required | description |
|---|---|---|---|
| command | String | true | Text of the command; 1-32 characters. Can contain only lowercase English letters, digits and underscores. |
| description | String | true | Description of the command; 1-256 characters. |
BotCommandScopeDefault(type: String)
Represents the default scope of bot commands. Default commands are used if no commands with a narrower scope are specified for the user.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Scope type, must be default |
BotCommandScopeAllPrivateChats(type: String)
Represents the scope of bot commands, covering all private chats.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Scope type, must be all_private_chats |
BotCommandScopeAllGroupChats(type: String)
Represents the scope of bot commands, covering all group and supergroup chats.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Scope type, must be all_group_chats |
BotCommandScopeAllChatAdministrators(type: String)
Represents the scope of bot commands, covering all group and supergroup chat administrators.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Scope type, must be all_chat_administrators |
BotCommandScopeChat(type: String, chat_id: IntegerOrString)
Represents the scope of bot commands, covering a specific chat.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Scope type, must be chat |
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) |
BotCommandScopeChatAdministrators(type: String, chat_id: IntegerOrString)
Represents the scope of bot commands, covering all administrators of a specific group or supergroup chat.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Scope type, must be chat_administrators |
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) |
BotCommandScopeChatMember(type: String, chat_id: IntegerOrString, user_id: Integer)
Represents the scope of bot commands, covering a specific member of a group or supergroup chat.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Scope type, must be chat_member |
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) |
| user_id | Integer | true | Unique identifier of the target user |
ResponseParameters(migrate_to_chat_id: Integer, retry_after: Integer)
Contains information about why a request was unsuccessful.
| name | type | required | description |
|---|---|---|---|
| migrate_to_chat_id | Integer | false | Optional. The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier. |
| retry_after | Integer | false | Optional. In case of exceeding flood control, the number of seconds left to wait before the request can be repeated |
InputMediaPhoto(type: String, media: String, caption: String, parse_mode: ParseMode, caption_entities: List<MessageEntity>)
Represents a photo to be sent.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Type of the result, must be photo |
| media | String | true | File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More info on Sending Files » |
| caption | String | false | Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing |
| parse_mode | ParseMode | false | Optional. Mode for parsing entities in the photo caption. See formatting options for more details. |
| caption_entities | List | false | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode |
InputMediaVideo(type: String, media: String, thumb: InputFileOrString, caption: String, parse_mode: ParseMode, caption_entities: List<MessageEntity>, width: Integer, height: Integer, duration: Integer, supports_streaming: Boolean)
Represents a video to be sent.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Type of the result, must be video |
| media | String | true | File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More info on Sending Files » |
| thumb | InputFileOrString | false | Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More info on Sending Files » |
| caption | String | false | Optional. Caption of the video to be sent, 0-1024 characters after entities parsing |
| parse_mode | ParseMode | false | Optional. Mode for parsing entities in the video caption. See formatting options for more details. |
| caption_entities | List | false | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode |
| width | Integer | false | Optional. Video width |
| height | Integer | false | Optional. Video height |
| duration | Integer | false | Optional. Video duration in seconds |
| supports_streaming | Boolean | false | Optional. Pass True, if the uploaded video is suitable for streaming |
InputMediaAnimation(type: String, media: String, thumb: InputFileOrString, caption: String, parse_mode: ParseMode, caption_entities: List<MessageEntity>, width: Integer, height: Integer, duration: Integer)
Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Type of the result, must be animation |
| media | String | true | File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More info on Sending Files » |
| thumb | InputFileOrString | false | Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More info on Sending Files » |
| caption | String | false | Optional. Caption of the animation to be sent, 0-1024 characters after entities parsing |
| parse_mode | ParseMode | false | Optional. Mode for parsing entities in the animation caption. See formatting options for more details. |
| caption_entities | List | false | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode |
| width | Integer | false | Optional. Animation width |
| height | Integer | false | Optional. Animation height |
| duration | Integer | false | Optional. Animation duration in seconds |
InputMediaAudio(type: String, media: String, thumb: InputFileOrString, caption: String, parse_mode: ParseMode, caption_entities: List<MessageEntity>, duration: Integer, performer: String, title: String)
Represents an audio file to be treated as music to be sent.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Type of the result, must be audio |
| media | String | true | File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More info on Sending Files » |
| thumb | InputFileOrString | false | Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More info on Sending Files » |
| caption | String | false | Optional. Caption of the audio to be sent, 0-1024 characters after entities parsing |
| parse_mode | ParseMode | false | Optional. Mode for parsing entities in the audio caption. See formatting options for more details. |
| caption_entities | List | false | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode |
| duration | Integer | false | Optional. Duration of the audio in seconds |
| performer | String | false | Optional. Performer of the audio |
| title | String | false | Optional. Title of the audio |
InputMediaDocument(type: String, media: String, thumb: InputFileOrString, caption: String, parse_mode: ParseMode, caption_entities: List<MessageEntity>, disable_content_type_detection: Boolean)
Represents a general file to be sent.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Type of the result, must be document |
| media | String | true | File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More info on Sending Files » |
| thumb | InputFileOrString | false | Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More info on Sending Files » |
| caption | String | false | Optional. Caption of the document to be sent, 0-1024 characters after entities parsing |
| parse_mode | ParseMode | false | Optional. Mode for parsing entities in the document caption. See formatting options for more details. |
| caption_entities | List | false | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode |
| disable_content_type_detection | Boolean | false | Optional. Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always True, if the document is sent as part of an album. |
logOut()
Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.
close()
Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.
sendMessage(chat_id: IntegerOrString, text: String, parse_mode: ParseMode, entities: List<MessageEntity>, disable_web_page_preview: Boolean, disable_notification: Boolean, protect_content: Boolean, reply_to_message_id: Integer, allow_sending_without_reply: Boolean, reply_markup: KeyboardOption)
Use this method to send text messages. On success, the sent Message is returned.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| text | String | true | Text of the message to be sent, 1-4096 characters after entities parsing |
| parse_mode | ParseMode | false | Mode for parsing entities in the message text. See formatting options for more details. |
| entities | List | false | A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode |
| disable_web_page_preview | Boolean | false | Disables link previews for links in this message |
| disable_notification | Boolean | false | Sends the message silently. Users will receive a notification with no sound. |
| protect_content | Boolean | false | Protects the contents of the sent message from forwarding and saving |
| reply_to_message_id | Integer | false | If the message is a reply, ID of the original message |
| allow_sending_without_reply | Boolean | false | Pass True, if the message should be sent even if the specified replied-to message is not found |
| reply_markup | KeyboardOption | false | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. |
forwardMessage(chat_id: IntegerOrString, from_chat_id: IntegerOrString, disable_notification: Boolean, protect_content: Boolean, message_id: Integer)
Use this method to forward messages of any kind. Service messages can't be forwarded. On success, the sent Message is returned.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| from_chat_id | IntegerOrString | true | Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername) |
| disable_notification | Boolean | false | Sends the message silently. Users will receive a notification with no sound. |
| protect_content | Boolean | false | Protects the contents of the forwarded message from forwarding and saving |
| message_id | Integer | true | Message identifier in the chat specified in from_chat_id |
copyMessage(chat_id: IntegerOrString, from_chat_id: IntegerOrString, message_id: Integer, caption: String, parse_mode: ParseMode, caption_entities: List<MessageEntity>, disable_notification: Boolean, protect_content: Boolean, reply_to_message_id: Integer, allow_sending_without_reply: Boolean, reply_markup: KeyboardOption)
Use this method to copy messages of any kind. Service messages and invoice messages can't be copied. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| from_chat_id | IntegerOrString | true | Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername) |
| message_id | Integer | true | Message identifier in the chat specified in from_chat_id |
| caption | String | false | New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept |
| parse_mode | ParseMode | false | Mode for parsing entities in the new caption. See formatting options for more details. |
| caption_entities | List | false | A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of parse_mode |
| disable_notification | Boolean | false | Sends the message silently. Users will receive a notification with no sound. |
| protect_content | Boolean | false | Protects the contents of the sent message from forwarding and saving |
| reply_to_message_id | Integer | false | If the message is a reply, ID of the original message |
| allow_sending_without_reply | Boolean | false | Pass True, if the message should be sent even if the specified replied-to message is not found |
| reply_markup | KeyboardOption | false | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. |
sendPhoto(chat_id: IntegerOrString, photo: InputFileOrString, caption: String, parse_mode: ParseMode, caption_entities: List<MessageEntity>, disable_notification: Boolean, protect_content: Boolean, reply_to_message_id: Integer, allow_sending_without_reply: Boolean, reply_markup: KeyboardOption)
Use this method to send photos. On success, the sent Message is returned.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| photo | InputFileOrString | true | Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. More info on Sending Files » |
| caption | String | false | Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing |
| parse_mode | ParseMode | false | Mode for parsing entities in the photo caption. See formatting options for more details. |
| caption_entities | List | false | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode |
| disable_notification | Boolean | false | Sends the message silently. Users will receive a notification with no sound. |
| protect_content | Boolean | false | Protects the contents of the sent message from forwarding and saving |
| reply_to_message_id | Integer | false | If the message is a reply, ID of the original message |
| allow_sending_without_reply | Boolean | false | Pass True, if the message should be sent even if the specified replied-to message is not found |
| reply_markup | KeyboardOption | false | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. |
sendAudio(chat_id: IntegerOrString, audio: InputFileOrString, caption: String, parse_mode: ParseMode, caption_entities: List<MessageEntity>, duration: Integer, performer: String, title: String, thumb: InputFileOrString, disable_notification: Boolean, protect_content: Boolean, reply_to_message_id: Integer, allow_sending_without_reply: Boolean, reply_markup: KeyboardOption)
Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.
For sending voice messages, use the sendVoice method instead.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| audio | InputFileOrString | true | Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files » |
| caption | String | false | Audio caption, 0-1024 characters after entities parsing |
| parse_mode | ParseMode | false | Mode for parsing entities in the audio caption. See formatting options for more details. |
| caption_entities | List | false | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode |
| duration | Integer | false | Duration of the audio in seconds |
| performer | String | false | Performer |
| title | String | false | Track name |
| thumb | InputFileOrString | false | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More info on Sending Files » |
| disable_notification | Boolean | false | Sends the message silently. Users will receive a notification with no sound. |
| protect_content | Boolean | false | Protects the contents of the sent message from forwarding and saving |
| reply_to_message_id | Integer | false | If the message is a reply, ID of the original message |
| allow_sending_without_reply | Boolean | false | Pass True, if the message should be sent even if the specified replied-to message is not found |
| reply_markup | KeyboardOption | false | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. |
sendDocument(chat_id: IntegerOrString, document: InputFileOrString, thumb: InputFileOrString, caption: String, parse_mode: ParseMode, caption_entities: List<MessageEntity>, disable_content_type_detection: Boolean, disable_notification: Boolean, protect_content: Boolean, reply_to_message_id: Integer, allow_sending_without_reply: Boolean, reply_markup: KeyboardOption)
Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| document | InputFileOrString | true | File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files » |
| thumb | InputFileOrString | false | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More info on Sending Files » |
| caption | String | false | Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing |
| parse_mode | ParseMode | false | Mode for parsing entities in the document caption. See formatting options for more details. |
| caption_entities | List | false | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode |
| disable_content_type_detection | Boolean | false | Disables automatic server-side content type detection for files uploaded using multipart/form-data |
| disable_notification | Boolean | false | Sends the message silently. Users will receive a notification with no sound. |
| protect_content | Boolean | false | Protects the contents of the sent message from forwarding and saving |
| reply_to_message_id | Integer | false | If the message is a reply, ID of the original message |
| allow_sending_without_reply | Boolean | false | Pass True, if the message should be sent even if the specified replied-to message is not found |
| reply_markup | KeyboardOption | false | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. |
sendVideo(chat_id: IntegerOrString, video: InputFileOrString, duration: Integer, width: Integer, height: Integer, thumb: InputFileOrString, caption: String, parse_mode: ParseMode, caption_entities: List<MessageEntity>, supports_streaming: Boolean, disable_notification: Boolean, protect_content: Boolean, reply_to_message_id: Integer, allow_sending_without_reply: Boolean, reply_markup: KeyboardOption)
Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| video | InputFileOrString | true | Video to send. Pass a file_id as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data. More info on Sending Files » |
| duration | Integer | false | Duration of sent video in seconds |
| width | Integer | false | Video width |
| height | Integer | false | Video height |
| thumb | InputFileOrString | false | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More info on Sending Files » |
| caption | String | false | Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing |
| parse_mode | ParseMode | false | Mode for parsing entities in the video caption. See formatting options for more details. |
| caption_entities | List | false | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode |
| supports_streaming | Boolean | false | Pass True, if the uploaded video is suitable for streaming |
| disable_notification | Boolean | false | Sends the message silently. Users will receive a notification with no sound. |
| protect_content | Boolean | false | Protects the contents of the sent message from forwarding and saving |
| reply_to_message_id | Integer | false | If the message is a reply, ID of the original message |
| allow_sending_without_reply | Boolean | false | Pass True, if the message should be sent even if the specified replied-to message is not found |
| reply_markup | KeyboardOption | false | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. |
sendAnimation(chat_id: IntegerOrString, animation: InputFileOrString, duration: Integer, width: Integer, height: Integer, thumb: InputFileOrString, caption: String, parse_mode: ParseMode, caption_entities: List<MessageEntity>, disable_notification: Boolean, protect_content: Boolean, reply_to_message_id: Integer, allow_sending_without_reply: Boolean, reply_markup: KeyboardOption)
Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| animation | InputFileOrString | true | Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. More info on Sending Files » |
| duration | Integer | false | Duration of sent animation in seconds |
| width | Integer | false | Animation width |
| height | Integer | false | Animation height |
| thumb | InputFileOrString | false | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More info on Sending Files » |
| caption | String | false | Animation caption (may also be used when resending animation by file_id), 0-1024 characters after entities parsing |
| parse_mode | ParseMode | false | Mode for parsing entities in the animation caption. See formatting options for more details. |
| caption_entities | List | false | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode |
| disable_notification | Boolean | false | Sends the message silently. Users will receive a notification with no sound. |
| protect_content | Boolean | false | Protects the contents of the sent message from forwarding and saving |
| reply_to_message_id | Integer | false | If the message is a reply, ID of the original message |
| allow_sending_without_reply | Boolean | false | Pass True, if the message should be sent even if the specified replied-to message is not found |
| reply_markup | KeyboardOption | false | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. |
sendVoice(chat_id: IntegerOrString, voice: InputFileOrString, caption: String, parse_mode: ParseMode, caption_entities: List<MessageEntity>, duration: Integer, disable_notification: Boolean, protect_content: Boolean, reply_to_message_id: Integer, allow_sending_without_reply: Boolean, reply_markup: KeyboardOption)
Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| voice | InputFileOrString | true | Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files » |
| caption | String | false | Voice message caption, 0-1024 characters after entities parsing |
| parse_mode | ParseMode | false | Mode for parsing entities in the voice message caption. See formatting options for more details. |
| caption_entities | List | false | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode |
| duration | Integer | false | Duration of the voice message in seconds |
| disable_notification | Boolean | false | Sends the message silently. Users will receive a notification with no sound. |
| protect_content | Boolean | false | Protects the contents of the sent message from forwarding and saving |
| reply_to_message_id | Integer | false | If the message is a reply, ID of the original message |
| allow_sending_without_reply | Boolean | false | Pass True, if the message should be sent even if the specified replied-to message is not found |
| reply_markup | KeyboardOption | false | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. |
sendVideoNote(chat_id: IntegerOrString, video_note: InputFileOrString, duration: Integer, length: Integer, thumb: InputFileOrString, disable_notification: Boolean, protect_content: Boolean, reply_to_message_id: Integer, allow_sending_without_reply: Boolean, reply_markup: KeyboardOption)
As of v.4.0, Telegram clients support rounded square mp4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| video_note | InputFileOrString | true | Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More info on Sending Files ». Sending video notes by a URL is currently unsupported |
| duration | Integer | false | Duration of sent video in seconds |
| length | Integer | false | Video width and height, i.e. diameter of the video message |
| thumb | InputFileOrString | false | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More info on Sending Files » |
| disable_notification | Boolean | false | Sends the message silently. Users will receive a notification with no sound. |
| protect_content | Boolean | false | Protects the contents of the sent message from forwarding and saving |
| reply_to_message_id | Integer | false | If the message is a reply, ID of the original message |
| allow_sending_without_reply | Boolean | false | Pass True, if the message should be sent even if the specified replied-to message is not found |
| reply_markup | KeyboardOption | false | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. |
sendMediaGroup(chat_id: IntegerOrString, media: List<InputMedia>, disable_notification: Boolean, protect_content: Boolean, reply_to_message_id: Integer, allow_sending_without_reply: Boolean)
Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| media | List | true | A JSON-serialized array describing messages to be sent, must include 2-10 items |
| disable_notification | Boolean | false | Sends messages silently. Users will receive a notification with no sound. |
| protect_content | Boolean | false | Protects the contents of the sent messages from forwarding and saving |
| reply_to_message_id | Integer | false | If the messages are a reply, ID of the original message |
| allow_sending_without_reply | Boolean | false | Pass True, if the message should be sent even if the specified replied-to message is not found |
sendLocation(chat_id: IntegerOrString, latitude: Float, longitude: Float, horizontal_accuracy: Float, live_period: Integer, heading: Integer, proximity_alert_radius: Integer, disable_notification: Boolean, protect_content: Boolean, reply_to_message_id: Integer, allow_sending_without_reply: Boolean, reply_markup: KeyboardOption)
Use this method to send point on the map. On success, the sent Message is returned.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| latitude | Float | true | Latitude of the location |
| longitude | Float | true | Longitude of the location |
| horizontal_accuracy | Float | false | The radius of uncertainty for the location, measured in meters; 0-1500 |
| live_period | Integer | false | Period in seconds for which the location will be updated (see Live Locations, should be between 60 and 86400. |
| heading | Integer | false | For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. |
| proximity_alert_radius | Integer | false | For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. |
| disable_notification | Boolean | false | Sends the message silently. Users will receive a notification with no sound. |
| protect_content | Boolean | false | Protects the contents of the sent message from forwarding and saving |
| reply_to_message_id | Integer | false | If the message is a reply, ID of the original message |
| allow_sending_without_reply | Boolean | false | Pass True, if the message should be sent even if the specified replied-to message is not found |
| reply_markup | KeyboardOption | false | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. |
editMessageLiveLocation(chat_id: IntegerOrString, message_id: Integer, inline_message_id: String, latitude: Float, longitude: Float, horizontal_accuracy: Float, heading: Integer, proximity_alert_radius: Integer, reply_markup: InlineKeyboardMarkup)
Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | false | Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| message_id | Integer | false | Required if inline_message_id is not specified. Identifier of the message to edit |
| inline_message_id | String | false | Required if chat_id and message_id are not specified. Identifier of the inline message |
| latitude | Float | true | Latitude of new location |
| longitude | Float | true | Longitude of new location |
| horizontal_accuracy | Float | false | The radius of uncertainty for the location, measured in meters; 0-1500 |
| heading | Integer | false | Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. |
| proximity_alert_radius | Integer | false | Maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. |
| reply_markup | InlineKeyboardMarkup | false | A JSON-serialized object for a new inline keyboard. |
stopMessageLiveLocation(chat_id: IntegerOrString, message_id: Integer, inline_message_id: String, reply_markup: InlineKeyboardMarkup)
Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | false | Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| message_id | Integer | false | Required if inline_message_id is not specified. Identifier of the message with live location to stop |
| inline_message_id | String | false | Required if chat_id and message_id are not specified. Identifier of the inline message |
| reply_markup | InlineKeyboardMarkup | false | A JSON-serialized object for a new inline keyboard. |
sendVenue(chat_id: IntegerOrString, latitude: Float, longitude: Float, title: String, address: String, foursquare_id: String, foursquare_type: String, google_place_id: String, google_place_type: String, disable_notification: Boolean, protect_content: Boolean, reply_to_message_id: Integer, allow_sending_without_reply: Boolean, reply_markup: KeyboardOption)
Use this method to send information about a venue. On success, the sent Message is returned.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| latitude | Float | true | Latitude of the venue |
| longitude | Float | true | Longitude of the venue |
| title | String | true | Name of the venue |
| address | String | true | Address of the venue |
| foursquare_id | String | false | Foursquare identifier of the venue |
| foursquare_type | String | false | Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.) |
| google_place_id | String | false | Google Places identifier of the venue |
| google_place_type | String | false | Google Places type of the venue. (See supported types.) |
| disable_notification | Boolean | false | Sends the message silently. Users will receive a notification with no sound. |
| protect_content | Boolean | false | Protects the contents of the sent message from forwarding and saving |
| reply_to_message_id | Integer | false | If the message is a reply, ID of the original message |
| allow_sending_without_reply | Boolean | false | Pass True, if the message should be sent even if the specified replied-to message is not found |
| reply_markup | KeyboardOption | false | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. |
sendContact(chat_id: IntegerOrString, phone_number: String, first_name: String, last_name: String, vcard: String, disable_notification: Boolean, protect_content: Boolean, reply_to_message_id: Integer, allow_sending_without_reply: Boolean, reply_markup: KeyboardOption)
Use this method to send phone contacts. On success, the sent Message is returned.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| phone_number | String | true | Contact's phone number |
| first_name | String | true | Contact's first name |
| last_name | String | false | Contact's last name |
| vcard | String | false | Additional data about the contact in the form of a vCard, 0-2048 bytes |
| disable_notification | Boolean | false | Sends the message silently. Users will receive a notification with no sound. |
| protect_content | Boolean | false | Protects the contents of the sent message from forwarding and saving |
| reply_to_message_id | Integer | false | If the message is a reply, ID of the original message |
| allow_sending_without_reply | Boolean | false | Pass True, if the message should be sent even if the specified replied-to message is not found |
| reply_markup | KeyboardOption | false | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove keyboard or to force a reply from the user. |
sendPoll(chat_id: IntegerOrString, question: String, options: List<String>, is_anonymous: Boolean, type: String, allows_multiple_answers: Boolean, correct_option_id: Integer, explanation: String, explanation_parse_mode: String, explanation_entities: List<MessageEntity>, open_period: Integer, close_date: Integer, is_closed: Boolean, disable_notification: Boolean, protect_content: Boolean, reply_to_message_id: Integer, allow_sending_without_reply: Boolean, reply_markup: KeyboardOption)
Use this method to send a native poll. On success, the sent Message is returned.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| question | String | true | Poll question, 1-300 characters |
| options | List | true | A JSON-serialized list of answer options, 2-10 strings 1-100 characters each |
| is_anonymous | Boolean | false | True, if the poll needs to be anonymous, defaults to True |
| type | String | false | Poll type, “quiz” or “regular”, defaults to “regular” |
| allows_multiple_answers | Boolean | false | True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False |
| correct_option_id | Integer | false | 0-based identifier of the correct answer option, required for polls in quiz mode |
| explanation | String | false | Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing |
| explanation_parse_mode | String | false | Mode for parsing entities in the explanation. See formatting options for more details. |
| explanation_entities | List | false | A JSON-serialized list of special entities that appear in the poll explanation, which can be specified instead of parse_mode |
| open_period | Integer | false | Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date. |
| close_date | Integer | false | Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can't be used together with open_period. |
| is_closed | Boolean | false | Pass True, if the poll needs to be immediately closed. This can be useful for poll preview. |
| disable_notification | Boolean | false | Sends the message silently. Users will receive a notification with no sound. |
| protect_content | Boolean | false | Protects the contents of the sent message from forwarding and saving |
| reply_to_message_id | Integer | false | If the message is a reply, ID of the original message |
| allow_sending_without_reply | Boolean | false | Pass True, if the message should be sent even if the specified replied-to message is not found |
| reply_markup | KeyboardOption | false | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. |
sendDice(chat_id: IntegerOrString, emoji: String, disable_notification: Boolean, protect_content: Boolean, reply_to_message_id: Integer, allow_sending_without_reply: Boolean, reply_markup: KeyboardOption)
Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| emoji | String | false | Emoji on which the dice throw animation is based. Currently, must be one of “ |
| disable_notification | Boolean | false | Sends the message silently. Users will receive a notification with no sound. |
| protect_content | Boolean | false | Protects the contents of the sent message from forwarding |
| reply_to_message_id | Integer | false | If the message is a reply, ID of the original message |
| allow_sending_without_reply | Boolean | false | Pass True, if the message should be sent even if the specified replied-to message is not found |
| reply_markup | KeyboardOption | false | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. |
sendChatAction(chat_id: IntegerOrString, action: String)
Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success.
Example: The ImageBot needs some time to process a request and upload the image. Instead of sending a text message along the lines of “Retrieving image, please wait…”, the bot may use sendChatAction with action = upload_photo. The user will see a “sending photo” status for the bot.
We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| action | String | true | Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes. |
getUserProfilePhotos(user_id: Integer, offset: Integer, limit: Integer)
Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.
| name | type | required | description |
|---|---|---|---|
| user_id | Integer | true | Unique identifier of the target user |
| offset | Integer | false | Sequential number of the first photo to be returned. By default, all photos are returned. |
| limit | Integer | false | Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100. |
getFile(file_id: String)
Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile again.
Note: This function may not preserve the original file name and MIME type. You should save the file's MIME type and name (if available) when the File object is received.
| name | type | required | description |
|---|---|---|---|
| file_id | String | true | File identifier to get info about |
banChatMember(chat_id: IntegerOrString, user_id: Integer, until_date: Integer, revoke_messages: Boolean)
Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername) |
| user_id | Integer | true | Unique identifier of the target user |
| until_date | Integer | false | Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only. |
| revoke_messages | Boolean | false | Pass True to delete all messages from the chat for the user that is being removed. If False, the user will be able to see messages in the group that were sent before the user was removed. Always True for supergroups and channels. |
unbanChatMember(chat_id: IntegerOrString, user_id: Integer, only_if_banned: Boolean)
Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target group or username of the target supergroup or channel (in the format @username) |
| user_id | Integer | true | Unique identifier of the target user |
| only_if_banned | Boolean | false | Do nothing if the user is not banned |
restrictChatMember(chat_id: IntegerOrString, user_id: Integer, permissions: ChatPermissions, until_date: Integer)
Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) |
| user_id | Integer | true | Unique identifier of the target user |
| permissions | ChatPermissions | true | A JSON-serialized object for new user permissions |
| until_date | Integer | false | Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever |
promoteChatMember(chat_id: IntegerOrString, user_id: Integer, is_anonymous: Boolean, can_manage_chat: Boolean, can_post_messages: Boolean, can_edit_messages: Boolean, can_delete_messages: Boolean, can_manage_voice_chats: Boolean, can_restrict_members: Boolean, can_promote_members: Boolean, can_change_info: Boolean, can_invite_users: Boolean, can_pin_messages: Boolean)
Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| user_id | Integer | true | Unique identifier of the target user |
| is_anonymous | Boolean | false | Pass True, if the administrator's presence in the chat is hidden |
| can_manage_chat | Boolean | false | Pass True, if the administrator can access the chat event log, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege |
| can_post_messages | Boolean | false | Pass True, if the administrator can create channel posts, channels only |
| can_edit_messages | Boolean | false | Pass True, if the administrator can edit messages of other users and can pin messages, channels only |
| can_delete_messages | Boolean | false | Pass True, if the administrator can delete messages of other users |
| can_manage_voice_chats | Boolean | false | Pass True, if the administrator can manage voice chats |
| can_restrict_members | Boolean | false | Pass True, if the administrator can restrict, ban or unban chat members |
| can_promote_members | Boolean | false | Pass True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by him) |
| can_change_info | Boolean | false | Pass True, if the administrator can change chat title, photo and other settings |
| can_invite_users | Boolean | false | Pass True, if the administrator can invite new users to the chat |
| can_pin_messages | Boolean | false | Pass True, if the administrator can pin messages, supergroups only |
setChatAdministratorCustomTitle(chat_id: IntegerOrString, user_id: Integer, custom_title: String)
Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) |
| user_id | Integer | true | Unique identifier of the target user |
| custom_title | String | true | New custom title for the administrator; 0-16 characters, emoji are not allowed |
banChatSenderChat(chat_id: IntegerOrString, sender_chat_id: Integer)
Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| sender_chat_id | Integer | true | Unique identifier of the target sender chat |
unbanChatSenderChat(chat_id: IntegerOrString, sender_chat_id: Integer)
Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| sender_chat_id | Integer | true | Unique identifier of the target sender chat |
setChatPermissions(chat_id: IntegerOrString, permissions: ChatPermissions)
Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) |
| permissions | ChatPermissions | true | A JSON-serialized object for new default chat permissions |
exportChatInviteLink(chat_id: IntegerOrString)
Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.
Note: Each administrator in a chat generates their own invite links. Bots can't use invite links generated by other administrators. If you want your bot to work with invite links, it will need to generate its own link using exportChatInviteLink or by calling the getChat method. If your bot needs to generate a new primary invite link replacing its previous one, use exportChatInviteLink again.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
createChatInviteLink(chat_id: IntegerOrString, name: String, expire_date: Integer, member_limit: Integer, creates_join_request: Boolean)
Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| name | String | false | Invite link name; 0-32 characters |
| expire_date | Integer | false | Point in time (Unix timestamp) when the link will expire |
| member_limit | Integer | false | Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999 |
| creates_join_request | Boolean | false | True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified |
editChatInviteLink(chat_id: IntegerOrString, invite_link: String, name: String, expire_date: Integer, member_limit: Integer, creates_join_request: Boolean)
Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| invite_link | String | true | The invite link to edit |
| name | String | false | Invite link name; 0-32 characters |
| expire_date | Integer | false | Point in time (Unix timestamp) when the link will expire |
| member_limit | Integer | false | Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999 |
| creates_join_request | Boolean | false | True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified |
revokeChatInviteLink(chat_id: IntegerOrString, invite_link: String)
Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier of the target chat or username of the target channel (in the format @channelusername) |
| invite_link | String | true | The invite link to revoke |
approveChatJoinRequest(chat_id: IntegerOrString, user_id: Integer)
Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| user_id | Integer | true | Unique identifier of the target user |
declineChatJoinRequest(chat_id: IntegerOrString, user_id: Integer)
Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| user_id | Integer | true | Unique identifier of the target user |
setChatPhoto(chat_id: IntegerOrString, photo: InputFile)
Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| photo | InputFile | true | New chat photo, uploaded using multipart/form-data |
deleteChatPhoto(chat_id: IntegerOrString)
Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
setChatTitle(chat_id: IntegerOrString, title: String)
Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| title | String | true | New chat title, 1-255 characters |
setChatDescription(chat_id: IntegerOrString, description: String)
Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| description | String | false | New chat description, 0-255 characters |
pinChatMessage(chat_id: IntegerOrString, message_id: Integer, disable_notification: Boolean)
Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| message_id | Integer | true | Identifier of a message to pin |
| disable_notification | Boolean | false | Pass True, if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats. |
unpinChatMessage(chat_id: IntegerOrString, message_id: Integer)
Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| message_id | Integer | false | Identifier of a message to unpin. If not specified, the most recent pinned message (by sending date) will be unpinned. |
unpinAllChatMessages(chat_id: IntegerOrString)
Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
leaveChat(chat_id: IntegerOrString)
Use this method for your bot to leave a group, supergroup or channel. Returns True on success.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) |
getChat(chat_id: IntegerOrString)
Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a Chat object on success.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) |
getChatAdministrators(chat_id: IntegerOrString)
Use this method to get a list of administrators in a chat. On success, returns an Array of ChatMember objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) |
getChatMemberCount(chat_id: IntegerOrString)
Use this method to get the number of members in a chat. Returns Int on success.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) |
getChatMember(chat_id: IntegerOrString, user_id: Integer)
Use this method to get information about a member of a chat. Returns a ChatMember object on success.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) |
| user_id | Integer | true | Unique identifier of the target user |
setChatStickerSet(chat_id: IntegerOrString, sticker_set_name: String)
Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) |
| sticker_set_name | String | true | Name of the sticker set to be set as the group sticker set |
deleteChatStickerSet(chat_id: IntegerOrString)
Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) |
answerCallbackQuery(callback_query_id: String, text: String, show_alert: Boolean, url: String, cache_time: Integer)
Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.
Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via @Botfather and accept the terms. Otherwise, you may use links like
t.me/your_bot?start=XXXXthat open your bot with a parameter.
| name | type | required | description |
|---|---|---|---|
| callback_query_id | String | true | Unique identifier for the query to be answered |
| text | String | false | Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters |
| show_alert | Boolean | false | If True, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false. |
| url | String | false | URL that will be opened by the user's client. If you have created a Game and accepted the conditions via @Botfather, specify the URL that opens your game — note that this will only work if the query comes from a callback_game button. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter. |
| cache_time | Integer | false | The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0. |
setMyCommands(commands: List<BotCommand>, scope: BotCommandScope, language_code: String)
Use this method to change the list of the bot's commands. See https://core.telegram.org/bots#commands for more details about bot commands. Returns True on success.
| name | type | required | description |
|---|---|---|---|
| commands | List | true | A JSON-serialized list of bot commands to be set as the list of the bot's commands. At most 100 commands can be specified. |
| scope | BotCommandScope | false | A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault. |
| language_code | String | false | A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands |
deleteMyCommands(scope: BotCommandScope, language_code: String)
Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.
| name | type | required | description |
|---|---|---|---|
| scope | BotCommandScope | false | A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault. |
| language_code | String | false | A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands |
getMyCommands(scope: BotCommandScope, language_code: String)
Use this method to get the current list of the bot's commands for the given scope and user language. Returns Array of BotCommand on success. If commands aren't set, an empty list is returned.
| name | type | required | description |
|---|---|---|---|
| scope | BotCommandScope | false | A JSON-serialized object, describing scope of users. Defaults to BotCommandScopeDefault. |
| language_code | String | false | A two-letter ISO 639-1 language code or an empty string |
editMessageText(chat_id: IntegerOrString, message_id: Integer, inline_message_id: String, text: String, parse_mode: ParseMode, entities: List<MessageEntity>, disable_web_page_preview: Boolean, reply_markup: InlineKeyboardMarkup)
Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | false | Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| message_id | Integer | false | Required if inline_message_id is not specified. Identifier of the message to edit |
| inline_message_id | String | false | Required if chat_id and message_id are not specified. Identifier of the inline message |
| text | String | true | New text of the message, 1-4096 characters after entities parsing |
| parse_mode | ParseMode | false | Mode for parsing entities in the message text. See formatting options for more details. |
| entities | List | false | A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode |
| disable_web_page_preview | Boolean | false | Disables link previews for links in this message |
| reply_markup | InlineKeyboardMarkup | false | A JSON-serialized object for an inline keyboard. |
editMessageCaption(chat_id: IntegerOrString, message_id: Integer, inline_message_id: String, caption: String, parse_mode: ParseMode, caption_entities: List<MessageEntity>, reply_markup: InlineKeyboardMarkup)
Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | false | Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| message_id | Integer | false | Required if inline_message_id is not specified. Identifier of the message to edit |
| inline_message_id | String | false | Required if chat_id and message_id are not specified. Identifier of the inline message |
| caption | String | false | New caption of the message, 0-1024 characters after entities parsing |
| parse_mode | ParseMode | false | Mode for parsing entities in the message caption. See formatting options for more details. |
| caption_entities | List | false | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode |
| reply_markup | InlineKeyboardMarkup | false | A JSON-serialized object for an inline keyboard. |
editMessageMedia(chat_id: IntegerOrString, message_id: Integer, inline_message_id: String, media: InputMedia, reply_markup: InlineKeyboardMarkup)
Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | false | Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| message_id | Integer | false | Required if inline_message_id is not specified. Identifier of the message to edit |
| inline_message_id | String | false | Required if chat_id and message_id are not specified. Identifier of the inline message |
| media | InputMedia | true | A JSON-serialized object for a new media content of the message |
| reply_markup | InlineKeyboardMarkup | false | A JSON-serialized object for a new inline keyboard. |
editMessageReplyMarkup(chat_id: IntegerOrString, message_id: Integer, inline_message_id: String, reply_markup: InlineKeyboardMarkup)
Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | false | Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| message_id | Integer | false | Required if inline_message_id is not specified. Identifier of the message to edit |
| inline_message_id | String | false | Required if chat_id and message_id are not specified. Identifier of the inline message |
| reply_markup | InlineKeyboardMarkup | false | A JSON-serialized object for an inline keyboard. |
stopPoll(chat_id: IntegerOrString, message_id: Integer, reply_markup: InlineKeyboardMarkup)
Use this method to stop a poll which was sent by the bot. On success, the stopped Poll is returned.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| message_id | Integer | true | Identifier of the original message with the poll |
| reply_markup | InlineKeyboardMarkup | false | A JSON-serialized object for a new message inline keyboard. |
deleteMessage(chat_id: IntegerOrString, message_id: Integer)
Use this method to delete a message, including service messages, with the following limitations:
- A message can only be deleted if it was sent less than 48 hours ago.
- A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.
- Bots can delete outgoing messages in private chats, groups, and supergroups.
- Bots can delete incoming messages in private chats.
- Bots granted can_post_messages permissions can delete outgoing messages in channels.
- If the bot is an administrator of a group, it can delete any message there.
- If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any message there.
Returns True on success.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| message_id | Integer | true | Identifier of the message to delete |
Sticker(file_id: String, file_unique_id: String, width: Integer, height: Integer, is_animated: Boolean, thumb: PhotoSize, emoji: String, set_name: String, mask_position: MaskPosition, file_size: Integer)
This object represents a sticker.
| name | type | required | description |
|---|---|---|---|
| file_id | String | true | Identifier for this file, which can be used to download or reuse the file |
| file_unique_id | String | true | 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. |
| width | Integer | true | Sticker width |
| height | Integer | true | Sticker height |
| is_animated | Boolean | true | True, if the sticker is animated |
| thumb | PhotoSize | false | Optional. Sticker thumbnail in the .WEBP or .JPG format |
| emoji | String | false | Optional. Emoji associated with the sticker |
| set_name | String | false | Optional. Name of the sticker set to which the sticker belongs |
| mask_position | MaskPosition | false | Optional. For mask stickers, the position where the mask should be placed |
| file_size | Integer | false | Optional. File size in bytes |
StickerSet(name: String, title: String, is_animated: Boolean, contains_masks: Boolean, stickers: List<Sticker>, thumb: PhotoSize)
This object represents a sticker set.
| name | type | required | description |
|---|---|---|---|
| name | String | true | Sticker set name |
| title | String | true | Sticker set title |
| is_animated | Boolean | true | True, if the sticker set contains animated stickers |
| contains_masks | Boolean | true | True, if the sticker set contains masks |
| stickers | List | true | List of all set stickers |
| thumb | PhotoSize | false | Optional. Sticker set thumbnail in the .WEBP or .TGS format |
MaskPosition(point: String, x_shift: Float, y_shift: Float, scale: Float)
This object describes the position on faces where a mask should be placed by default.
| name | type | required | description |
|---|---|---|---|
| point | String | true | The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”. |
| x_shift | Float | true | 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. |
| y_shift | Float | true | 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. |
| scale | Float | true | Mask scaling coefficient. For example, 2.0 means double size. |
sendSticker(chat_id: IntegerOrString, sticker: InputFileOrString, disable_notification: Boolean, protect_content: Boolean, reply_to_message_id: Integer, allow_sending_without_reply: Boolean, reply_markup: KeyboardOption)
Use this method to send static .WEBP or animated .TGS stickers. On success, the sent Message is returned.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| sticker | InputFileOrString | true | Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files » |
| disable_notification | Boolean | false | Sends the message silently. Users will receive a notification with no sound. |
| protect_content | Boolean | false | Protects the contents of the sent message from forwarding and saving |
| reply_to_message_id | Integer | false | If the message is a reply, ID of the original message |
| allow_sending_without_reply | Boolean | false | Pass True, if the message should be sent even if the specified replied-to message is not found |
| reply_markup | KeyboardOption | false | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. |
getStickerSet(name: String)
Use this method to get a sticker set. On success, a StickerSet object is returned.
| name | type | required | description |
|---|---|---|---|
| name | String | true | Name of the sticker set |
uploadStickerFile(user_id: Integer, png_sticker: InputFile)
Use this method to upload a .PNG file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times). Returns the uploaded File on success.
| name | type | required | description |
|---|---|---|---|
| user_id | Integer | true | User identifier of sticker file owner |
| png_sticker | InputFile | true | PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. More info on Sending Files » |
createNewStickerSet(user_id: Integer, name: String, title: String, png_sticker: InputFileOrString, tgs_sticker: InputFile, emojis: String, contains_masks: Boolean, mask_position: MaskPosition)
Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. You must use exactly one of the fields png_sticker or tgs_sticker. Returns True on success.
| name | type | required | description |
|---|---|---|---|
| user_id | Integer | true | User identifier of created sticker set owner |
| name | String | true | Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only english letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in “by<bot username>”. <bot_username> is case insensitive. 1-64 characters. |
| title | String | true | Sticker set title, 1-64 characters |
| png_sticker | InputFileOrString | false | PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files » |
| tgs_sticker | InputFile | false | TGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/animated_stickers#technical-requirements for technical requirements |
| emojis | String | true | One or more emoji corresponding to the sticker |
| contains_masks | Boolean | false | Pass True, if a set of mask stickers should be created |
| mask_position | MaskPosition | false | A JSON-serialized object for position where the mask should be placed on faces |
addStickerToSet(user_id: Integer, name: String, png_sticker: InputFileOrString, tgs_sticker: InputFile, emojis: String, mask_position: MaskPosition)
Use this method to add a new sticker to a set created by the bot. You must use exactly one of the fields png_sticker or tgs_sticker. Animated stickers can be added to animated sticker sets and only to them. Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.
| name | type | required | description |
|---|---|---|---|
| user_id | Integer | true | User identifier of sticker set owner |
| name | String | true | Sticker set name |
| png_sticker | InputFileOrString | false | PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files » |
| tgs_sticker | InputFile | false | TGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/animated_stickers#technical-requirements for technical requirements |
| emojis | String | true | One or more emoji corresponding to the sticker |
| mask_position | MaskPosition | false | A JSON-serialized object for position where the mask should be placed on faces |
setStickerPositionInSet(sticker: String, position: Integer)
Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.
| name | type | required | description |
|---|---|---|---|
| sticker | String | true | File identifier of the sticker |
| position | Integer | true | New sticker position in the set, zero-based |
deleteStickerFromSet(sticker: String)
Use this method to delete a sticker from a set created by the bot. Returns True on success.
| name | type | required | description |
|---|---|---|---|
| sticker | String | true | File identifier of the sticker |
setStickerSetThumb(name: String, user_id: Integer, thumb: InputFileOrString)
Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Returns True on success.
| name | type | required | description |
|---|---|---|---|
| name | String | true | Sticker set name |
| user_id | Integer | true | User identifier of the sticker set owner |
| thumb | InputFileOrString | false | A PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a TGS animation with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/animated_stickers#technical-requirements for animated sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files ». Animated sticker set thumbnail can't be uploaded via HTTP URL. |
InlineQuery(id: String, from: User, query: String, offset: String, chat_type: String, location: Location)
This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.
| name | type | required | description |
|---|---|---|---|
| id | String | true | Unique identifier for this query |
| from | User | true | Sender |
| query | String | true | Text of the query (up to 256 characters) |
| offset | String | true | Offset of the results to be returned, can be controlled by the bot |
| chat_type | String | false | Optional. Type of the chat, from which the inline query was sent. Can be either “sender” for a private chat with the inline query sender, “private”, “group”, “supergroup”, or “channel”. The chat type should be always known for requests sent from official clients and most third-party clients, unless the request was sent from a secret chat |
| location | Location | false | Optional. Sender location, only for bots that request user location |
InlineQueryResultArticle(type: String, id: String, title: String, input_message_content: InputMessageContent, reply_markup: InlineKeyboardMarkup, url: String, hide_url: Boolean, description: String, thumb_url: String, thumb_width: Integer, thumb_height: Integer)
Represents a link to an article or web page.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Type of the result, must be article |
| id | String | true | Unique identifier for this result, 1-64 Bytes |
| title | String | true | Title of the result |
| input_message_content | InputMessageContent | true | Content of the message to be sent |
| reply_markup | InlineKeyboardMarkup | false | Optional. Inline keyboard attached to the message |
| url | String | false | Optional. URL of the result |
| hide_url | Boolean | false | Optional. Pass True, if you don't want the URL to be shown in the message |
| description | String | false | Optional. Short description of the result |
| thumb_url | String | false | Optional. Url of the thumbnail for the result |
| thumb_width | Integer | false | Optional. Thumbnail width |
| thumb_height | Integer | false | Optional. Thumbnail height |
InlineQueryResultPhoto(type: String, id: String, photo_url: String, thumb_url: String, photo_width: Integer, photo_height: Integer, title: String, description: String, caption: String, parse_mode: ParseMode, caption_entities: List<MessageEntity>, reply_markup: InlineKeyboardMarkup, input_message_content: InputMessageContent)
Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Type of the result, must be photo |
| id | String | true | Unique identifier for this result, 1-64 bytes |
| photo_url | String | true | A valid URL of the photo. Photo must be in JPEG format. Photo size must not exceed 5MB |
| thumb_url | String | true | URL of the thumbnail for the photo |
| photo_width | Integer | false | Optional. Width of the photo |
| photo_height | Integer | false | Optional. Height of the photo |
| title | String | false | Optional. Title for the result |
| description | String | false | Optional. Short description of the result |
| caption | String | false | Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing |
| parse_mode | ParseMode | false | Optional. Mode for parsing entities in the photo caption. See formatting options for more details. |
| caption_entities | List | false | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode |
| reply_markup | InlineKeyboardMarkup | false | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | false | Optional. Content of the message to be sent instead of the photo |
InlineQueryResultGif(type: String, id: String, gif_url: String, gif_width: Integer, gif_height: Integer, gif_duration: Integer, thumb_url: String, thumb_mime_type: String, title: String, caption: String, parse_mode: ParseMode, caption_entities: List<MessageEntity>, reply_markup: InlineKeyboardMarkup, input_message_content: InputMessageContent)
Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Type of the result, must be gif |
| id | String | true | Unique identifier for this result, 1-64 bytes |
| gif_url | String | true | A valid URL for the GIF file. File size must not exceed 1MB |
| gif_width | Integer | false | Optional. Width of the GIF |
| gif_height | Integer | false | Optional. Height of the GIF |
| gif_duration | Integer | false | Optional. Duration of the GIF in seconds |
| thumb_url | String | true | URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result |
| thumb_mime_type | String | false | Optional. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg” |
| title | String | false | Optional. Title for the result |
| caption | String | false | Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing |
| parse_mode | ParseMode | false | Optional. Mode for parsing entities in the caption. See formatting options for more details. |
| caption_entities | List | false | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode |
| reply_markup | InlineKeyboardMarkup | false | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | false | Optional. Content of the message to be sent instead of the GIF animation |
InlineQueryResultMpeg4Gif(type: String, id: String, mpeg4_url: String, mpeg4_width: Integer, mpeg4_height: Integer, mpeg4_duration: Integer, thumb_url: String, thumb_mime_type: String, title: String, caption: String, parse_mode: ParseMode, caption_entities: List<MessageEntity>, reply_markup: InlineKeyboardMarkup, input_message_content: InputMessageContent)
Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this animated MPEG-4 file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Type of the result, must be mpeg4_gif |
| id | String | true | Unique identifier for this result, 1-64 bytes |
| mpeg4_url | String | true | A valid URL for the MP4 file. File size must not exceed 1MB |
| mpeg4_width | Integer | false | Optional. Video width |
| mpeg4_height | Integer | false | Optional. Video height |
| mpeg4_duration | Integer | false | Optional. Video duration in seconds |
| thumb_url | String | true | URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result |
| thumb_mime_type | String | false | Optional. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg” |
| title | String | false | Optional. Title for the result |
| caption | String | false | Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing |
| parse_mode | ParseMode | false | Optional. Mode for parsing entities in the caption. See formatting options for more details. |
| caption_entities | List | false | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode |
| reply_markup | InlineKeyboardMarkup | false | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | false | Optional. Content of the message to be sent instead of the video animation |
InlineQueryResultVideo(type: String, id: String, video_url: String, mime_type: String, thumb_url: String, title: String, caption: String, parse_mode: ParseMode, caption_entities: List<MessageEntity>, video_width: Integer, video_height: Integer, video_duration: Integer, description: String, reply_markup: InlineKeyboardMarkup, input_message_content: InputMessageContent)
Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.
If an InlineQueryResultVideo message contains an embedded video (e.g., YouTube), you must replace its content using input_message_content.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Type of the result, must be video |
| id | String | true | Unique identifier for this result, 1-64 bytes |
| video_url | String | true | A valid URL for the embedded video player or video file |
| mime_type | String | true | Mime type of the content of video url, “text/html” or “video/mp4” |
| thumb_url | String | true | URL of the thumbnail (JPEG only) for the video |
| title | String | true | Title for the result |
| caption | String | false | Optional. Caption of the video to be sent, 0-1024 characters after entities parsing |
| parse_mode | ParseMode | false | Optional. Mode for parsing entities in the video caption. See formatting options for more details. |
| caption_entities | List | false | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode |
| video_width | Integer | false | Optional. Video width |
| video_height | Integer | false | Optional. Video height |
| video_duration | Integer | false | Optional. Video duration in seconds |
| description | String | false | Optional. Short description of the result |
| reply_markup | InlineKeyboardMarkup | false | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | false | Optional. Content of the message to be sent instead of the video. This field is required if InlineQueryResultVideo is used to send an HTML-page as a result (e.g., a YouTube video). |
InlineQueryResultAudio(type: String, id: String, audio_url: String, title: String, caption: String, parse_mode: ParseMode, caption_entities: List<MessageEntity>, performer: String, audio_duration: Integer, reply_markup: InlineKeyboardMarkup, input_message_content: InputMessageContent)
Represents a link to an MP3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Type of the result, must be audio |
| id | String | true | Unique identifier for this result, 1-64 bytes |
| audio_url | String | true | A valid URL for the audio file |
| title | String | true | Title |
| caption | String | false | Optional. Caption, 0-1024 characters after entities parsing |
| parse_mode | ParseMode | false | Optional. Mode for parsing entities in the audio caption. See formatting options for more details. |
| caption_entities | List | false | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode |
| performer | String | false | Optional. Performer |
| audio_duration | Integer | false | Optional. Audio duration in seconds |
| reply_markup | InlineKeyboardMarkup | false | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | false | Optional. Content of the message to be sent instead of the audio |
InlineQueryResultVoice(type: String, id: String, voice_url: String, title: String, caption: String, parse_mode: ParseMode, caption_entities: List<MessageEntity>, voice_duration: Integer, reply_markup: InlineKeyboardMarkup, input_message_content: InputMessageContent)
Represents a link to a voice recording in an .OGG container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the the voice message.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Type of the result, must be voice |
| id | String | true | Unique identifier for this result, 1-64 bytes |
| voice_url | String | true | A valid URL for the voice recording |
| title | String | true | Recording title |
| caption | String | false | Optional. Caption, 0-1024 characters after entities parsing |
| parse_mode | ParseMode | false | Optional. Mode for parsing entities in the voice message caption. See formatting options for more details. |
| caption_entities | List | false | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode |
| voice_duration | Integer | false | Optional. Recording duration in seconds |
| reply_markup | InlineKeyboardMarkup | false | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | false | Optional. Content of the message to be sent instead of the voice recording |
InlineQueryResultDocument(type: String, id: String, title: String, caption: String, parse_mode: ParseMode, caption_entities: List<MessageEntity>, document_url: String, mime_type: String, description: String, reply_markup: InlineKeyboardMarkup, input_message_content: InputMessageContent, thumb_url: String, thumb_width: Integer, thumb_height: Integer)
Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file. Currently, only .PDF and .ZIP files can be sent using this method.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Type of the result, must be document |
| id | String | true | Unique identifier for this result, 1-64 bytes |
| title | String | true | Title for the result |
| caption | String | false | Optional. Caption of the document to be sent, 0-1024 characters after entities parsing |
| parse_mode | ParseMode | false | Optional. Mode for parsing entities in the document caption. See formatting options for more details. |
| caption_entities | List | false | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode |
| document_url | String | true | A valid URL for the file |
| mime_type | String | true | Mime type of the content of the file, either “application/pdf” or “application/zip” |
| description | String | false | Optional. Short description of the result |
| reply_markup | InlineKeyboardMarkup | false | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | false | Optional. Content of the message to be sent instead of the file |
| thumb_url | String | false | Optional. URL of the thumbnail (JPEG only) for the file |
| thumb_width | Integer | false | Optional. Thumbnail width |
| thumb_height | Integer | false | Optional. Thumbnail height |
InlineQueryResultLocation(type: String, id: String, latitude: Float, longitude: Float, title: String, horizontal_accuracy: Float, live_period: Integer, heading: Integer, proximity_alert_radius: Integer, reply_markup: InlineKeyboardMarkup, input_message_content: InputMessageContent, thumb_url: String, thumb_width: Integer, thumb_height: Integer)
Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the location.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Type of the result, must be location |
| id | String | true | Unique identifier for this result, 1-64 Bytes |
| latitude | Float | true | Location latitude in degrees |
| longitude | Float | true | Location longitude in degrees |
| title | String | true | Location title |
| horizontal_accuracy | Float | false | Optional. The radius of uncertainty for the location, measured in meters; 0-1500 |
| live_period | Integer | false | Optional. Period in seconds for which the location can be updated, should be between 60 and 86400. |
| heading | Integer | false | Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. |
| proximity_alert_radius | Integer | false | Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. |
| reply_markup | InlineKeyboardMarkup | false | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | false | Optional. Content of the message to be sent instead of the location |
| thumb_url | String | false | Optional. Url of the thumbnail for the result |
| thumb_width | Integer | false | Optional. Thumbnail width |
| thumb_height | Integer | false | Optional. Thumbnail height |
InlineQueryResultVenue(type: String, id: String, latitude: Float, longitude: Float, title: String, address: String, foursquare_id: String, foursquare_type: String, google_place_id: String, google_place_type: String, reply_markup: InlineKeyboardMarkup, input_message_content: InputMessageContent, thumb_url: String, thumb_width: Integer, thumb_height: Integer)
Represents a venue. By default, the venue will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the venue.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Type of the result, must be venue |
| id | String | true | Unique identifier for this result, 1-64 Bytes |
| latitude | Float | true | Latitude of the venue location in degrees |
| longitude | Float | true | Longitude of the venue location in degrees |
| title | String | true | Title of the venue |
| address | String | true | Address of the venue |
| foursquare_id | String | false | Optional. Foursquare identifier of the venue if known |
| foursquare_type | String | false | Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.) |
| google_place_id | String | false | Optional. Google Places identifier of the venue |
| google_place_type | String | false | Optional. Google Places type of the venue. (See supported types.) |
| reply_markup | InlineKeyboardMarkup | false | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | false | Optional. Content of the message to be sent instead of the venue |
| thumb_url | String | false | Optional. Url of the thumbnail for the result |
| thumb_width | Integer | false | Optional. Thumbnail width |
| thumb_height | Integer | false | Optional. Thumbnail height |
InlineQueryResultContact(type: String, id: String, phone_number: String, first_name: String, last_name: String, vcard: String, reply_markup: InlineKeyboardMarkup, input_message_content: InputMessageContent, thumb_url: String, thumb_width: Integer, thumb_height: Integer)
Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the contact.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Type of the result, must be contact |
| id | String | true | Unique identifier for this result, 1-64 Bytes |
| phone_number | String | true | Contact's phone number |
| first_name | String | true | Contact's first name |
| last_name | String | false | Optional. Contact's last name |
| vcard | String | false | Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes |
| reply_markup | InlineKeyboardMarkup | false | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | false | Optional. Content of the message to be sent instead of the contact |
| thumb_url | String | false | Optional. Url of the thumbnail for the result |
| thumb_width | Integer | false | Optional. Thumbnail width |
| thumb_height | Integer | false | Optional. Thumbnail height |
InlineQueryResultGame(type: String, id: String, game_short_name: String, reply_markup: InlineKeyboardMarkup)
Represents a Game.
Note: This will only work in Telegram versions released after October 1, 2016. Older clients will not display any inline results if a game result is among them.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Type of the result, must be game |
| id | String | true | Unique identifier for this result, 1-64 bytes |
| game_short_name | String | true | Short name of the game |
| reply_markup | InlineKeyboardMarkup | false | Optional. Inline keyboard attached to the message |
InlineQueryResultCachedPhoto(type: String, id: String, photo_file_id: String, title: String, description: String, caption: String, parse_mode: ParseMode, caption_entities: List<MessageEntity>, reply_markup: InlineKeyboardMarkup, input_message_content: InputMessageContent)
Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Type of the result, must be photo |
| id | String | true | Unique identifier for this result, 1-64 bytes |
| photo_file_id | String | true | A valid file identifier of the photo |
| title | String | false | Optional. Title for the result |
| description | String | false | Optional. Short description of the result |
| caption | String | false | Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing |
| parse_mode | ParseMode | false | Optional. Mode for parsing entities in the photo caption. See formatting options for more details. |
| caption_entities | List | false | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode |
| reply_markup | InlineKeyboardMarkup | false | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | false | Optional. Content of the message to be sent instead of the photo |
InlineQueryResultCachedGif(type: String, id: String, gif_file_id: String, title: String, caption: String, parse_mode: ParseMode, caption_entities: List<MessageEntity>, reply_markup: InlineKeyboardMarkup, input_message_content: InputMessageContent)
Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with specified content instead of the animation.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Type of the result, must be gif |
| id | String | true | Unique identifier for this result, 1-64 bytes |
| gif_file_id | String | true | A valid file identifier for the GIF file |
| title | String | false | Optional. Title for the result |
| caption | String | false | Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing |
| parse_mode | ParseMode | false | Optional. Mode for parsing entities in the caption. See formatting options for more details. |
| caption_entities | List | false | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode |
| reply_markup | InlineKeyboardMarkup | false | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | false | Optional. Content of the message to be sent instead of the GIF animation |
InlineQueryResultCachedMpeg4Gif(type: String, id: String, mpeg4_file_id: String, title: String, caption: String, parse_mode: ParseMode, caption_entities: List<MessageEntity>, reply_markup: InlineKeyboardMarkup, input_message_content: InputMessageContent)
Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By default, this animated MPEG-4 file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Type of the result, must be mpeg4_gif |
| id | String | true | Unique identifier for this result, 1-64 bytes |
| mpeg4_file_id | String | true | A valid file identifier for the MP4 file |
| title | String | false | Optional. Title for the result |
| caption | String | false | Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing |
| parse_mode | ParseMode | false | Optional. Mode for parsing entities in the caption. See formatting options for more details. |
| caption_entities | List | false | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode |
| reply_markup | InlineKeyboardMarkup | false | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | false | Optional. Content of the message to be sent instead of the video animation |
InlineQueryResultCachedSticker(type: String, id: String, sticker_file_id: String, reply_markup: InlineKeyboardMarkup, input_message_content: InputMessageContent)
Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the sticker.
Note: This will only work in Telegram versions released after 9 April, 2016 for static stickers and after 06 July, 2019 for animated stickers. Older clients will ignore them.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Type of the result, must be sticker |
| id | String | true | Unique identifier for this result, 1-64 bytes |
| sticker_file_id | String | true | A valid file identifier of the sticker |
| reply_markup | InlineKeyboardMarkup | false | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | false | Optional. Content of the message to be sent instead of the sticker |
InlineQueryResultCachedDocument(type: String, id: String, title: String, document_file_id: String, description: String, caption: String, parse_mode: ParseMode, caption_entities: List<MessageEntity>, reply_markup: InlineKeyboardMarkup, input_message_content: InputMessageContent)
Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Type of the result, must be document |
| id | String | true | Unique identifier for this result, 1-64 bytes |
| title | String | true | Title for the result |
| document_file_id | String | true | A valid file identifier for the file |
| description | String | false | Optional. Short description of the result |
| caption | String | false | Optional. Caption of the document to be sent, 0-1024 characters after entities parsing |
| parse_mode | ParseMode | false | Optional. Mode for parsing entities in the document caption. See formatting options for more details. |
| caption_entities | List | false | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode |
| reply_markup | InlineKeyboardMarkup | false | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | false | Optional. Content of the message to be sent instead of the file |
InlineQueryResultCachedVideo(type: String, id: String, video_file_id: String, title: String, description: String, caption: String, parse_mode: ParseMode, caption_entities: List<MessageEntity>, reply_markup: InlineKeyboardMarkup, input_message_content: InputMessageContent)
Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Type of the result, must be video |
| id | String | true | Unique identifier for this result, 1-64 bytes |
| video_file_id | String | true | A valid file identifier for the video file |
| title | String | true | Title for the result |
| description | String | false | Optional. Short description of the result |
| caption | String | false | Optional. Caption of the video to be sent, 0-1024 characters after entities parsing |
| parse_mode | ParseMode | false | Optional. Mode for parsing entities in the video caption. See formatting options for more details. |
| caption_entities | List | false | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode |
| reply_markup | InlineKeyboardMarkup | false | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | false | Optional. Content of the message to be sent instead of the video |
InlineQueryResultCachedVoice(type: String, id: String, voice_file_id: String, title: String, caption: String, parse_mode: ParseMode, caption_entities: List<MessageEntity>, reply_markup: InlineKeyboardMarkup, input_message_content: InputMessageContent)
Represents a link to a voice message stored on the Telegram servers. By default, this voice message will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the voice message.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Type of the result, must be voice |
| id | String | true | Unique identifier for this result, 1-64 bytes |
| voice_file_id | String | true | A valid file identifier for the voice message |
| title | String | true | Voice message title |
| caption | String | false | Optional. Caption, 0-1024 characters after entities parsing |
| parse_mode | ParseMode | false | Optional. Mode for parsing entities in the voice message caption. See formatting options for more details. |
| caption_entities | List | false | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode |
| reply_markup | InlineKeyboardMarkup | false | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | false | Optional. Content of the message to be sent instead of the voice message |
InlineQueryResultCachedAudio(type: String, id: String, audio_file_id: String, caption: String, parse_mode: ParseMode, caption_entities: List<MessageEntity>, reply_markup: InlineKeyboardMarkup, input_message_content: InputMessageContent)
Represents a link to an MP3 audio file stored on the Telegram servers. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Type of the result, must be audio |
| id | String | true | Unique identifier for this result, 1-64 bytes |
| audio_file_id | String | true | A valid file identifier for the audio file |
| caption | String | false | Optional. Caption, 0-1024 characters after entities parsing |
| parse_mode | ParseMode | false | Optional. Mode for parsing entities in the audio caption. See formatting options for more details. |
| caption_entities | List | false | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode |
| reply_markup | InlineKeyboardMarkup | false | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | false | Optional. Content of the message to be sent instead of the audio |
InputTextMessageContent(message_text: String, parse_mode: ParseMode, entities: List<MessageEntity>, disable_web_page_preview: Boolean)
Represents the content of a text message to be sent as the result of an inline query.
| name | type | required | description |
|---|---|---|---|
| message_text | String | true | Text of the message to be sent, 1-4096 characters |
| parse_mode | ParseMode | false | Optional. Mode for parsing entities in the message text. See formatting options for more details. |
| entities | List | false | Optional. List of special entities that appear in message text, which can be specified instead of parse_mode |
| disable_web_page_preview | Boolean | false | Optional. Disables link previews for links in the sent message |
InputLocationMessageContent(latitude: Float, longitude: Float, horizontal_accuracy: Float, live_period: Integer, heading: Integer, proximity_alert_radius: Integer)
Represents the content of a location message to be sent as the result of an inline query.
| name | type | required | description |
|---|---|---|---|
| latitude | Float | true | Latitude of the location in degrees |
| longitude | Float | true | Longitude of the location in degrees |
| horizontal_accuracy | Float | false | Optional. The radius of uncertainty for the location, measured in meters; 0-1500 |
| live_period | Integer | false | Optional. Period in seconds for which the location can be updated, should be between 60 and 86400. |
| heading | Integer | false | Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. |
| proximity_alert_radius | Integer | false | Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. |
InputVenueMessageContent(latitude: Float, longitude: Float, title: String, address: String, foursquare_id: String, foursquare_type: String, google_place_id: String, google_place_type: String)
Represents the content of a venue message to be sent as the result of an inline query.
| name | type | required | description |
|---|---|---|---|
| latitude | Float | true | Latitude of the venue in degrees |
| longitude | Float | true | Longitude of the venue in degrees |
| title | String | true | Name of the venue |
| address | String | true | Address of the venue |
| foursquare_id | String | false | Optional. Foursquare identifier of the venue, if known |
| foursquare_type | String | false | Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.) |
| google_place_id | String | false | Optional. Google Places identifier of the venue |
| google_place_type | String | false | Optional. Google Places type of the venue. (See supported types.) |
InputContactMessageContent(phone_number: String, first_name: String, last_name: String, vcard: String)
Represents the content of a contact message to be sent as the result of an inline query.
| name | type | required | description |
|---|---|---|---|
| phone_number | String | true | Contact's phone number |
| first_name | String | true | Contact's first name |
| last_name | String | false | Optional. Contact's last name |
| vcard | String | false | Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes |
InputInvoiceMessageContent(title: String, description: String, payload: String, provider_token: String, currency: String, prices: List<LabeledPrice>, max_tip_amount: Integer, suggested_tip_amounts: List<Integer>, provider_data: String, photo_url: String, photo_size: Integer, photo_width: Integer, photo_height: Integer, need_name: Boolean, need_phone_number: Boolean, need_email: Boolean, need_shipping_address: Boolean, send_phone_number_to_provider: Boolean, send_email_to_provider: Boolean, is_flexible: Boolean)
Represents the content of an invoice message to be sent as the result of an inline query.
| name | type | required | description |
|---|---|---|---|
| title | String | true | Product name, 1-32 characters |
| description | String | true | Product description, 1-255 characters |
| payload | String | true | Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. |
| provider_token | String | true | Payment provider token, obtained via Botfather |
| currency | String | true | Three-letter ISO 4217 currency code, see more on currencies |
| prices | List | true | Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.) |
| max_tip_amount | Integer | false | Optional. The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0 |
| suggested_tip_amounts | List | false | Optional. A JSON-serialized array of suggested amounts of tip in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount. |
| provider_data | String | false | Optional. A JSON-serialized object for data about the invoice, which will be shared with the payment provider. A detailed description of the required fields should be provided by the payment provider. |
| photo_url | String | false | Optional. URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for. |
| photo_size | Integer | false | Optional. Photo size |
| photo_width | Integer | false | Optional. Photo width |
| photo_height | Integer | false | Optional. Photo height |
| need_name | Boolean | false | Optional. Pass True, if you require the user's full name to complete the order |
| need_phone_number | Boolean | false | Optional. Pass True, if you require the user's phone number to complete the order |
| need_email | Boolean | false | Optional. Pass True, if you require the user's email address to complete the order |
| need_shipping_address | Boolean | false | Optional. Pass True, if you require the user's shipping address to complete the order |
| send_phone_number_to_provider | Boolean | false | Optional. Pass True, if user's phone number should be sent to provider |
| send_email_to_provider | Boolean | false | Optional. Pass True, if user's email address should be sent to provider |
| is_flexible | Boolean | false | Optional. Pass True, if the final price depends on the shipping method |
ChosenInlineResult(result_id: String, from: User, location: Location, inline_message_id: String, query: String)
Represents a result of an inline query that was chosen by the user and sent to their chat partner.
Note: It is necessary to enable inline feedback via @Botfather in order to receive these objects in updates.
| name | type | required | description |
|---|---|---|---|
| result_id | String | true | The unique identifier for the result that was chosen |
| from | User | true | The user that chose the result |
| location | Location | false | Optional. Sender location, only for bots that require user location |
| inline_message_id | String | false | Optional. Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message. Will be also received in callback queries and can be used to edit the message. |
| query | String | true | The query that was used to obtain the result |
answerInlineQuery(inline_query_id: String, results: List<InlineQueryResult>, cache_time: Integer, is_personal: Boolean, next_offset: String, switch_pm_text: String, switch_pm_parameter: String)
Use this method to send answers to an inline query. On success, True is returned.
No more than 50 results per query are allowed.
| name | type | required | description |
|---|---|---|---|
| inline_query_id | String | true | Unique identifier for the answered query |
| results | List | true | A JSON-serialized array of results for the inline query |
| cache_time | Integer | false | The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300. |
| is_personal | Boolean | false | Pass True, if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query |
| next_offset | String | false | Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don't support pagination. Offset length can't exceed 64 bytes. |
| switch_pm_text | String | false | If passed, clients will display a button with specified text that switches the user to a private chat with the bot and sends the bot a start message with the parameter switch_pm_parameter |
| switch_pm_parameter | String | false | Deep-linking parameter for the /start message sent to the bot when user presses the switch button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed.Example: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a 'Connect your YouTube account' button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an OAuth link. Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities. |
LabeledPrice(label: String, amount: Integer)
This object represents a portion of the price for goods or services.
| name | type | required | description |
|---|---|---|---|
| label | String | true | Portion label |
| amount | Integer | true | Price of the product in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). |
Invoice(title: String, description: String, start_parameter: String, currency: String, total_amount: Integer)
This object contains basic information about an invoice.
| name | type | required | description |
|---|---|---|---|
| title | String | true | Product name |
| description | String | true | Product description |
| start_parameter | String | true | Unique bot deep-linking parameter that can be used to generate this invoice |
| currency | String | true | Three-letter ISO 4217 currency code |
| total_amount | Integer | true | Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). |
ShippingAddress(country_code: String, state: String, city: String, street_line1: String, street_line2: String, post_code: String)
This object represents a shipping address.
| name | type | required | description |
|---|---|---|---|
| country_code | String | true | ISO 3166-1 alpha-2 country code |
| state | String | true | State, if applicable |
| city | String | true | City |
| street_line1 | String | true | First line for the address |
| street_line2 | String | true | Second line for the address |
| post_code | String | true | Address post code |
OrderInfo(name: String, phone_number: String, email: String, shipping_address: ShippingAddress)
This object represents information about an order.
| name | type | required | description |
|---|---|---|---|
| name | String | false | Optional. User name |
| phone_number | String | false | Optional. User's phone number |
| String | false | Optional. User email | |
| shipping_address | ShippingAddress | false | Optional. User shipping address |
ShippingOption(id: String, title: String, prices: List<LabeledPrice>)
This object represents one shipping option.
| name | type | required | description |
|---|---|---|---|
| id | String | true | Shipping option identifier |
| title | String | true | Option title |
| prices | List | true | List of price portions |
SuccessfulPayment(currency: String, total_amount: Integer, invoice_payload: String, shipping_option_id: String, order_info: OrderInfo, telegram_payment_charge_id: String, provider_payment_charge_id: String)
This object contains basic information about a successful payment.
| name | type | required | description |
|---|---|---|---|
| currency | String | true | Three-letter ISO 4217 currency code |
| total_amount | Integer | true | Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). |
| invoice_payload | String | true | Bot specified invoice payload |
| shipping_option_id | String | false | Optional. Identifier of the shipping option chosen by the user |
| order_info | OrderInfo | false | Optional. Order info provided by the user |
| telegram_payment_charge_id | String | true | Telegram payment identifier |
| provider_payment_charge_id | String | true | Provider payment identifier |
ShippingQuery(id: String, from: User, invoice_payload: String, shipping_address: ShippingAddress)
This object contains information about an incoming shipping query.
| name | type | required | description |
|---|---|---|---|
| id | String | true | Unique query identifier |
| from | User | true | User who sent the query |
| invoice_payload | String | true | Bot specified invoice payload |
| shipping_address | ShippingAddress | true | User specified shipping address |
PreCheckoutQuery(id: String, from: User, currency: String, total_amount: Integer, invoice_payload: String, shipping_option_id: String, order_info: OrderInfo)
This object contains information about an incoming pre-checkout query.
| name | type | required | description |
|---|---|---|---|
| id | String | true | Unique query identifier |
| from | User | true | User who sent the query |
| currency | String | true | Three-letter ISO 4217 currency code |
| total_amount | Integer | true | Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). |
| invoice_payload | String | true | Bot specified invoice payload |
| shipping_option_id | String | false | Optional. Identifier of the shipping option chosen by the user |
| order_info | OrderInfo | false | Optional. Order info provided by the user |
sendInvoice(chat_id: IntegerOrString, title: String, description: String, payload: String, provider_token: String, currency: String, prices: List<LabeledPrice>, max_tip_amount: Integer, suggested_tip_amounts: List<Integer>, start_parameter: String, provider_data: String, photo_url: String, photo_size: Integer, photo_width: Integer, photo_height: Integer, need_name: Boolean, need_phone_number: Boolean, need_email: Boolean, need_shipping_address: Boolean, send_phone_number_to_provider: Boolean, send_email_to_provider: Boolean, is_flexible: Boolean, disable_notification: Boolean, protect_content: Boolean, reply_to_message_id: Integer, allow_sending_without_reply: Boolean, reply_markup: InlineKeyboardMarkup)
Use this method to send invoices. On success, the sent Message is returned.
| name | type | required | description |
|---|---|---|---|
| chat_id | IntegerOrString | true | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| title | String | true | Product name, 1-32 characters |
| description | String | true | Product description, 1-255 characters |
| payload | String | true | Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. |
| provider_token | String | true | Payments provider token, obtained via Botfather |
| currency | String | true | Three-letter ISO 4217 currency code, see more on currencies |
| prices | List | true | Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.) |
| max_tip_amount | Integer | false | The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0 |
| suggested_tip_amounts | List | false | A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount. |
| start_parameter | String | false | Unique deep-linking parameter. If left empty, forwarded copies of the sent message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using the same invoice. If non-empty, forwarded copies of the sent message will have a URL button with a deep link to the bot (instead of a Pay button), with the value used as the start parameter |
| provider_data | String | false | A JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider. |
| photo_url | String | false | 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. |
| photo_size | Integer | false | Photo size |
| photo_width | Integer | false | Photo width |
| photo_height | Integer | false | Photo height |
| need_name | Boolean | false | Pass True, if you require the user's full name to complete the order |
| need_phone_number | Boolean | false | Pass True, if you require the user's phone number to complete the order |
| need_email | Boolean | false | Pass True, if you require the user's email address to complete the order |
| need_shipping_address | Boolean | false | Pass True, if you require the user's shipping address to complete the order |
| send_phone_number_to_provider | Boolean | false | Pass True, if user's phone number should be sent to provider |
| send_email_to_provider | Boolean | false | Pass True, if user's email address should be sent to provider |
| is_flexible | Boolean | false | Pass True, if the final price depends on the shipping method |
| disable_notification | Boolean | false | Sends the message silently. Users will receive a notification with no sound. |
| protect_content | Boolean | false | Protects the contents of the sent message from forwarding and saving |
| reply_to_message_id | Integer | false | If the message is a reply, ID of the original message |
| allow_sending_without_reply | Boolean | false | Pass True, if the message should be sent even if the specified replied-to message is not found |
| reply_markup | InlineKeyboardMarkup | false | A JSON-serialized object for an inline keyboard. If empty, one 'Pay total price' button will be shown. If not empty, the first button must be a Pay button. |
answerShippingQuery(shipping_query_id: String, ok: Boolean, shipping_options: List<ShippingOption>, error_message: String)
If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.
| name | type | required | description |
|---|---|---|---|
| shipping_query_id | String | true | Unique identifier for the query to be answered |
| ok | Boolean | true | Specify True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible) |
| shipping_options | List | false | Required if ok is True. A JSON-serialized array of available shipping options. |
| error_message | String | false | Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. "Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user. |
answerPreCheckoutQuery(pre_checkout_query_id: String, ok: Boolean, error_message: String)
Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.
| name | type | required | description |
|---|---|---|---|
| pre_checkout_query_id | String | true | Unique identifier for the query to be answered |
| ok | Boolean | true | Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems. |
| error_message | String | false | Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user. |
PassportData(data: List<EncryptedPassportElement>, credentials: EncryptedCredentials)
Contains information about Telegram Passport data shared with the bot by the user.
| name | type | required | description |
|---|---|---|---|
| data | List | true | Array with information about documents and other Telegram Passport elements that was shared with the bot |
| credentials | EncryptedCredentials | true | Encrypted credentials required to decrypt the data |
PassportFile(file_id: String, file_unique_id: String, file_size: Integer, file_date: Integer)
This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB.
| name | type | required | description |
|---|---|---|---|
| file_id | String | true | Identifier for this file, which can be used to download or reuse the file |
| file_unique_id | String | true | 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. |
| file_size | Integer | true | File size in bytes |
| file_date | Integer | true | Unix time when the file was uploaded |
EncryptedPassportElement(type: String, data: String, phone_number: String, email: String, files: List<PassportFile>, front_side: PassportFile, reverse_side: PassportFile, selfie: PassportFile, translation: List<PassportFile>, hash: String)
Contains information about documents or other Telegram Passport elements shared with the bot by the user.
| name | type | required | description |
|---|---|---|---|
| type | String | true | Element type. One of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”, “phone_number”, “email”. |
| data | String | false | Optional. Base64-encoded encrypted Telegram Passport element data provided by the user, available for “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport” and “address” types. Can be decrypted and verified using the accompanying EncryptedCredentials. |
| phone_number | String | false | Optional. User's verified phone number, available only for “phone_number” type |
| String | false | Optional. User's verified email address, available only for “email” type | |
| files | List | false | Optional. Array of encrypted files with documents provided by the user, available for “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials. |
| front_side | PassportFile | false | Optional. Encrypted file with the front side of the document, provided by the user. Available for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials. |
| reverse_side | PassportFile | false | Optional. Encrypted file with the reverse side of the document, provided by the user. Available for “driver_license” and “identity_card”. The file can be decrypted and verified using the accompanying EncryptedCredentials. |
| selfie | PassportFile | false | Optional. Encrypted file with the selfie of the user holding a document, provided by the user; available for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials. |
| translation | List | false | Optional. Array of encrypted files with translated versions of documents provided by the user. Available if requested for “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials. |
| hash | String | true | Base64-encoded element hash for using in PassportElementErrorUnspecified |
EncryptedCredentials(data: String, hash: String, secret: String)
Contains data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.
| name | type | required | description |
|---|---|---|---|
| data | String | true | Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for EncryptedPassportElement decryption and authentication |
| hash | String | true | Base64-encoded data hash for data authentication |
| secret | String | true | Base64-encoded secret, encrypted with the bot's public RSA key, required for data decryption |
PassportElementErrorDataField(source: String, type: String, field_name: String, data_hash: String, message: String)
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.
| name | type | required | description |
|---|---|---|---|
| source | String | true | Error source, must be data |
| type | String | true | The section of the user's Telegram Passport which has the error, one of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address” |
| field_name | String | true | Name of the data field which has the error |
| data_hash | String | true | Base64-encoded data hash |
| message | String | true | Error message |
PassportElementErrorFrontSide(source: String, type: String, file_hash: String, message: String)
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.
| name | type | required | description |
|---|---|---|---|
| source | String | true | Error source, must be front_side |
| type | String | true | The section of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport” |
| file_hash | String | true | Base64-encoded hash of the file with the front side of the document |
| message | String | true | Error message |
PassportElementErrorReverseSide(source: String, type: String, file_hash: String, message: String)
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.
| name | type | required | description |
|---|---|---|---|
| source | String | true | Error source, must be reverse_side |
| type | String | true | The section of the user's Telegram Passport which has the issue, one of “driver_license”, “identity_card” |
| file_hash | String | true | Base64-encoded hash of the file with the reverse side of the document |
| message | String | true | Error message |
PassportElementErrorSelfie(source: String, type: String, file_hash: String, message: String)
Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes.
| name | type | required | description |
|---|---|---|---|
| source | String | true | Error source, must be selfie |
| type | String | true | The section of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport” |
| file_hash | String | true | Base64-encoded hash of the file with the selfie |
| message | String | true | Error message |
PassportElementErrorFile(source: String, type: String, file_hash: String, message: String)
Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes.
| name | type | required | description |
|---|---|---|---|
| source | String | true | Error source, must be file |
| type | String | true | The section of the user's Telegram Passport which has the issue, one of “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration” |
| file_hash | String | true | Base64-encoded file hash |
| message | String | true | Error message |
PassportElementErrorFiles(source: String, type: String, file_hashes: List<String>, message: String)
Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.
| name | type | required | description |
|---|---|---|---|
| source | String | true | Error source, must be files |
| type | String | true | The section of the user's Telegram Passport which has the issue, one of “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration” |
| file_hashes | List | true | List of base64-encoded file hashes |
| message | String | true | Error message |
PassportElementErrorTranslationFile(source: String, type: String, file_hash: String, message: String)
Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes.
| name | type | required | description |
|---|---|---|---|
| source | String | true | Error source, must be translation_file |
| type | String | true | Type of element of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration” |
| file_hash | String | true | Base64-encoded file hash |
| message | String | true | Error message |
PassportElementErrorTranslationFiles(source: String, type: String, file_hashes: List<String>, message: String)
Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation change.
| name | type | required | description |
|---|---|---|---|
| source | String | true | Error source, must be translation_files |
| type | String | true | Type of element of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration” |
| file_hashes | List | true | List of base64-encoded file hashes |
| message | String | true | Error message |
PassportElementErrorUnspecified(source: String, type: String, element_hash: String, message: String)
Represents an issue in an unspecified place. The error is considered resolved when new data is added.
| name | type | required | description |
|---|---|---|---|
| source | String | true | Error source, must be unspecified |
| type | String | true | Type of element of the user's Telegram Passport which has the issue |
| element_hash | String | true | Base64-encoded element hash |
| message | String | true | Error message |
setPassportDataErrors(user_id: Integer, errors: List<PassportElementError>)
Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.
Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.
| name | type | required | description |
|---|---|---|---|
| user_id | Integer | true | User identifier |
| errors | List | true | A JSON-serialized array describing the errors |
Game(title: String, description: String, photo: List<PhotoSize>, text: String, text_entities: List<MessageEntity>, animation: Animation)
This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.
| name | type | required | description |
|---|---|---|---|
| title | String | true | Title of the game |
| description | String | true | Description of the game |
| photo | List | true | Photo that will be displayed in the game message in chats. |
| text | String | false | Optional. Brief description of the game or high scores included in the game message. Can be automatically edited to include current high scores for the game when the bot calls setGameScore, or manually edited using editMessageText. 0-4096 characters. |
| text_entities | List | false | Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc. |
| animation | Animation | false | Optional. Animation that will be displayed in the game message in chats. Upload via BotFather |
GameHighScore(position: Integer, user: User, score: Integer)
This object represents one row of the high scores table for a game.
And that's about all we've got for now.
If you've got any questions, please check out our Bot FAQ »
| name | type | required | description |
|---|---|---|---|
| position | Integer | true | Position in high score table for the game |
| user | User | true | User |
| score | Integer | true | Score |
sendGame(chat_id: Integer, game_short_name: String, disable_notification: Boolean, protect_content: Boolean, reply_to_message_id: Integer, allow_sending_without_reply: Boolean, reply_markup: InlineKeyboardMarkup)
Use this method to send a game. On success, the sent Message is returned.
| name | type | required | description |
|---|---|---|---|
| chat_id | Integer | true | Unique identifier for the target chat |
| game_short_name | String | true | Short name of the game, serves as the unique identifier for the game. Set up your games via Botfather. |
| disable_notification | Boolean | false | Sends the message silently. Users will receive a notification with no sound. |
| protect_content | Boolean | false | Protects the contents of the sent message from forwarding and saving |
| reply_to_message_id | Integer | false | If the message is a reply, ID of the original message |
| allow_sending_without_reply | Boolean | false | Pass True, if the message should be sent even if the specified replied-to message is not found |
| reply_markup | InlineKeyboardMarkup | false | A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game. |
setGameScore(user_id: Integer, score: Integer, force: Boolean, disable_edit_message: Boolean, chat_id: Integer, message_id: Integer, inline_message_id: String)
Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.
| name | type | required | description |
|---|---|---|---|
| user_id | Integer | true | User identifier |
| score | Integer | true | New score, must be non-negative |
| force | Boolean | false | Pass True, if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters |
| disable_edit_message | Boolean | false | Pass True, if the game message should not be automatically edited to include the current scoreboard |
| chat_id | Integer | false | Required if inline_message_id is not specified. Unique identifier for the target chat |
| message_id | Integer | false | Required if inline_message_id is not specified. Identifier of the sent message |
| inline_message_id | String | false | Required if chat_id and message_id are not specified. Identifier of the inline message |
getGameHighScores(user_id: Integer, chat_id: Integer, message_id: Integer, inline_message_id: String)
Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. On success, returns an Array of GameHighScore objects.
This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and his neighbors are not among them. Please note that this behavior is subject to change.
| name | type | required | description |
|---|---|---|---|
| user_id | Integer | true | Target user id |
| chat_id | Integer | false | Required if inline_message_id is not specified. Unique identifier for the target chat |
| message_id | Integer | false | Required if inline_message_id is not specified. Identifier of the sent message |
| inline_message_id | String | false | Required if chat_id and message_id are not specified. Identifier of the inline message |