> ## 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 > Telegram Bot - messaging, chat management, and bot settings **Server path:** `/telegram-bot` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | | [`telegram_bot_answer_callback_query`](#telegram_bot_answer_callback_query) | Describes `answerCallbackQuery` method | | [`telegram_bot_approve_chat_join_request`](#telegram_bot_approve_chat_join_request) | Describes `approveChatJoinRequest` method | | [`telegram_bot_ban_chat_member`](#telegram_bot_ban_chat_member) | Describes `banChatMember` method | | [`telegram_bot_ban_chat_sender_chat`](#telegram_bot_ban_chat_sender_chat) | Describes `banChatSenderChat` method | | [`telegram_bot_close`](#telegram_bot_close) | Describes `close` method | | [`telegram_bot_close_forum_topic`](#telegram_bot_close_forum_topic) | Describes `closeForumTopic` method | | [`telegram_bot_close_general_forum_topic`](#telegram_bot_close_general_forum_topic) | Describes `closeGeneralForumTopic` method | | [`telegram_bot_copy_message`](#telegram_bot_copy_message) | Describes `copyMessage` method | | [`telegram_bot_copy_messages`](#telegram_bot_copy_messages) | Describes `copyMessages` method | | [`telegram_bot_create_chat_invite_link`](#telegram_bot_create_chat_invite_link) | Describes `createChatInviteLink` method | | [`telegram_bot_create_forum_topic`](#telegram_bot_create_forum_topic) | Describes `createForumTopic` method | | [`telegram_bot_decline_chat_join_request`](#telegram_bot_decline_chat_join_request) | Describes `declineChatJoinRequest` method | | [`telegram_bot_delete_chat_photo`](#telegram_bot_delete_chat_photo) | Describes `deleteChatPhoto` method | | [`telegram_bot_delete_chat_sticker_set`](#telegram_bot_delete_chat_sticker_set) | Describes `deleteChatStickerSet` method | | [`telegram_bot_delete_forum_topic`](#telegram_bot_delete_forum_topic) | Describes `deleteForumTopic` method | | [`telegram_bot_delete_my_commands`](#telegram_bot_delete_my_commands) | Describes `deleteMyCommands` method | | [`telegram_bot_delete_webhook`](#telegram_bot_delete_webhook) | Describes `deleteWebhook` method | | [`telegram_bot_edit_chat_invite_link`](#telegram_bot_edit_chat_invite_link) | Describes `editChatInviteLink` method | | [`telegram_bot_edit_forum_topic`](#telegram_bot_edit_forum_topic) | Describes `editForumTopic` method | | [`telegram_bot_edit_general_forum_topic`](#telegram_bot_edit_general_forum_topic) | Describes `editGeneralForumTopic` method | | [`telegram_bot_export_chat_invite_link`](#telegram_bot_export_chat_invite_link) | Describes `exportChatInviteLink` method | | [`telegram_bot_forward_message`](#telegram_bot_forward_message) | Describes `forwardMessage` method | | [`telegram_bot_forward_messages`](#telegram_bot_forward_messages) | Describes `forwardMessages` method | | [`telegram_bot_get_business_connection`](#telegram_bot_get_business_connection) | Describes `getBusinessConnection` method | | [`telegram_bot_get_chat`](#telegram_bot_get_chat) | Describes `getChat` method | | [`telegram_bot_get_chat_administrators`](#telegram_bot_get_chat_administrators) | Describes `getChatAdministrators` method | | [`telegram_bot_get_chat_member`](#telegram_bot_get_chat_member) | Describes `getChatMember` method | | [`telegram_bot_get_chat_member_count`](#telegram_bot_get_chat_member_count) | Describes `getChatMemberCount` method | | [`telegram_bot_get_chat_menu_button`](#telegram_bot_get_chat_menu_button) | Describes `getChatMenuButton` method | | [`telegram_bot_get_file`](#telegram_bot_get_file) | Describes `getFile` method | | [`telegram_bot_get_forum_topic_icon_stickers`](#telegram_bot_get_forum_topic_icon_stickers) | Describes `getForumTopicIconStickers` method | | [`telegram_bot_get_me`](#telegram_bot_get_me) | Describes `getMe` method | | [`telegram_bot_get_my_commands`](#telegram_bot_get_my_commands) | Describes `getMyCommands` method | | [`telegram_bot_get_my_default_administrator_rights`](#telegram_bot_get_my_default_administrator_rights) | Describes `getMyDefaultAdministratorRights` method | | [`telegram_bot_get_my_description`](#telegram_bot_get_my_description) | Describes `getMyDescription` method | | [`telegram_bot_get_my_name`](#telegram_bot_get_my_name) | Describes `getMyName` method | | [`telegram_bot_get_my_short_description`](#telegram_bot_get_my_short_description) | Describes `getMyShortDescription` method | | [`telegram_bot_get_updates`](#telegram_bot_get_updates) | Describes `getUpdates` method | | [`telegram_bot_get_user_chat_boosts`](#telegram_bot_get_user_chat_boosts) | Describes `getUserChatBoosts` method | | [`telegram_bot_get_user_profile_photos`](#telegram_bot_get_user_profile_photos) | Describes `getUserProfilePhotos` method | | [`telegram_bot_get_webhook_info`](#telegram_bot_get_webhook_info) | Describes `getWebhookInfo` method | | [`telegram_bot_hide_general_forum_topic`](#telegram_bot_hide_general_forum_topic) | Describes `hideGeneralForumTopic` method | | [`telegram_bot_leave_chat`](#telegram_bot_leave_chat) | Describes `leaveChat` method | | [`telegram_bot_log_out`](#telegram_bot_log_out) | Describes `logOut` method | | [`telegram_bot_pin_chat_message`](#telegram_bot_pin_chat_message) | Describes `pinChatMessage` method | | [`telegram_bot_promote_chat_member`](#telegram_bot_promote_chat_member) | Describes `promoteChatMember` method | | [`telegram_bot_reopen_forum_topic`](#telegram_bot_reopen_forum_topic) | Describes `reopenForumTopic` method | | [`telegram_bot_reopen_general_forum_topic`](#telegram_bot_reopen_general_forum_topic) | Describes `reopenGeneralForumTopic` method | | [`telegram_bot_restrict_chat_member`](#telegram_bot_restrict_chat_member) | Describes `restrictChatMember` method | | [`telegram_bot_revoke_chat_invite_link`](#telegram_bot_revoke_chat_invite_link) | Describes `revokeChatInviteLink` method | | [`telegram_bot_send_animation`](#telegram_bot_send_animation) | Describes `sendAnimation` method | | [`telegram_bot_send_audio`](#telegram_bot_send_audio) | Describes `sendAudio` method | | [`telegram_bot_send_chat_action`](#telegram_bot_send_chat_action) | Describes `sendChatAction` method | | [`telegram_bot_send_contact`](#telegram_bot_send_contact) | Describes `sendContact` method | | [`telegram_bot_send_dice`](#telegram_bot_send_dice) | Describes `sendDice` method | | [`telegram_bot_send_document`](#telegram_bot_send_document) | Describes `sendDocument` method | | [`telegram_bot_send_location`](#telegram_bot_send_location) | Describes `sendLocation` method | | [`telegram_bot_send_media_group`](#telegram_bot_send_media_group) | Describes `sendMediaGroup` method | | [`telegram_bot_send_message`](#telegram_bot_send_message) | Describes `sendMessage` method | | [`telegram_bot_send_photo`](#telegram_bot_send_photo) | Describes `sendPhoto` method | | [`telegram_bot_send_poll`](#telegram_bot_send_poll) | Describes `sendPoll` method | | [`telegram_bot_send_venue`](#telegram_bot_send_venue) | Describes `sendVenue` method | | [`telegram_bot_send_video`](#telegram_bot_send_video) | Describes `sendVideo` method | | [`telegram_bot_send_video_note`](#telegram_bot_send_video_note) | Describes `sendVideoNote` method | | [`telegram_bot_send_voice`](#telegram_bot_send_voice) | Describes `sendVoice` method | | [`telegram_bot_set_chat_administrator_custom_title`](#telegram_bot_set_chat_administrator_custom_title) | Describes `setChatAdministratorCustomTitle` method | | [`telegram_bot_set_chat_description`](#telegram_bot_set_chat_description) | Describes `setChatDescription` method | | [`telegram_bot_set_chat_menu_button`](#telegram_bot_set_chat_menu_button) | Describes `setChatMenuButton` method | | [`telegram_bot_set_chat_permissions`](#telegram_bot_set_chat_permissions) | Describes `setChatPermissions` method | | [`telegram_bot_set_chat_photo`](#telegram_bot_set_chat_photo) | Describes `setChatPhoto` method | | [`telegram_bot_set_chat_sticker_set`](#telegram_bot_set_chat_sticker_set) | Describes `setChatStickerSet` method | | [`telegram_bot_set_chat_title`](#telegram_bot_set_chat_title) | Describes `setChatTitle` method | | [`telegram_bot_set_message_reaction`](#telegram_bot_set_message_reaction) | Describes `setMessageReaction` method | | [`telegram_bot_set_my_commands`](#telegram_bot_set_my_commands) | Describes `setMyCommands` method | | [`telegram_bot_set_my_default_administrator_rights`](#telegram_bot_set_my_default_administrator_rights) | Describes `setMyDefaultAdministratorRights` method | | [`telegram_bot_set_my_description`](#telegram_bot_set_my_description) | Describes `setMyDescription` method | | [`telegram_bot_set_my_name`](#telegram_bot_set_my_name) | Describes `setMyName` method | | [`telegram_bot_set_my_short_description`](#telegram_bot_set_my_short_description) | Describes `setMyShortDescription` method | | [`telegram_bot_set_webhook`](#telegram_bot_set_webhook) | Describes `setWebhook` method | | [`telegram_bot_unban_chat_member`](#telegram_bot_unban_chat_member) | Describes `unbanChatMember` method | | [`telegram_bot_unban_chat_sender_chat`](#telegram_bot_unban_chat_sender_chat) | Describes `unbanChatSenderChat` method | | [`telegram_bot_unhide_general_forum_topic`](#telegram_bot_unhide_general_forum_topic) | Describes `unhideGeneralForumTopic` method | | [`telegram_bot_unpin_all_chat_messages`](#telegram_bot_unpin_all_chat_messages) | Describes `unpinAllChatMessages` method | | [`telegram_bot_unpin_all_forum_topic_messages`](#telegram_bot_unpin_all_forum_topic_messages) | Describes `unpinAllForumTopicMessages` method | | [`telegram_bot_unpin_all_general_forum_topic_messages`](#telegram_bot_unpin_all_general_forum_topic_messages) | Describes `unpinAllGeneralForumTopicMessages` method | | [`telegram_bot_unpin_chat_message`](#telegram_bot_unpin_chat_message) | Describes `unpinChatMessage` method | *** ## telegram\_bot\_answer\_callback\_query Describes `answerCallbackQuery` 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](https://core.telegram.org/bots/api#game) and accepted the conditions via [@BotFather](https://t.me/botfather), specify the URL that opens your game - note that this will only work if the query comes from a [callback\_game](https://core.telegram.org/bots/api#inlinekeyboardbutton) button.Otherwise, you may use links like t.me/your\_bot?start=XXXX that open your bot with a parameter. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cache_time": { "type": "integer", "description": "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": { "type": "string", "description": "Unique identifier for the query to be answered" }, "show_alert": { "type": "boolean", "description": "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": { "type": "string", "description": "Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters" }, "url": { "type": "string", "description": "URL that will be opened by the user's client. If you have created a [Game](https://core.telegram.org/bots/api#game) and accepted the conditions via [@BotFather](https://t.me/botfather), specify the URL that opens your game - note that this will only work if the query comes from a [callback_game](https://core.telegram.org/bots/api#inlinekeyboardbutton) button.Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter." } }, "required": [ "PCID", "callback_query_id" ] } ``` *** ## telegram\_bot\_approve\_chat\_join\_request Describes `approveChatJoinRequest` 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "integer", "description": "Unique identifier of the target user" } }, "required": [ "PCID", "chat_id", "user_id" ] } ``` *** ## telegram\_bot\_ban\_chat\_member Describes `banChatMember` 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "boolean", "description": "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": { "type": "integer", "description": "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": { "type": "integer", "description": "Unique identifier of the target user" } }, "required": [ "PCID", "chat_id", "user_id" ] } ``` *** ## telegram\_bot\_ban\_chat\_sender\_chat Describes `banChatSenderChat` 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "integer", "description": "Unique identifier of the target sender chat" } }, "required": [ "PCID", "chat_id", "sender_chat_id" ] } ``` *** ## telegram\_bot\_close Describes `close` method ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## telegram\_bot\_close\_forum\_topic Describes `closeForumTopic` 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "integer", "description": "Unique identifier for the target message thread of the forum topic" } }, "required": [ "PCID", "chat_id", "message_thread_id" ] } ``` *** ## telegram\_bot\_close\_general\_forum\_topic Describes `closeGeneralForumTopic` 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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." } }, "required": [ "PCID", "chat_id" ] } ``` *** ## telegram\_bot\_copy\_message Describes `copyMessage` 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](https://telegram.org/blog/channels-2-0#silent-messages). 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](https://core.telegram.org/bots/api#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](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "caption": { "type": "string", "description": "New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept" }, "caption_entities": { "type": "array", "items": { "type": "object", "properties": { "custom_emoji_id": { "type": "string", "description": "Optional. For “custom_emoji” only, unique identifier of the custom emoji. Use [getCustomEmojiStickers](https://core.telegram.org/bots/api#getcustomemojistickers) to get full information about the sticker" }, "language": { "type": "string", "description": "Optional. For “pre” only, the programming language of the entity text" }, "length": { "type": "integer", "format": "int32", "description": "Length of the entity in [UTF-16 code units](https://core.telegram.org/api/entities#entity-length)" }, "offset": { "type": "integer", "format": "int32", "description": "Offset in [UTF-16 code units](https://core.telegram.org/api/entities#entity-length) to the start of the entity" }, "type": { "type": "string", "description": "Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “blockquote” (block quotation), “expandable_blockquote” (collapsed-by-default block quotation), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users [without usernames](https://telegram.org/blog/edit#new-mentions)), “custom_emoji” (for inline custom emoji stickers)" }, "url": { "type": "string", "description": "Optional. For “text_link” only, URL that will be opened after user taps on the text" }, "user": { "type": "object", "description": "This object represents a Telegram user or bot." } }, "required": [ "type", "offset", "length" ] }, "description": "A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of parse_mode" }, "chat_id": { "type": "string", "description": "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": { "type": "boolean", "description": "Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound." }, "from_chat_id": { "type": "string", "description": "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": { "type": "integer", "description": "Message identifier in the chat specified in from_chat_id" }, "message_thread_id": { "type": "integer", "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only" }, "parse_mode": { "type": "string", "description": "Mode for parsing entities in the new caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details." }, "protect_content": { "type": "boolean", "description": "Protects the contents of the sent message from forwarding and saving" }, "reply_markup": { "type": "object", "description": "Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user" }, "reply_parameters": { "type": "object", "description": "Describes reply parameters for the message that is being sent.", "properties": { "allow_sending_without_reply": { "type": "boolean", "description": "Optional. Pass True if the message should be sent even if the specified message to be replied to is not found. Always False for replies in another chat or forum topic. Always True for messages sent on behalf of a business account." }, "chat_id": { "type": "string", "description": "Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername). Not supported for messages sent on behalf of a business account. Pass as a numeric string or @username." }, "message_id": { "type": "integer", "description": "Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified" }, "quote": { "type": "string", "description": "Optional. Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, and custom_emoji entities. The message will fail to send if the quote isn't found in the original message." }, "quote_entities": { "type": "array", "items": { "type": "object" }, "description": "Optional. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of quote_parse_mode." }, "quote_parse_mode": { "type": "string", "description": "Optional. Mode for parsing entities in the quote. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details." }, "quote_position": { "type": "integer", "description": "Optional. Position of the quote in the original message in UTF-16 code units" } }, "required": [ "message_id" ] }, "show_caption_above_media": { "type": "boolean", "description": "Pass True, if the caption must be shown above the message media. Ignored if a new caption isn't specified." } }, "required": [ "PCID", "chat_id", "from_chat_id", "message_id" ] } ``` *** ## telegram\_bot\_copy\_messages Describes `copyMessages` 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](https://telegram.org/blog/channels-2-0#silent-messages). 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "boolean", "description": "Sends the messages [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound." }, "from_chat_id": { "type": "string", "description": "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": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "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": { "type": "integer", "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only" }, "protect_content": { "type": "boolean", "description": "Protects the contents of the sent messages from forwarding and saving" }, "remove_caption": { "type": "boolean", "description": "Pass True to copy the messages without their captions" } }, "required": [ "PCID", "chat_id", "from_chat_id", "message_ids" ] } ``` *** ## telegram\_bot\_create\_chat\_invite\_link Describes `createChatInviteLink` 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "boolean", "description": "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": { "type": "integer", "description": "Point in time (Unix timestamp) when the link will expire" }, "member_limit": { "type": "integer", "description": "The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999" }, "name": { "type": "string", "description": "Invite link name; 0-32 characters" } }, "required": [ "PCID", "chat_id" ] } ``` *** ## telegram\_bot\_create\_forum\_topic Describes `createForumTopic` 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](https://core.telegram.org/bots/api#getforumtopiciconstickers) to get all allowed custom emoji identifiers. | | `name` | string | Yes | — | Topic name, 1-128 characters | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "integer", "description": "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": { "type": "string", "description": "Unique identifier of the custom emoji shown as the topic icon. Use [getForumTopicIconStickers](https://core.telegram.org/bots/api#getforumtopiciconstickers) to get all allowed custom emoji identifiers." }, "name": { "type": "string", "description": "Topic name, 1-128 characters" } }, "required": [ "PCID", "chat_id", "name" ] } ``` *** ## telegram\_bot\_decline\_chat\_join\_request Describes `declineChatJoinRequest` 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "integer", "description": "Unique identifier of the target user" } }, "required": [ "PCID", "chat_id", "user_id" ] } ``` *** ## telegram\_bot\_delete\_chat\_photo Describes `deleteChatPhoto` 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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." } }, "required": [ "PCID", "chat_id" ] } ``` *** ## telegram\_bot\_delete\_chat\_sticker\_set Describes `deleteChatStickerSet` 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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." } }, "required": [ "PCID", "chat_id" ] } ``` *** ## telegram\_bot\_delete\_forum\_topic Describes `deleteForumTopic` 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "integer", "description": "Unique identifier for the target message thread of the forum topic" } }, "required": [ "PCID", "chat_id", "message_thread_id" ] } ``` *** ## telegram\_bot\_delete\_my\_commands Describes `deleteMyCommands` 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](https://core.telegram.org/bots/api#botcommandscopedefault) - [BotCommandScopeAllPrivateChats](https://core.telegram.org/bots/api#botcommandscopeallprivatechats) - [BotCommandScopeAllGroupChats](https://core.telegram.org/bots/api#botcommandscopeallgroupchats) - [BotCommandScopeAllChatAdministrators](https://core.telegram.org/bots/api#botcommandscopeallchatadministrators) - [BotCommandScopeChat](https://core.telegram.org/bots/api#botcommandscopechat) - [BotCommandScopeChatAdministrators](https://core.telegram.org/bots/api#botcommandscopechatadministrators) - [BotCommandScopeChatMember](https://core.telegram.org/bots/api#botcommandscopechatmember) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "language_code": { "type": "string", "description": "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": { "type": "object", "description": "This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported: - [BotCommandScopeDefault](https://core.telegram.org/bots/api#botcommandscopedefault) - [BotCommandScopeAllPrivateChats](https://core.telegram.org/bots/api#botcommandscopeallprivatechats) - [BotCommandScopeAllGroupChats](https://core.telegram.org/bots/api#botcommandscopeallgroupchats) - [BotCommandScopeAllChatAdministrators](https://core.telegram.org/bots/api#botcommandscopeallchatadministrators) - [BotCommandScopeChat](https://core.telegram.org/bots/api#botcommandscopechat) - [BotCommandScopeChatAdministrators](https://core.telegram.org/bots/api#botcommandscopechatadministrators) - [BotCommandScopeChatMember](https://core.telegram.org/bots/api#botcommandscopechatmember)" } }, "required": [ "PCID" ] } ``` *** ## telegram\_bot\_delete\_webhook Describes `deleteWebhook` method **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | ------------------------------------- | | `drop_pending_updates` | boolean | No | — | Pass True to drop all pending updates | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "drop_pending_updates": { "type": "boolean", "description": "Pass True to drop all pending updates" } }, "required": [ "PCID" ] } ``` *** ## telegram\_bot\_edit\_chat\_invite\_link Describes `editChatInviteLink` 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "boolean", "description": "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": { "type": "integer", "description": "Point in time (Unix timestamp) when the link will expire" }, "invite_link": { "type": "string", "description": "The invite link to edit" }, "member_limit": { "type": "integer", "description": "The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999" }, "name": { "type": "string", "description": "Invite link name; 0-32 characters" } }, "required": [ "PCID", "chat_id", "invite_link" ] } ``` *** ## telegram\_bot\_edit\_forum\_topic Describes `editForumTopic` 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](https://core.telegram.org/bots/api#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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "string", "description": "New unique identifier of the custom emoji shown as the topic icon. Use [getForumTopicIconStickers](https://core.telegram.org/bots/api#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": { "type": "integer", "description": "Unique identifier for the target message thread of the forum topic" }, "name": { "type": "string", "description": "New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept" } }, "required": [ "PCID", "chat_id", "message_thread_id" ] } ``` *** ## telegram\_bot\_edit\_general\_forum\_topic Describes `editGeneralForumTopic` 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "string", "description": "New topic name, 1-128 characters" } }, "required": [ "PCID", "chat_id", "name" ] } ``` *** ## telegram\_bot\_export\_chat\_invite\_link Describes `exportChatInviteLink` 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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." } }, "required": [ "PCID", "chat_id" ] } ``` *** ## telegram\_bot\_forward\_message Describes `forwardMessage` 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](https://telegram.org/blog/channels-2-0#silent-messages). 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "boolean", "description": "Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound." }, "from_chat_id": { "type": "string", "description": "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": { "type": "integer", "description": "Message identifier in the chat specified in from_chat_id" }, "message_thread_id": { "type": "integer", "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only" }, "protect_content": { "type": "boolean", "description": "Protects the contents of the forwarded message from forwarding and saving" } }, "required": [ "PCID", "chat_id", "from_chat_id", "message_id" ] } ``` *** ## telegram\_bot\_forward\_messages Describes `forwardMessages` 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](https://telegram.org/blog/channels-2-0#silent-messages). 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "boolean", "description": "Sends the messages [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound." }, "from_chat_id": { "type": "string", "description": "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": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "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": { "type": "integer", "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only" }, "protect_content": { "type": "boolean", "description": "Protects the contents of the forwarded messages from forwarding and saving" } }, "required": [ "PCID", "chat_id", "from_chat_id", "message_ids" ] } ``` *** ## telegram\_bot\_get\_business\_connection Describes `getBusinessConnection` method **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------ | ------ | -------- | ------- | -------------------------------------------- | | `business_connection_id` | string | Yes | — | Unique identifier of the business connection | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "business_connection_id": { "type": "string", "description": "Unique identifier of the business connection" } }, "required": [ "PCID", "business_connection_id" ] } ``` *** ## telegram\_bot\_get\_chat Describes `getChat` 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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." } }, "required": [ "PCID", "chat_id" ] } ``` *** ## telegram\_bot\_get\_chat\_administrators Describes `getChatAdministrators` 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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." } }, "required": [ "PCID", "chat_id" ] } ``` *** ## telegram\_bot\_get\_chat\_member Describes `getChatMember` 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "integer", "description": "Unique identifier of the target user" } }, "required": [ "PCID", "chat_id", "user_id" ] } ``` *** ## telegram\_bot\_get\_chat\_member\_count Describes `getChatMemberCount` 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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." } }, "required": [ "PCID", "chat_id" ] } ``` *** ## telegram\_bot\_get\_chat\_menu\_button Describes `getChatMenuButton` 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "integer", "description": "Unique identifier for the target private chat. If not specified, default bot's menu button will be returned" } }, "required": [ "PCID" ] } ``` *** ## telegram\_bot\_get\_file Describes `getFile` method **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ---------------------------------------- | | `file_id` | string | Yes | — | File identifier to get information about | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "file_id": { "type": "string", "description": "File identifier to get information about" } }, "required": [ "PCID", "file_id" ] } ``` *** ## telegram\_bot\_get\_forum\_topic\_icon\_stickers Describes `getForumTopicIconStickers` method ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## telegram\_bot\_get\_me Describes `getMe` method ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## telegram\_bot\_get\_my\_commands Describes `getMyCommands` 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](https://core.telegram.org/bots/api#botcommandscopedefault) - [BotCommandScopeAllPrivateChats](https://core.telegram.org/bots/api#botcommandscopeallprivatechats) - [BotCommandScopeAllGroupChats](https://core.telegram.org/bots/api#botcommandscopeallgroupchats) - [BotCommandScopeAllChatAdministrators](https://core.telegram.org/bots/api#botcommandscopeallchatadministrators) - [BotCommandScopeChat](https://core.telegram.org/bots/api#botcommandscopechat) - [BotCommandScopeChatAdministrators](https://core.telegram.org/bots/api#botcommandscopechatadministrators) - [BotCommandScopeChatMember](https://core.telegram.org/bots/api#botcommandscopechatmember) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "language_code": { "type": "string", "description": "A two-letter ISO 639-1 language code or an empty string" }, "scope": { "type": "object", "description": "This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported: - [BotCommandScopeDefault](https://core.telegram.org/bots/api#botcommandscopedefault) - [BotCommandScopeAllPrivateChats](https://core.telegram.org/bots/api#botcommandscopeallprivatechats) - [BotCommandScopeAllGroupChats](https://core.telegram.org/bots/api#botcommandscopeallgroupchats) - [BotCommandScopeAllChatAdministrators](https://core.telegram.org/bots/api#botcommandscopeallchatadministrators) - [BotCommandScopeChat](https://core.telegram.org/bots/api#botcommandscopechat) - [BotCommandScopeChatAdministrators](https://core.telegram.org/bots/api#botcommandscopechatadministrators) - [BotCommandScopeChatMember](https://core.telegram.org/bots/api#botcommandscopechatmember)" } }, "required": [ "PCID" ] } ``` *** ## telegram\_bot\_get\_my\_default\_administrator\_rights Describes `getMyDefaultAdministratorRights` 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "for_channels": { "type": "boolean", "description": "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." } }, "required": [ "PCID" ] } ``` *** ## telegram\_bot\_get\_my\_description Describes `getMyDescription` method **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ------------------------------------------------------- | | `language_code` | string | No | — | A two-letter ISO 639-1 language code or an empty string | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "language_code": { "type": "string", "description": "A two-letter ISO 639-1 language code or an empty string" } }, "required": [ "PCID" ] } ``` *** ## telegram\_bot\_get\_my\_name Describes `getMyName` method **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ------------------------------------------------------- | | `language_code` | string | No | — | A two-letter ISO 639-1 language code or an empty string | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "language_code": { "type": "string", "description": "A two-letter ISO 639-1 language code or an empty string" } }, "required": [ "PCID" ] } ``` *** ## telegram\_bot\_get\_my\_short\_description Describes `getMyShortDescription` method **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ------------------------------------------------------- | | `language_code` | string | No | — | A two-letter ISO 639-1 language code or an empty string | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "language_code": { "type": "string", "description": "A two-letter ISO 639-1 language code or an empty string" } }, "required": [ "PCID" ] } ``` *** ## telegram\_bot\_get\_updates Describes `getUpdates` 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](https://core.telegram.org/bots/api#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](https://core.telegram.org/bots/api#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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "allowed_updates": { "type": "array", "items": { "type": "string" }, "description": "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](https://core.telegram.org/bots/api#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": { "type": "integer", "description": "Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100." }, "offset": { "type": "integer", "description": "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](https://core.telegram.org/bots/api#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": { "type": "integer", "description": "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." } }, "required": [ "PCID" ] } ``` *** ## telegram\_bot\_get\_user\_chat\_boosts Describes `getUserChatBoosts` 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "integer", "description": "Unique identifier of the target user" } }, "required": [ "PCID", "chat_id", "user_id" ] } ``` *** ## telegram\_bot\_get\_user\_profile\_photos Describes `getUserProfilePhotos` 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100." }, "offset": { "type": "integer", "description": "Sequential number of the first photo to be returned. By default, all photos are returned." }, "user_id": { "type": "integer", "description": "Unique identifier of the target user" } }, "required": [ "PCID", "user_id" ] } ``` *** ## telegram\_bot\_get\_webhook\_info Describes `getWebhookInfo` method ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## telegram\_bot\_hide\_general\_forum\_topic Describes `hideGeneralForumTopic` 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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." } }, "required": [ "PCID", "chat_id" ] } ``` *** ## telegram\_bot\_leave\_chat Describes `leaveChat` 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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." } }, "required": [ "PCID", "chat_id" ] } ``` *** ## telegram\_bot\_log\_out Describes `logOut` method ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## telegram\_bot\_pin\_chat\_message Describes `pinChatMessage` 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "boolean", "description": "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": { "type": "integer", "description": "Identifier of a message to pin" } }, "required": [ "PCID", "chat_id", "message_id" ] } ``` *** ## telegram\_bot\_promote\_chat\_member Describes `promoteChatMember` 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "can_change_info": { "type": "boolean", "description": "Pass True if the administrator can change chat title, photo and other settings" }, "can_delete_messages": { "type": "boolean", "description": "Pass True if the administrator can delete messages of other users" }, "can_delete_stories": { "type": "boolean", "description": "Pass True if the administrator can delete stories posted by other users" }, "can_edit_messages": { "type": "boolean", "description": "Pass True if the administrator can edit messages of other users and can pin messages; for channels only" }, "can_edit_stories": { "type": "boolean", "description": "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": { "type": "boolean", "description": "Pass True if the administrator can invite new users to the chat" }, "can_manage_chat": { "type": "boolean", "description": "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": { "type": "boolean", "description": "Pass True if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only" }, "can_manage_video_chats": { "type": "boolean", "description": "Pass True if the administrator can manage video chats" }, "can_pin_messages": { "type": "boolean", "description": "Pass True if the administrator can pin messages; for supergroups only" }, "can_post_messages": { "type": "boolean", "description": "Pass True if the administrator can post messages in the channel, or access channel statistics; for channels only" }, "can_post_stories": { "type": "boolean", "description": "Pass True if the administrator can post stories to the chat" }, "can_promote_members": { "type": "boolean", "description": "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": { "type": "boolean", "description": "Pass True if the administrator can restrict, ban or unban chat members, or access supergroup statistics" }, "chat_id": { "type": "string", "description": "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": { "type": "boolean", "description": "Pass True if the administrator's presence in the chat is hidden" }, "user_id": { "type": "integer", "description": "Unique identifier of the target user" } }, "required": [ "PCID", "chat_id", "user_id" ] } ``` *** ## telegram\_bot\_reopen\_forum\_topic Describes `reopenForumTopic` 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "integer", "description": "Unique identifier for the target message thread of the forum topic" } }, "required": [ "PCID", "chat_id", "message_thread_id" ] } ``` *** ## telegram\_bot\_reopen\_general\_forum\_topic Describes `reopenGeneralForumTopic` 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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." } }, "required": [ "PCID", "chat_id" ] } ``` *** ## telegram\_bot\_restrict\_chat\_member Describes `restrictChatMember` 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "object", "description": "Describes actions that a non-administrator user is allowed to take in a chat.", "properties": { "can_add_web_page_previews": { "type": "boolean", "description": "Optional. True, if the user is allowed to add web page previews to their messages" }, "can_change_info": { "type": "boolean", "description": "Optional. True, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups" }, "can_invite_users": { "type": "boolean", "description": "Optional. True, if the user is allowed to invite new users to the chat" }, "can_manage_topics": { "type": "boolean", "description": "Optional. True, if the user is allowed to create forum topics. If omitted defaults to the value of can_pin_messages" }, "can_pin_messages": { "type": "boolean", "description": "Optional. True, if the user is allowed to pin messages. Ignored in public supergroups" }, "can_send_audios": { "type": "boolean", "description": "Optional. True, if the user is allowed to send audios" }, "can_send_documents": { "type": "boolean", "description": "Optional. True, if the user is allowed to send documents" }, "can_send_messages": { "type": "boolean", "description": "Optional. True, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues" }, "can_send_other_messages": { "type": "boolean", "description": "Optional. True, if the user is allowed to send animations, games, stickers and use inline bots" }, "can_send_photos": { "type": "boolean", "description": "Optional. True, if the user is allowed to send photos" }, "can_send_polls": { "type": "boolean", "description": "Optional. True, if the user is allowed to send polls" }, "can_send_video_notes": { "type": "boolean", "description": "Optional. True, if the user is allowed to send video notes" }, "can_send_videos": { "type": "boolean", "description": "Optional. True, if the user is allowed to send videos" }, "can_send_voice_notes": { "type": "boolean", "description": "Optional. True, if the user is allowed to send voice notes" } } }, "until_date": { "type": "integer", "description": "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": { "type": "boolean", "description": "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": { "type": "integer", "description": "Unique identifier of the target user" } }, "required": [ "PCID", "chat_id", "permissions", "user_id" ] } ``` *** ## telegram\_bot\_revoke\_chat\_invite\_link Describes `revokeChatInviteLink` 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "string", "description": "The invite link to revoke" } }, "required": [ "PCID", "chat_id", "invite_link" ] } ``` *** ## telegram\_bot\_send\_animation Describes `sendAnimation` 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 »](https://core.telegram.org/bots/api#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](https://telegram.org/blog/channels-2-0#silent-messages). 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](https://core.telegram.org/bots/api#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](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), 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://\” if the thumbnail was uploaded using multipart/form-data under \. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | | `width` | integer | No | — | Animation width | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "animation": { "type": "string", "description": "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 »](https://core.telegram.org/bots/api#sending-files)" }, "business_connection_id": { "type": "string", "description": "Unique identifier of the business connection on behalf of which the message will be sent" }, "caption": { "type": "string", "description": "Animation caption (may also be used when resending animation by file_id), 0-1024 characters after entities parsing" }, "caption_entities": { "type": "array", "items": { "type": "object", "properties": { "custom_emoji_id": { "type": "string", "description": "Optional. For “custom_emoji” only, unique identifier of the custom emoji. Use [getCustomEmojiStickers](https://core.telegram.org/bots/api#getcustomemojistickers) to get full information about the sticker" }, "language": { "type": "string", "description": "Optional. For “pre” only, the programming language of the entity text" }, "length": { "type": "integer", "format": "int32", "description": "Length of the entity in [UTF-16 code units](https://core.telegram.org/api/entities#entity-length)" }, "offset": { "type": "integer", "format": "int32", "description": "Offset in [UTF-16 code units](https://core.telegram.org/api/entities#entity-length) to the start of the entity" }, "type": { "type": "string", "description": "Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “blockquote” (block quotation), “expandable_blockquote” (collapsed-by-default block quotation), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users [without usernames](https://telegram.org/blog/edit#new-mentions)), “custom_emoji” (for inline custom emoji stickers)" }, "url": { "type": "string", "description": "Optional. For “text_link” only, URL that will be opened after user taps on the text" }, "user": { "type": "object", "description": "This object represents a Telegram user or bot." } }, "required": [ "type", "offset", "length" ] }, "description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode" }, "chat_id": { "type": "string", "description": "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": { "type": "boolean", "description": "Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound." }, "duration": { "type": "integer", "description": "Duration of sent animation in seconds" }, "has_spoiler": { "type": "boolean", "description": "Pass True if the animation needs to be covered with a spoiler animation" }, "height": { "type": "integer", "description": "Animation height" }, "message_effect_id": { "type": "string", "description": "Unique identifier of the message effect to be added to the message; for private chats only" }, "message_thread_id": { "type": "integer", "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only" }, "parse_mode": { "type": "string", "description": "Mode for parsing entities in the animation caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details." }, "protect_content": { "type": "boolean", "description": "Protects the contents of the sent message from forwarding and saving" }, "reply_markup": { "type": "object", "description": "Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user" }, "reply_parameters": { "type": "object", "description": "Describes reply parameters for the message that is being sent.", "properties": { "allow_sending_without_reply": { "type": "boolean", "description": "Optional. Pass True if the message should be sent even if the specified message to be replied to is not found. Always False for replies in another chat or forum topic. Always True for messages sent on behalf of a business account." }, "chat_id": { "type": "string", "description": "Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername). Not supported for messages sent on behalf of a business account. Pass as a numeric string or @username." }, "message_id": { "type": "integer", "description": "Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified" }, "quote": { "type": "string", "description": "Optional. Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, and custom_emoji entities. The message will fail to send if the quote isn't found in the original message." }, "quote_entities": { "type": "array", "items": { "type": "object" }, "description": "Optional. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of quote_parse_mode." }, "quote_parse_mode": { "type": "string", "description": "Optional. Mode for parsing entities in the quote. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details." }, "quote_position": { "type": "integer", "description": "Optional. Position of the quote in the original message in UTF-16 code units" } }, "required": [ "message_id" ] }, "show_caption_above_media": { "type": "boolean", "description": "Pass True, if the caption must be shown above the message media" }, "thumbnail": { "type": "string", "description": "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://” if the thumbnail was uploaded using multipart/form-data under . [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files)" }, "width": { "type": "integer", "description": "Animation width" } }, "required": [ "PCID", "animation", "chat_id" ] } ``` *** ## telegram\_bot\_send\_audio Describes `sendAudio` 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 »](https://core.telegram.org/bots/api#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](https://telegram.org/blog/channels-2-0#silent-messages). 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](https://core.telegram.org/bots/api#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](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), 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://\” if the thumbnail was uploaded using multipart/form-data under \. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | | `title` | string | No | — | Track name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "audio": { "type": "string", "description": "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 »](https://core.telegram.org/bots/api#sending-files)" }, "business_connection_id": { "type": "string", "description": "Unique identifier of the business connection on behalf of which the message will be sent" }, "caption": { "type": "string", "description": "Audio caption, 0-1024 characters after entities parsing" }, "caption_entities": { "type": "array", "items": { "type": "object", "properties": { "custom_emoji_id": { "type": "string", "description": "Optional. For “custom_emoji” only, unique identifier of the custom emoji. Use [getCustomEmojiStickers](https://core.telegram.org/bots/api#getcustomemojistickers) to get full information about the sticker" }, "language": { "type": "string", "description": "Optional. For “pre” only, the programming language of the entity text" }, "length": { "type": "integer", "format": "int32", "description": "Length of the entity in [UTF-16 code units](https://core.telegram.org/api/entities#entity-length)" }, "offset": { "type": "integer", "format": "int32", "description": "Offset in [UTF-16 code units](https://core.telegram.org/api/entities#entity-length) to the start of the entity" }, "type": { "type": "string", "description": "Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “blockquote” (block quotation), “expandable_blockquote” (collapsed-by-default block quotation), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users [without usernames](https://telegram.org/blog/edit#new-mentions)), “custom_emoji” (for inline custom emoji stickers)" }, "url": { "type": "string", "description": "Optional. For “text_link” only, URL that will be opened after user taps on the text" }, "user": { "type": "object", "description": "This object represents a Telegram user or bot." } }, "required": [ "type", "offset", "length" ] }, "description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode" }, "chat_id": { "type": "string", "description": "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": { "type": "boolean", "description": "Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound." }, "duration": { "type": "integer", "description": "Duration of the audio in seconds" }, "message_effect_id": { "type": "string", "description": "Unique identifier of the message effect to be added to the message; for private chats only" }, "message_thread_id": { "type": "integer", "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only" }, "parse_mode": { "type": "string", "description": "Mode for parsing entities in the audio caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details." }, "performer": { "type": "string", "description": "The performer value" }, "protect_content": { "type": "boolean", "description": "Protects the contents of the sent message from forwarding and saving" }, "reply_markup": { "type": "object", "description": "Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user" }, "reply_parameters": { "type": "object", "description": "Describes reply parameters for the message that is being sent.", "properties": { "allow_sending_without_reply": { "type": "boolean", "description": "Optional. Pass True if the message should be sent even if the specified message to be replied to is not found. Always False for replies in another chat or forum topic. Always True for messages sent on behalf of a business account." }, "chat_id": { "type": "string", "description": "Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername). Not supported for messages sent on behalf of a business account. Pass as a numeric string or @username." }, "message_id": { "type": "integer", "description": "Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified" }, "quote": { "type": "string", "description": "Optional. Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, and custom_emoji entities. The message will fail to send if the quote isn't found in the original message." }, "quote_entities": { "type": "array", "items": { "type": "object" }, "description": "Optional. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of quote_parse_mode." }, "quote_parse_mode": { "type": "string", "description": "Optional. Mode for parsing entities in the quote. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details." }, "quote_position": { "type": "integer", "description": "Optional. Position of the quote in the original message in UTF-16 code units" } }, "required": [ "message_id" ] }, "thumbnail": { "type": "string", "description": "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://” if the thumbnail was uploaded using multipart/form-data under . [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files)" }, "title": { "type": "string", "description": "Track name" } }, "required": [ "PCID", "audio", "chat_id" ] } ``` *** ## telegram\_bot\_send\_chat\_action Describes `sendChatAction` 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](https://core.telegram.org/bots/api#sendmessage), upload\_photo for [photos](https://core.telegram.org/bots/api#sendphoto), record\_video or upload\_video for [videos](https://core.telegram.org/bots/api#sendvideo), record\_voice or upload\_voice for [voice notes](https://core.telegram.org/bots/api#sendvoice), upload\_document for [general files](https://core.telegram.org/bots/api#senddocument), choose\_sticker for [stickers](https://core.telegram.org/bots/api#sendsticker), find\_location for [location data](https://core.telegram.org/bots/api#sendlocation), record\_video\_note or upload\_video\_note for [video notes](https://core.telegram.org/bots/api#sendvideonote). | | `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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "action": { "type": "string", "description": "Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for [text messages](https://core.telegram.org/bots/api#sendmessage), upload_photo for [photos](https://core.telegram.org/bots/api#sendphoto), record_video or upload_video for [videos](https://core.telegram.org/bots/api#sendvideo), record_voice or upload_voice for [voice notes](https://core.telegram.org/bots/api#sendvoice), upload_document for [general files](https://core.telegram.org/bots/api#senddocument), choose_sticker for [stickers](https://core.telegram.org/bots/api#sendsticker), find_location for [location data](https://core.telegram.org/bots/api#sendlocation), record_video_note or upload_video_note for [video notes](https://core.telegram.org/bots/api#sendvideonote)." }, "business_connection_id": { "type": "string", "description": "Unique identifier of the business connection on behalf of which the action will be sent" }, "chat_id": { "type": "string", "description": "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": { "type": "integer", "description": "Unique identifier for the target message thread; for supergroups only" } }, "required": [ "PCID", "action", "chat_id" ] } ``` *** ## telegram\_bot\_send\_contact Describes `sendContact` 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](https://telegram.org/blog/channels-2-0#silent-messages). 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](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), 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](https://en.wikipedia.org/wiki/VCard), 0-2048 bytes | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "business_connection_id": { "type": "string", "description": "Unique identifier of the business connection on behalf of which the message will be sent" }, "chat_id": { "type": "string", "description": "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": { "type": "boolean", "description": "Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound." }, "first_name": { "type": "string", "description": "Contact's first name" }, "last_name": { "type": "string", "description": "Contact's last name" }, "message_effect_id": { "type": "string", "description": "Unique identifier of the message effect to be added to the message; for private chats only" }, "message_thread_id": { "type": "integer", "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only" }, "phone_number": { "type": "string", "description": "Contact's phone number" }, "protect_content": { "type": "boolean", "description": "Protects the contents of the sent message from forwarding and saving" }, "reply_markup": { "type": "object", "description": "Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user" }, "reply_parameters": { "type": "object", "description": "Describes reply parameters for the message that is being sent.", "properties": { "allow_sending_without_reply": { "type": "boolean", "description": "Optional. Pass True if the message should be sent even if the specified message to be replied to is not found. Always False for replies in another chat or forum topic. Always True for messages sent on behalf of a business account." }, "chat_id": { "type": "string", "description": "Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername). Not supported for messages sent on behalf of a business account. Pass as a numeric string or @username." }, "message_id": { "type": "integer", "description": "Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified" }, "quote": { "type": "string", "description": "Optional. Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, and custom_emoji entities. The message will fail to send if the quote isn't found in the original message." }, "quote_entities": { "type": "array", "items": { "type": "object" }, "description": "Optional. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of quote_parse_mode." }, "quote_parse_mode": { "type": "string", "description": "Optional. Mode for parsing entities in the quote. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details." }, "quote_position": { "type": "integer", "description": "Optional. Position of the quote in the original message in UTF-16 code units" } }, "required": [ "message_id" ] }, "vcard": { "type": "string", "description": "Additional data about the contact in the form of a [vCard](https://en.wikipedia.org/wiki/VCard), 0-2048 bytes" } }, "required": [ "PCID", "chat_id", "first_name", "phone_number" ] } ``` *** ## telegram\_bot\_send\_dice Describes `sendDice` 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](https://telegram.org/blog/channels-2-0#silent-messages). 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](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "business_connection_id": { "type": "string", "description": "Unique identifier of the business connection on behalf of which the message will be sent" }, "chat_id": { "type": "string", "description": "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": { "type": "boolean", "description": "Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound." }, "emoji": { "type": "string", "description": "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": { "type": "string", "description": "Unique identifier of the message effect to be added to the message; for private chats only" }, "message_thread_id": { "type": "integer", "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only" }, "protect_content": { "type": "boolean", "description": "Protects the contents of the sent message from forwarding" }, "reply_markup": { "type": "object", "description": "Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user" }, "reply_parameters": { "type": "object", "description": "Describes reply parameters for the message that is being sent.", "properties": { "allow_sending_without_reply": { "type": "boolean", "description": "Optional. Pass True if the message should be sent even if the specified message to be replied to is not found. Always False for replies in another chat or forum topic. Always True for messages sent on behalf of a business account." }, "chat_id": { "type": "string", "description": "Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername). Not supported for messages sent on behalf of a business account. Pass as a numeric string or @username." }, "message_id": { "type": "integer", "description": "Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified" }, "quote": { "type": "string", "description": "Optional. Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, and custom_emoji entities. The message will fail to send if the quote isn't found in the original message." }, "quote_entities": { "type": "array", "items": { "type": "object" }, "description": "Optional. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of quote_parse_mode." }, "quote_parse_mode": { "type": "string", "description": "Optional. Mode for parsing entities in the quote. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details." }, "quote_position": { "type": "integer", "description": "Optional. Position of the quote in the original message in UTF-16 code units" } }, "required": [ "message_id" ] } }, "required": [ "PCID", "chat_id" ] } ``` *** ## telegram\_bot\_send\_document Describes `sendDocument` 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](https://telegram.org/blog/channels-2-0#silent-messages). 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 »](https://core.telegram.org/bots/api#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](https://core.telegram.org/bots/api#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](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), 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://\” if the thumbnail was uploaded using multipart/form-data under \. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "business_connection_id": { "type": "string", "description": "Unique identifier of the business connection on behalf of which the message will be sent" }, "caption": { "type": "string", "description": "Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing" }, "caption_entities": { "type": "array", "items": { "type": "object", "properties": { "custom_emoji_id": { "type": "string", "description": "Optional. For “custom_emoji” only, unique identifier of the custom emoji. Use [getCustomEmojiStickers](https://core.telegram.org/bots/api#getcustomemojistickers) to get full information about the sticker" }, "language": { "type": "string", "description": "Optional. For “pre” only, the programming language of the entity text" }, "length": { "type": "integer", "format": "int32", "description": "Length of the entity in [UTF-16 code units](https://core.telegram.org/api/entities#entity-length)" }, "offset": { "type": "integer", "format": "int32", "description": "Offset in [UTF-16 code units](https://core.telegram.org/api/entities#entity-length) to the start of the entity" }, "type": { "type": "string", "description": "Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “blockquote” (block quotation), “expandable_blockquote” (collapsed-by-default block quotation), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users [without usernames](https://telegram.org/blog/edit#new-mentions)), “custom_emoji” (for inline custom emoji stickers)" }, "url": { "type": "string", "description": "Optional. For “text_link” only, URL that will be opened after user taps on the text" }, "user": { "type": "object", "description": "This object represents a Telegram user or bot." } }, "required": [ "type", "offset", "length" ] }, "description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode" }, "chat_id": { "type": "string", "description": "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": { "type": "boolean", "description": "Disables automatic server-side content type detection for files uploaded using multipart/form-data" }, "disable_notification": { "type": "boolean", "description": "Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound." }, "document": { "type": "string", "description": "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 »](https://core.telegram.org/bots/api#sending-files)" }, "message_effect_id": { "type": "string", "description": "Unique identifier of the message effect to be added to the message; for private chats only" }, "message_thread_id": { "type": "integer", "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only" }, "parse_mode": { "type": "string", "description": "Mode for parsing entities in the document caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details." }, "protect_content": { "type": "boolean", "description": "Protects the contents of the sent message from forwarding and saving" }, "reply_markup": { "type": "object", "description": "Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user" }, "reply_parameters": { "type": "object", "description": "Describes reply parameters for the message that is being sent.", "properties": { "allow_sending_without_reply": { "type": "boolean", "description": "Optional. Pass True if the message should be sent even if the specified message to be replied to is not found. Always False for replies in another chat or forum topic. Always True for messages sent on behalf of a business account." }, "chat_id": { "type": "string", "description": "Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername). Not supported for messages sent on behalf of a business account. Pass as a numeric string or @username." }, "message_id": { "type": "integer", "description": "Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified" }, "quote": { "type": "string", "description": "Optional. Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, and custom_emoji entities. The message will fail to send if the quote isn't found in the original message." }, "quote_entities": { "type": "array", "items": { "type": "object" }, "description": "Optional. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of quote_parse_mode." }, "quote_parse_mode": { "type": "string", "description": "Optional. Mode for parsing entities in the quote. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details." }, "quote_position": { "type": "integer", "description": "Optional. Position of the quote in the original message in UTF-16 code units" } }, "required": [ "message_id" ] }, "thumbnail": { "type": "string", "description": "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://” if the thumbnail was uploaded using multipart/form-data under . [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files)" } }, "required": [ "PCID", "chat_id", "document" ] } ``` *** ## telegram\_bot\_send\_location Describes `sendLocation` 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](https://telegram.org/blog/channels-2-0#silent-messages). 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](https://telegram.org/blog/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](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "business_connection_id": { "type": "string", "description": "Unique identifier of the business connection on behalf of which the message will be sent" }, "chat_id": { "type": "string", "description": "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": { "type": "boolean", "description": "Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound." }, "heading": { "type": "integer", "description": "For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified." }, "horizontal_accuracy": { "type": "number", "description": "The radius of uncertainty for the location, measured in meters; 0-1500" }, "latitude": { "type": "number", "description": "Latitude of the location" }, "live_period": { "type": "integer", "description": "Period in seconds during which the location will be updated (see [Live Locations](https://telegram.org/blog/live-locations), should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely." }, "longitude": { "type": "number", "description": "Longitude of the location" }, "message_effect_id": { "type": "string", "description": "Unique identifier of the message effect to be added to the message; for private chats only" }, "message_thread_id": { "type": "integer", "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only" }, "protect_content": { "type": "boolean", "description": "Protects the contents of the sent message from forwarding and saving" }, "proximity_alert_radius": { "type": "integer", "description": "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": { "type": "object", "description": "Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user" }, "reply_parameters": { "type": "object", "description": "Describes reply parameters for the message that is being sent.", "properties": { "allow_sending_without_reply": { "type": "boolean", "description": "Optional. Pass True if the message should be sent even if the specified message to be replied to is not found. Always False for replies in another chat or forum topic. Always True for messages sent on behalf of a business account." }, "chat_id": { "type": "string", "description": "Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername). Not supported for messages sent on behalf of a business account. Pass as a numeric string or @username." }, "message_id": { "type": "integer", "description": "Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified" }, "quote": { "type": "string", "description": "Optional. Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, and custom_emoji entities. The message will fail to send if the quote isn't found in the original message." }, "quote_entities": { "type": "array", "items": { "type": "object" }, "description": "Optional. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of quote_parse_mode." }, "quote_parse_mode": { "type": "string", "description": "Optional. Mode for parsing entities in the quote. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details." }, "quote_position": { "type": "integer", "description": "Optional. Position of the quote in the original message in UTF-16 code units" } }, "required": [ "message_id" ] } }, "required": [ "PCID", "chat_id", "latitude", "longitude" ] } ``` *** ## telegram\_bot\_send\_media\_group Describes `sendMediaGroup` 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](https://telegram.org/blog/channels-2-0#silent-messages). 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "business_connection_id": { "type": "string", "description": "Unique identifier of the business connection on behalf of which the message will be sent" }, "chat_id": { "type": "string", "description": "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": { "type": "boolean", "description": "Sends messages [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound." }, "media": { "type": "array", "description": "A JSON-serialized array describing messages to be sent, must include 2-10 items" }, "message_effect_id": { "type": "string", "description": "Unique identifier of the message effect to be added to the message; for private chats only" }, "message_thread_id": { "type": "integer", "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only" }, "protect_content": { "type": "boolean", "description": "Protects the contents of the sent messages from forwarding and saving" }, "reply_parameters": { "type": "object", "description": "Describes reply parameters for the message that is being sent.", "properties": { "allow_sending_without_reply": { "type": "boolean", "description": "Optional. Pass True if the message should be sent even if the specified message to be replied to is not found. Always False for replies in another chat or forum topic. Always True for messages sent on behalf of a business account." }, "chat_id": { "type": "string", "description": "Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername). Not supported for messages sent on behalf of a business account. Pass as a numeric string or @username." }, "message_id": { "type": "integer", "description": "Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified" }, "quote": { "type": "string", "description": "Optional. Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, and custom_emoji entities. The message will fail to send if the quote isn't found in the original message." }, "quote_entities": { "type": "array", "items": { "type": "object" }, "description": "Optional. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of quote_parse_mode." }, "quote_parse_mode": { "type": "string", "description": "Optional. Mode for parsing entities in the quote. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details." }, "quote_position": { "type": "integer", "description": "Optional. Position of the quote in the original message in UTF-16 code units" } }, "required": [ "message_id" ] } }, "required": [ "PCID", "chat_id", "media" ] } ``` *** ## telegram\_bot\_send\_message Describes `sendMessage` 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](https://telegram.org/blog/channels-2-0#silent-messages). 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](https://core.telegram.org/bots/api#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](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "business_connection_id": { "type": "string", "description": "Unique identifier of the business connection on behalf of which the message will be sent" }, "chat_id": { "type": "string", "description": "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": { "type": "boolean", "description": "Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound." }, "entities": { "type": "array", "items": { "type": "object", "properties": { "custom_emoji_id": { "type": "string", "description": "Optional. For “custom_emoji” only, unique identifier of the custom emoji. Use [getCustomEmojiStickers](https://core.telegram.org/bots/api#getcustomemojistickers) to get full information about the sticker" }, "language": { "type": "string", "description": "Optional. For “pre” only, the programming language of the entity text" }, "length": { "type": "integer", "format": "int32", "description": "Length of the entity in [UTF-16 code units](https://core.telegram.org/api/entities#entity-length)" }, "offset": { "type": "integer", "format": "int32", "description": "Offset in [UTF-16 code units](https://core.telegram.org/api/entities#entity-length) to the start of the entity" }, "type": { "type": "string", "description": "Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “blockquote” (block quotation), “expandable_blockquote” (collapsed-by-default block quotation), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users [without usernames](https://telegram.org/blog/edit#new-mentions)), “custom_emoji” (for inline custom emoji stickers)" }, "url": { "type": "string", "description": "Optional. For “text_link” only, URL that will be opened after user taps on the text" }, "user": { "type": "object", "description": "This object represents a Telegram user or bot." } }, "required": [ "type", "offset", "length" ] }, "description": "A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode" }, "link_preview_options": { "type": "object", "description": "Describes the options used for link preview generation.", "properties": { "is_disabled": { "type": "boolean", "description": "Optional. True, if the link preview is disabled" }, "prefer_large_media": { "type": "boolean", "description": "Optional. True, if the media in the link preview is supposed to be enlarged; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview" }, "prefer_small_media": { "type": "boolean", "description": "Optional. True, if the media in the link preview is supposed to be shrunk; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview" }, "show_above_text": { "type": "boolean", "description": "Optional. True, if the link preview must be shown above the message text; otherwise, the link preview will be shown below the message text" }, "url": { "type": "string", "description": "Optional. URL to use for the link preview. If empty, then the first URL found in the message text will be used" } } }, "message_effect_id": { "type": "string", "description": "Unique identifier of the message effect to be added to the message; for private chats only" }, "message_thread_id": { "type": "integer", "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only" }, "parse_mode": { "type": "string", "description": "Mode for parsing entities in the message text. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details." }, "protect_content": { "type": "boolean", "description": "Protects the contents of the sent message from forwarding and saving" }, "reply_markup": { "type": "object", "description": "Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user" }, "reply_parameters": { "type": "object", "description": "Describes reply parameters for the message that is being sent.", "properties": { "allow_sending_without_reply": { "type": "boolean", "description": "Optional. Pass True if the message should be sent even if the specified message to be replied to is not found. Always False for replies in another chat or forum topic. Always True for messages sent on behalf of a business account." }, "chat_id": { "type": "string", "description": "Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername). Not supported for messages sent on behalf of a business account. Pass as a numeric string or @username." }, "message_id": { "type": "integer", "description": "Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified" }, "quote": { "type": "string", "description": "Optional. Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, and custom_emoji entities. The message will fail to send if the quote isn't found in the original message." }, "quote_entities": { "type": "array", "items": { "type": "object" }, "description": "Optional. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of quote_parse_mode." }, "quote_parse_mode": { "type": "string", "description": "Optional. Mode for parsing entities in the quote. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details." }, "quote_position": { "type": "integer", "description": "Optional. Position of the quote in the original message in UTF-16 code units" } }, "required": [ "message_id" ] }, "text": { "type": "string", "description": "Text of the message to be sent, 1-4096 characters after entities parsing" } }, "required": [ "PCID", "chat_id", "text" ] } ``` *** ## telegram\_bot\_send\_photo Describes `sendPhoto` 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](https://telegram.org/blog/channels-2-0#silent-messages). 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](https://core.telegram.org/bots/api#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 »](https://core.telegram.org/bots/api#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](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "business_connection_id": { "type": "string", "description": "Unique identifier of the business connection on behalf of which the message will be sent" }, "caption": { "type": "string", "description": "Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing" }, "caption_entities": { "type": "array", "items": { "type": "object", "properties": { "custom_emoji_id": { "type": "string", "description": "Optional. For “custom_emoji” only, unique identifier of the custom emoji. Use [getCustomEmojiStickers](https://core.telegram.org/bots/api#getcustomemojistickers) to get full information about the sticker" }, "language": { "type": "string", "description": "Optional. For “pre” only, the programming language of the entity text" }, "length": { "type": "integer", "format": "int32", "description": "Length of the entity in [UTF-16 code units](https://core.telegram.org/api/entities#entity-length)" }, "offset": { "type": "integer", "format": "int32", "description": "Offset in [UTF-16 code units](https://core.telegram.org/api/entities#entity-length) to the start of the entity" }, "type": { "type": "string", "description": "Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “blockquote” (block quotation), “expandable_blockquote” (collapsed-by-default block quotation), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users [without usernames](https://telegram.org/blog/edit#new-mentions)), “custom_emoji” (for inline custom emoji stickers)" }, "url": { "type": "string", "description": "Optional. For “text_link” only, URL that will be opened after user taps on the text" }, "user": { "type": "object", "description": "This object represents a Telegram user or bot." } }, "required": [ "type", "offset", "length" ] }, "description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode" }, "chat_id": { "type": "string", "description": "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": { "type": "boolean", "description": "Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound." }, "has_spoiler": { "type": "boolean", "description": "Pass True if the photo needs to be covered with a spoiler animation" }, "message_effect_id": { "type": "string", "description": "Unique identifier of the message effect to be added to the message; for private chats only" }, "message_thread_id": { "type": "integer", "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only" }, "parse_mode": { "type": "string", "description": "Mode for parsing entities in the photo caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details." }, "photo": { "type": "string", "description": "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 »](https://core.telegram.org/bots/api#sending-files)" }, "protect_content": { "type": "boolean", "description": "Protects the contents of the sent message from forwarding and saving" }, "reply_markup": { "type": "object", "description": "Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user" }, "reply_parameters": { "type": "object", "description": "Describes reply parameters for the message that is being sent.", "properties": { "allow_sending_without_reply": { "type": "boolean", "description": "Optional. Pass True if the message should be sent even if the specified message to be replied to is not found. Always False for replies in another chat or forum topic. Always True for messages sent on behalf of a business account." }, "chat_id": { "type": "string", "description": "Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername). Not supported for messages sent on behalf of a business account. Pass as a numeric string or @username." }, "message_id": { "type": "integer", "description": "Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified" }, "quote": { "type": "string", "description": "Optional. Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, and custom_emoji entities. The message will fail to send if the quote isn't found in the original message." }, "quote_entities": { "type": "array", "items": { "type": "object" }, "description": "Optional. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of quote_parse_mode." }, "quote_parse_mode": { "type": "string", "description": "Optional. Mode for parsing entities in the quote. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details." }, "quote_position": { "type": "integer", "description": "Optional. Position of the quote in the original message in UTF-16 code units" } }, "required": [ "message_id" ] }, "show_caption_above_media": { "type": "boolean", "description": "Pass True, if the caption must be shown above the message media" } }, "required": [ "PCID", "chat_id", "photo" ] } ``` *** ## telegram\_bot\_send\_poll Describes `sendPoll` 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](https://telegram.org/blog/channels-2-0#silent-messages). 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](https://core.telegram.org/bots/api#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](https://core.telegram.org/bots/api#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](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), 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” | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "allows_multiple_answers": { "type": "boolean", "description": "True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False" }, "business_connection_id": { "type": "string", "description": "Unique identifier of the business connection on behalf of which the message will be sent" }, "chat_id": { "type": "string", "description": "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": { "type": "integer", "description": "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": { "type": "integer", "description": "0-based identifier of the correct answer option, required for polls in quiz mode" }, "disable_notification": { "type": "boolean", "description": "Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound." }, "explanation": { "type": "string", "description": "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": { "type": "array", "items": { "type": "object", "properties": { "custom_emoji_id": { "type": "string", "description": "Optional. For “custom_emoji” only, unique identifier of the custom emoji. Use [getCustomEmojiStickers](https://core.telegram.org/bots/api#getcustomemojistickers) to get full information about the sticker" }, "language": { "type": "string", "description": "Optional. For “pre” only, the programming language of the entity text" }, "length": { "type": "integer", "format": "int32", "description": "Length of the entity in [UTF-16 code units](https://core.telegram.org/api/entities#entity-length)" }, "offset": { "type": "integer", "format": "int32", "description": "Offset in [UTF-16 code units](https://core.telegram.org/api/entities#entity-length) to the start of the entity" }, "type": { "type": "string", "description": "Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “blockquote” (block quotation), “expandable_blockquote” (collapsed-by-default block quotation), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users [without usernames](https://telegram.org/blog/edit#new-mentions)), “custom_emoji” (for inline custom emoji stickers)" }, "url": { "type": "string", "description": "Optional. For “text_link” only, URL that will be opened after user taps on the text" }, "user": { "type": "object", "description": "This object represents a Telegram user or bot." } }, "required": [ "type", "offset", "length" ] }, "description": "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": { "type": "string", "description": "Mode for parsing entities in the explanation. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details." }, "is_anonymous": { "type": "boolean", "description": "True, if the poll needs to be anonymous, defaults to True" }, "is_closed": { "type": "boolean", "description": "Pass True if the poll needs to be immediately closed. This can be useful for poll preview." }, "message_effect_id": { "type": "string", "description": "Unique identifier of the message effect to be added to the message; for private chats only" }, "message_thread_id": { "type": "integer", "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only" }, "open_period": { "type": "integer", "description": "Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date." }, "options": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "Option text, 1-100 characters" }, "text_entities": { "type": "array", "items": { "type": "object", "properties": { "custom_emoji_id": { "type": "string", "description": "Optional. For “custom_emoji” only, unique identifier of the custom emoji. Use [getCustomEmojiStickers](https://core.telegram.org/bots/api#getcustomemojistickers) to get full information about the sticker" }, "language": { "type": "string", "description": "Optional. For “pre” only, the programming language of the entity text" }, "length": { "type": "integer", "description": "Length of the entity in [UTF-16 code units](https://core.telegram.org/api/entities#entity-length)" }, "offset": { "type": "integer", "description": "Offset in [UTF-16 code units](https://core.telegram.org/api/entities#entity-length) to the start of the entity" }, "type": { "type": "string", "description": "Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “blockquote” (block quotation), “expandable_blockquote” (collapsed-by-default block quotation), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users [without usernames](https://telegram.org/blog/edit#new-mentions)), “custom_emoji” (for inline custom emoji stickers)" }, "url": { "type": "string", "description": "Optional. For “text_link” only, URL that will be opened after user taps on the text" }, "user": { "type": "object", "description": "This object represents a Telegram user or bot." } } }, "description": "Optional. A JSON-serialized list of special entities that appear in the poll option text. It can be specified instead of text_parse_mode" }, "text_parse_mode": { "type": "string", "description": "Optional. Mode for parsing entities in the text. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. Currently, only custom emoji entities are allowed" } }, "required": [ "text" ] }, "description": "A JSON-serialized list of 2-10 answer options" }, "protect_content": { "type": "boolean", "description": "Protects the contents of the sent message from forwarding and saving" }, "question": { "type": "string", "description": "Poll question, 1-300 characters" }, "question_entities": { "type": "array", "items": { "type": "object", "properties": { "custom_emoji_id": { "type": "string", "description": "Optional. For “custom_emoji” only, unique identifier of the custom emoji. Use [getCustomEmojiStickers](https://core.telegram.org/bots/api#getcustomemojistickers) to get full information about the sticker" }, "language": { "type": "string", "description": "Optional. For “pre” only, the programming language of the entity text" }, "length": { "type": "integer", "format": "int32", "description": "Length of the entity in [UTF-16 code units](https://core.telegram.org/api/entities#entity-length)" }, "offset": { "type": "integer", "format": "int32", "description": "Offset in [UTF-16 code units](https://core.telegram.org/api/entities#entity-length) to the start of the entity" }, "type": { "type": "string", "description": "Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “blockquote” (block quotation), “expandable_blockquote” (collapsed-by-default block quotation), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users [without usernames](https://telegram.org/blog/edit#new-mentions)), “custom_emoji” (for inline custom emoji stickers)" }, "url": { "type": "string", "description": "Optional. For “text_link” only, URL that will be opened after user taps on the text" }, "user": { "type": "object", "description": "This object represents a Telegram user or bot." } }, "required": [ "type", "offset", "length" ] }, "description": "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": { "type": "string", "description": "Mode for parsing entities in the question. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details. Currently, only custom emoji entities are allowed" }, "reply_markup": { "type": "object", "description": "Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user" }, "reply_parameters": { "type": "object", "description": "Describes reply parameters for the message that is being sent.", "properties": { "allow_sending_without_reply": { "type": "boolean", "description": "Optional. Pass True if the message should be sent even if the specified message to be replied to is not found. Always False for replies in another chat or forum topic. Always True for messages sent on behalf of a business account." }, "chat_id": { "type": "string", "description": "Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername). Not supported for messages sent on behalf of a business account. Pass as a numeric string or @username." }, "message_id": { "type": "integer", "description": "Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified" }, "quote": { "type": "string", "description": "Optional. Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, and custom_emoji entities. The message will fail to send if the quote isn't found in the original message." }, "quote_entities": { "type": "array", "items": { "type": "object" }, "description": "Optional. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of quote_parse_mode." }, "quote_parse_mode": { "type": "string", "description": "Optional. Mode for parsing entities in the quote. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details." }, "quote_position": { "type": "integer", "description": "Optional. Position of the quote in the original message in UTF-16 code units" } }, "required": [ "message_id" ] }, "type": { "type": "string", "description": "Poll type, “quiz” or “regular”, defaults to “regular”" } }, "required": [ "PCID", "chat_id", "options", "question" ] } ``` *** ## telegram\_bot\_send\_venue Describes `sendVenue` 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](https://telegram.org/blog/channels-2-0#silent-messages). 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](https://developers.google.com/places/web-service/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](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "address": { "type": "string", "description": "Address of the venue" }, "business_connection_id": { "type": "string", "description": "Unique identifier of the business connection on behalf of which the message will be sent" }, "chat_id": { "type": "string", "description": "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": { "type": "boolean", "description": "Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound." }, "foursquare_id": { "type": "string", "description": "Foursquare identifier of the venue" }, "foursquare_type": { "type": "string", "description": "Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)" }, "google_place_id": { "type": "string", "description": "Google Places identifier of the venue" }, "google_place_type": { "type": "string", "description": "Google Places type of the venue. (See [supported types](https://developers.google.com/places/web-service/supported_types).)" }, "latitude": { "type": "number", "description": "Latitude of the venue" }, "longitude": { "type": "number", "description": "Longitude of the venue" }, "message_effect_id": { "type": "string", "description": "Unique identifier of the message effect to be added to the message; for private chats only" }, "message_thread_id": { "type": "integer", "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only" }, "protect_content": { "type": "boolean", "description": "Protects the contents of the sent message from forwarding and saving" }, "reply_markup": { "type": "object", "description": "Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user" }, "reply_parameters": { "type": "object", "description": "Describes reply parameters for the message that is being sent.", "properties": { "allow_sending_without_reply": { "type": "boolean", "description": "Optional. Pass True if the message should be sent even if the specified message to be replied to is not found. Always False for replies in another chat or forum topic. Always True for messages sent on behalf of a business account." }, "chat_id": { "type": "string", "description": "Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername). Not supported for messages sent on behalf of a business account. Pass as a numeric string or @username." }, "message_id": { "type": "integer", "description": "Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified" }, "quote": { "type": "string", "description": "Optional. Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, and custom_emoji entities. The message will fail to send if the quote isn't found in the original message." }, "quote_entities": { "type": "array", "items": { "type": "object" }, "description": "Optional. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of quote_parse_mode." }, "quote_parse_mode": { "type": "string", "description": "Optional. Mode for parsing entities in the quote. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details." }, "quote_position": { "type": "integer", "description": "Optional. Position of the quote in the original message in UTF-16 code units" } }, "required": [ "message_id" ] }, "title": { "type": "string", "description": "Name of the venue" } }, "required": [ "PCID", "address", "chat_id", "latitude", "longitude", "title" ] } ``` *** ## telegram\_bot\_send\_video Describes `sendVideo` 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](https://telegram.org/blog/channels-2-0#silent-messages). 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](https://core.telegram.org/bots/api#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](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), 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://\” if the thumbnail was uploaded using multipart/form-data under \. [More information on Sending Files »](https://core.telegram.org/bots/api#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 »](https://core.telegram.org/bots/api#sending-files) | | `width` | integer | No | — | Video width | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "business_connection_id": { "type": "string", "description": "Unique identifier of the business connection on behalf of which the message will be sent" }, "caption": { "type": "string", "description": "Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing" }, "caption_entities": { "type": "array", "items": { "type": "object", "properties": { "custom_emoji_id": { "type": "string", "description": "Optional. For “custom_emoji” only, unique identifier of the custom emoji. Use [getCustomEmojiStickers](https://core.telegram.org/bots/api#getcustomemojistickers) to get full information about the sticker" }, "language": { "type": "string", "description": "Optional. For “pre” only, the programming language of the entity text" }, "length": { "type": "integer", "format": "int32", "description": "Length of the entity in [UTF-16 code units](https://core.telegram.org/api/entities#entity-length)" }, "offset": { "type": "integer", "format": "int32", "description": "Offset in [UTF-16 code units](https://core.telegram.org/api/entities#entity-length) to the start of the entity" }, "type": { "type": "string", "description": "Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “blockquote” (block quotation), “expandable_blockquote” (collapsed-by-default block quotation), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users [without usernames](https://telegram.org/blog/edit#new-mentions)), “custom_emoji” (for inline custom emoji stickers)" }, "url": { "type": "string", "description": "Optional. For “text_link” only, URL that will be opened after user taps on the text" }, "user": { "type": "object", "description": "This object represents a Telegram user or bot." } }, "required": [ "type", "offset", "length" ] }, "description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode" }, "chat_id": { "type": "string", "description": "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": { "type": "boolean", "description": "Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound." }, "duration": { "type": "integer", "description": "Duration of sent video in seconds" }, "has_spoiler": { "type": "boolean", "description": "Pass True if the video needs to be covered with a spoiler animation" }, "height": { "type": "integer", "description": "Video height" }, "message_effect_id": { "type": "string", "description": "Unique identifier of the message effect to be added to the message; for private chats only" }, "message_thread_id": { "type": "integer", "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only" }, "parse_mode": { "type": "string", "description": "Mode for parsing entities in the video caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details." }, "protect_content": { "type": "boolean", "description": "Protects the contents of the sent message from forwarding and saving" }, "reply_markup": { "type": "object", "description": "Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user" }, "reply_parameters": { "type": "object", "description": "Describes reply parameters for the message that is being sent.", "properties": { "allow_sending_without_reply": { "type": "boolean", "description": "Optional. Pass True if the message should be sent even if the specified message to be replied to is not found. Always False for replies in another chat or forum topic. Always True for messages sent on behalf of a business account." }, "chat_id": { "type": "string", "description": "Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername). Not supported for messages sent on behalf of a business account. Pass as a numeric string or @username." }, "message_id": { "type": "integer", "description": "Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified" }, "quote": { "type": "string", "description": "Optional. Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, and custom_emoji entities. The message will fail to send if the quote isn't found in the original message." }, "quote_entities": { "type": "array", "items": { "type": "object" }, "description": "Optional. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of quote_parse_mode." }, "quote_parse_mode": { "type": "string", "description": "Optional. Mode for parsing entities in the quote. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details." }, "quote_position": { "type": "integer", "description": "Optional. Position of the quote in the original message in UTF-16 code units" } }, "required": [ "message_id" ] }, "show_caption_above_media": { "type": "boolean", "description": "Pass True, if the caption must be shown above the message media" }, "supports_streaming": { "type": "boolean", "description": "Pass True if the uploaded video is suitable for streaming" }, "thumbnail": { "type": "string", "description": "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://” if the thumbnail was uploaded using multipart/form-data under . [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files)" }, "video": { "type": "string", "description": "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 »](https://core.telegram.org/bots/api#sending-files)" }, "width": { "type": "integer", "description": "Video width" } }, "required": [ "PCID", "chat_id", "video" ] } ``` *** ## telegram\_bot\_send\_video\_note Describes `sendVideoNote` 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](https://telegram.org/blog/channels-2-0#silent-messages). 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](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), 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://\” if the thumbnail was uploaded using multipart/form-data under \. [More information on Sending Files »](https://core.telegram.org/bots/api#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 »](https://core.telegram.org/bots/api#sending-files). Sending video notes by a URL is currently unsupported | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "business_connection_id": { "type": "string", "description": "Unique identifier of the business connection on behalf of which the message will be sent" }, "chat_id": { "type": "string", "description": "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": { "type": "boolean", "description": "Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound." }, "duration": { "type": "integer", "description": "Duration of sent video in seconds" }, "length": { "type": "integer", "description": "Video width and height, i.e. diameter of the video message" }, "message_effect_id": { "type": "string", "description": "Unique identifier of the message effect to be added to the message; for private chats only" }, "message_thread_id": { "type": "integer", "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only" }, "protect_content": { "type": "boolean", "description": "Protects the contents of the sent message from forwarding and saving" }, "reply_markup": { "type": "object", "description": "Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user" }, "reply_parameters": { "type": "object", "description": "Describes reply parameters for the message that is being sent.", "properties": { "allow_sending_without_reply": { "type": "boolean", "description": "Optional. Pass True if the message should be sent even if the specified message to be replied to is not found. Always False for replies in another chat or forum topic. Always True for messages sent on behalf of a business account." }, "chat_id": { "type": "string", "description": "Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername). Not supported for messages sent on behalf of a business account. Pass as a numeric string or @username." }, "message_id": { "type": "integer", "description": "Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified" }, "quote": { "type": "string", "description": "Optional. Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, and custom_emoji entities. The message will fail to send if the quote isn't found in the original message." }, "quote_entities": { "type": "array", "items": { "type": "object" }, "description": "Optional. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of quote_parse_mode." }, "quote_parse_mode": { "type": "string", "description": "Optional. Mode for parsing entities in the quote. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details." }, "quote_position": { "type": "integer", "description": "Optional. Position of the quote in the original message in UTF-16 code units" } }, "required": [ "message_id" ] }, "thumbnail": { "type": "string", "description": "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://” if the thumbnail was uploaded using multipart/form-data under . [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files)" }, "video_note": { "type": "string", "description": "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 »](https://core.telegram.org/bots/api#sending-files). Sending video notes by a URL is currently unsupported" } }, "required": [ "PCID", "chat_id", "video_note" ] } ``` *** ## telegram\_bot\_send\_voice Describes `sendVoice` 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](https://telegram.org/blog/channels-2-0#silent-messages). 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](https://core.telegram.org/bots/api#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](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), 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 »](https://core.telegram.org/bots/api#sending-files) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "business_connection_id": { "type": "string", "description": "Unique identifier of the business connection on behalf of which the message will be sent" }, "caption": { "type": "string", "description": "Voice message caption, 0-1024 characters after entities parsing" }, "caption_entities": { "type": "array", "items": { "type": "object", "properties": { "custom_emoji_id": { "type": "string", "description": "Optional. For “custom_emoji” only, unique identifier of the custom emoji. Use [getCustomEmojiStickers](https://core.telegram.org/bots/api#getcustomemojistickers) to get full information about the sticker" }, "language": { "type": "string", "description": "Optional. For “pre” only, the programming language of the entity text" }, "length": { "type": "integer", "format": "int32", "description": "Length of the entity in [UTF-16 code units](https://core.telegram.org/api/entities#entity-length)" }, "offset": { "type": "integer", "format": "int32", "description": "Offset in [UTF-16 code units](https://core.telegram.org/api/entities#entity-length) to the start of the entity" }, "type": { "type": "string", "description": "Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “blockquote” (block quotation), “expandable_blockquote” (collapsed-by-default block quotation), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users [without usernames](https://telegram.org/blog/edit#new-mentions)), “custom_emoji” (for inline custom emoji stickers)" }, "url": { "type": "string", "description": "Optional. For “text_link” only, URL that will be opened after user taps on the text" }, "user": { "type": "object", "description": "This object represents a Telegram user or bot." } }, "required": [ "type", "offset", "length" ] }, "description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode" }, "chat_id": { "type": "string", "description": "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": { "type": "boolean", "description": "Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound." }, "duration": { "type": "integer", "description": "Duration of the voice message in seconds" }, "message_effect_id": { "type": "string", "description": "Unique identifier of the message effect to be added to the message; for private chats only" }, "message_thread_id": { "type": "integer", "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only" }, "parse_mode": { "type": "string", "description": "Mode for parsing entities in the voice message caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details." }, "protect_content": { "type": "boolean", "description": "Protects the contents of the sent message from forwarding and saving" }, "reply_markup": { "type": "object", "description": "Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a reply from the user" }, "reply_parameters": { "type": "object", "description": "Describes reply parameters for the message that is being sent.", "properties": { "allow_sending_without_reply": { "type": "boolean", "description": "Optional. Pass True if the message should be sent even if the specified message to be replied to is not found. Always False for replies in another chat or forum topic. Always True for messages sent on behalf of a business account." }, "chat_id": { "type": "string", "description": "Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername). Not supported for messages sent on behalf of a business account. Pass as a numeric string or @username." }, "message_id": { "type": "integer", "description": "Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified" }, "quote": { "type": "string", "description": "Optional. Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, and custom_emoji entities. The message will fail to send if the quote isn't found in the original message." }, "quote_entities": { "type": "array", "items": { "type": "object" }, "description": "Optional. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of quote_parse_mode." }, "quote_parse_mode": { "type": "string", "description": "Optional. Mode for parsing entities in the quote. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details." }, "quote_position": { "type": "integer", "description": "Optional. Position of the quote in the original message in UTF-16 code units" } }, "required": [ "message_id" ] }, "voice": { "type": "string", "description": "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 »](https://core.telegram.org/bots/api#sending-files)" } }, "required": [ "PCID", "chat_id", "voice" ] } ``` *** ## telegram\_bot\_set\_chat\_administrator\_custom\_title Describes `setChatAdministratorCustomTitle` 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "string", "description": "New custom title for the administrator; 0-16 characters, emoji are not allowed" }, "user_id": { "type": "integer", "description": "Unique identifier of the target user" } }, "required": [ "PCID", "chat_id", "custom_title", "user_id" ] } ``` *** ## telegram\_bot\_set\_chat\_description Describes `setChatDescription` 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "string", "description": "New chat description, 0-255 characters" } }, "required": [ "PCID", "chat_id" ] } ``` *** ## telegram\_bot\_set\_chat\_menu\_button Describes `setChatMenuButton` 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](https://core.telegram.org/bots/api#menubuttoncommands) - [MenuButtonWebApp](https://core.telegram.org/bots/api#menubuttonwebapp) - [MenuButtonDefault](https://core.telegram.org/bots/api#menubuttondefault) If a menu button other than [MenuButtonDefault](https://core.telegram.org/bots/api#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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "integer", "description": "Unique identifier for the target private chat. If not specified, default bot's menu button will be changed" }, "menu_button": { "type": "object", "description": "This object describes the bot's menu button in a private chat. It should be one of - [MenuButtonCommands](https://core.telegram.org/bots/api#menubuttoncommands) - [MenuButtonWebApp](https://core.telegram.org/bots/api#menubuttonwebapp) - [MenuButtonDefault](https://core.telegram.org/bots/api#menubuttondefault) If a menu button other than [MenuButtonDefault](https://core.telegram.org/bots/api#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." } }, "required": [ "PCID" ] } ``` *** ## telegram\_bot\_set\_chat\_permissions Describes `setChatPermissions` 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "object", "description": "Describes actions that a non-administrator user is allowed to take in a chat.", "properties": { "can_add_web_page_previews": { "type": "boolean", "description": "Optional. True, if the user is allowed to add web page previews to their messages" }, "can_change_info": { "type": "boolean", "description": "Optional. True, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups" }, "can_invite_users": { "type": "boolean", "description": "Optional. True, if the user is allowed to invite new users to the chat" }, "can_manage_topics": { "type": "boolean", "description": "Optional. True, if the user is allowed to create forum topics. If omitted defaults to the value of can_pin_messages" }, "can_pin_messages": { "type": "boolean", "description": "Optional. True, if the user is allowed to pin messages. Ignored in public supergroups" }, "can_send_audios": { "type": "boolean", "description": "Optional. True, if the user is allowed to send audios" }, "can_send_documents": { "type": "boolean", "description": "Optional. True, if the user is allowed to send documents" }, "can_send_messages": { "type": "boolean", "description": "Optional. True, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues" }, "can_send_other_messages": { "type": "boolean", "description": "Optional. True, if the user is allowed to send animations, games, stickers and use inline bots" }, "can_send_photos": { "type": "boolean", "description": "Optional. True, if the user is allowed to send photos" }, "can_send_polls": { "type": "boolean", "description": "Optional. True, if the user is allowed to send polls" }, "can_send_video_notes": { "type": "boolean", "description": "Optional. True, if the user is allowed to send video notes" }, "can_send_videos": { "type": "boolean", "description": "Optional. True, if the user is allowed to send videos" }, "can_send_voice_notes": { "type": "boolean", "description": "Optional. True, if the user is allowed to send voice notes" } } }, "use_independent_chat_permissions": { "type": "boolean", "description": "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." } }, "required": [ "PCID", "chat_id", "permissions" ] } ``` *** ## telegram\_bot\_set\_chat\_photo Describes `setChatPhoto` 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "string", "description": "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." } }, "required": [ "PCID", "chat_id", "photo" ] } ``` *** ## telegram\_bot\_set\_chat\_sticker\_set Describes `setChatStickerSet` 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "string", "description": "Name of the sticker set to be set as the group sticker set" } }, "required": [ "PCID", "chat_id", "sticker_set_name" ] } ``` *** ## telegram\_bot\_set\_chat\_title Describes `setChatTitle` 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "string", "description": "New chat title, 1-128 characters" } }, "required": [ "PCID", "chat_id", "title" ] } ``` *** ## telegram\_bot\_set\_message\_reaction Describes `setMessageReaction` 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "boolean", "description": "Pass True to set the reaction with a big animation" }, "message_id": { "type": "integer", "description": "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": { "type": "array", "items": { "type": "object" }, "description": "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." } }, "required": [ "PCID", "chat_id", "message_id" ] } ``` *** ## telegram\_bot\_set\_my\_commands Describes `setMyCommands` 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](https://core.telegram.org/bots/api#botcommandscopedefault) - [BotCommandScopeAllPrivateChats](https://core.telegram.org/bots/api#botcommandscopeallprivatechats) - [BotCommandScopeAllGroupChats](https://core.telegram.org/bots/api#botcommandscopeallgroupchats) - [BotCommandScopeAllChatAdministrators](https://core.telegram.org/bots/api#botcommandscopeallchatadministrators) - [BotCommandScopeChat](https://core.telegram.org/bots/api#botcommandscopechat) - [BotCommandScopeChatAdministrators](https://core.telegram.org/bots/api#botcommandscopechatadministrators) - [BotCommandScopeChatMember](https://core.telegram.org/bots/api#botcommandscopechatmember) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "commands": { "type": "array", "items": { "type": "object", "properties": { "command": { "type": "string", "description": "Text of the command; 1-32 characters. Can contain only lowercase English letters, digits and underscores." }, "description": { "type": "string", "description": "Description of the command; 1-256 characters." } }, "required": [ "command", "description" ] }, "description": "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": { "type": "string", "description": "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": { "type": "object", "description": "This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported: - [BotCommandScopeDefault](https://core.telegram.org/bots/api#botcommandscopedefault) - [BotCommandScopeAllPrivateChats](https://core.telegram.org/bots/api#botcommandscopeallprivatechats) - [BotCommandScopeAllGroupChats](https://core.telegram.org/bots/api#botcommandscopeallgroupchats) - [BotCommandScopeAllChatAdministrators](https://core.telegram.org/bots/api#botcommandscopeallchatadministrators) - [BotCommandScopeChat](https://core.telegram.org/bots/api#botcommandscopechat) - [BotCommandScopeChatAdministrators](https://core.telegram.org/bots/api#botcommandscopechatadministrators) - [BotCommandScopeChatMember](https://core.telegram.org/bots/api#botcommandscopechatmember)" } }, "required": [ "PCID", "commands" ] } ``` *** ## telegram\_bot\_set\_my\_default\_administrator\_rights Describes `setMyDefaultAdministratorRights` 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "for_channels": { "type": "boolean", "description": "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": { "type": "object", "description": "Represents the rights of an administrator in a chat.", "properties": { "can_change_info": { "type": "boolean", "description": "True, if the user is allowed to change the chat title, photo and other settings" }, "can_delete_messages": { "type": "boolean", "description": "True, if the administrator can delete messages of other users" }, "can_delete_stories": { "type": "boolean", "description": "True, if the administrator can delete stories posted by other users" }, "can_edit_messages": { "type": "boolean", "description": "Optional. True, if the administrator can edit messages of other users and can pin messages; for channels only" }, "can_edit_stories": { "type": "boolean", "description": "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": { "type": "boolean", "description": "True, if the user is allowed to invite new users to the chat" }, "can_manage_chat": { "type": "boolean", "description": "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": { "type": "boolean", "description": "Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only" }, "can_manage_video_chats": { "type": "boolean", "description": "True, if the administrator can manage video chats" }, "can_pin_messages": { "type": "boolean", "description": "Optional. True, if the user is allowed to pin messages; for groups and supergroups only" }, "can_post_messages": { "type": "boolean", "description": "Optional. True, if the administrator can post messages in the channel, or access channel statistics; for channels only" }, "can_post_stories": { "type": "boolean", "description": "True, if the administrator can post stories to the chat" }, "can_promote_members": { "type": "boolean", "description": "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 the user)" }, "can_restrict_members": { "type": "boolean", "description": "True, if the administrator can restrict, ban or unban chat members, or access supergroup statistics" }, "is_anonymous": { "type": "boolean", "description": "True, if the user's presence in the chat is hidden" } }, "required": [ "is_anonymous", "can_manage_chat", "can_delete_messages", "can_manage_video_chats", "can_restrict_members", "can_promote_members", "can_change_info", "can_invite_users", "can_post_stories", "can_edit_stories", "can_delete_stories" ] } }, "required": [ "PCID" ] } ``` *** ## telegram\_bot\_set\_my\_description Describes `setMyDescription` 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "description": { "type": "string", "description": "New bot description; 0-512 characters. Pass an empty string to remove the dedicated description for the given language." }, "language_code": { "type": "string", "description": "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." } }, "required": [ "PCID" ] } ``` *** ## telegram\_bot\_set\_my\_name Describes `setMyName` 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "language_code": { "type": "string", "description": "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": { "type": "string", "description": "New bot name; 0-64 characters. Pass an empty string to remove the dedicated name for the given language." } }, "required": [ "PCID" ] } ``` *** ## telegram\_bot\_set\_my\_short\_description Describes `setMyShortDescription` 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "language_code": { "type": "string", "description": "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": { "type": "string", "description": "New short description for the bot; 0-120 characters. Pass an empty string to remove the dedicated short description for the given language." } }, "required": [ "PCID" ] } ``` *** ## telegram\_bot\_set\_webhook Describes `setWebhook` 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](https://core.telegram.org/bots/api#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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "allowed_updates": { "type": "array", "items": { "type": "string" }, "description": "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](https://core.telegram.org/bots/api#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": { "type": "boolean", "description": "Pass True to drop all pending updates" }, "ip_address": { "type": "string", "description": "The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS" }, "max_connections": { "type": "integer", "description": "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": { "type": "string", "description": "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": { "type": "string", "description": "HTTPS URL to send updates to. Use an empty string to remove webhook integration" } }, "required": [ "PCID", "url" ] } ``` *** ## telegram\_bot\_unban\_chat\_member Describes `unbanChatMember` 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "boolean", "description": "Do nothing if the user is not banned" }, "user_id": { "type": "integer", "description": "Unique identifier of the target user" } }, "required": [ "PCID", "chat_id", "user_id" ] } ``` *** ## telegram\_bot\_unban\_chat\_sender\_chat Describes `unbanChatSenderChat` 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "integer", "description": "Unique identifier of the target sender chat" } }, "required": [ "PCID", "chat_id", "sender_chat_id" ] } ``` *** ## telegram\_bot\_unhide\_general\_forum\_topic Describes `unhideGeneralForumTopic` 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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." } }, "required": [ "PCID", "chat_id" ] } ``` *** ## telegram\_bot\_unpin\_all\_chat\_messages Describes `unpinAllChatMessages` 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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." } }, "required": [ "PCID", "chat_id" ] } ``` *** ## telegram\_bot\_unpin\_all\_forum\_topic\_messages Describes `unpinAllForumTopicMessages` 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "integer", "description": "Unique identifier for the target message thread of the forum topic" } }, "required": [ "PCID", "chat_id", "message_thread_id" ] } ``` *** ## telegram\_bot\_unpin\_all\_general\_forum\_topic\_messages Describes `unpinAllGeneralForumTopicMessages` 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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." } }, "required": [ "PCID", "chat_id" ] } ``` *** ## telegram\_bot\_unpin\_chat\_message Describes `unpinChatMessage` 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chat_id": { "type": "string", "description": "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": { "type": "integer", "description": "Identifier of a message to unpin. If not specified, the most recent pinned message (by sending date) will be unpinned." } }, "required": [ "PCID", "chat_id" ] } ```