The Bot API is an HTTP-based interface created for developers keen on building bots for Telegram.
To learn how to create and set up a bot, please consult our Introduction to Bots and Bot FAQ. 這個 bot API 是以 HTTP 為基礎的介面，為了給熱衷於構建 Telegram bot 的開發者而創建。
學習如何創建和設定 bot 請參考我們的 bot 介紹 和 bot FAQ.
這篇 bot API 是以中文所翻譯的文章，為了構建舒適的中文圈而貢獻。
參與翻譯請參考本篇的 GitHub ，感謝您 Orz。
Each bot is given a unique authentication token when it is created. The token looks something like 123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11, but we'll use simply <token> in this document instead. You can learn about obtaining tokens and generating new ones in this document.
每個 bot 在被創建時會被給予一道獨特的授權令牌。
授權令牌看起來像是 123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11 的樣子，
但我們將在本文中以簡單的 <token> 代替。
你能在 這篇文件
中學習到關於如何獲取令牌和產生新的一個 bot。
All queries to the Telegram Bot API must be served over HTTPS and need to be presented in this form: https://api.telegram.org/bot<token>/METHOD_NAME. Like this for example:
所有對 Telegram Bot API 的查詢必須被服務於 HTTPS 上，並且需要被提交像此格式：
https://api.telegram.org/bot<token>/METHOD_NAME 。
像是以這個為範例：
https://api.telegram.org/bot123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11/getMeWe support GET and POST HTTP methods. We support four ways of passing parameters in Bot API requests: 我們支援 GET 和 POST HTTP 方法。 我們對於 Bot API 的 request 支援四種傳遞參數的方式：
The response contains a JSON object, which always has a Boolean field ‘ok’ and may have an optional String field ‘description’ with a human-readable description of the result. If ‘ok’ equals true, the request was successful and the result of the query can be found in the ‘result’ field. In case of an unsuccessful request, ‘ok’ equals false and the error is explained in the ‘description’. An Integer ‘error_code’ field is also returned, but its contents are subject to change in the future. 這個 response 包含一個 JSON object，其中總是有一個 Boolean 欄位 ‘ok’ 和可能有一個可選的 String 欄位 ‘description’ 紀錄人類可閱讀的結果描述。 如果 ‘ok’ 等於 true，則 request 是成功的並且可以在 ‘result’ 欄位中找到其查詢的結果。 在非成功 request 的情況下，‘ok’ 等於 false 並且錯誤會在 ‘description’ 裡說明。 一個 Integer ‘error_code’ 欄位也會被回傳，但其內容很可能在未來被改變。 Some errors may also have an optional field ‘parameters’ of the type ResponseParameters, which can help to automatically handle the error.
If you're using webhooks, you can perform a request to the Bot API while sending an answer to the webhook. Use either application/json or application/x-www-form-urlencoded or multipart/form-data response content type for passing parameters. Specify the method to be invoked in the method parameter of the request. It's not possible to know that such a request was successful or get its result.
Please see our FAQ for examples.
There are two mutually exclusive ways of receiving updates for your bot — the getUpdates method on one hand and Webhooks on the other. Incoming updates are stored on the server until the bot receives them either way, but they will not be kept longer than 24 hours. 有兩種互斥的方式替你的 bot 來接收更新 — getUpdates 方法是一種，Webhooks 是另一種。 傳入更新被存儲在服務器上直到 bot 接收它們，無論以何種方式， 但其不會被存儲超過 24 小時。
Regardless of which option you choose, you will receive JSON-serialized Update objects as a result. 無論您選擇哪個選項，你都會接收到 JSON-serialized Update objects。
This object represents an incoming update.
At most one of the optional parameters can be present in any given update.
| Field | Type | Description |
| update_id | Integer | 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 | Optional. New incoming message of any kind — text, photo, sticker, etc. |
| edited_message | Message | Optional. New version of a message that is known to the bot and was edited |
| channel_post | Message | Optional. New incoming channel post of any kind — text, photo, sticker, etc. |
| edited_channel_post | Message | Optional. New version of a channel post that is known to the bot and was edited |
| inline_query | InlineQuery | Optional. New incoming inline query |
| chosen_inline_result | ChosenInlineResult | 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 | Optional. New incoming callback query |
| shipping_query | ShippingQuery | Optional. New incoming shipping query. Only for invoices with flexible price |
| pre_checkout_query | PreCheckoutQuery | Optional. New incoming pre-checkout query. Contains full information about checkout |
Use this method to receive incoming updates using long polling (wiki). An Array of Update objects is returned.
| Parameters | Type | Required | Description |
| offset | Integer | Optional | Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will forgotten. |
| limit | Integer | Optional | Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100. |
| timeout | Integer | Optional | Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only. |
| allowed_updates | Array of String | Optional | 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. |
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.
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.
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.
| Parameters | Type | Required | Description |
| url | String | Yes | HTTPS url to send updates to. Use an empty string to remove webhook integration 發送更新到達 HTTPS 網址。 使用空 string 來移除 webhook integration |
| certificate | InputFile | Optional | Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details. |
| max_connections | Integer | Optional | Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot‘s server, and higher values to increase your bot’s throughput. HTTPS 同時連限至用於投遞更新的 webhook 的最大允許數量， 1-100。 預設值為 40。 使用較低的值來限制 bot 服務器的負載， 使用較高的值來增加 bot 的處理能力。 |
| allowed_updates | Array of String | Optional |
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.
列出你想要 bot 接收的更新類型。
例如， 指定 [“message”, “edited_channel_post”, “callback_query”]
就只接收這些類型的更新。
查看 Update 有關於可用更新類型的完整列表。
指定一個空列表來接收所有更新類型（預設）。
如果未指定， 則將使用之前的設置。
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. 請注意此參數不會影響在調用 setWebhook 之前被創建的更新， 所以可能會在短時間內收到不想要的更新。 |
Notes
1. You will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up. 只要設置了傳出的 webhook， 您將不能使用 getUpdates 去接收更新。
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. 您需要使用 certificate 參數上傳 公鑰證書 。 請以 InputFile 上傳， 發送一個 String 將無法工作。
3. Ports currently supported for Webhooks: 443, 80, 88, 8443. Webhooks 當前支持的埠口： 443, 80, 88, 8443.NEW! If you're having any trouble setting up webhooks, please check out this amazing guide to Webhooks. 如果您在設置 webhooks 有遇到任何困難， 請查看這個 令人驚嘆的 Webhooks 指南 。
Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success. Requires no parameters. 如果您決定切換回 getUpdates ， 使用此方法移除 webhook integration。 成功時傳回 True。 不需要參數。
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. 使用此方法取得當前的 webhook 狀態。 不需要參數。 成功時，回傳一個 WebhookInfo object。 如果 bot 使用 getUpdates 將回傳一個 url 欄位為空值的物件。
Contains information about the current status of a webhook.
| Field | Type | Description |
| url | String | Webhook URL, may be empty if webhook is not set up |
| has_custom_certificate | Boolean | True, if a custom certificate was provided for webhook certificate checks |
| pending_update_count | Integer | Number of updates awaiting delivery |
| last_error_date | Integer | Optional. Unix time for the most recent error that happened when trying to deliver an update via webhook |
| last_error_message | String | 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 | Optional. Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery |
| allowed_updates | Array of String | Optional. A list of update types the bot is subscribed to. Defaults to all update types |
All types used in the Bot API responses are represented as JSON-objects.
It is safe to use 32-bit signed integers for storing all Integer fields unless otherwise noted.
Optional fields may be not returned when irrelevant.
This object represents a Telegram user or bot.
| Field | Type | Description |
| id | Integer | Unique identifier for this user or bot |
| is_bot | Boolean | True, if this user is a bot |
| first_name | String | User‘s or bot’s first name |
| last_name | String | Optional. User‘s or bot’s last name |
| username | String | Optional. User‘s or bot’s username |
| language_code | String | Optional. IETF language tag of the user's language |
This object represents a chat.
| Field | Type | Description |
| id | Integer | Unique identifier for this chat. This number may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. |
| type | String | Type of chat, can be either “private”, “group”, “supergroup” or “channel” |
| title | String | Optional. Title, for supergroups, channels and group chats |
| username | String | Optional. Username, for private chats, supergroups and channels if available |
| first_name | String | Optional. First name of the other party in a private chat |
| last_name | String | Optional. Last name of the other party in a private chat |
| all_members_are_administrators | Boolean | Optional. True if a group has ‘All Members Are Admins’ enabled. |
| photo | ChatPhoto | Optional. Chat photo. Returned only in getChat. |
| description | String | Optional. Description, for supergroups and channel chats. Returned only in getChat. |
| invite_link | String | Optional. Chat invite link, for supergroups and channel chats. Returned only in getChat. |
| pinned_message | Message | Optional. Pinned message, for supergroups and channel chats. Returned only in getChat. |
| sticker_set_name | String | Optional. For supergroups, name of group sticker set. Returned only in getChat. |
| can_set_sticker_set | Boolean | Optional. True, if the bot can change the group sticker set. Returned only in getChat. |
This object represents a message. 這個 object 表示一個訊息。
| Field | Type | Description |
| message_id | Integer | Unique message identifier inside this chat 在這個 chat 中唯一的訊息識別碼 |
| from | User | Optional. Sender, empty for messages sent to channels |
| date | Integer | Date the message was sent in Unix time 訊息被發送的時間，以 Unix 時間 [註1] 表示 |
| chat | Chat | Conversation the message belongs to 訊息所屬的對話 |
| forward_from | User | Optional. For forwarded messages, sender of the original message |
| forward_from_chat | Chat | Optional. For messages forwarded from channels, information about the original channel |
| forward_from_message_id | Integer | Optional. For messages forwarded from channels, identifier of the original message in the channel |
| forward_signature | String | Optional. For messages forwarded from channels, signature of the post author if present |
| forward_date | Integer | Optional. For forwarded messages, date the original message was sent in Unix time |
| reply_to_message | Message | 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. |
| edit_date | Integer | Optional. Date the message was last edited in Unix time |
| media_group_id | String | Optional. The unique identifier of a media message group this message belongs to |
| author_signature | String | Optional. Signature of the post author for messages in channels |
| text | String | Optional. For text messages, the actual UTF-8 text of the message, 0-4096 characters. 可選的。 對於 text 訊息中實際的 UTF-8 文本，0-4096 字符。 [註2] |
| entities | Array of MessageEntity | Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text 可選的。 對於 text 訊息中特別的實體像是 用戶名、網址、bot 命令 ... 等。 |
| caption_entities | Array of MessageEntity | Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption |
| audio | Audio | Optional. Message is an audio file, information about the file |
| document | Document | Optional. Message is a general file, information about the file |
| game | Game | Optional. Message is a game, information about the game. More about games » |
| photo | Array of PhotoSize | Optional. Message is a photo, available sizes of the photo |
| sticker | Sticker | Optional. Message is a sticker, information about the sticker |
| video | Video | Optional. Message is a video, information about the video |
| voice | Voice | Optional. Message is a voice message, information about the file |
| video_note | VideoNote | Optional. Message is a video note, information about the video message |
| caption | String | Optional. Caption for the audio, document, photo, video or voice, 0-200 characters |
| contact | Contact | Optional. Message is a shared contact, information about the contact |
| location | Location | Optional. Message is a shared location, information about the location |
| venue | Venue | Optional. Message is a venue, information about the venue |
| new_chat_members | Array of User | 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 | Optional. A member was removed from the group, information about them (this member may be the bot itself) |
| new_chat_title | String | Optional. A chat title was changed to this value |
| new_chat_photo | Array of PhotoSize | Optional. A chat photo was change to this value |
| delete_chat_photo | True | Optional. Service message: the chat photo was deleted |
| group_chat_created | True | Optional. Service message: the group has been created |
| supergroup_chat_created | True | 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 | True | 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. |
| migrate_to_chat_id | Integer | Optional. The group has been migrated to a supergroup with the specified identifier. This number may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. |
| migrate_from_chat_id | Integer | Optional. The supergroup has been migrated from a group with the specified identifier. This number may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. |
| pinned_message | Message | 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 | Optional. Message is an invoice for a payment, information about the invoice. More about payments » |
| successful_payment | SuccessfulPayment | Optional. Message is a service message about a successful payment, information about the payment. More about payments » |
| connected_website | String | Optional. The domain name of the website on which the user has logged in. More about Telegram Login » |
This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.
| Field | Type | Description |
| type | String | Type of the entity. Can be mention (@username), hashtag, bot_command, url, email, bold (bold text), italic (italic text), code (monowidth string), pre (monowidth block), text_link (for clickable text URLs), text_mention (for users without usernames) |
| offset | Integer | Offset in UTF-16 code units to the start of the entity |
| length | Integer | Length of the entity in UTF-16 code units |
| url | String | Optional. For “text_link” only, url that will be opened after user taps on the text |
| user | User | Optional. For “text_mention” only, the mentioned user |
This object represents one size of a photo or a file / sticker thumbnail.
| Field | Type | Description |
| file_id | String | Unique identifier for this file |
| width | Integer | Photo width |
| height | Integer | Photo height |
| file_size | Integer | Optional. File size |
This object represents an audio file to be treated as music by the Telegram clients.
| Field | Type | Description |
| file_id | String | Unique identifier for this file |
| duration | Integer | Duration of the audio in seconds as defined by sender |
| performer | String | Optional. Performer of the audio as defined by sender or by audio tags |
| title | String | Optional. Title of the audio as defined by sender or by audio tags |
| mime_type | String | Optional. MIME type of the file as defined by sender |
| file_size | Integer | Optional. File size |
This object represents a general file (as opposed to photos, voice messages and audio files).
| Field | Type | Description |
| file_id | String | Unique file identifier |
| thumb | PhotoSize | Optional. Document thumbnail as defined by sender |
| file_name | String | Optional. Original filename as defined by sender |
| mime_type | String | Optional. MIME type of the file as defined by sender |
| file_size | Integer | Optional. File size |
This object represents a video file.
| Field | Type | Description |
| file_id | String | Unique identifier for this file |
| width | Integer | Video width as defined by sender |
| height | Integer | Video height as defined by sender |
| duration | Integer | Duration of the video in seconds as defined by sender |
| thumb | PhotoSize | Optional. Video thumbnail |
| mime_type | String | Optional. Mime type of a file as defined by sender |
| file_size | Integer | Optional. File size |
This object represents a voice note.
| Field | Type | Description |
| file_id | String | Unique identifier for this file |
| duration | Integer | Duration of the audio in seconds as defined by sender |
| mime_type | String | Optional. MIME type of the file as defined by sender |
| file_size | Integer | Optional. File size |
This object represents a video message (available in Telegram apps as of v.4.0).
| Field | Type | Description |
| file_id | String | Unique identifier for this file |
| length | Integer | Video width and height as defined by sender |
| duration | Integer | Duration of the video in seconds as defined by sender |
| thumb | PhotoSize | Optional. Video thumbnail |
| file_size | Integer | Optional. File size |
This object represents a phone contact.
| Field | Type | Description |
| phone_number | String | Contact's phone number |
| first_name | String | Contact's first name |
| last_name | String | Optional. Contact's last name |
| user_id | Integer | Optional. Contact's user identifier in Telegram |
This object represents a point on the map.
| Field | Type | Description |
| longitude | Float | Longitude as defined by sender |
| latitude | Float | Latitude as defined by sender |
This object represents a venue.
| Field | Type | Description |
| location | Location | Venue location |
| title | String | Name of the venue |
| address | String | Address of the venue |
| foursquare_id | String | Optional. Foursquare identifier of the venue |
This object represent a user's profile pictures.
| Field | Type | Description |
| total_count | Integer | Total number of profile pictures the target user has |
| photos | Array of Array of PhotoSize | Requested profile pictures (in up to 4 sizes each) |
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
| Field | Type | Description |
| file_id | String | Unique identifier for this file |
| file_size | Integer | Optional. File size, if known |
| file_path | String | Optional. File path. Use https://api.telegram.org/file/bot<token>/<file_path> to get the file. |
This object represents a custom keyboard with reply options (see Introduction to bots for details and examples). 此 object 表示帶回覆選項的 客製化鍵盤 （詳細信息和示例見 bots 簡介）。
| Field | Type | Description |
| keyboard | Array of Array of KeyboardButton | Array of button rows, each represented by an Array of KeyboardButton objects 按鈕行的 Array，每行以 KeyboardButton objects 組成的 Array 表示 |
| resize_keyboard | Boolean | 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. 可選的。 請求客戶端調整垂直方向鍵盤至最適合的尺寸 （例如： 如果只有兩列按鈕，則鍵盤變小）。 預設為 false， 在此情況下，客製化鍵盤始終與應用程式標準鍵盤的高度相同。 |
| one_time_keyboard | Boolean | 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. 可選的。 請求客戶端在使用後立即隱藏鍵盤。 鍵盤仍然可用，但客戶端會自動在 chat 中顯示一般的字母鍵盤 – 用戶可以按下輸入欄位中的特殊按鈕來再次查看客製化鍵盤。 預設為 false。 |
| selective | Boolean |
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.
可選的。
如果您只想給指定用戶顯示鍵盤，請使用此參數。
目標對象：
1）Message object 的 text 中 @mentioned 提及的用戶；
2）如果 bot 的訊息是一則回覆訊息（有 reply_to_message_id），則為原始訊息的發送者。
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. 例如： 用戶請求更改機器人的語言， bot 用鍵盤回覆請求來選擇新語言。 群組中的其他用戶看不到該鍵盤。 |
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 are mutually exclusive. 此 object 表示一個回覆鍵盤的按鈕。 這是個簡單的文本按鈕並在回傳時以該 String 代表此 object。 [註4] 可選的欄位是互斥的。
| Field | Type | Description |
| text | String | 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 | Optional. If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only 可選的。 如果為 True，當按下按鈕時用戶的電話號碼將被作為聯絡人發送。 僅有效於私人的 chats 中 |
| request_location | Boolean | Optional. If True, the user's current location will be sent when the button is pressed. Available in private chats only 可選的。 如果為 True，當按下按鈕時用戶的當前位置將被發送。 僅有效於私人的 chats 中 |
Note: request_contact and request_location options will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them. request_contact 和 request_location 選項只適用於 2016 年 4 月 9 日之後發布的 Telegram 版本。 較舊的客戶端將忽略它們。
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). 一旦接收到此 object 的訊息時，Telegram 客戶端將移除當前的客製化鍵盤並顯示預設的字母鍵盤。 預設情況下，客製化鍵盤會被顯示直到 bot 發送新的鍵盤。 使用當用戶按下按鈕後立即隱藏的一次性鍵盤是個例外 （見 ReplyKeyboardMarkup）。
| Field | Type | Description |
| remove_keyboard | 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) 請求客戶端移除客製化鍵盤（用戶將無法喚回此鍵盤； 如果你是想隱藏鍵盤但仍保持其有效，請使用 ReplyKeyboardMarkup 中的 one_time_keyboard） |
| selective | Boolean |
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.
可選的。
如果您只想對指定用戶移除鍵盤，請使用此參數。
目標對象：
1）Message object 的 text 中 @mentioned 提及的用戶；
2）如果 bot 的訊息是一則回覆訊息（有 reply_to_message_id），則為原始訊息的發送者。
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. 例如： 一位用戶投下意見調查的投票 [註6]， bot 對該用戶在回覆中回傳已投票的確認訊息並移除其鍵盤。 同時仍然向尚未投票的用戶顯示意見調查選項的鍵盤。 |
This object represents an inline keyboard that appears right next to the message it belongs to. 此 object 表示一個出現在所屬消息旁邊的 內嵌鍵盤。
| Field | Type | Description |
| inline_keyboard | Array of Array of InlineKeyboardButton | Array of button rows, each represented by an Array of InlineKeyboardButton objects 按鈕行的 Array，每行以 InlineKeyboardButton objects 組成的 Array 表示 |
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message. 這只適用於 2016 年 4 月 9 日之後發布的 Telegram 版本。 較舊的客戶端將顯示 unsupported message。
This object represents one button of an inline keyboard. You must use exactly one of the optional fields. 此 object 表示一個內嵌鍵盤的按鈕。 你 必須 確切地使用可選欄位中的其中之一。
| Field | Type | Description |
| text | String | Label text on the button |
| url | String | Optional。 HTTP url to be opened when button is pressed 可選的。 當按下按鈕時， HTTP 網址將被開啟 |
| callback_data | String | Optional。 Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes 可選的。 當按下按鈕時，數據被以 callback query 發送到 bot，1-64 字節 |
| switch_inline_query | String |
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.
可選的。
如果有設置，
按下按鈕將提示用戶選擇一個其擁有的 chats，
開啟該 chat 並在輸入欄位中插入 bot 的用戶名和指定的 inline query。
可以是空的，在此情況下只會插入 bot 的用戶名。
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. 當他們正與你的 bot 在私人的 chat 時， 這為用戶提供一種簡單的方式開始以 內嵌模式 使用你的 bot。 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 |
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.
可選的。
如果有設置，
按下按鈕將在當前 chat 的輸入欄位中插入 bot 的用戶名和指定的 inline query。
可以是空的，在此情況下只會插入 bot 的用戶名。
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. 這為用戶提供一種快速的方式在同一個 chat 中以內嵌模式開啟你的 bot。 - 適用於從多個選項中選擇某項。 |
| callback_game | CallbackGame |
Optional. Description of the game that will be launched when the user presses the button.
可選的。
當用戶按下按鈕時，遊戲說明將被啟動。
NOTE: This type of button must always be the first button in the first row. 這種類型的按鈕 必須 是第一行中的第一個按鈕。 |
| pay | Boolean |
Optional. Specify True, to send a Pay button.
可選的。
Specify True, to send a Pay button.
NOTE: This type of button must always be the first button in the first row. 這種類型的按鈕 必須 是第一行中的第一個按鈕。 |
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. 此 object 表示來自 內嵌鍵盤 的 callback button 傳入的 callback query。 如果發起 query 的按鈕 was attached to a message sent by the bot, 將出現 message 欄位。 如果該按鈕 was attached to a message sent via the bot (in 內嵌模式), 將出現 inline_message_id 欄位。 將出現 data 或 game_short_name 欄位中的一個。
| Field | Type | Description |
| id | String | Unique identifier for this query |
| from | User | Sender |
| message | Message | Optional. Message with the callback button that originated the query. Note that message content and message date will not be available if the message is too old |
| inline_message_id | String | Optional. Identifier of the message sent via the bot in inline mode, that originated the query. |
| chat_instance | String | 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 | Optional. Data associated with the callback button. Be aware that a bad client can send arbitrary data in this field. |
| game_short_name | String | Optional. Short name of a Game to be returned, serves as the unique identifier for the game |
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).
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. 一旦接收此 object 的訊息時，Telegram 客戶端會向用戶顯示一個回覆界面 （動作如同用戶已經選擇 bot 的訊息並點擊「回覆」）。 如果您想創建友善用戶的按步操作界面又不犧牲 私人模式，這會是非常有用。
| Field | Type | Description |
| force_reply | True | Shows reply interface to the user, as if they manually selected the bot‘s message and tapped ’Reply' 向用戶顯示回覆界面，如同用戶已經選擇 bot 的訊息並點擊「回覆」 |
| selective | Boolean | 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. 可選的。 如果您只想給指定用戶顯示鍵盤，請使用此參數。 目標對象： 1）Message object 的 text 中 @mentioned 提及的用戶； 2）如果 bot 的訊息是一則回覆訊息（有 reply_to_message_id），則為原始訊息的發送者。 |
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: 在私人模式的群組運行的 poll bot 只可接收 命令、對其訊息的回覆、提及 [註4]。 有兩種方法可以創建新的意見調查：
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. 最後的選項肯定是更有吸引力。 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.
This object represents a chat photo.
| Field | Type | Description |
| small_file_id | String | Unique file identifier of small (160x160) chat photo. This file_id can be used only for photo download. |
| big_file_id | String | Unique file identifier of big (640x640) chat photo. This file_id can be used only for photo download. |
This object contains information about one member of a chat.
| Field | Type | Description |
| user | User | Information about the user |
| status | String | The member's status in the chat. Can be “creator”, “administrator”, “member”, “restricted”, “left” or “kicked” |
| until_date | Integer | Optional. Restricted and kicked only. Date when restrictions will be lifted for this user, unix time |
| can_be_edited | Boolean | Optional. Administrators only. True, if the bot is allowed to edit administrator privileges of that user |
| can_change_info | Boolean | Optional. Administrators only. True, if the administrator can change the chat title, photo and other settings |
| can_post_messages | Boolean | Optional. Administrators only. True, if the administrator can post in the channel, channels only |
| can_edit_messages | Boolean | Optional. Administrators only. True, if the administrator can edit messages of other users and can pin messages, channels only |
| can_delete_messages | Boolean | Optional. Administrators only. True, if the administrator can delete messages of other users |
| can_invite_users | Boolean | Optional. Administrators only. True, if the administrator can invite new users to the chat |
| can_restrict_members | Boolean | Optional. Administrators only. True, if the administrator can restrict, ban or unban chat members |
| can_pin_messages | Boolean | Optional. Administrators only. True, if the administrator can pin messages, supergroups only |
| can_promote_members | Boolean | Optional. Administrators only. True, if the administrator can add new administrators with a subset of his own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by the user) |
| can_send_messages | Boolean | Optional. Restricted only. True, if the user can send text messages, contacts, locations and venues |
| can_send_media_messages | Boolean | Optional. Restricted only. True, if the user can send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages |
| can_send_other_messages | Boolean | Optional. Restricted only. True, if the user can send animations, games, stickers and use inline bots, implies can_send_media_messages |
| can_add_web_page_previews | Boolean | Optional. Restricted only. True, if user may add web page previews to his messages, implies can_send_media_messages |
Contains information about why a request was unsuccessful. 包含關於為何 request 不成功的資訊。
| Field | Type | Description |
| migrate_to_chat_id | Integer | Optional. The group has been migrated to a supergroup with the specified identifier. This number may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. 可選的。 此群組已經被遷移到具有指定識別碼的 supergroup。 這組數字可能大於 32 位元 [註:wiki] ，某些程式語言可能在解析它上會有困難或無聲的缺陷。 不過它小於 52 位元，所以一個有符號的 64 位 [註:wiki] integer 或 double-precision float 類型對於儲存這個識別碼是安全地。 |
| retry_after | Integer | Optional. In case of exceeding flood control, the number of seconds left to wait before the request can be repeated 可選的。 當超過 flood control [註:wiki] 的情況時， 此數字是在 request 能被重複之前需等待的秒數 |
This object represents the content of a media message to be sent. It should be one of
Represents a photo to be sent.
| Field | Type | Description |
| type | String | Type of the result, must be photo |
| media | String | 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 | Optional. Caption of the photo to be sent, 0-200 characters |
| parse_mode | String | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
Represents a video to be sent.
| Field | Type | Description |
| type | String | Type of the result, must be video |
| media | String | 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 | Optional. Caption of the video to be sent, 0-200 characters |
| parse_mode | String | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
| width | Integer | Optional. Video width |
| height | Integer | Optional. Video height |
| duration | Integer | Optional. Video duration |
| supports_streaming | Boolean | Optional. Pass True, if the uploaded video is suitable for streaming |
This object represents the contents of a file to be uploaded. Must be posted using multipart/form-data in the usual way that files are uploaded via the browser.
There are three ways to send files (photos, stickers, audio, media, etc.): 有三種方式發送文件（圖片 photos、貼紙 stickers、音頻 audio、媒體 media ... 等）：
Sending by file_id 以 file_id 發送
Sending by URL 以 URL 發送
Objects and methods used in the inline mode are described in the Inline mode section. 內嵌模式使用的 objects 和 methods 在 內嵌模式部分 中介紹。
All methods in the Bot API are case-insensitive. We support GET and POST HTTP methods. Use either URL query string or application/json or application/x-www-form-urlencoded or multipart/form-data for passing parameters in Bot API requests.
On successful call, a JSON-object containing the result will be returned. 所有 Bot API 的方法是不區分大小寫的。 我們支持 GET 和 POST HTTP 方法。 使用 URL query string 或 application/json 或 application/x-www-form-urlencoded 或 multipart/form-data 在 Bot API request 中的傳遞參數。
在成功的調用時，一個包含 result 的 JSON-object 將被回傳。
A simple method for testing your bot's auth token. Requires no parameters. Returns basic information about the bot in form of a User object. 一個簡單的方法去測試你 bot 的 auth 令牌。 不需要參數。 會以 User object 的型式回傳關於 bot 的基本資訊。
Use this method to send text messages. On success, the sent Message is returned. 使用此方法去寄送文本訊息。 成功時會回傳 Message。
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes |
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
目標 chat 的唯一識別碼或者目標 channel
[註3]
的用戶名 （以 @channelusername 格式）
|
| text | String | Yes | Text of the message to be sent 被發送的訊息文本 |
| parse_mode | String | Optional | Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message. |
| disable_web_page_preview | Boolean | Optional | Disables link previews for links in this message 對於訊息中的連結禁用連結預覽 |
| disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. 寄送 silently 的訊息。 用戶將收到無聲的通知。 |
| reply_to_message_id | Integer | Optional | If the message is a reply, ID of the original message 如果這是一則回覆訊息，則填上原始訊息的識別碼 |
| reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Optional | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. 附加的界面選項。 對於 內嵌鍵盤 、 客製化回覆鍵盤 、 移除回覆鍵盤命令 及 強制用戶回覆命令 的 JSON-serialized object。 |
The Bot API supports basic formatting for messages. You can use bold and italic text, as well as inline links and pre-formatted code in your bots' messages. Telegram clients will render them accordingly. You can use either markdown-style or HTML-style formatting.
Note that Telegram clients will display an alert to the user before opening an inline link (‘Open this link?’ together with the full URL).
Links 'tg://user?id=<user_id>' can be used to mention a user by their id without using a username. Please note:
To use this mode, pass Markdown in the parse_mode field when using sendMessage. Use the following syntax in your message:
*bold text*
_italic text_
[inline URL](http://www.example.com/)
[inline mention of a user](tg://user?id=123456789)
`inline fixed-width code`
```block_language
pre-formatted fixed-width code block
```To use this mode, pass HTML in the parse_mode field when using sendMessage. The following tags are currently supported:
<b>bold</b>, <strong>bold</strong>
<i>italic</i>, <em>italic</em>
<a href="http://www.example.com/">inline URL</a>
<a href="tg://user?id=123456789">inline mention of a user</a>
<code>inline fixed-width code</code>
<pre>pre-formatted fixed-width code block</pre>Please note:
<, > and & symbols that are not a part of a tag or an HTML entity must be replaced with the corresponding HTML entities (< with <, > with > and & with &).<, >, & and ".Use this method to forward messages of any kind. On success, the sent Message is returned. 使用此方法轉發任何種類的訊息。 成功時會回傳 Message。
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes |
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
目標 chat 的唯一識別碼或者目標 channel
[註3]
的用戶名 （以 @channelusername 格式中）
|
| from_chat_id | Integer or String | Yes |
Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)
原始訊息被寄送到的 chat 的唯一識別碼
（或者以 @channelusername 格式的 channel
[註3]
的用戶名）
|
| disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. 寄送 silently 的訊息。 用戶將收到無聲的通知。 |
| message_id | Integer | Yes | Message identifier in the chat specified in from_chat_id 在 from_chat_id 的 chat 中被指定的訊息識別碼 |
Use this method to send photos. On success, the sent Message is returned. 使用這個方法去發送圖片。 成功時會回傳 Message。
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes |
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
目標 chat 的唯一識別碼或者目標 channel
[註3]
的用戶名 （以 @channelusername 格式中）
|
| photo | InputFile or String | Yes | 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. More info on Sending Files » 被發送的圖片。 傳遞 String 的 file_id 去發送已存在於 Telegram 服務器上的圖片（推薦）， 傳遞 String 的 HTTP 網址讓 Telegram 從 Internet 上取得的圖片， 或者使用 multipart/form-data 上傳新的圖片。 有關發送 file 的更多信息 » |
| caption | String | Optional | Photo caption (may also be used when resending photos by file_id), 0-200 characters 圖片說明（也能使用在以 file_id 發送圖片時）， 0-200 字符 |
| parse_mode | String | Optional | Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
| disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. 寄送 silently 的訊息。 用戶將收到無聲的通知。 |
| reply_to_message_id | Integer | Optional | If the message is a reply, ID of the original message 如果這是一則回覆訊息，則填上原始訊息的識別碼 |
| reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Optional | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. 附加的界面選項。 對於 內嵌鍵盤 、 客製化回覆鍵盤 、 移除回覆鍵盤命令 及 強制用戶回覆命令 的 JSON-serialized object。 |
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 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. 如果你希望 Telegram 客戶端在音樂播放器中顯示 audio 文件，請使用此方法發送它們。 你的 audio 必須為 .mp3 格式。 成功時回傳 Message。 目前可以發送最大 50 MB 的 audio 文件，這個限制在未來可能會改變。
For sending voice messages, use the sendVoice method instead. 要發送 voice messages，請使用 sendVoice 方法代替。
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes |
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
目標 chat 的唯一識別碼或者目標 channel
[註3]
的用戶名 （以 @channelusername 格式）
|
| audio | InputFile or String | Yes | Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files » 被發送的 audio 文件。 傳遞 String 的 file_id 去發送已存在於 Telegram 服務器上的 audio 文件（推薦）， 傳遞 String 的 HTTP 網址讓 Telegram 從 Internet 上取得的 audio 文件， 或者使用 multipart/form-data 上傳新的 audio 文件。 有關發送 file 的更多信息 » |
| caption | String | Optional | Audio caption, 0-200 characters Audio 說明， 0-200 字符 |
| parse_mode | String | Optional | Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
| duration | Integer | Optional | Duration of the audio in seconds |
| performer | String | Optional | Performer [註5] |
| title | String | Optional | Track name [註5] |
| disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. 寄送 silently 的訊息。 用戶將收到無聲的通知。 |
| reply_to_message_id | Integer | Optional | If the message is a reply, ID of the original message 如果這是一則回覆訊息，則填上原始訊息的識別碼 |
| reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Optional | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. 附加的界面選項。 對於 內嵌鍵盤 、 客製化回覆鍵盤 、 移除回覆鍵盤命令 及 強制用戶回覆命令 的 JSON-serialized object。 |
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.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| document | InputFile or String | Yes | 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 | Optional | Document caption (may also be used when resending documents by file_id), 0-200 characters |
| parse_mode | String | Optional | Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
| disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. |
| reply_to_message_id | Integer | Optional | If the message is a reply, ID of the original message |
| reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Optional | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. |
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.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| video | InputFile or String | Yes | 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 | Optional | Duration of sent video in seconds |
| width | Integer | Optional | Video width |
| height | Integer | Optional | Video height |
| caption | String | Optional | Video caption (may also be used when resending videos by file_id), 0-200 characters |
| parse_mode | String | Optional | Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
| supports_streaming | Boolean | Optional | Pass True, if the uploaded video is suitable for streaming |
| disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. |
| reply_to_message_id | Integer | Optional | If the message is a reply, ID of the original message |
| reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Optional | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. |
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. 如果你希望 Telegram 客戶端將 audio 文件顯示為可播放的 voice message，請使用此方法發送它們。 為此，你的 audio 必須以 OPUS 編碼為 .ogg 文件（其他格式可能被作為 Audio 或 Document 發送）。 成功時會回傳 Message。 目前可以發送最大 50 MB 的 audio 文件，這個限制在未來可能會改變。
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes |
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
目標 chat 的唯一識別碼或者目標 channel
[註3]
的用戶名 （以 @channelusername 格式）
|
| voice | InputFile or String | Yes | Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files » 被發送的 audio 文件。 傳遞 String 的 file_id 去發送已存在於 Telegram 服務器上的 audio 文件（推薦）， 傳遞 String 的 HTTP 網址讓 Telegram 從 Internet 上取得的 audio 文件， 或者使用 multipart/form-data 上傳新的 audio 文件。 有關發送 file 的更多信息 » |
| caption | String | Optional | Voice message caption, 0-200 characters Voice message 說明， 0-200 字符 |
| parse_mode | String | Optional | Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
| duration | Integer | Optional | Duration of the voice message in seconds |
| disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. 寄送 silently 的訊息。 用戶將收到無聲的通知。 |
| reply_to_message_id | Integer | Optional | If the message is a reply, ID of the original message 如果這是一則回覆訊息，則填上原始訊息的識別碼 |
| reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Optional | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. 附加的界面選項。 對於 內嵌鍵盤 、 客製化回覆鍵盤 、 移除回覆鍵盤命令 及 強制用戶回覆命令 的 JSON-serialized object。 |
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.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| video_note | InputFile or String | Yes | 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 | Optional | Duration of sent video in seconds |
| length | Integer | Optional | Video width and height |
| disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. |
| reply_to_message_id | Integer | Optional | If the message is a reply, ID of the original message |
| reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Optional | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. |
Use this method to send a group of photos or videos as an album. On success, an array of the sent Messages is returned.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| media | Array of InputMedia | Yes | A JSON-serialized array describing photos and videos to be sent, must include 2–10 items |
| disable_notification | Boolean | Optional | Sends the messages silently. Users will receive a notification with no sound. |
| reply_to_message_id | Integer | Optional | If the messages are a reply, ID of the original message |
Use this method to send point on the map. On success, the sent Message is returned.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| latitude | Float number | Yes | Latitude of the location |
| longitude | Float number | Yes | Longitude of the location |
| live_period | Integer | Optional | Period in seconds for which the location will be updated (see Live Locations, should be between 60 and 86400. |
| disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. |
| reply_to_message_id | Integer | Optional | If the message is a reply, ID of the original message |
| reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Optional | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. |
Use this method to edit live location messages sent by the bot or via the bot (for inline bots). 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 was sent by the bot, the edited Message is returned, otherwise True is returned.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Optional | Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| message_id | Integer | Optional | Required if inline_message_id is not specified. Identifier of the sent message |
| inline_message_id | String | Optional | Required if chat_id and message_id are not specified. Identifier of the inline message |
| latitude | Float number | Yes | Latitude of new location |
| longitude | Float number | Yes | Longitude of new location |
| reply_markup | InlineKeyboardMarkup | Optional | A JSON-serialized object for a new inline keyboard. |
Use this method to stop updating a live location message sent by the bot or via the bot (for inline bots) before live_period expires. On success, if the message was sent by the bot, the sent Message is returned, otherwise True is returned.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Optional | Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| message_id | Integer | Optional | Required if inline_message_id is not specified. Identifier of the sent message |
| inline_message_id | String | Optional | Required if chat_id and message_id are not specified. Identifier of the inline message |
| reply_markup | InlineKeyboardMarkup | Optional | A JSON-serialized object for a new inline keyboard. |
Use this method to send information about a venue. On success, the sent Message is returned.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| latitude | Float number | Yes | Latitude of the venue |
| longitude | Float number | Yes | Longitude of the venue |
| title | String | Yes | Name of the venue |
| address | String | Yes | Address of the venue |
| foursquare_id | String | Optional | Foursquare identifier of the venue |
| disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. |
| reply_to_message_id | Integer | Optional | If the message is a reply, ID of the original message |
| reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Optional | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. |
Use this method to send phone contacts. On success, the sent Message is returned.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| phone_number | String | Yes | Contact's phone number |
| first_name | String | Yes | Contact's first name |
| last_name | String | Optional | Contact's last name |
| disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. |
| reply_to_message_id | Integer | Optional | If the message is a reply, ID of the original message |
| reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Optional | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove keyboard or to force a reply from the user. |
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.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| action | String | Yes | 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_audio or upload_audio for audio files, upload_document for general files, find_location for location data, record_video_note or upload_video_note for video notes. |
Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.
| Parameters | Type | Required | Description |
| user_id | Integer | Yes | Unique identifier of the target user |
| offset | Integer | Optional | Sequential number of the first photo to be returned. By default, all photos are returned. |
| limit | Integer | Optional | Limits the number of photos to be retrieved. Values between 1—100 are accepted. Defaults to 100. |
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.
| Parameters | Type | Required | Description |
| file_id | String | Yes | File identifier to get info about |
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.
Use this method to kick a user from a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the group on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.
Note: In regular groups (non-supergroups), this method will only work if the ‘All Members Are Admins’ setting is off in the target group. Otherwise members may only be removed by the group's creator or by the member that added them.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername) |
| user_id | Integer | Yes | Unique identifier of the target user |
| until_date | Integer | Optional | Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever |
Use this method to unban a previously kicked user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. Returns True on success.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target group or username of the target supergroup or channel (in the format @username) |
| user_id | Integer | Yes | Unique identifier of the target user |
Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate admin rights. Pass True for all boolean parameters to lift restrictions from a user. Returns True on success.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) |
| user_id | Integer | Yes | Unique identifier of the target user |
| until_date | Integer | Optional | Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever |
| can_send_messages | Boolean | Optional | Pass True, if the user can send text messages, contacts, locations and venues |
| can_send_media_messages | Boolean | Optional | Pass True, if the user can send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages |
| can_send_other_messages | Boolean | Optional | Pass True, if the user can send animations, games, stickers and use inline bots, implies can_send_media_messages |
| can_add_web_page_previews | Boolean | Optional | Pass True, if the user may add web page previews to their messages, implies can_send_media_messages |
Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Pass False for all boolean parameters to demote a user. Returns True on success.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| user_id | Integer | Yes | Unique identifier of the target user |
| can_change_info | Boolean | Optional | Pass True, if the administrator can change chat title, photo and other settings |
| can_post_messages | Boolean | Optional | Pass True, if the administrator can create channel posts, channels only |
| can_edit_messages | Boolean | Optional | Pass True, if the administrator can edit messages of other users and can pin messages, channels only |
| can_delete_messages | Boolean | Optional | Pass True, if the administrator can delete messages of other users |
| can_invite_users | Boolean | Optional | Pass True, if the administrator can invite new users to the chat |
| can_restrict_members | Boolean | Optional | Pass True, if the administrator can restrict, ban or unban chat members |
| can_pin_messages | Boolean | Optional | Pass True, if the administrator can pin messages, supergroups only |
| can_promote_members | Boolean | Optional | Pass True, if the administrator can add new administrators with a subset of his own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by him) |
Use this method to generate a new invite link for a chat; any previously generated link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the new invite link as String on success.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.
Note: In regular groups (non-supergroups), this method will only work if the ‘All Members Are Admins’ setting is off in the target group.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| photo | InputFile | Yes | New chat photo, uploaded using multipart/form-data |
Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.
Note: In regular groups (non-supergroups), this method will only work if the ‘All Members Are Admins’ setting is off in the target group.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.
Note: In regular groups (non-supergroups), this method will only work if the ‘All Members Are Admins’ setting is off in the target group.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| title | String | Yes | New chat title, 1-255 characters |
Use this method to change the description of a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| description | String | Optional | New chat description, 0-255 characters |
Use this method to pin a message in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the ‘can_pin_messages’ admin right in the supergroup or ‘can_edit_messages’ admin right in the channel. Returns True on success.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| message_id | Integer | Yes | Identifier of a message to pin |
| disable_notification | Boolean | Optional | Pass True, if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels. |
Use this method to unpin a message in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the ‘can_pin_messages’ admin right in the supergroup or ‘can_edit_messages’ admin right in the channel. Returns True on success.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
Use this method for your bot to leave a group, supergroup or channel. Returns True on success.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) |
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.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) |
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.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) |
Use this method to get the number of members in a chat. Returns Int on success.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) |
Use this method to get information about a member of a chat. Returns a ChatMember object on success.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) |
| user_id | Integer | Yes | Unique identifier of the target user |
Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) |
| sticker_set_name | String | Yes | Name of the sticker set to be set as the group sticker set |
Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) |
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.
| Parameters | Type | Required | Description |
| callback_query_id | String | Yes | Unique identifier for the query to be answered |
| text | String | Optional | Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters |
| show_alert | Boolean | Optional | If true, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false. |
| url | String | Optional | URL that will be opened by the user's client. If you have created a Game and accepted the conditions via @Botfather, specify the URL that opens your game – note that this will only work if the query comes from a callback_game button. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter. |
| cache_time | Integer | Optional | The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0. |
Methods and objects used in the inline mode are described in the Inline mode section. 內嵌模式使用的 methods 和 objects 在 內嵌模式部分 中介紹。
The following methods allow you to change an existing message in the message history instead of sending a new one with a result of an action. This is most useful for messages with inline keyboards using callback queries, but can also help reduce clutter in conversations with regular chat bots.
Please note, that it is currently only possible to edit messages without reply_markup or with inline keyboards.
Use this method to edit text and game messages sent by the bot or via the bot (for inline bots). On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Optional | Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| message_id | Integer | Optional | Required if inline_message_id is not specified. Identifier of the sent message |
| inline_message_id | String | Optional | Required if chat_id and message_id are not specified. Identifier of the inline message |
| text | String | Yes | New text of the message |
| parse_mode | String | Optional | Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message. |
| disable_web_page_preview | Boolean | Optional | Disables link previews for links in this message |
| reply_markup | InlineKeyboardMarkup | Optional | A JSON-serialized object for an inline keyboard. |
Use this method to edit captions of messages sent by the bot or via the bot (for inline bots). On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Optional | Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| message_id | Integer | Optional | Required if inline_message_id is not specified. Identifier of the sent message |
| inline_message_id | String | Optional | Required if chat_id and message_id are not specified. Identifier of the inline message |
| caption | String | Optional | New caption of the message |
| parse_mode | String | Optional | Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
| reply_markup | InlineKeyboardMarkup | Optional | A JSON-serialized object for an inline keyboard. |
Use this method to edit only the reply markup of messages sent by the bot or via the bot (for inline bots). On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Optional | Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| message_id | Integer | Optional | Required if inline_message_id is not specified. Identifier of the sent message |
| inline_message_id | String | Optional | Required if chat_id and message_id are not specified. Identifier of the inline message |
| reply_markup | InlineKeyboardMarkup | Optional | A JSON-serialized object for an inline keyboard. |
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.
- Bots can delete outgoing messages in groups and supergroups.
- 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.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| message_id | Integer | Yes | Identifier of the message to delete |
The following methods and objects allow your bot to handle stickers and sticker sets.
This object represents a sticker.
| Field | Type | Description |
| file_id | String | Unique identifier for this file |
| width | Integer | Sticker width |
| height | Integer | Sticker height |
| thumb | PhotoSize | Optional. Sticker thumbnail in the .webp or .jpg format |
| emoji | String | Optional. Emoji associated with the sticker |
| set_name | String | Optional. Name of the sticker set to which the sticker belongs |
| mask_position | MaskPosition | Optional. For mask stickers, the position where the mask should be placed |
| file_size | Integer | Optional. File size |
This object represents a sticker set.
| Field | Type | Description |
| name | String | Sticker set name |
| title | String | Sticker set title |
| contains_masks | Boolean | True, if the sticker set contains masks |
| stickers | Array of Sticker | List of all set stickers |
This object describes the position on faces where a mask should be placed by default.
| Field | Type | Description |
| point | String | The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”. |
| x_shift | Float number | 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 number | 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 number | Mask scaling coefficient. For example, 2.0 means double size. |
Use this method to send .webp stickers. On success, the sent Message is returned.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| sticker | InputFile or String | Yes | 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 | Optional | Sends the message silently. Users will receive a notification with no sound. |
| reply_to_message_id | Integer | Optional | If the message is a reply, ID of the original message |
| reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Optional | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. |
Use this method to get a sticker set. On success, a StickerSet object is returned.
| Parameters | Type | Required | Description |
| name | String | Yes | Name of the sticker set |
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.
| Parameters | Type | Required | Description |
| user_id | Integer | Yes | User identifier of sticker file owner |
| png_sticker | InputFile | Yes | 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 » |
Use this method to create new sticker set owned by a user. The bot will be able to edit the created sticker set. Returns True on success.
| Parameters | Type | Required | Description |
| user_id | Integer | Yes | User identifier of created sticker set owner |
| name | String | Yes | 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 | Yes | Sticker set title, 1-64 characters |
| png_sticker | InputFile or String | Yes | 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 » |
| emojis | String | Yes | One or more emoji corresponding to the sticker |
| contains_masks | Boolean | Optional | Pass True, if a set of mask stickers should be created |
| mask_position | MaskPosition | Optional | A JSON-serialized object for position where the mask should be placed on faces |
Use this method to add a new sticker to a set created by the bot. Returns True on success.
| Parameters | Type | Required | Description |
| user_id | Integer | Yes | User identifier of sticker set owner |
| name | String | Yes | Sticker set name |
| png_sticker | InputFile or String | Yes | 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 » |
| emojis | String | Yes | One or more emoji corresponding to the sticker |
| mask_position | MaskPosition | Optional | A JSON-serialized object for position where the mask should be placed on faces |
Use this method to move a sticker in a set created by the bot to a specific position . Returns True on success.
| Parameters | Type | Required | Description |
| sticker | String | Yes | File identifier of the sticker |
| position | Integer | Yes | New sticker position in the set, zero-based |
Use this method to delete a sticker from a set created by the bot. Returns True on success.
| Parameters | Type | Required | Description |
| sticker | String | Yes | File identifier of the sticker |
The following methods and objects allow your bot to work in inline mode.
Please see our Introduction to Inline bots for more details.
以下方法和 objects 允許你的 bot 在 內嵌模式 工作。
更多詳細信息請見我們的 內嵌 bots 簡介。
To enable this option, send the /setinline command to @BotFather and provide the placeholder text that the user will see in the input field after typing your bot’s name.
要啟用此選項， 發送 /setinline 命令到 @BotFather
，並且提供用戶在輸入 bot 的名稱後在輸入欄位中看到代替文字。
This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results. 此 object 表示一個傳入的 inline query。 當用戶發送空查詢時，你的 bot 可能會返回一些預設或趨勢的結果。
| Field | Type | Description |
| id | String | Unique identifier for this query |
| from | User | Sender |
| location | Location | Optional. Sender location, only for bots that request user location |
| query | String | Text of the query (up to 512 characters) |
| offset | String | Offset of the results to be returned, can be controlled by the bot |
Use this method to send answers to an inline query. On success, True is returned.
No more than 50 results per query are allowed.
| Parameters | Type | Required | Description |
| inline_query_id | String | Yes | Unique identifier for the answered query |
| results | Array of InlineQueryResult | Yes | A JSON-serialized array of results for the inline query |
| cache_time | Integer | Optional | 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 | Optional | Pass True, if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query |
| next_offset | String | Optional | Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don‘t support pagination. Offset length can’t exceed 64 bytes. |
| switch_pm_text | String | Optional | If passed, clients will display a button with specified text that switches the user to a private chat with the bot and sends the bot a start message with the parameter switch_pm_parameter |
| switch_pm_parameter | String | Optional | Deep-linking parameter for the /start message sent to the bot when user presses the switch button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed.Example: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a ‘Connect your YouTube account’ button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an oauth link. Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities. |
This object represents one result of an inline query. Telegram clients currently support results of the following 20 types:
Represents a link to an article or web page.
| Field | Type | Description |
| type | String | Type of the result, must be article |
| id | String | Unique identifier for this result, 1-64 Bytes |
| title | String | Title of the result |
| input_message_content | InputMessageContent | Content of the message to be sent |
| reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message |
| url | String | Optional. URL of the result |
| hide_url | Boolean | Optional. Pass True, if you don't want the URL to be shown in the message |
| description | String | Optional. Short description of the result |
| thumb_url | String | Optional. Url of the thumbnail for the result |
| thumb_width | Integer | Optional. Thumbnail width |
| thumb_height | Integer | Optional. Thumbnail height |
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.
| Field | Type | Description |
| type | String | Type of the result, must be photo |
| id | String | Unique identifier for this result, 1-64 bytes |
| photo_url | String | A valid URL of the photo. Photo must be in jpeg format. Photo size must not exceed 5MB |
| thumb_url | String | URL of the thumbnail for the photo |
| photo_width | Integer | Optional. Width of the photo |
| photo_height | Integer | Optional. Height of the photo |
| title | String | Optional. Title for the result |
| description | String | Optional. Short description of the result |
| caption | String | Optional. Caption of the photo to be sent, 0-200 characters |
| parse_mode | String | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
| reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the photo |
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.
| Field | Type | Description |
| type | String | Type of the result, must be gif |
| id | String | Unique identifier for this result, 1-64 bytes |
| gif_url | String | A valid URL for the GIF file. File size must not exceed 1MB |
| gif_width | Integer | Optional. Width of the GIF |
| gif_height | Integer | Optional. Height of the GIF |
| gif_duration | Integer | Optional. Duration of the GIF |
| thumb_url | String | URL of the static thumbnail for the result (jpeg or gif) |
| title | String | Optional. Title for the result |
| caption | String | Optional. Caption of the GIF file to be sent, 0-200 characters |
| parse_mode | String | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
| reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the GIF animation |
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.
| Field | Type | Description |
| type | String | Type of the result, must be mpeg4_gif |
| id | String | Unique identifier for this result, 1-64 bytes |
| mpeg4_url | String | A valid URL for the MP4 file. File size must not exceed 1MB |
| mpeg4_width | Integer | Optional. Video width |
| mpeg4_height | Integer | Optional. Video height |
| mpeg4_duration | Integer | Optional. Video duration |
| thumb_url | String | URL of the static thumbnail (jpeg or gif) for the result |
| title | String | Optional. Title for the result |
| caption | String | Optional. Caption of the MPEG-4 file to be sent, 0-200 characters |
| parse_mode | String | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
| reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the video animation |
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.
| Field | Type | Description |
| type | String | Type of the result, must be video |
| id | String | Unique identifier for this result, 1-64 bytes |
| video_url | String | A valid URL for the embedded video player or video file |
| mime_type | String | Mime type of the content of video url, “text/html” or “video/mp4” |
| thumb_url | String | URL of the thumbnail (jpeg only) for the video |
| title | String | Title for the result |
| caption | String | Optional. Caption of the video to be sent, 0-200 characters |
| parse_mode | String | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
| video_width | Integer | Optional. Video width |
| video_height | Integer | Optional. Video height |
| video_duration | Integer | Optional. Video duration in seconds |
| description | String | Optional. Short description of the result |
| reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the video. This field is required if InlineQueryResultVideo is used to send an HTML-page as a result (e.g., a YouTube video). |
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.
| Field | Type | Description |
| type | String | Type of the result, must be audio |
| id | String | Unique identifier for this result, 1-64 bytes |
| audio_url | String | A valid URL for the audio file |
| title | String | Title |
| caption | String | Optional. Caption, 0-200 characters |
| parse_mode | String | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
| performer | String | Optional. Performer |
| audio_duration | Integer | Optional. Audio duration in seconds |
| reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the audio |
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
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.
| Field | Type | Description |
| type | String | Type of the result, must be voice |
| id | String | Unique identifier for this result, 1-64 bytes |
| voice_url | String | A valid URL for the voice recording |
| title | String | Recording title |
| caption | String | Optional. Caption, 0-200 characters |
| parse_mode | String | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
| voice_duration | Integer | Optional. Recording duration in seconds |
| reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the voice recording |
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
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.
| Field | Type | Description |
| type | String | Type of the result, must be document |
| id | String | Unique identifier for this result, 1-64 bytes |
| title | String | Title for the result |
| caption | String | Optional. Caption of the document to be sent, 0-200 characters |
| parse_mode | String | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
| document_url | String | A valid URL for the file |
| mime_type | String | Mime type of the content of the file, either “application/pdf” or “application/zip” |
| description | String | Optional. Short description of the result |
| reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the file |
| thumb_url | String | Optional. URL of the thumbnail (jpeg only) for the file |
| thumb_width | Integer | Optional. Thumbnail width |
| thumb_height | Integer | Optional. Thumbnail height |
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
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.
| Field | Type | Description |
| type | String | Type of the result, must be location |
| id | String | Unique identifier for this result, 1-64 Bytes |
| latitude | Float number | Location latitude in degrees |
| longitude | Float number | Location longitude in degrees |
| title | String | Location title |
| live_period | Integer | Optional. Period in seconds for which the location can be updated, should be between 60 and 86400. |
| reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the location |
| thumb_url | String | Optional. Url of the thumbnail for the result |
| thumb_width | Integer | Optional. Thumbnail width |
| thumb_height | Integer | Optional. Thumbnail height |
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
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.
| Field | Type | Description |
| type | String | Type of the result, must be venue |
| id | String | Unique identifier for this result, 1-64 Bytes |
| latitude | Float | Latitude of the venue location in degrees |
| longitude | Float | Longitude of the venue location in degrees |
| title | String | Title of the venue |
| address | String | Address of the venue |
| foursquare_id | String | Optional. Foursquare identifier of the venue if known |
| reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the venue |
| thumb_url | String | Optional. Url of the thumbnail for the result |
| thumb_width | Integer | Optional. Thumbnail width |
| thumb_height | Integer | Optional. Thumbnail height |
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
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.
| Field | Type | Description |
| type | String | Type of the result, must be contact |
| id | String | Unique identifier for this result, 1-64 Bytes |
| phone_number | String | Contact's phone number |
| first_name | String | Contact's first name |
| last_name | String | Optional. Contact's last name |
| reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the contact |
| thumb_url | String | Optional. Url of the thumbnail for the result |
| thumb_width | Integer | Optional. Thumbnail width |
| thumb_height | Integer | Optional. Thumbnail height |
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
Represents a Game.
| Field | Type | Description |
| type | String | Type of the result, must be game |
| id | String | Unique identifier for this result, 1-64 bytes |
| game_short_name | String | Short name of the game |
| reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message |
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.
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.
| Field | Type | Description |
| type | String | Type of the result, must be photo |
| id | String | Unique identifier for this result, 1-64 bytes |
| photo_file_id | String | A valid file identifier of the photo |
| title | String | Optional. Title for the result |
| description | String | Optional. Short description of the result |
| caption | String | Optional. Caption of the photo to be sent, 0-200 characters |
| parse_mode | String | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
| reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the photo |
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.
| Field | Type | Description |
| type | String | Type of the result, must be gif |
| id | String | Unique identifier for this result, 1-64 bytes |
| gif_file_id | String | A valid file identifier for the GIF file |
| title | String | Optional. Title for the result |
| caption | String | Optional. Caption of the GIF file to be sent, 0-200 characters |
| parse_mode | String | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
| reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the GIF animation |
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.
| Field | Type | Description |
| type | String | Type of the result, must be mpeg4_gif |
| id | String | Unique identifier for this result, 1-64 bytes |
| mpeg4_file_id | String | A valid file identifier for the MP4 file |
| title | String | Optional. Title for the result |
| caption | String | Optional. Caption of the MPEG-4 file to be sent, 0-200 characters |
| parse_mode | String | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
| reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the video animation |
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.
| Field | Type | Description |
| type | String | Type of the result, must be sticker |
| id | String | Unique identifier for this result, 1-64 bytes |
| sticker_file_id | String | A valid file identifier of the sticker |
| reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the sticker |
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
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.
| Field | Type | Description |
| type | String | Type of the result, must be document |
| id | String | Unique identifier for this result, 1-64 bytes |
| title | String | Title for the result |
| document_file_id | String | A valid file identifier for the file |
| description | String | Optional. Short description of the result |
| caption | String | Optional. Caption of the document to be sent, 0-200 characters |
| parse_mode | String | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
| reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the file |
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
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.
| Field | Type | Description |
| type | String | Type of the result, must be video |
| id | String | Unique identifier for this result, 1-64 bytes |
| video_file_id | String | A valid file identifier for the video file |
| title | String | Title for the result |
| description | String | Optional. Short description of the result |
| caption | String | Optional. Caption of the video to be sent, 0-200 characters |
| parse_mode | String | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
| reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the video |
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.
| Field | Type | Description |
| type | String | Type of the result, must be voice |
| id | String | Unique identifier for this result, 1-64 bytes |
| voice_file_id | String | A valid file identifier for the voice message |
| title | String | Voice message title |
| caption | String | Optional. Caption, 0-200 characters |
| parse_mode | String | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
| reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the voice message |
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
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.
| Field | Type | Description |
| type | String | Type of the result, must be audio |
| id | String | Unique identifier for this result, 1-64 bytes |
| audio_file_id | String | A valid file identifier for the audio file |
| caption | String | Optional. Caption, 0-200 characters |
| parse_mode | String | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
| reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message |
| input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the audio |
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
This object represents the content of a message to be sent as a result of an inline query. Telegram clients currently support the following 4 types:
Represents the content of a text message to be sent as the result of an inline query.
| Field | Type | Description |
| message_text | String | Text of the message to be sent, 1-4096 characters |
| parse_mode | String | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message. |
| disable_web_page_preview | Boolean | Optional. Disables link previews for links in the sent message |
Represents the content of a location message to be sent as the result of an inline query.
| Field | Type | Description |
| latitude | Float | Latitude of the location in degrees |
| longitude | Float | Longitude of the location in degrees |
| live_period | Integer | Optional. Period in seconds for which the location can be updated, should be between 60 and 86400. |
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
Represents the content of a venue message to be sent as the result of an inline query.
| Field | Type | Description |
| latitude | Float | Latitude of the venue in degrees |
| longitude | Float | Longitude of the venue in degrees |
| title | String | Name of the venue |
| address | String | Address of the venue |
| foursquare_id | String | Optional. Foursquare identifier of the venue, if known |
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
Represents the content of a contact message to be sent as the result of an inline query.
| Field | Type | Description |
| phone_number | String | Contact's phone number |
| first_name | String | Contact's first name |
| last_name | String | Optional. Contact's last name |
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
Represents a result of an inline query that was chosen by the user and sent to their chat partner.
| Field | Type | Description |
| result_id | String | The unique identifier for the result that was chosen |
| from | User | The user that chose the result |
| location | Location | Optional. Sender location, only for bots that require user location |
| inline_message_id | String | 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 | The query that was used to obtain the result |
Note: It is necessary to enable inline feedback via @Botfather in order to receive these objects in updates.
Your bot can accept payments from Telegram users. Please see the introduction to payments for more details on the process and how to set up payments for your bot. Please note that users will need Telegram v.4.0 or higher to use payments (released on May 18, 2017).
Use this method to send invoices. On success, the sent Message is returned.
| Parameters | Type | Required | Description |
| chat_id | Integer | Yes | Unique identifier for the target private chat |
| title | String | Yes | Product name, 1-32 characters |
| description | String | Yes | Product description, 1-255 characters |
| payload | String | Yes | Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. |
| provider_token | String | Yes | Payments provider token, obtained via Botfather |
| start_parameter | String | Yes | Unique deep-linking parameter that can be used to generate this invoice when used as a start parameter |
| currency | String | Yes | Three-letter ISO 4217 currency code, see more on currencies |
| prices | Array of LabeledPrice | Yes | Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.) |
| provider_data | String | Optional | JSON-encoded 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 | 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 | Optional | Photo size |
| photo_width | Integer | Optional | Photo width |
| photo_height | Integer | Optional | Photo height |
| need_name | Boolean | Optional | Pass True, if you require the user's full name to complete the order |
| need_phone_number | Boolean | Optional | Pass True, if you require the user's phone number to complete the order |
| need_email | Boolean | Optional | Pass True, if you require the user's email address to complete the order |
| need_shipping_address | Boolean | Optional | Pass True, if you require the user's shipping address to complete the order |
| send_phone_number_to_provider | Boolean | Optional | Pass True, if user's phone number should be sent to provider |
| send_email_to_provider | Boolean | Optional | Pass True, if user's email address should be sent to provider |
| is_flexible | Boolean | Optional | Pass True, if the final price depends on the shipping method |
| disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. |
| reply_to_message_id | Integer | Optional | If the message is a reply, ID of the original message |
| reply_markup | InlineKeyboardMarkup | Optional | A JSON-serialized object for an inline keyboard. If empty, one 'Pay total price' button will be shown. If not empty, the first button must be a Pay button. |
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.
| Parameters | Type | Required | Description |
| shipping_query_id | String | Yes | Unique identifier for the query to be answered |
| ok | Boolean | Yes | 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 | Array of ShippingOption | Optional | Required if ok is True. A JSON-serialized array of available shipping options. |
| error_message | String | Optional | Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. "Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user. |
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.
| Parameters | Type | Required | Description |
| pre_checkout_query_id | String | Yes | Unique identifier for the query to be answered |
| ok | Boolean | Yes | 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 | Optional | Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user. |
This object represents a portion of the price for goods or services.
| Field | Type | Description |
| label | String | Portion label |
| amount | Integer | 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). |
This object contains basic information about an invoice.
| Field | Type | Description |
| title | String | Product name |
| description | String | Product description |
| start_parameter | String | Unique bot deep-linking parameter that can be used to generate this invoice |
| currency | String | Three-letter ISO 4217 currency code |
| total_amount | Integer | 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). |
This object represents a shipping address.
| Field | Type | Description |
| country_code | String | ISO 3166-1 alpha-2 country code |
| state | String | State, if applicable |
| city | String | City |
| street_line1 | String | First line for the address |
| street_line2 | String | Second line for the address |
| post_code | String | Address post code |
This object represents information about an order.
| Field | Type | Description |
| name | String | Optional. User name |
| phone_number | String | Optional. User's phone number |
| String | Optional. User email | |
| shipping_address | ShippingAddress | Optional. User shipping address |
This object represents one shipping option.
| Field | Type | Description |
| id | String | Shipping option identifier |
| title | String | Option title |
| prices | Array of LabeledPrice | List of price portions |
This object contains basic information about a successful payment.
| Field | Type | Description |
| currency | String | Three-letter ISO 4217 currency code |
| total_amount | Integer | 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 | Bot specified invoice payload |
| shipping_option_id | String | Optional. Identifier of the shipping option chosen by the user |
| order_info | OrderInfo | Optional. Order info provided by the user |
| telegram_payment_charge_id | String | Telegram payment identifier |
| provider_payment_charge_id | String | Provider payment identifier |
This object contains information about an incoming shipping query.
| Field | Type | Description |
| id | String | Unique query identifier |
| from | User | User who sent the query |
| invoice_payload | String | Bot specified invoice payload |
| shipping_address | ShippingAddress | User specified shipping address |
This object contains information about an incoming pre-checkout query.
| Field | Type | Description |
| id | String | Unique query identifier |
| from | User | User who sent the query |
| currency | String | Three-letter ISO 4217 currency code |
| total_amount | Integer | 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 | Bot specified invoice payload |
| shipping_option_id | String | Optional. Identifier of the shipping option chosen by the user |
| order_info | OrderInfo | Optional. Order info provided by the user |
Your bot can offer users HTML5 games to play solo or to compete against each other in groups and one-on-one chats. Create games via @BotFather using the /newgame command. Please note that this kind of power requires responsibility: you will need to accept the terms for each game that your bots will be offering.
Use this method to send a game. On success, the sent Message is returned.
| Parameters | Type | Required | Description |
| chat_id | Integer | Yes | Unique identifier for the target chat |
| game_short_name | String | Yes | Short name of the game, serves as the unique identifier for the game. Set up your games via Botfather. |
| disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. |
| reply_to_message_id | Integer | Optional | If the message is a reply, ID of the original message |
| reply_markup | InlineKeyboardMarkup | Optional | A JSON-serialized object for an inline keyboard. If empty, one ‘Play game_title’ button will be shown. If not empty, the first button must launch the game. |
This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.
| Field | Type | Description |
| title | String | Title of the game |
| description | String | Description of the game |
| photo | Array of PhotoSize | Photo that will be displayed in the game message in chats. |
| text | String | 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 | Array of MessageEntity | Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc. |
| animation | Animation | Optional. Animation that will be displayed in the game message in chats. Upload via BotFather |
You can provide an animation for your game so that it looks stylish in chats (check out Lumberjack for an example). This object represents an animation file to be displayed in the message containing a game.
| Field | Type | Description |
| file_id | String | Unique file identifier |
| thumb | PhotoSize | Optional. Animation thumbnail as defined by sender |
| file_name | String | Optional. Original animation filename as defined by sender |
| mime_type | String | Optional. MIME type of the file as defined by sender |
| file_size | Integer | Optional. File size |
A placeholder, currently holds no information. Use BotFather to set up your game.
Use this method to set the score of the specified user in a game. On success, if the message was sent by the bot, returns the edited Message, otherwise returns True. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.
| Parameters | Type | Required | Description |
| user_id | Integer | Yes | User identifier |
| score | Integer | Yes | New score, must be non-negative |
| force | Boolean | Optional | Pass True, if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters |
| disable_edit_message | Boolean | Optional | Pass True, if the game message should not be automatically edited to include the current scoreboard |
| chat_id | Integer | Optional | Required if inline_message_id is not specified. Unique identifier for the target chat |
| message_id | Integer | Optional | Required if inline_message_id is not specified. Identifier of the sent message |
| inline_message_id | String | Optional | Required if chat_id and message_id are not specified. Identifier of the inline message |
Use this method to get data for high score tables. Will return the score of the specified user and several of his 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 his 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.
| Parameters | Type | Required | Description |
| user_id | Integer | Yes | Target user id |
| chat_id | Integer | Optional | Required if inline_message_id is not specified. Unique identifier for the target chat |
| message_id | Integer | Optional | Required if inline_message_id is not specified. Identifier of the sent message |
| inline_message_id | String | Optional | Required if chat_id and message_id are not specified. Identifier of the inline message |
This object represents one row of the high scores table for a game.
| Field | Type | Description |
| position | Integer | Position in high score table for the game |
| user | User | User |
| score | Integer | Score |
And that‘s about all we’ve got for now.
If you've got any questions, please check out our Bot FAQ »
關於譯者個人的補充訊息。
註釋範例，使用類似本文風格。
從 世界協調時間（UTC）
1970 年 1 月 1 日 0 時 0 分 0 秒起至現在的總秒數。
更多資訊見 維基百科 。
此處的 text 訊息應該是指 sendMessage 中的 text，
在 Message 的 text 欄位中會回傳
sendMessage 的 text 訊息中實際可見的部分。
譬如在 HTML 樣式下發送 <b>bold</b>
的訊息，實際可見的部分只有 “bold”，共佔 4 個字符。
被允許發送的字數長度為 0 ~ 4096 個實際可見的字符長度，
若超過則請求會失敗，並回傳 “error_code” 欄位等於 400，
“description” 欄位為 "Bad Request: message is too long" 的失敗訊息。
在 sendMessage 的 “chat_id” 欄位裡所表示的
channel 實測對頻道或者群組皆有效。
目前還不清楚是否本文中所有 channel 都有頻道和群組兩種意思。
譯者當前程度無法讀懂該原文的字面意思， 但仍可以依部分理解的原文和經實測的從旁推敲出用譯者口語化的解釋。
以字面意思理解 “performer”（演出者）、 “title”（標題）
原認為與 windows 系統
文件 > 內容 > 詳細資料
裡頭的 “參與演出者”、“標題” 欄位相同。
但實測上看不出填寫其欄位有任何作用。
電報討論串： Telegram 討論區 #71374。
“vote” 譯作投票。
“poll” 譯作意見調查。
參考： What is the difference between 'vote','suffrage','poll' and 'ballot'? - Quora。