https://github.com/omarmiatello/telegram-api-generator
Parse https://core.telegram.org/bots/api page and generate a Kotlin class "DocSection" with "DocType" and "DocMethod"
https://github.com/omarmiatello/telegram-api-generator
api-generator documentation json kotlin markdown parser telegram
Last synced: 10 months ago
JSON representation
Parse https://core.telegram.org/bots/api page and generate a Kotlin class "DocSection" with "DocType" and "DocMethod"
- Host: GitHub
- URL: https://github.com/omarmiatello/telegram-api-generator
- Owner: omarmiatello
- License: mit
- Created: 2019-02-23T13:14:45.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-08-14T12:54:18.000Z (almost 2 years ago)
- Last Synced: 2025-04-28T02:36:26.013Z (about 1 year ago)
- Topics: api-generator, documentation, json, kotlin, markdown, parser, telegram
- Language: Kotlin
- Homepage:
- Size: 2.15 MB
- Stars: 15
- Watchers: 0
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# telegram-api-generator
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](src/main/kotlin/GeneratorKotlin.kt) | [TelegramModelsOnly.kt](example/TelegramModelsOnly.kt) |
| Kotlin (Kotlin/Serialization + Ktor client) | [GeneratorKotlin.kt](src/main/kotlin/GeneratorKotlin.kt) | [TelegramModels.kt](example/TelegramModels.kt) + [TelegramClient.kt](example/TelegramClient.kt) |
| Rust (data class only) | [GeneratorRust.kt](src/main/kotlin/GeneratorRust.kt) | [TelegramModels.rs](example/TelegramModels.rs) |
| Json | [GeneratorJson.kt](src/main/kotlin/GeneratorJson.kt) | [telegram.json](example/telegram.json) |
| Markdown | [GeneratorReadmeExample.kt](src/main/kotlin/GeneratorReadmeExample.kt) | [telegram.md](example/telegram.md) or [telegram_full.md](example/telegram_full.md) or [telegram_tiny.md](example/telegram_tiny.md) |
| Build your own ... |
## Library
Libraries build with this tool
| Language | Repo |
| --- | --- |
| Kotlin | https://github.com/omarmiatello/telegram |
## Kotlin Example
[TelegramClient.kt](example/TelegramClient.kt)
```kotlin
class TelegramClient(apiKey: String, httpClient: HttpClient) {
// ...
/**
*
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.
*
*
* @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 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.
* @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 Update 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.
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]
* */
fun getUpdates(
offset: Int? = null,
limit: Int? = null,
timeout: Int? = null,
allowed_updates: List? = null
) = telegram(
"$basePath/getUpdates",
TelegramRequest.GetUpdatesRequest(
offset,
limit,
timeout,
allowed_updates
).toJsonForRequest(),
ListSerializer(Update.serializer())
)
// ...
}
```
[TelegramModels.kt](example/TelegramModels.kt)
```kotlin
// Getting updates
/**
*
This object represents an incoming update.
At most one of the optional parameters can be present in any given update.
*
* @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 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.
* @property message Optional. New incoming message of any kind — text, photo, sticker, etc.
* @property edited_message Optional. New version of a message that is known to the bot and was edited
* @property channel_post Optional. New incoming channel post of any kind — text, photo, sticker, etc.
* @property edited_channel_post Optional. New version of a channel post that is known to the bot and was edited
* @property inline_query Optional. New incoming inline query
* @property chosen_inline_result 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.
* @property callback_query Optional. New incoming callback query
* @property shipping_query Optional. New incoming shipping query. Only for invoices with flexible price
* @property pre_checkout_query Optional. New incoming pre-checkout query. Contains full information about checkout
* @property poll Optional. New poll state. Bots receive only updates about stopped polls and polls, which are sent by the bot
* @property poll_answer 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.
* @property my_chat_member 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.
* @property chat_member 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.
* @property chat_join_request 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.
*
* @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)
}
}
// ...
```
## Example Markdown
Below an example generated with [GeneratorReadmeExample.kt](src/main/kotlin/GeneratorReadmeExample.kt)
---
## Getting updates
### Data Types
#### Update
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
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)
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 |
### Methods
#### getUpdates
getUpdates(offset: Integer, limit: Integer, timeout: Integer, allowed_updates: List)
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
setWebhook(url: String, certificate: InputFile, ip_address: String, max_connections: Integer, allowed_updates: List, 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
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
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.
## Available types
### Data Types
#### User
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
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(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, animation: Animation, audio: Audio, document: Document, photo: List, sticker: Sticker, video: Video, video_note: VideoNote, voice: Voice, caption: String, caption_entities: List, contact: Contact, dice: Dice, game: Game, poll: Poll, venue: Venue, location: Location, new_chat_members: List, left_chat_member: User, new_chat_title: String, new_chat_photo: List, 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
MessageId(message_id: Integer)
This object represents a unique message identifier.
| name | type | required | description |
|---|---|---|---|
| message_id | Integer | true | Unique message identifier |
#### MessageEntity
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
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
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
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
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
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
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
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
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
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 “
”, “
” and “
” base emoji, 1-5 for “
” and “
” base emoji, 1-64 for “
” base emoji |
#### PollOption
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
PollAnswer(poll_id: String, user: User, option_ids: List)
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
Poll(id: String, question: String, options: List, 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, 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
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
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
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
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
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
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
VoiceChatParticipantsInvited(users: List)
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
UserProfilePhotos(total_count: Integer, photos: List>)
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> | true | Requested profile pictures (in up to 4 sizes each) |
#### File
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
ReplyKeyboardMarkup(keyboard: List>, 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> | 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
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
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
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
InlineKeyboardMarkup(inline_keyboard: List>)
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> | true | Array of button rows, each represented by an Array of InlineKeyboardButton objects |
#### InlineKeyboardButton
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
InputMediaPhoto(type: String, media: String, caption: String, parse_mode: ParseMode, caption_entities: List)
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
InputMediaVideo(type: String, media: String, thumb: InputFileOrString, caption: String, parse_mode: ParseMode, caption_entities: List, 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
InputMediaAnimation(type: String, media: String, thumb: InputFileOrString, caption: String, parse_mode: ParseMode, caption_entities: List, 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
InputMediaAudio(type: String, media: String, thumb: InputFileOrString, caption: String, parse_mode: ParseMode, caption_entities: List, 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
InputMediaDocument(type: String, media: String, thumb: InputFileOrString, caption: String, parse_mode: ParseMode, caption_entities: List, 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. |
## Available methods
### Methods
#### logOut
logOut()
Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.
#### close
close()
Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.
#### sendMessage
sendMessage(chat_id: IntegerOrString, text: String, parse_mode: ParseMode, entities: List, 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
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<
”, “
” and “
” base emoji, 1-5 for “
” and “
” base emoji, 1-64 for “
” base emoji |