Server path:Documentation Index
Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
Use this file to discover all available pages before exploring further.
/telegram-bot | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
telegram_bot_answer_callback_query | Describes answerCallbackQuery method |
telegram_bot_approve_chat_join_request | Describes approveChatJoinRequest method |
telegram_bot_ban_chat_member | Describes banChatMember method |
telegram_bot_ban_chat_sender_chat | Describes banChatSenderChat method |
telegram_bot_close | Describes close method |
telegram_bot_close_forum_topic | Describes closeForumTopic method |
telegram_bot_close_general_forum_topic | Describes closeGeneralForumTopic method |
telegram_bot_copy_message | Describes copyMessage method |
telegram_bot_copy_messages | Describes copyMessages method |
telegram_bot_create_chat_invite_link | Describes createChatInviteLink method |
telegram_bot_create_forum_topic | Describes createForumTopic method |
telegram_bot_decline_chat_join_request | Describes declineChatJoinRequest method |
telegram_bot_delete_chat_photo | Describes deleteChatPhoto method |
telegram_bot_delete_chat_sticker_set | Describes deleteChatStickerSet method |
telegram_bot_delete_forum_topic | Describes deleteForumTopic method |
telegram_bot_delete_my_commands | Describes deleteMyCommands method |
telegram_bot_delete_webhook | Describes deleteWebhook method |
telegram_bot_edit_chat_invite_link | Describes editChatInviteLink method |
telegram_bot_edit_forum_topic | Describes editForumTopic method |
telegram_bot_edit_general_forum_topic | Describes editGeneralForumTopic method |
telegram_bot_export_chat_invite_link | Describes exportChatInviteLink method |
telegram_bot_forward_message | Describes forwardMessage method |
telegram_bot_forward_messages | Describes forwardMessages method |
telegram_bot_get_business_connection | Describes getBusinessConnection method |
telegram_bot_get_chat | Describes getChat method |
telegram_bot_get_chat_administrators | Describes getChatAdministrators method |
telegram_bot_get_chat_member | Describes getChatMember method |
telegram_bot_get_chat_member_count | Describes getChatMemberCount method |
telegram_bot_get_chat_menu_button | Describes getChatMenuButton method |
telegram_bot_get_file | Describes getFile method |
telegram_bot_get_forum_topic_icon_stickers | Describes getForumTopicIconStickers method |
telegram_bot_get_me | Describes getMe method |
telegram_bot_get_my_commands | Describes getMyCommands method |
telegram_bot_get_my_default_administrator_rights | Describes getMyDefaultAdministratorRights method |
telegram_bot_get_my_description | Describes getMyDescription method |
telegram_bot_get_my_name | Describes getMyName method |
telegram_bot_get_my_short_description | Describes getMyShortDescription method |
telegram_bot_get_updates | Describes getUpdates method |
telegram_bot_get_user_chat_boosts | Describes getUserChatBoosts method |
telegram_bot_get_user_profile_photos | Describes getUserProfilePhotos method |
telegram_bot_get_webhook_info | Describes getWebhookInfo method |
telegram_bot_hide_general_forum_topic | Describes hideGeneralForumTopic method |
telegram_bot_leave_chat | Describes leaveChat method |
telegram_bot_log_out | Describes logOut method |
telegram_bot_pin_chat_message | Describes pinChatMessage method |
telegram_bot_promote_chat_member | Describes promoteChatMember method |
telegram_bot_reopen_forum_topic | Describes reopenForumTopic method |
telegram_bot_reopen_general_forum_topic | Describes reopenGeneralForumTopic method |
telegram_bot_restrict_chat_member | Describes restrictChatMember method |
telegram_bot_revoke_chat_invite_link | Describes revokeChatInviteLink method |
telegram_bot_send_animation | Describes sendAnimation method |
telegram_bot_send_audio | Describes sendAudio method |
telegram_bot_send_chat_action | Describes sendChatAction method |
telegram_bot_send_contact | Describes sendContact method |
telegram_bot_send_dice | Describes sendDice method |
telegram_bot_send_document | Describes sendDocument method |
telegram_bot_send_location | Describes sendLocation method |
telegram_bot_send_media_group | Describes sendMediaGroup method |
telegram_bot_send_message | Describes sendMessage method |
telegram_bot_send_photo | Describes sendPhoto method |
telegram_bot_send_poll | Describes sendPoll method |
telegram_bot_send_venue | Describes sendVenue method |
telegram_bot_send_video | Describes sendVideo method |
telegram_bot_send_video_note | Describes sendVideoNote method |
telegram_bot_send_voice | Describes sendVoice method |
telegram_bot_set_chat_administrator_custom_title | Describes setChatAdministratorCustomTitle method |
telegram_bot_set_chat_description | Describes setChatDescription method |
telegram_bot_set_chat_menu_button | Describes setChatMenuButton method |
telegram_bot_set_chat_permissions | Describes setChatPermissions method |
telegram_bot_set_chat_photo | Describes setChatPhoto method |
telegram_bot_set_chat_sticker_set | Describes setChatStickerSet method |
telegram_bot_set_chat_title | Describes setChatTitle method |
telegram_bot_set_message_reaction | Describes setMessageReaction method |
telegram_bot_set_my_commands | Describes setMyCommands method |
telegram_bot_set_my_default_administrator_rights | Describes setMyDefaultAdministratorRights method |
telegram_bot_set_my_description | Describes setMyDescription method |
telegram_bot_set_my_name | Describes setMyName method |
telegram_bot_set_my_short_description | Describes setMyShortDescription method |
telegram_bot_set_webhook | Describes setWebhook method |
telegram_bot_unban_chat_member | Describes unbanChatMember method |
telegram_bot_unban_chat_sender_chat | Describes unbanChatSenderChat method |
telegram_bot_unhide_general_forum_topic | Describes unhideGeneralForumTopic method |
telegram_bot_unpin_all_chat_messages | Describes unpinAllChatMessages method |
telegram_bot_unpin_all_forum_topic_messages | Describes unpinAllForumTopicMessages method |
telegram_bot_unpin_all_general_forum_topic_messages | Describes unpinAllGeneralForumTopicMessages method |
telegram_bot_unpin_chat_message | Describes unpinChatMessage method |
telegram_bot_answer_callback_query
DescribesanswerCallbackQuery method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cache_time | integer | No | — | 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. |
callback_query_id | string | Yes | — | Unique identifier for the query to be answered |
show_alert | boolean | No | — | If True, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false. |
text | string | No | — | Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters |
url | string | No | — | 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. |
telegram_bot_approve_chat_join_request
DescribesapproveChatJoinRequest method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
user_id | integer | Yes | — | Unique identifier of the target user |
telegram_bot_ban_chat_member
DescribesbanChatMember method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
revoke_messages | boolean | No | — | Pass True to delete all messages from the chat for the user that is being removed. If False, the user will be able to see messages in the group that were sent before the user was removed. Always True for supergroups and channels. |
until_date | integer | No | — | Date when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only. |
user_id | integer | Yes | — | Unique identifier of the target user |
telegram_bot_ban_chat_sender_chat
DescribesbanChatSenderChat method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
sender_chat_id | integer | Yes | — | Unique identifier of the target sender chat |
telegram_bot_close
Describesclose method
telegram_bot_close_forum_topic
DescribescloseForumTopic method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
message_thread_id | integer | Yes | — | Unique identifier for the target message thread of the forum topic |
telegram_bot_close_general_forum_topic
DescribescloseGeneralForumTopic method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
telegram_bot_copy_message
DescribescopyMessage method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caption | string | No | — | New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept |
caption_entities | object[] | No | — | A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of parse_mode |
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
disable_notification | boolean | No | — | Sends the message silently. Users will receive a notification with no sound. |
from_chat_id | string | Yes | — | Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
message_id | integer | Yes | — | Message identifier in the chat specified in from_chat_id |
message_thread_id | integer | No | — | Unique identifier for the target message thread (topic) of the forum; for forum supergroups only |
parse_mode | string | No | — | Mode for parsing entities in the new caption. See formatting options for more details. |
protect_content | boolean | No | — | Protects the contents of the sent message from forwarding and saving |
reply_markup | object | No | — | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user |
reply_parameters | object | No | — | Describes reply parameters for the message that is being sent. |
show_caption_above_media | boolean | No | — | Pass True, if the caption must be shown above the message media. Ignored if a new caption isn’t specified. |
telegram_bot_copy_messages
DescribescopyMessages method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
disable_notification | boolean | No | — | Sends the messages silently. Users will receive a notification with no sound. |
from_chat_id | string | Yes | — | Unique identifier for the chat where the original messages were sent (or channel username in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
message_ids | integer[] | Yes | — | A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to copy. The identifiers must be specified in a strictly increasing order. |
message_thread_id | integer | No | — | Unique identifier for the target message thread (topic) of the forum; for forum supergroups only |
protect_content | boolean | No | — | Protects the contents of the sent messages from forwarding and saving |
remove_caption | boolean | No | — | Pass True to copy the messages without their captions |
telegram_bot_create_chat_invite_link
DescribescreateChatInviteLink method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
creates_join_request | boolean | No | — | True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can’t be specified |
expire_date | integer | No | — | Point in time (Unix timestamp) when the link will expire |
member_limit | integer | No | — | The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999 |
name | string | No | — | Invite link name; 0-32 characters |
telegram_bot_create_forum_topic
DescribescreateForumTopic method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
icon_color | integer | No | — | Color of the topic icon in RGB format. Currently, must be one of 7322096 (0x6FB9F0), 16766590 (0xFFD67E), 13338331 (0xCB86DB), 9367192 (0x8EEE98), 16749490 (0xFF93B2), or 16478047 (0xFB6F5F) |
icon_custom_emoji_id | string | No | — | Unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers. |
name | string | Yes | — | Topic name, 1-128 characters |
telegram_bot_decline_chat_join_request
DescribesdeclineChatJoinRequest method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
user_id | integer | Yes | — | Unique identifier of the target user |
telegram_bot_delete_chat_photo
DescribesdeleteChatPhoto method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
telegram_bot_delete_chat_sticker_set
DescribesdeleteChatStickerSet method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
telegram_bot_delete_forum_topic
DescribesdeleteForumTopic method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
message_thread_id | integer | Yes | — | Unique identifier for the target message thread of the forum topic |
telegram_bot_delete_my_commands
DescribesdeleteMyCommands method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
language_code | string | No | — | A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands |
scope | object | No | — | This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported: - BotCommandScopeDefault - BotCommandScopeAllPrivateChats - BotCommandScopeAllGroupChats - BotCommandScopeAllChatAdministrators - BotCommandScopeChat - BotCommandScopeChatAdministrators - BotCommandScopeChatMember |
telegram_bot_delete_webhook
DescribesdeleteWebhook method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
drop_pending_updates | boolean | No | — | Pass True to drop all pending updates |
telegram_bot_edit_chat_invite_link
DescribeseditChatInviteLink method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
creates_join_request | boolean | No | — | True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can’t be specified |
expire_date | integer | No | — | Point in time (Unix timestamp) when the link will expire |
invite_link | string | Yes | — | The invite link to edit |
member_limit | integer | No | — | The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999 |
name | string | No | — | Invite link name; 0-32 characters |
telegram_bot_edit_forum_topic
DescribeseditForumTopic method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
icon_custom_emoji_id | string | No | — | New unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept |
message_thread_id | integer | Yes | — | Unique identifier for the target message thread of the forum topic |
name | string | No | — | New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept |
telegram_bot_edit_general_forum_topic
DescribeseditGeneralForumTopic method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
name | string | Yes | — | New topic name, 1-128 characters |
telegram_bot_export_chat_invite_link
DescribesexportChatInviteLink method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
telegram_bot_forward_message
DescribesforwardMessage method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
disable_notification | boolean | No | — | Sends the message silently. Users will receive a notification with no sound. |
from_chat_id | string | Yes | — | Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
message_id | integer | Yes | — | Message identifier in the chat specified in from_chat_id |
message_thread_id | integer | No | — | Unique identifier for the target message thread (topic) of the forum; for forum supergroups only |
protect_content | boolean | No | — | Protects the contents of the forwarded message from forwarding and saving |
telegram_bot_forward_messages
DescribesforwardMessages method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
disable_notification | boolean | No | — | Sends the messages silently. Users will receive a notification with no sound. |
from_chat_id | string | Yes | — | Unique identifier for the chat where the original messages were sent (or channel username in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
message_ids | integer[] | Yes | — | A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to forward. The identifiers must be specified in a strictly increasing order. |
message_thread_id | integer | No | — | Unique identifier for the target message thread (topic) of the forum; for forum supergroups only |
protect_content | boolean | No | — | Protects the contents of the forwarded messages from forwarding and saving |
telegram_bot_get_business_connection
DescribesgetBusinessConnection method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
business_connection_id | string | Yes | — | Unique identifier of the business connection |
telegram_bot_get_chat
DescribesgetChat method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
telegram_bot_get_chat_administrators
DescribesgetChatAdministrators method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
telegram_bot_get_chat_member
DescribesgetChatMember method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
user_id | integer | Yes | — | Unique identifier of the target user |
telegram_bot_get_chat_member_count
DescribesgetChatMemberCount method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
telegram_bot_get_chat_menu_button
DescribesgetChatMenuButton method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | integer | No | — | Unique identifier for the target private chat. If not specified, default bot’s menu button will be returned |
telegram_bot_get_file
DescribesgetFile method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
file_id | string | Yes | — | File identifier to get information about |
telegram_bot_get_forum_topic_icon_stickers
DescribesgetForumTopicIconStickers method
telegram_bot_get_me
DescribesgetMe method
telegram_bot_get_my_commands
DescribesgetMyCommands method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
language_code | string | No | — | A two-letter ISO 639-1 language code or an empty string |
scope | object | No | — | This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported: - BotCommandScopeDefault - BotCommandScopeAllPrivateChats - BotCommandScopeAllGroupChats - BotCommandScopeAllChatAdministrators - BotCommandScopeChat - BotCommandScopeChatAdministrators - BotCommandScopeChatMember |
telegram_bot_get_my_default_administrator_rights
DescribesgetMyDefaultAdministratorRights method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
for_channels | boolean | No | — | Pass True to get default administrator rights of the bot in channels. Otherwise, default administrator rights of the bot for groups and supergroups will be returned. |
telegram_bot_get_my_description
DescribesgetMyDescription method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
language_code | string | No | — | A two-letter ISO 639-1 language code or an empty string |
telegram_bot_get_my_name
DescribesgetMyName method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
language_code | string | No | — | A two-letter ISO 639-1 language code or an empty string |
telegram_bot_get_my_short_description
DescribesgetMyShortDescription method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
language_code | string | No | — | A two-letter ISO 639-1 language code or an empty string |
telegram_bot_get_updates
DescribesgetUpdates method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
allowed_updates | string[] | No | — | A JSON-serialized list of the update types you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (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. |
limit | integer | No | — | Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100. |
offset | integer | No | — | 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 be forgotten. |
timeout | integer | No | — | 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. |
telegram_bot_get_user_chat_boosts
DescribesgetUserChatBoosts method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the chat or username of the channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
user_id | integer | Yes | — | Unique identifier of the target user |
telegram_bot_get_user_profile_photos
DescribesgetUserProfilePhotos method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100. |
offset | integer | No | — | Sequential number of the first photo to be returned. By default, all photos are returned. |
user_id | integer | Yes | — | Unique identifier of the target user |
telegram_bot_get_webhook_info
DescribesgetWebhookInfo method
telegram_bot_hide_general_forum_topic
DescribeshideGeneralForumTopic method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
telegram_bot_leave_chat
DescribesleaveChat method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
telegram_bot_log_out
DescribeslogOut method
telegram_bot_pin_chat_message
DescribespinChatMessage method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
disable_notification | boolean | No | — | Pass True if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats. |
message_id | integer | Yes | — | Identifier of a message to pin |
telegram_bot_promote_chat_member
DescribespromoteChatMember method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
can_change_info | boolean | No | — | Pass True if the administrator can change chat title, photo and other settings |
can_delete_messages | boolean | No | — | Pass True if the administrator can delete messages of other users |
can_delete_stories | boolean | No | — | Pass True if the administrator can delete stories posted by other users |
can_edit_messages | boolean | No | — | Pass True if the administrator can edit messages of other users and can pin messages; for channels only |
can_edit_stories | boolean | No | — | Pass True if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat’s story archive |
can_invite_users | boolean | No | — | Pass True if the administrator can invite new users to the chat |
can_manage_chat | boolean | No | — | Pass True if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege. |
can_manage_topics | boolean | No | — | Pass True if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only |
can_manage_video_chats | boolean | No | — | Pass True if the administrator can manage video chats |
can_pin_messages | boolean | No | — | Pass True if the administrator can pin messages; for supergroups only |
can_post_messages | boolean | No | — | Pass True if the administrator can post messages in the channel, or access channel statistics; for channels only |
can_post_stories | boolean | No | — | Pass True if the administrator can post stories to the chat |
can_promote_members | boolean | No | — | Pass True if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by him) |
can_restrict_members | boolean | No | — | Pass True if the administrator can restrict, ban or unban chat members, or access supergroup statistics |
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
is_anonymous | boolean | No | — | Pass True if the administrator’s presence in the chat is hidden |
user_id | integer | Yes | — | Unique identifier of the target user |
telegram_bot_reopen_forum_topic
DescribesreopenForumTopic method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
message_thread_id | integer | Yes | — | Unique identifier for the target message thread of the forum topic |
telegram_bot_reopen_general_forum_topic
DescribesreopenGeneralForumTopic method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
telegram_bot_restrict_chat_member
DescribesrestrictChatMember method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
permissions | object | Yes | — | Describes actions that a non-administrator user is allowed to take in a chat. |
until_date | integer | No | — | 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 |
use_independent_chat_permissions | boolean | No | — | Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission. |
user_id | integer | Yes | — | Unique identifier of the target user |
telegram_bot_revoke_chat_invite_link
DescribesrevokeChatInviteLink method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier of the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
invite_link | string | Yes | — | The invite link to revoke |
telegram_bot_send_animation
DescribessendAnimation method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
animation | string | Yes | — | Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. More information on Sending Files » |
business_connection_id | string | No | — | Unique identifier of the business connection on behalf of which the message will be sent |
caption | string | No | — | Animation caption (may also be used when resending animation by file_id), 0-1024 characters after entities parsing |
caption_entities | object[] | No | — | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode |
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
disable_notification | boolean | No | — | Sends the message silently. Users will receive a notification with no sound. |
duration | integer | No | — | Duration of sent animation in seconds |
has_spoiler | boolean | No | — | Pass True if the animation needs to be covered with a spoiler animation |
height | integer | No | — | Animation height |
message_effect_id | string | No | — | Unique identifier of the message effect to be added to the message; for private chats only |
message_thread_id | integer | No | — | Unique identifier for the target message thread (topic) of the forum; for forum supergroups only |
parse_mode | string | No | — | Mode for parsing entities in the animation caption. See formatting options for more details. |
protect_content | boolean | No | — | Protects the contents of the sent message from forwarding and saving |
reply_markup | object | No | — | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user |
reply_parameters | object | No | — | Describes reply parameters for the message that is being sent. |
show_caption_above_media | boolean | No | — | Pass True, if the caption must be shown above the message media |
thumbnail | string | No | — | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail’s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » |
width | integer | No | — | Animation width |
telegram_bot_send_audio
DescribessendAudio method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
audio | 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 information on Sending Files » |
business_connection_id | string | No | — | Unique identifier of the business connection on behalf of which the message will be sent |
caption | string | No | — | Audio caption, 0-1024 characters after entities parsing |
caption_entities | object[] | No | — | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode |
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
disable_notification | boolean | No | — | Sends the message silently. Users will receive a notification with no sound. |
duration | integer | No | — | Duration of the audio in seconds |
message_effect_id | string | No | — | Unique identifier of the message effect to be added to the message; for private chats only |
message_thread_id | integer | No | — | Unique identifier for the target message thread (topic) of the forum; for forum supergroups only |
parse_mode | string | No | — | Mode for parsing entities in the audio caption. See formatting options for more details. |
performer | string | No | — | The performer value |
protect_content | boolean | No | — | Protects the contents of the sent message from forwarding and saving |
reply_markup | object | No | — | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user |
reply_parameters | object | No | — | Describes reply parameters for the message that is being sent. |
thumbnail | string | No | — | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail’s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » |
title | string | No | — | Track name |
telegram_bot_send_chat_action
DescribessendChatAction method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
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_voice or upload_voice for voice notes, upload_document for general files, choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes. |
business_connection_id | string | No | — | Unique identifier of the business connection on behalf of which the action will be sent |
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
message_thread_id | integer | No | — | Unique identifier for the target message thread; for supergroups only |
telegram_bot_send_contact
DescribessendContact method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
business_connection_id | string | No | — | Unique identifier of the business connection on behalf of which the message will be sent |
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
disable_notification | boolean | No | — | Sends the message silently. Users will receive a notification with no sound. |
first_name | string | Yes | — | Contact’s first name |
last_name | string | No | — | Contact’s last name |
message_effect_id | string | No | — | Unique identifier of the message effect to be added to the message; for private chats only |
message_thread_id | integer | No | — | Unique identifier for the target message thread (topic) of the forum; for forum supergroups only |
phone_number | string | Yes | — | Contact’s phone number |
protect_content | boolean | No | — | Protects the contents of the sent message from forwarding and saving |
reply_markup | object | No | — | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user |
reply_parameters | object | No | — | Describes reply parameters for the message that is being sent. |
vcard | string | No | — | Additional data about the contact in the form of a vCard, 0-2048 bytes |
telegram_bot_send_dice
DescribessendDice method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
business_connection_id | string | No | — | Unique identifier of the business connection on behalf of which the message will be sent |
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
disable_notification | boolean | No | — | Sends the message silently. Users will receive a notification with no sound. |
emoji | string | No | — | Emoji on which the dice throw animation is based. Currently, must be one of “”, “”, “”, “”, “”, or “”. Dice can have values 1-6 for “”, “” and “”, values 1-5 for “” and “”, and values 1-64 for “”. Defaults to “” |
message_effect_id | string | No | — | Unique identifier of the message effect to be added to the message; for private chats only |
message_thread_id | integer | No | — | Unique identifier for the target message thread (topic) of the forum; for forum supergroups only |
protect_content | boolean | No | — | Protects the contents of the sent message from forwarding |
reply_markup | object | No | — | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user |
reply_parameters | object | No | — | Describes reply parameters for the message that is being sent. |
telegram_bot_send_document
DescribessendDocument method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
business_connection_id | string | No | — | Unique identifier of the business connection on behalf of which the message will be sent |
caption | string | No | — | Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing |
caption_entities | object[] | No | — | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode |
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
disable_content_type_detection | boolean | No | — | Disables automatic server-side content type detection for files uploaded using multipart/form-data |
disable_notification | boolean | No | — | Sends the message silently. Users will receive a notification with no sound. |
document | 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 information on Sending Files » |
message_effect_id | string | No | — | Unique identifier of the message effect to be added to the message; for private chats only |
message_thread_id | integer | No | — | Unique identifier for the target message thread (topic) of the forum; for forum supergroups only |
parse_mode | string | No | — | Mode for parsing entities in the document caption. See formatting options for more details. |
protect_content | boolean | No | — | Protects the contents of the sent message from forwarding and saving |
reply_markup | object | No | — | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user |
reply_parameters | object | No | — | Describes reply parameters for the message that is being sent. |
thumbnail | string | No | — | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail’s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » |
telegram_bot_send_location
DescribessendLocation method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
business_connection_id | string | No | — | Unique identifier of the business connection on behalf of which the message will be sent |
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
disable_notification | boolean | No | — | Sends the message silently. Users will receive a notification with no sound. |
heading | integer | No | — | For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. |
horizontal_accuracy | number | No | — | The radius of uncertainty for the location, measured in meters; 0-1500 |
latitude | number | Yes | — | Latitude of the location |
live_period | integer | No | — | Period in seconds during which the location will be updated (see Live Locations, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely. |
longitude | number | Yes | — | Longitude of the location |
message_effect_id | string | No | — | Unique identifier of the message effect to be added to the message; for private chats only |
message_thread_id | integer | No | — | Unique identifier for the target message thread (topic) of the forum; for forum supergroups only |
protect_content | boolean | No | — | Protects the contents of the sent message from forwarding and saving |
proximity_alert_radius | integer | No | — | For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. |
reply_markup | object | No | — | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user |
reply_parameters | object | No | — | Describes reply parameters for the message that is being sent. |
telegram_bot_send_media_group
DescribessendMediaGroup method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
business_connection_id | string | No | — | Unique identifier of the business connection on behalf of which the message will be sent |
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
disable_notification | boolean | No | — | Sends messages silently. Users will receive a notification with no sound. |
media | any[] | Yes | — | A JSON-serialized array describing messages to be sent, must include 2-10 items |
message_effect_id | string | No | — | Unique identifier of the message effect to be added to the message; for private chats only |
message_thread_id | integer | No | — | Unique identifier for the target message thread (topic) of the forum; for forum supergroups only |
protect_content | boolean | No | — | Protects the contents of the sent messages from forwarding and saving |
reply_parameters | object | No | — | Describes reply parameters for the message that is being sent. |
telegram_bot_send_message
DescribessendMessage method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
business_connection_id | string | No | — | Unique identifier of the business connection on behalf of which the message will be sent |
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
disable_notification | boolean | No | — | Sends the message silently. Users will receive a notification with no sound. |
entities | object[] | No | — | A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode |
link_preview_options | object | No | — | Describes the options used for link preview generation. |
message_effect_id | string | No | — | Unique identifier of the message effect to be added to the message; for private chats only |
message_thread_id | integer | No | — | Unique identifier for the target message thread (topic) of the forum; for forum supergroups only |
parse_mode | string | No | — | Mode for parsing entities in the message text. See formatting options for more details. |
protect_content | boolean | No | — | Protects the contents of the sent message from forwarding and saving |
reply_markup | object | No | — | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user |
reply_parameters | object | No | — | Describes reply parameters for the message that is being sent. |
text | string | Yes | — | Text of the message to be sent, 1-4096 characters after entities parsing |
telegram_bot_send_photo
DescribessendPhoto method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
business_connection_id | string | No | — | Unique identifier of the business connection on behalf of which the message will be sent |
caption | string | No | — | Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing |
caption_entities | object[] | No | — | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode |
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
disable_notification | boolean | No | — | Sends the message silently. Users will receive a notification with no sound. |
has_spoiler | boolean | No | — | Pass True if the photo needs to be covered with a spoiler animation |
message_effect_id | string | No | — | Unique identifier of the message effect to be added to the message; for private chats only |
message_thread_id | integer | No | — | Unique identifier for the target message thread (topic) of the forum; for forum supergroups only |
parse_mode | string | No | — | Mode for parsing entities in the photo caption. See formatting options for more details. |
photo | 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. The photo must be at most 10 MB in size. The photo’s width and height must not exceed 10000 in total. Width and height ratio must be at most 20. More information on Sending Files » |
protect_content | boolean | No | — | Protects the contents of the sent message from forwarding and saving |
reply_markup | object | No | — | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user |
reply_parameters | object | No | — | Describes reply parameters for the message that is being sent. |
show_caption_above_media | boolean | No | — | Pass True, if the caption must be shown above the message media |
telegram_bot_send_poll
DescribessendPoll method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
allows_multiple_answers | boolean | No | — | True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False |
business_connection_id | string | No | — | Unique identifier of the business connection on behalf of which the message will be sent |
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
close_date | integer | No | — | Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can’t be used together with open_period. |
correct_option_id | integer | No | — | 0-based identifier of the correct answer option, required for polls in quiz mode |
disable_notification | boolean | No | — | Sends the message silently. Users will receive a notification with no sound. |
explanation | string | No | — | Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing |
explanation_entities | object[] | No | — | A JSON-serialized list of special entities that appear in the poll explanation. It can be specified instead of explanation_parse_mode |
explanation_parse_mode | string | No | — | Mode for parsing entities in the explanation. See formatting options for more details. |
is_anonymous | boolean | No | — | True, if the poll needs to be anonymous, defaults to True |
is_closed | boolean | No | — | Pass True if the poll needs to be immediately closed. This can be useful for poll preview. |
message_effect_id | string | No | — | Unique identifier of the message effect to be added to the message; for private chats only |
message_thread_id | integer | No | — | Unique identifier for the target message thread (topic) of the forum; for forum supergroups only |
open_period | integer | No | — | Amount of time in seconds the poll will be active after creation, 5-600. Can’t be used together with close_date. |
options | object[] | Yes | — | A JSON-serialized list of 2-10 answer options |
protect_content | boolean | No | — | Protects the contents of the sent message from forwarding and saving |
question | string | Yes | — | Poll question, 1-300 characters |
question_entities | object[] | No | — | A JSON-serialized list of special entities that appear in the poll question. It can be specified instead of question_parse_mode |
question_parse_mode | string | No | — | Mode for parsing entities in the question. See formatting options for more details. Currently, only custom emoji entities are allowed |
reply_markup | object | No | — | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user |
reply_parameters | object | No | — | Describes reply parameters for the message that is being sent. |
type | string | No | — | Poll type, “quiz” or “regular”, defaults to “regular” |
telegram_bot_send_venue
DescribessendVenue method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
address | string | Yes | — | Address of the venue |
business_connection_id | string | No | — | Unique identifier of the business connection on behalf of which the message will be sent |
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
disable_notification | boolean | No | — | Sends the message silently. Users will receive a notification with no sound. |
foursquare_id | string | No | — | Foursquare identifier of the venue |
foursquare_type | string | No | — | Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.) |
google_place_id | string | No | — | Google Places identifier of the venue |
google_place_type | string | No | — | Google Places type of the venue. (See supported types.) |
latitude | number | Yes | — | Latitude of the venue |
longitude | number | Yes | — | Longitude of the venue |
message_effect_id | string | No | — | Unique identifier of the message effect to be added to the message; for private chats only |
message_thread_id | integer | No | — | Unique identifier for the target message thread (topic) of the forum; for forum supergroups only |
protect_content | boolean | No | — | Protects the contents of the sent message from forwarding and saving |
reply_markup | object | No | — | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user |
reply_parameters | object | No | — | Describes reply parameters for the message that is being sent. |
title | string | Yes | — | Name of the venue |
telegram_bot_send_video
DescribessendVideo method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
business_connection_id | string | No | — | Unique identifier of the business connection on behalf of which the message will be sent |
caption | string | No | — | Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing |
caption_entities | object[] | No | — | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode |
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
disable_notification | boolean | No | — | Sends the message silently. Users will receive a notification with no sound. |
duration | integer | No | — | Duration of sent video in seconds |
has_spoiler | boolean | No | — | Pass True if the video needs to be covered with a spoiler animation |
height | integer | No | — | Video height |
message_effect_id | string | No | — | Unique identifier of the message effect to be added to the message; for private chats only |
message_thread_id | integer | No | — | Unique identifier for the target message thread (topic) of the forum; for forum supergroups only |
parse_mode | string | No | — | Mode for parsing entities in the video caption. See formatting options for more details. |
protect_content | boolean | No | — | Protects the contents of the sent message from forwarding and saving |
reply_markup | object | No | — | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user |
reply_parameters | object | No | — | Describes reply parameters for the message that is being sent. |
show_caption_above_media | boolean | No | — | Pass True, if the caption must be shown above the message media |
supports_streaming | boolean | No | — | Pass True if the uploaded video is suitable for streaming |
thumbnail | string | No | — | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail’s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » |
video | 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 information on Sending Files » |
width | integer | No | — | Video width |
telegram_bot_send_video_note
DescribessendVideoNote method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
business_connection_id | string | No | — | Unique identifier of the business connection on behalf of which the message will be sent |
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
disable_notification | boolean | No | — | Sends the message silently. Users will receive a notification with no sound. |
duration | integer | No | — | Duration of sent video in seconds |
length | integer | No | — | Video width and height, i.e. diameter of the video message |
message_effect_id | string | No | — | Unique identifier of the message effect to be added to the message; for private chats only |
message_thread_id | integer | No | — | Unique identifier for the target message thread (topic) of the forum; for forum supergroups only |
protect_content | boolean | No | — | Protects the contents of the sent message from forwarding and saving |
reply_markup | object | No | — | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user |
reply_parameters | object | No | — | Describes reply parameters for the message that is being sent. |
thumbnail | string | No | — | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail’s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » |
video_note | 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 information on Sending Files ». Sending video notes by a URL is currently unsupported |
telegram_bot_send_voice
DescribessendVoice method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
business_connection_id | string | No | — | Unique identifier of the business connection on behalf of which the message will be sent |
caption | string | No | — | Voice message caption, 0-1024 characters after entities parsing |
caption_entities | object[] | No | — | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode |
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
disable_notification | boolean | No | — | Sends the message silently. Users will receive a notification with no sound. |
duration | integer | No | — | Duration of the voice message in seconds |
message_effect_id | string | No | — | Unique identifier of the message effect to be added to the message; for private chats only |
message_thread_id | integer | No | — | Unique identifier for the target message thread (topic) of the forum; for forum supergroups only |
parse_mode | string | No | — | Mode for parsing entities in the voice message caption. See formatting options for more details. |
protect_content | boolean | No | — | Protects the contents of the sent message from forwarding and saving |
reply_markup | object | No | — | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user |
reply_parameters | object | No | — | Describes reply parameters for the message that is being sent. |
voice | string | Yes | — | Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files » |
telegram_bot_set_chat_administrator_custom_title
DescribessetChatAdministratorCustomTitle method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
custom_title | string | Yes | — | New custom title for the administrator; 0-16 characters, emoji are not allowed |
user_id | integer | Yes | — | Unique identifier of the target user |
telegram_bot_set_chat_description
DescribessetChatDescription method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
description | string | No | — | New chat description, 0-255 characters |
telegram_bot_set_chat_menu_button
DescribessetChatMenuButton method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | integer | No | — | Unique identifier for the target private chat. If not specified, default bot’s menu button will be changed |
menu_button | object | No | — | This object describes the bot’s menu button in a private chat. It should be one of - MenuButtonCommands - MenuButtonWebApp - MenuButtonDefault If a menu button other than MenuButtonDefault is set for a private chat, then it is applied in the chat. Otherwise the default menu button is applied. By default, the menu button opens the list of bot commands. |
telegram_bot_set_chat_permissions
DescribessetChatPermissions method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
permissions | object | Yes | — | Describes actions that a non-administrator user is allowed to take in a chat. |
use_independent_chat_permissions | boolean | No | — | Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission. |
telegram_bot_set_chat_photo
DescribessetChatPhoto method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
photo | string | Yes | — | 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. |
telegram_bot_set_chat_sticker_set
DescribessetChatStickerSet method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
sticker_set_name | string | Yes | — | Name of the sticker set to be set as the group sticker set |
telegram_bot_set_chat_title
DescribessetChatTitle method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
title | string | Yes | — | New chat title, 1-128 characters |
telegram_bot_set_message_reaction
DescribessetMessageReaction method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
is_big | boolean | No | — | Pass True to set the reaction with a big animation |
message_id | integer | Yes | — | Identifier of the target message. If the message belongs to a media group, the reaction is set to the first non-deleted message in the group instead. |
reaction | object[] | No | — | A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators. |
telegram_bot_set_my_commands
DescribessetMyCommands method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
commands | object[] | Yes | — | A JSON-serialized list of bot commands to be set as the list of the bot’s commands. At most 100 commands can be specified. |
language_code | string | No | — | A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands |
scope | object | No | — | This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported: - BotCommandScopeDefault - BotCommandScopeAllPrivateChats - BotCommandScopeAllGroupChats - BotCommandScopeAllChatAdministrators - BotCommandScopeChat - BotCommandScopeChatAdministrators - BotCommandScopeChatMember |
telegram_bot_set_my_default_administrator_rights
DescribessetMyDefaultAdministratorRights method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
for_channels | boolean | No | — | Pass True to change the default administrator rights of the bot in channels. Otherwise, the default administrator rights of the bot for groups and supergroups will be changed. |
rights | object | No | — | Represents the rights of an administrator in a chat. |
telegram_bot_set_my_description
DescribessetMyDescription method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | New bot description; 0-512 characters. Pass an empty string to remove the dedicated description for the given language. |
language_code | string | No | — | A two-letter ISO 639-1 language code. If empty, the description will be applied to all users for whose language there is no dedicated description. |
telegram_bot_set_my_name
DescribessetMyName method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
language_code | string | No | — | A two-letter ISO 639-1 language code. If empty, the name will be shown to all users for whose language there is no dedicated name. |
name | string | No | — | New bot name; 0-64 characters. Pass an empty string to remove the dedicated name for the given language. |
telegram_bot_set_my_short_description
DescribessetMyShortDescription method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
language_code | string | No | — | A two-letter ISO 639-1 language code. If empty, the short description will be applied to all users for whose language there is no dedicated short description. |
short_description | string | No | — | New short description for the bot; 0-120 characters. Pass an empty string to remove the dedicated short description for the given language. |
telegram_bot_set_webhook
DescribessetWebhook method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
allowed_updates | string[] | No | — | A JSON-serialized list of the update types you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used.Please note that this parameter doesn’t affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time. |
drop_pending_updates | boolean | No | — | Pass True to drop all pending updates |
ip_address | string | No | — | The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS |
max_connections | integer | No | — | The 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. |
secret_token | string | No | — | A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you. |
url | string | Yes | — | HTTPS URL to send updates to. Use an empty string to remove webhook integration |
telegram_bot_unban_chat_member
DescribesunbanChatMember method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
only_if_banned | boolean | No | — | Do nothing if the user is not banned |
user_id | integer | Yes | — | Unique identifier of the target user |
telegram_bot_unban_chat_sender_chat
DescribesunbanChatSenderChat method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
sender_chat_id | integer | Yes | — | Unique identifier of the target sender chat |
telegram_bot_unhide_general_forum_topic
DescribesunhideGeneralForumTopic method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
telegram_bot_unpin_all_chat_messages
DescribesunpinAllChatMessages method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
telegram_bot_unpin_all_forum_topic_messages
DescribesunpinAllForumTopicMessages method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
message_thread_id | integer | Yes | — | Unique identifier for the target message thread of the forum topic |
telegram_bot_unpin_all_general_forum_topic_messages
DescribesunpinAllGeneralForumTopicMessages method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
telegram_bot_unpin_chat_message
DescribesunpinChatMessage method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
message_id | integer | No | — | Identifier of a message to unpin. If not specified, the most recent pinned message (by sending date) will be unpinned. |

