/telegram-content | Type: Application | PCID required: Yes
Tools
telegram_content_add_sticker_to_set
DescribesaddStickerToSet method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Sticker set name |
sticker | object | Yes | — | This object describes a sticker to be added to a sticker set. |
user_id | integer | Yes | — | User identifier of sticker set owner |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "Sticker set name"
},
"sticker": {
"type": "object",
"description": "This object describes a sticker to be added to a sticker set.",
"properties": {
"emoji_list": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of 1-20 emoji associated with the sticker"
},
"format": {
"type": "string",
"description": "Format of the added sticker, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, “video” for a WEBM video"
},
"keywords": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional. List of 0-20 search keywords for the sticker with total length of up to 64 characters. For “regular” and “custom_emoji” stickers only."
},
"mask_position": {
"type": "object",
"description": "This object describes the position on faces where a mask should be placed by default."
},
"sticker": {
"type": "string",
"description": "The added sticker. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, upload a new one using multipart/form-data, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. Animated and video stickers can't be uploaded via HTTP URL. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) Pass a file_id string to reuse an existing file."
}
},
"required": [
"sticker",
"format",
"emoji_list"
]
},
"user_id": {
"type": "integer",
"description": "User identifier of sticker set owner"
}
},
"required": [
"PCID",
"name",
"sticker",
"user_id"
]
}
telegram_content_answer_inline_query
DescribesanswerInlineQuery method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
button | object | No | — | This object represents a button to be shown above inline query results. You must use exactly one of the optional fields. |
cache_time | integer | No | — | The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300. |
inline_query_id | string | Yes | — | Unique identifier for the answered query |
is_personal | boolean | No | — | Pass True if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query. |
next_offset | string | No | — | Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don’t support pagination. Offset length can’t exceed 64 bytes. |
results | object[] | Yes | — | A JSON-serialized array of results for the inline query |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"button": {
"type": "object",
"description": "This object represents a button to be shown above inline query results. You must use exactly one of the optional fields.",
"properties": {
"start_parameter": {
"type": "string",
"description": "Optional. [Deep-linking](https://core.telegram.org/bots/features#deep-linking) parameter for the /start message sent to the bot when a user presses the button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed.Example: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a 'Connect your YouTube account' button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an OAuth link. Once done, the bot can offer a [switch_inline](https://core.telegram.org/bots/api#inlinekeyboardmarkup) button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities."
},
"text": {
"type": "string",
"description": "Label text on the button"
},
"web_app": {
"type": "object",
"description": "Describes a [Web App](https://core.telegram.org/bots/webapps)."
}
},
"required": [
"text"
]
},
"cache_time": {
"type": "integer",
"description": "The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300."
},
"inline_query_id": {
"type": "string",
"description": "Unique identifier for the answered query"
},
"is_personal": {
"type": "boolean",
"description": "Pass True if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query."
},
"next_offset": {
"type": "string",
"description": "Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don't support pagination. Offset length can't exceed 64 bytes."
},
"results": {
"type": "array",
"items": {
"type": "object"
},
"description": "A JSON-serialized array of results for the inline query"
}
},
"required": [
"PCID",
"inline_query_id",
"results"
]
}
telegram_content_answer_pre_checkout_query
DescribesanswerPreCheckoutQuery method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
error_message | string | No | — | Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. “Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!”). Telegram will display this message to the user. |
ok | boolean | Yes | — | Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems. |
pre_checkout_query_id | string | Yes | — | Unique identifier for the query to be answered |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"error_message": {
"type": "string",
"description": "Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. \"Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!\"). Telegram will display this message to the user."
},
"ok": {
"type": "boolean",
"description": "Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems."
},
"pre_checkout_query_id": {
"type": "string",
"description": "Unique identifier for the query to be answered"
}
},
"required": [
"PCID",
"ok",
"pre_checkout_query_id"
]
}
telegram_content_answer_shipping_query
DescribesanswerShippingQuery method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
error_message | string | No | — | Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. “Sorry, delivery to your desired address is unavailable’). Telegram will display this message to the user. |
ok | boolean | Yes | — | Pass True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible) |
shipping_options | object[] | No | — | Required if ok is True. A JSON-serialized array of available shipping options. |
shipping_query_id | string | Yes | — | Unique identifier for the query to be answered |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"error_message": {
"type": "string",
"description": "Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. \"Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user."
},
"ok": {
"type": "boolean",
"description": "Pass True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible)"
},
"shipping_options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Shipping option identifier"
},
"prices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"amount": {
"type": "integer",
"description": "Price of the product in the smallest units of the [currency](https://core.telegram.org/bots/payments#supported-currencies) (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies)."
},
"label": {
"type": "string",
"description": "Portion label"
}
}
},
"description": "List of price portions"
},
"title": {
"type": "string",
"description": "Option title"
}
},
"required": [
"id",
"title",
"prices"
]
},
"description": "Required if ok is True. A JSON-serialized array of available shipping options."
},
"shipping_query_id": {
"type": "string",
"description": "Unique identifier for the query to be answered"
}
},
"required": [
"PCID",
"ok",
"shipping_query_id"
]
}
telegram_content_answer_web_app_query
DescribesanswerWebAppQuery method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
result | object | Yes | — | This object represents one result of an inline query. Telegram clients currently support results of the following 20 types: - InlineQueryResultCachedAudio - InlineQueryResultCachedDocument - InlineQueryResultCachedGif - InlineQueryResultCachedMpeg4Gif - InlineQueryResultCachedPhoto - InlineQueryResultCachedSticker - InlineQueryResultCachedVideo - InlineQueryResultCachedVoice - InlineQueryResultArticle - InlineQueryResultAudio - InlineQueryResultContact - InlineQueryResultGame - InlineQueryResultDocument - InlineQueryResultGif - InlineQueryResultLocation - InlineQueryResultMpeg4Gif - InlineQueryResultPhoto - InlineQueryResultVenue - InlineQueryResultVideo - InlineQueryResultVoice Note: All URLs passed in inline query results will be available to end users and therefore must be assumed to be public. |
web_app_query_id | string | Yes | — | Unique identifier for the query to be answered |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"result": {
"type": "object",
"description": "This object represents one result of an inline query. Telegram clients currently support results of the following 20 types: - [InlineQueryResultCachedAudio](https://core.telegram.org/bots/api#inlinequeryresultcachedaudio) - [InlineQueryResultCachedDocument](https://core.telegram.org/bots/api#inlinequeryresultcacheddocument) - [InlineQueryResultCachedGif](https://core.telegram.org/bots/api#inlinequeryresultcachedgif) - [InlineQueryResultCachedMpeg4Gif](https://core.telegram.org/bots/api#inlinequeryresultcachedmpeg4gif) - [InlineQueryResultCachedPhoto](https://core.telegram.org/bots/api#inlinequeryresultcachedphoto) - [InlineQueryResultCachedSticker](https://core.telegram.org/bots/api#inlinequeryresultcachedsticker) - [InlineQueryResultCachedVideo](https://core.telegram.org/bots/api#inlinequeryresultcachedvideo) - [InlineQueryResultCachedVoice](https://core.telegram.org/bots/api#inlinequeryresultcachedvoice) - [InlineQueryResultArticle](https://core.telegram.org/bots/api#inlinequeryresultarticle) - [InlineQueryResultAudio](https://core.telegram.org/bots/api#inlinequeryresultaudio) - [InlineQueryResultContact](https://core.telegram.org/bots/api#inlinequeryresultcontact) - [InlineQueryResultGame](https://core.telegram.org/bots/api#inlinequeryresultgame) - [InlineQueryResultDocument](https://core.telegram.org/bots/api#inlinequeryresultdocument) - [InlineQueryResultGif](https://core.telegram.org/bots/api#inlinequeryresultgif) - [InlineQueryResultLocation](https://core.telegram.org/bots/api#inlinequeryresultlocation) - [InlineQueryResultMpeg4Gif](https://core.telegram.org/bots/api#inlinequeryresultmpeg4gif) - [InlineQueryResultPhoto](https://core.telegram.org/bots/api#inlinequeryresultphoto) - [InlineQueryResultVenue](https://core.telegram.org/bots/api#inlinequeryresultvenue) - [InlineQueryResultVideo](https://core.telegram.org/bots/api#inlinequeryresultvideo) - [InlineQueryResultVoice](https://core.telegram.org/bots/api#inlinequeryresultvoice) Note: All URLs passed in inline query results will be available to end users and therefore must be assumed to be public."
},
"web_app_query_id": {
"type": "string",
"description": "Unique identifier for the query to be answered"
}
},
"required": [
"PCID",
"result",
"web_app_query_id"
]
}
telegram_content_create_invoice_link
DescribescreateInvoiceLink method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
currency | string | Yes | — | Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars. |
description | string | Yes | — | Product description, 1-255 characters |
is_flexible | boolean | No | — | Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars. |
max_tip_amount | integer | No | — | The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars. |
need_email | boolean | No | — | Pass True if you require the user’s email address to complete the order. Ignored for payments in Telegram Stars. |
need_name | boolean | No | — | Pass True if you require the user’s full name to complete the order. Ignored for payments in Telegram Stars. |
need_phone_number | boolean | No | — | Pass True if you require the user’s phone number to complete the order. Ignored for payments in Telegram Stars. |
need_shipping_address | boolean | No | — | Pass True if you require the user’s shipping address to complete the order. Ignored for payments in Telegram Stars. |
payload | string | Yes | — | Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. |
photo_height | integer | No | — | Photo height |
photo_size | integer | No | — | Photo size in bytes |
photo_url | string | No | — | URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. |
photo_width | integer | No | — | Photo width |
prices | object[] | Yes | — | Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars. |
provider_data | string | No | — | JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider. |
provider_token | string | No | — | Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars. |
send_email_to_provider | boolean | No | — | Pass True if the user’s email address should be sent to the provider. Ignored for payments in Telegram Stars. |
send_phone_number_to_provider | boolean | No | — | Pass True if the user’s phone number should be sent to the provider. Ignored for payments in Telegram Stars. |
suggested_tip_amounts | integer[] | No | — | A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount. |
title | string | Yes | — | Product name, 1-32 characters |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"currency": {
"type": "string",
"description": "Three-letter ISO 4217 currency code, see [more on currencies](https://core.telegram.org/bots/payments#supported-currencies). Pass “XTR” for payments in [Telegram Stars](https://t.me/BotNews/90)."
},
"description": {
"type": "string",
"description": "Product description, 1-255 characters"
},
"is_flexible": {
"type": "boolean",
"description": "Pass True if the final price depends on the shipping method. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90)."
},
"max_tip_amount": {
"type": "integer",
"description": "The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in [Telegram Stars](https://t.me/BotNews/90)."
},
"need_email": {
"type": "boolean",
"description": "Pass True if you require the user's email address to complete the order. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90)."
},
"need_name": {
"type": "boolean",
"description": "Pass True if you require the user's full name to complete the order. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90)."
},
"need_phone_number": {
"type": "boolean",
"description": "Pass True if you require the user's phone number to complete the order. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90)."
},
"need_shipping_address": {
"type": "boolean",
"description": "Pass True if you require the user's shipping address to complete the order. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90)."
},
"payload": {
"type": "string",
"description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes."
},
"photo_height": {
"type": "integer",
"description": "Photo height"
},
"photo_size": {
"type": "integer",
"description": "Photo size in bytes"
},
"photo_url": {
"type": "string",
"description": "URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service."
},
"photo_width": {
"type": "integer",
"description": "Photo width"
},
"prices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"amount": {
"type": "integer",
"format": "int32",
"description": "Price of the product in the smallest units of the [currency](https://core.telegram.org/bots/payments#supported-currencies) (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies)."
},
"label": {
"type": "string",
"description": "Portion label"
}
},
"required": [
"label",
"amount"
]
},
"description": "Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in [Telegram Stars](https://t.me/BotNews/90)."
},
"provider_data": {
"type": "string",
"description": "JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider."
},
"provider_token": {
"type": "string",
"description": "Payment provider token, obtained via [@BotFather](https://t.me/botfather). Pass an empty string for payments in [Telegram Stars](https://t.me/BotNews/90)."
},
"send_email_to_provider": {
"type": "boolean",
"description": "Pass True if the user's email address should be sent to the provider. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90)."
},
"send_phone_number_to_provider": {
"type": "boolean",
"description": "Pass True if the user's phone number should be sent to the provider. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90)."
},
"suggested_tip_amounts": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount."
},
"title": {
"type": "string",
"description": "Product name, 1-32 characters"
}
},
"required": [
"PCID",
"currency",
"description",
"payload",
"prices",
"title"
]
}
telegram_content_create_new_sticker_set
DescribescreateNewStickerSet method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only English letters, digits and underscores. Must begin with a letter, can’t contain consecutive underscores and must end in “by<bot_username>”. <bot_username> is case insensitive. 1-64 characters. |
needs_repainting | boolean | No | — | Pass True if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only |
sticker_type | string | No | — | Type of stickers in the set, pass “regular”, “mask”, or “custom_emoji”. By default, a regular sticker set is created. |
stickers | object[] | Yes | — | A JSON-serialized list of 1-50 initial stickers to be added to the sticker set |
title | string | Yes | — | Sticker set title, 1-64 characters |
user_id | integer | Yes | — | User identifier of created sticker set owner |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only English letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in \"_by_<bot_username>\". <bot_username> is case insensitive. 1-64 characters."
},
"needs_repainting": {
"type": "boolean",
"description": "Pass True if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only"
},
"sticker_type": {
"type": "string",
"description": "Type of stickers in the set, pass “regular”, “mask”, or “custom_emoji”. By default, a regular sticker set is created."
},
"stickers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"emoji_list": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of 1-20 emoji associated with the sticker"
},
"format": {
"type": "string",
"description": "Format of the added sticker, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, “video” for a WEBM video"
},
"keywords": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional. List of 0-20 search keywords for the sticker with total length of up to 64 characters. For “regular” and “custom_emoji” stickers only."
},
"mask_position": {
"type": "object",
"description": "This object describes the position on faces where a mask should be placed by default."
},
"sticker": {
"type": "string",
"description": "The added sticker. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, upload a new one using multipart/form-data, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. Animated and video stickers can't be uploaded via HTTP URL. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) Pass a file_id string to reuse an existing file."
}
},
"required": [
"sticker",
"format",
"emoji_list"
]
},
"description": "A JSON-serialized list of 1-50 initial stickers to be added to the sticker set"
},
"title": {
"type": "string",
"description": "Sticker set title, 1-64 characters"
},
"user_id": {
"type": "integer",
"description": "User identifier of created sticker set owner"
}
},
"required": [
"PCID",
"name",
"stickers",
"title",
"user_id"
]
}
telegram_content_delete_message
DescribesdeleteMessage 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 | Yes | — | Identifier of the message to delete |
Show inputSchema
Show inputSchema
{
"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 the message to delete"
}
},
"required": [
"PCID",
"chat_id",
"message_id"
]
}
telegram_content_delete_messages
DescribesdeleteMessages 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_ids | integer[] | Yes | — | A JSON-serialized list of 1-100 identifiers of messages to delete. See deleteMessage for limitations on which messages can be deleted |
Show inputSchema
Show inputSchema
{
"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_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "A JSON-serialized list of 1-100 identifiers of messages to delete. See [deleteMessage](https://core.telegram.org/bots/api#deletemessage) for limitations on which messages can be deleted"
}
},
"required": [
"PCID",
"chat_id",
"message_ids"
]
}
telegram_content_delete_sticker_from_set
DescribesdeleteStickerFromSet method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sticker | string | Yes | — | File identifier of the sticker |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"sticker": {
"type": "string",
"description": "File identifier of the sticker"
}
},
"required": [
"PCID",
"sticker"
]
}
telegram_content_delete_sticker_set
DescribesdeleteStickerSet method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Sticker set name |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "Sticker set name"
}
},
"required": [
"PCID",
"name"
]
}
telegram_content_edit_message_caption
DescribeseditMessageCaption method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caption | string | No | — | New caption of the message, 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 | No | — | Required if inline_message_id is not specified. 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. |
inline_message_id | string | No | — | Required if chat_id and message_id are not specified. Identifier of the inline message |
message_id | integer | No | — | Required if inline_message_id is not specified. Identifier of the message to edit |
parse_mode | string | No | — | Mode for parsing entities in the message caption. See formatting options for more details. |
reply_markup | object | No | — | This object represents an inline keyboard that appears right next to the message it belongs to. |
show_caption_above_media | boolean | No | — | Pass True, if the caption must be shown above the message media. Supported only for animation, photo and video messages. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caption": {
"type": "string",
"description": "New caption of the message, 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": "Required if inline_message_id is not specified. 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."
},
"inline_message_id": {
"type": "string",
"description": "Required if chat_id and message_id are not specified. Identifier of the inline message"
},
"message_id": {
"type": "integer",
"description": "Required if inline_message_id is not specified. Identifier of the message to edit"
},
"parse_mode": {
"type": "string",
"description": "Mode for parsing entities in the message caption. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details."
},
"reply_markup": {
"type": "object",
"description": "This object represents an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) that appears right next to the message it belongs to.",
"properties": {
"inline_keyboard": {
"type": "array",
"items": {
"type": "array"
},
"description": "Array of button rows, each represented by an Array of [InlineKeyboardButton](https://core.telegram.org/bots/api#inlinekeyboardbutton) objects"
}
},
"required": [
"inline_keyboard"
]
},
"show_caption_above_media": {
"type": "boolean",
"description": "Pass True, if the caption must be shown above the message media. Supported only for animation, photo and video messages."
}
},
"required": [
"PCID"
]
}
telegram_content_edit_message_live_location
DescribeseditMessageLiveLocation method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | No | — | Required if inline_message_id is not specified. 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. |
heading | integer | No | — | 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 |
inline_message_id | string | No | — | Required if chat_id and message_id are not specified. Identifier of the inline message |
latitude | number | Yes | — | Latitude of new location |
live_period | integer | No | — | New period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current live_period by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then live_period remains unchanged |
longitude | number | Yes | — | Longitude of new location |
message_id | integer | No | — | Required if inline_message_id is not specified. Identifier of the message to edit |
proximity_alert_radius | integer | No | — | The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. |
reply_markup | object | No | — | This object represents an inline keyboard that appears right next to the message it belongs to. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"chat_id": {
"type": "string",
"description": "Required if inline_message_id is not specified. 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."
},
"heading": {
"type": "integer",
"description": "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"
},
"inline_message_id": {
"type": "string",
"description": "Required if chat_id and message_id are not specified. Identifier of the inline message"
},
"latitude": {
"type": "number",
"description": "Latitude of new location"
},
"live_period": {
"type": "integer",
"description": "New period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current live_period by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then live_period remains unchanged"
},
"longitude": {
"type": "number",
"description": "Longitude of new location"
},
"message_id": {
"type": "integer",
"description": "Required if inline_message_id is not specified. Identifier of the message to edit"
},
"proximity_alert_radius": {
"type": "integer",
"description": "The 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": "This object represents an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) that appears right next to the message it belongs to.",
"properties": {
"inline_keyboard": {
"type": "array",
"items": {
"type": "array"
},
"description": "Array of button rows, each represented by an Array of [InlineKeyboardButton](https://core.telegram.org/bots/api#inlinekeyboardbutton) objects"
}
},
"required": [
"inline_keyboard"
]
}
},
"required": [
"PCID",
"latitude",
"longitude"
]
}
telegram_content_edit_message_media
DescribeseditMessageMedia method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | No | — | Required if inline_message_id is not specified. 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. |
inline_message_id | string | No | — | Required if chat_id and message_id are not specified. Identifier of the inline message |
media | object | Yes | — | This object represents the content of a media message to be sent. It should be one of - InputMediaAnimation - InputMediaDocument - InputMediaAudio - InputMediaPhoto - InputMediaVideo |
message_id | integer | No | — | Required if inline_message_id is not specified. Identifier of the message to edit |
reply_markup | object | No | — | This object represents an inline keyboard that appears right next to the message it belongs to. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"chat_id": {
"type": "string",
"description": "Required if inline_message_id is not specified. 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."
},
"inline_message_id": {
"type": "string",
"description": "Required if chat_id and message_id are not specified. Identifier of the inline message"
},
"media": {
"type": "object",
"description": "This object represents the content of a media message to be sent. It should be one of - [InputMediaAnimation](https://core.telegram.org/bots/api#inputmediaanimation) - [InputMediaDocument](https://core.telegram.org/bots/api#inputmediadocument) - [InputMediaAudio](https://core.telegram.org/bots/api#inputmediaaudio) - [InputMediaPhoto](https://core.telegram.org/bots/api#inputmediaphoto) - [InputMediaVideo](https://core.telegram.org/bots/api#inputmediavideo)"
},
"message_id": {
"type": "integer",
"description": "Required if inline_message_id is not specified. Identifier of the message to edit"
},
"reply_markup": {
"type": "object",
"description": "This object represents an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) that appears right next to the message it belongs to.",
"properties": {
"inline_keyboard": {
"type": "array",
"items": {
"type": "array"
},
"description": "Array of button rows, each represented by an Array of [InlineKeyboardButton](https://core.telegram.org/bots/api#inlinekeyboardbutton) objects"
}
},
"required": [
"inline_keyboard"
]
}
},
"required": [
"PCID",
"media"
]
}
telegram_content_edit_message_reply_markup
DescribeseditMessageReplyMarkup method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | No | — | Required if inline_message_id is not specified. 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. |
inline_message_id | string | No | — | Required if chat_id and message_id are not specified. Identifier of the inline message |
message_id | integer | No | — | Required if inline_message_id is not specified. Identifier of the message to edit |
reply_markup | object | No | — | This object represents an inline keyboard that appears right next to the message it belongs to. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"chat_id": {
"type": "string",
"description": "Required if inline_message_id is not specified. 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."
},
"inline_message_id": {
"type": "string",
"description": "Required if chat_id and message_id are not specified. Identifier of the inline message"
},
"message_id": {
"type": "integer",
"description": "Required if inline_message_id is not specified. Identifier of the message to edit"
},
"reply_markup": {
"type": "object",
"description": "This object represents an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) that appears right next to the message it belongs to.",
"properties": {
"inline_keyboard": {
"type": "array",
"items": {
"type": "array"
},
"description": "Array of button rows, each represented by an Array of [InlineKeyboardButton](https://core.telegram.org/bots/api#inlinekeyboardbutton) objects"
}
},
"required": [
"inline_keyboard"
]
}
},
"required": [
"PCID"
]
}
telegram_content_edit_message_text
DescribeseditMessageText method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | No | — | Required if inline_message_id is not specified. 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. |
entities | object[] | No | — | A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode |
inline_message_id | string | No | — | Required if chat_id and message_id are not specified. Identifier of the inline message |
link_preview_options | object | No | — | Describes the options used for link preview generation. |
message_id | integer | No | — | Required if inline_message_id is not specified. Identifier of the message to edit |
parse_mode | string | No | — | Mode for parsing entities in the message text. See formatting options for more details. |
reply_markup | object | No | — | This object represents an inline keyboard that appears right next to the message it belongs to. |
text | string | Yes | — | New text of the message, 1-4096 characters after entities parsing |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"chat_id": {
"type": "string",
"description": "Required if inline_message_id is not specified. 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."
},
"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"
},
"inline_message_id": {
"type": "string",
"description": "Required if chat_id and message_id are not specified. Identifier of the inline message"
},
"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_id": {
"type": "integer",
"description": "Required if inline_message_id is not specified. Identifier of the message to edit"
},
"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."
},
"reply_markup": {
"type": "object",
"description": "This object represents an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) that appears right next to the message it belongs to.",
"properties": {
"inline_keyboard": {
"type": "array",
"items": {
"type": "array"
},
"description": "Array of button rows, each represented by an Array of [InlineKeyboardButton](https://core.telegram.org/bots/api#inlinekeyboardbutton) objects"
}
},
"required": [
"inline_keyboard"
]
},
"text": {
"type": "string",
"description": "New text of the message, 1-4096 characters after entities parsing"
}
},
"required": [
"PCID",
"text"
]
}
telegram_content_get_custom_emoji_stickers
DescribesgetCustomEmojiStickers method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
custom_emoji_ids | string[] | Yes | — | A JSON-serialized list of custom emoji identifiers. At most 200 custom emoji identifiers can be specified. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"custom_emoji_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "A JSON-serialized list of custom emoji identifiers. At most 200 custom emoji identifiers can be specified."
}
},
"required": [
"PCID",
"custom_emoji_ids"
]
}
telegram_content_get_game_high_scores
DescribesgetGameHighScores method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | integer | No | — | Required if inline_message_id is not specified. Unique identifier for the target chat |
inline_message_id | string | No | — | Required if chat_id and message_id are not specified. Identifier of the inline message |
message_id | integer | No | — | Required if inline_message_id is not specified. Identifier of the sent message |
user_id | integer | Yes | — | Target user id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"chat_id": {
"type": "integer",
"description": "Required if inline_message_id is not specified. Unique identifier for the target chat"
},
"inline_message_id": {
"type": "string",
"description": "Required if chat_id and message_id are not specified. Identifier of the inline message"
},
"message_id": {
"type": "integer",
"description": "Required if inline_message_id is not specified. Identifier of the sent message"
},
"user_id": {
"type": "integer",
"description": "Target user id"
}
},
"required": [
"PCID",
"user_id"
]
}
telegram_content_get_sticker_set
DescribesgetStickerSet method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Name of the sticker set |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "Name of the sticker set"
}
},
"required": [
"PCID",
"name"
]
}
telegram_content_refund_star_payment
DescribesrefundStarPayment method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
telegram_payment_charge_id | string | Yes | — | Telegram payment identifier |
user_id | integer | Yes | — | Identifier of the user whose payment will be refunded |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"telegram_payment_charge_id": {
"type": "string",
"description": "Telegram payment identifier"
},
"user_id": {
"type": "integer",
"description": "Identifier of the user whose payment will be refunded"
}
},
"required": [
"PCID",
"telegram_payment_charge_id",
"user_id"
]
}
telegram_content_replace_sticker_in_set
DescribesreplaceStickerInSet method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Sticker set name |
old_sticker | string | Yes | — | File identifier of the replaced sticker |
sticker | object | Yes | — | This object describes a sticker to be added to a sticker set. |
user_id | integer | Yes | — | User identifier of the sticker set owner |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "Sticker set name"
},
"old_sticker": {
"type": "string",
"description": "File identifier of the replaced sticker"
},
"sticker": {
"type": "object",
"description": "This object describes a sticker to be added to a sticker set.",
"properties": {
"emoji_list": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of 1-20 emoji associated with the sticker"
},
"format": {
"type": "string",
"description": "Format of the added sticker, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, “video” for a WEBM video"
},
"keywords": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional. List of 0-20 search keywords for the sticker with total length of up to 64 characters. For “regular” and “custom_emoji” stickers only."
},
"mask_position": {
"type": "object",
"description": "This object describes the position on faces where a mask should be placed by default."
},
"sticker": {
"type": "string",
"description": "The added sticker. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, upload a new one using multipart/form-data, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. Animated and video stickers can't be uploaded via HTTP URL. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files) Pass a file_id string to reuse an existing file."
}
},
"required": [
"sticker",
"format",
"emoji_list"
]
},
"user_id": {
"type": "integer",
"description": "User identifier of the sticker set owner"
}
},
"required": [
"PCID",
"name",
"old_sticker",
"sticker",
"user_id"
]
}
telegram_content_send_game
DescribessendGame 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 | integer | Yes | — | Unique identifier for the target chat |
disable_notification | boolean | No | — | Sends the message silently. Users will receive a notification with no sound. |
game_short_name | string | Yes | — | Short name of the game, serves as the unique identifier for the game. Set up your games via @BotFather. |
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 | — | This object represents an inline keyboard that appears right next to the message it belongs to. |
reply_parameters | object | No | — | Describes reply parameters for the message that is being sent. |
Show inputSchema
Show inputSchema
{
"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": "integer",
"description": "Unique identifier for the target chat"
},
"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."
},
"game_short_name": {
"type": "string",
"description": "Short name of the game, serves as the unique identifier for the game. Set up your games via [@BotFather](https://t.me/botfather)."
},
"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": "This object represents an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) that appears right next to the message it belongs to.",
"properties": {
"inline_keyboard": {
"type": "array",
"items": {
"type": "array"
},
"description": "Array of button rows, each represented by an Array of [InlineKeyboardButton](https://core.telegram.org/bots/api#inlinekeyboardbutton) objects"
}
},
"required": [
"inline_keyboard"
]
},
"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",
"game_short_name"
]
}
telegram_content_send_invoice
DescribessendInvoice 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. |
currency | string | Yes | — | Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars. |
description | string | Yes | — | Product description, 1-255 characters |
disable_notification | boolean | No | — | Sends the message silently. Users will receive a notification with no sound. |
is_flexible | boolean | No | — | Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars. |
max_tip_amount | integer | No | — | The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars. |
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 |
need_email | boolean | No | — | Pass True if you require the user’s email address to complete the order. Ignored for payments in Telegram Stars. |
need_name | boolean | No | — | Pass True if you require the user’s full name to complete the order. Ignored for payments in Telegram Stars. |
need_phone_number | boolean | No | — | Pass True if you require the user’s phone number to complete the order. Ignored for payments in Telegram Stars. |
need_shipping_address | boolean | No | — | Pass True if you require the user’s shipping address to complete the order. Ignored for payments in Telegram Stars. |
payload | string | Yes | — | Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. |
photo_height | integer | No | — | Photo height |
photo_size | integer | No | — | Photo size in bytes |
photo_url | string | No | — | URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for. |
photo_width | integer | No | — | Photo width |
prices | object[] | Yes | — | Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars. |
protect_content | boolean | No | — | Protects the contents of the sent message from forwarding and saving |
provider_data | string | No | — | JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider. |
provider_token | string | No | — | Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars. |
reply_markup | object | No | — | This object represents an inline keyboard that appears right next to the message it belongs to. |
reply_parameters | object | No | — | Describes reply parameters for the message that is being sent. |
send_email_to_provider | boolean | No | — | Pass True if the user’s email address should be sent to the provider. Ignored for payments in Telegram Stars. |
send_phone_number_to_provider | boolean | No | — | Pass True if the user’s phone number should be sent to the provider. Ignored for payments in Telegram Stars. |
start_parameter | string | No | — | Unique deep-linking parameter. If left empty, forwarded copies of the sent message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using the same invoice. If non-empty, forwarded copies of the sent message will have a URL button with a deep link to the bot (instead of a Pay button), with the value used as the start parameter |
suggested_tip_amounts | integer[] | No | — | A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount. |
title | string | Yes | — | Product name, 1-32 characters |
Show inputSchema
Show inputSchema
{
"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."
},
"currency": {
"type": "string",
"description": "Three-letter ISO 4217 currency code, see [more on currencies](https://core.telegram.org/bots/payments#supported-currencies). Pass “XTR” for payments in [Telegram Stars](https://t.me/BotNews/90)."
},
"description": {
"type": "string",
"description": "Product description, 1-255 characters"
},
"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."
},
"is_flexible": {
"type": "boolean",
"description": "Pass True if the final price depends on the shipping method. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90)."
},
"max_tip_amount": {
"type": "integer",
"description": "The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in [Telegram Stars](https://t.me/BotNews/90)."
},
"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"
},
"need_email": {
"type": "boolean",
"description": "Pass True if you require the user's email address to complete the order. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90)."
},
"need_name": {
"type": "boolean",
"description": "Pass True if you require the user's full name to complete the order. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90)."
},
"need_phone_number": {
"type": "boolean",
"description": "Pass True if you require the user's phone number to complete the order. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90)."
},
"need_shipping_address": {
"type": "boolean",
"description": "Pass True if you require the user's shipping address to complete the order. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90)."
},
"payload": {
"type": "string",
"description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes."
},
"photo_height": {
"type": "integer",
"description": "Photo height"
},
"photo_size": {
"type": "integer",
"description": "Photo size in bytes"
},
"photo_url": {
"type": "string",
"description": "URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for."
},
"photo_width": {
"type": "integer",
"description": "Photo width"
},
"prices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"amount": {
"type": "integer",
"format": "int32",
"description": "Price of the product in the smallest units of the [currency](https://core.telegram.org/bots/payments#supported-currencies) (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies)."
},
"label": {
"type": "string",
"description": "Portion label"
}
},
"required": [
"label",
"amount"
]
},
"description": "Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in [Telegram Stars](https://t.me/BotNews/90)."
},
"protect_content": {
"type": "boolean",
"description": "Protects the contents of the sent message from forwarding and saving"
},
"provider_data": {
"type": "string",
"description": "JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider."
},
"provider_token": {
"type": "string",
"description": "Payment provider token, obtained via [@BotFather](https://t.me/botfather). Pass an empty string for payments in [Telegram Stars](https://t.me/BotNews/90)."
},
"reply_markup": {
"type": "object",
"description": "This object represents an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) that appears right next to the message it belongs to.",
"properties": {
"inline_keyboard": {
"type": "array",
"items": {
"type": "array"
},
"description": "Array of button rows, each represented by an Array of [InlineKeyboardButton](https://core.telegram.org/bots/api#inlinekeyboardbutton) objects"
}
},
"required": [
"inline_keyboard"
]
},
"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"
]
},
"send_email_to_provider": {
"type": "boolean",
"description": "Pass True if the user's email address should be sent to the provider. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90)."
},
"send_phone_number_to_provider": {
"type": "boolean",
"description": "Pass True if the user's phone number should be sent to the provider. Ignored for payments in [Telegram Stars](https://t.me/BotNews/90)."
},
"start_parameter": {
"type": "string",
"description": "Unique deep-linking parameter. If left empty, forwarded copies of the sent message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using the same invoice. If non-empty, forwarded copies of the sent message will have a URL button with a deep link to the bot (instead of a Pay button), with the value used as the start parameter"
},
"suggested_tip_amounts": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount."
},
"title": {
"type": "string",
"description": "Product name, 1-32 characters"
}
},
"required": [
"PCID",
"chat_id",
"currency",
"description",
"payload",
"prices",
"title"
]
}
telegram_content_send_sticker
DescribessendSticker method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
business_connection_id | string | No | — | Unique identifier of the business connection on behalf of which the message will be sent |
chat_id | string | Yes | — | Unique identifier for the target chat or username of the target channel (in the format @channelusername) Pass as a numeric string (e.g., “-100123456789”) or @username. |
disable_notification | boolean | No | — | Sends the message silently. Users will receive a notification with no sound. |
emoji | string | No | — | Emoji associated with the sticker; only for just uploaded stickers |
message_effect_id | string | No | — | Unique identifier of the message effect to be added to the message; for private chats only |
message_thread_id | integer | No | — | Unique identifier for the target message thread (topic) of the forum; for forum supergroups only |
protect_content | boolean | No | — | Protects the contents of the sent message from forwarding and saving |
reply_markup | object | No | — | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user |
reply_parameters | object | No | — | Describes reply parameters for the message that is being sent. |
sticker | string | Yes | — | Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP sticker from the Internet, or upload a new .WEBP, .TGS, or .WEBM sticker using multipart/form-data. More information on Sending Files ». Video and animated stickers can’t be sent via an HTTP URL. |
Show inputSchema
Show inputSchema
{
"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 associated with the sticker; only for just uploaded stickers"
},
"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"
]
},
"sticker": {
"type": "string",
"description": "Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP sticker from the Internet, or upload a new .WEBP, .TGS, or .WEBM sticker using multipart/form-data. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files). Video and animated stickers can't be sent via an HTTP URL."
}
},
"required": [
"PCID",
"chat_id",
"sticker"
]
}
telegram_content_set_custom_emoji_sticker_set_thumbnail
DescribessetCustomEmojiStickerSetThumbnail method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
custom_emoji_id | string | No | — | Custom emoji identifier of a sticker from the sticker set; pass an empty string to drop the thumbnail and use the first sticker as the thumbnail. |
name | string | Yes | — | Sticker set name |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"custom_emoji_id": {
"type": "string",
"description": "Custom emoji identifier of a sticker from the sticker set; pass an empty string to drop the thumbnail and use the first sticker as the thumbnail."
},
"name": {
"type": "string",
"description": "Sticker set name"
}
},
"required": [
"PCID",
"name"
]
}
telegram_content_set_game_score
DescribessetGameScore method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | integer | No | — | Required if inline_message_id is not specified. Unique identifier for the target chat |
disable_edit_message | boolean | No | — | Pass True if the game message should not be automatically edited to include the current scoreboard |
force | boolean | No | — | Pass True if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters |
inline_message_id | string | No | — | Required if chat_id and message_id are not specified. Identifier of the inline message |
message_id | integer | No | — | Required if inline_message_id is not specified. Identifier of the sent message |
score | integer | Yes | — | New score, must be non-negative |
user_id | integer | Yes | — | User identifier |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"chat_id": {
"type": "integer",
"description": "Required if inline_message_id is not specified. Unique identifier for the target chat"
},
"disable_edit_message": {
"type": "boolean",
"description": "Pass True if the game message should not be automatically edited to include the current scoreboard"
},
"force": {
"type": "boolean",
"description": "Pass True if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters"
},
"inline_message_id": {
"type": "string",
"description": "Required if chat_id and message_id are not specified. Identifier of the inline message"
},
"message_id": {
"type": "integer",
"description": "Required if inline_message_id is not specified. Identifier of the sent message"
},
"score": {
"type": "integer",
"description": "New score, must be non-negative"
},
"user_id": {
"type": "integer",
"description": "User identifier"
}
},
"required": [
"PCID",
"score",
"user_id"
]
}
telegram_content_set_passport_data_errors
DescribessetPassportDataErrors method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
errors | object[] | Yes | — | A JSON-serialized array describing the errors |
user_id | integer | Yes | — | User identifier |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"errors": {
"type": "array",
"items": {
"type": "object"
},
"description": "A JSON-serialized array describing the errors"
},
"user_id": {
"type": "integer",
"description": "User identifier"
}
},
"required": [
"PCID",
"errors",
"user_id"
]
}
telegram_content_set_sticker_emoji_list
DescribessetStickerEmojiList method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
emoji_list | string[] | Yes | — | A JSON-serialized list of 1-20 emoji associated with the sticker |
sticker | string | Yes | — | File identifier of the sticker |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"emoji_list": {
"type": "array",
"items": {
"type": "string"
},
"description": "A JSON-serialized list of 1-20 emoji associated with the sticker"
},
"sticker": {
"type": "string",
"description": "File identifier of the sticker"
}
},
"required": [
"PCID",
"emoji_list",
"sticker"
]
}
telegram_content_set_sticker_keywords
DescribessetStickerKeywords method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
keywords | string[] | No | — | A JSON-serialized list of 0-20 search keywords for the sticker with total length of up to 64 characters |
sticker | string | Yes | — | File identifier of the sticker |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"keywords": {
"type": "array",
"items": {
"type": "string"
},
"description": "A JSON-serialized list of 0-20 search keywords for the sticker with total length of up to 64 characters"
},
"sticker": {
"type": "string",
"description": "File identifier of the sticker"
}
},
"required": [
"PCID",
"sticker"
]
}
telegram_content_set_sticker_mask_position
DescribessetStickerMaskPosition method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
mask_position | object | No | — | This object describes the position on faces where a mask should be placed by default. |
sticker | string | Yes | — | File identifier of the sticker |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"mask_position": {
"type": "object",
"description": "This object describes the position on faces where a mask should be placed by default.",
"properties": {
"point": {
"type": "string",
"description": "The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”."
},
"scale": {
"type": "number",
"description": "Mask scaling coefficient. For example, 2.0 means double size."
},
"x_shift": {
"type": "number",
"description": "Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. For example, choosing -1.0 will place mask just to the left of the default mask position."
},
"y_shift": {
"type": "number",
"description": "Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. For example, 1.0 will place the mask just below the default mask position."
}
},
"required": [
"point",
"x_shift",
"y_shift",
"scale"
]
},
"sticker": {
"type": "string",
"description": "File identifier of the sticker"
}
},
"required": [
"PCID",
"sticker"
]
}
telegram_content_set_sticker_position_in_set
DescribessetStickerPositionInSet method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
position | integer | Yes | — | New sticker position in the set, zero-based |
sticker | string | Yes | — | File identifier of the sticker |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"position": {
"type": "integer",
"description": "New sticker position in the set, zero-based"
},
"sticker": {
"type": "string",
"description": "File identifier of the sticker"
}
},
"required": [
"PCID",
"position",
"sticker"
]
}
telegram_content_set_sticker_set_thumbnail
DescribessetStickerSetThumbnail method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
format | string | Yes | — | Format of the thumbnail, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, or “video” for a WEBM video |
name | string | Yes | — | Sticker set name |
thumbnail | string | No | — | A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements), or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files ». Animated and video sticker set thumbnails can’t be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail. |
user_id | integer | Yes | — | User identifier of the sticker set owner |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"format": {
"type": "string",
"description": "Format of the thumbnail, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, or “video” for a WEBM video"
},
"name": {
"type": "string",
"description": "Sticker set name"
},
"thumbnail": {
"type": "string",
"description": "A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see [](https://core.telegram.org/stickers#animated-sticker-requirements)https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements), or a WEBM video with the thumbnail up to 32 kilobytes in size; see [](https://core.telegram.org/stickers#video-sticker-requirements)https://core.telegram.org/stickers#video-sticker-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files). Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail."
},
"user_id": {
"type": "integer",
"description": "User identifier of the sticker set owner"
}
},
"required": [
"PCID",
"format",
"name",
"user_id"
]
}
telegram_content_set_sticker_set_title
DescribessetStickerSetTitle method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Sticker set name |
title | string | Yes | — | Sticker set title, 1-64 characters |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "Sticker set name"
},
"title": {
"type": "string",
"description": "Sticker set title, 1-64 characters"
}
},
"required": [
"PCID",
"name",
"title"
]
}
telegram_content_stop_message_live_location
DescribesstopMessageLiveLocation method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_id | string | No | — | Required if inline_message_id is not specified. 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. |
inline_message_id | string | No | — | Required if chat_id and message_id are not specified. Identifier of the inline message |
message_id | integer | No | — | Required if inline_message_id is not specified. Identifier of the message with live location to stop |
reply_markup | object | No | — | This object represents an inline keyboard that appears right next to the message it belongs to. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"chat_id": {
"type": "string",
"description": "Required if inline_message_id is not specified. 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."
},
"inline_message_id": {
"type": "string",
"description": "Required if chat_id and message_id are not specified. Identifier of the inline message"
},
"message_id": {
"type": "integer",
"description": "Required if inline_message_id is not specified. Identifier of the message with live location to stop"
},
"reply_markup": {
"type": "object",
"description": "This object represents an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) that appears right next to the message it belongs to.",
"properties": {
"inline_keyboard": {
"type": "array",
"items": {
"type": "array"
},
"description": "Array of button rows, each represented by an Array of [InlineKeyboardButton](https://core.telegram.org/bots/api#inlinekeyboardbutton) objects"
}
},
"required": [
"inline_keyboard"
]
}
},
"required": [
"PCID"
]
}
telegram_content_stop_poll
DescribesstopPoll 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 | Yes | — | Identifier of the original message with the poll |
reply_markup | object | No | — | This object represents an inline keyboard that appears right next to the message it belongs to. |
Show inputSchema
Show inputSchema
{
"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 the original message with the poll"
},
"reply_markup": {
"type": "object",
"description": "This object represents an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) that appears right next to the message it belongs to.",
"properties": {
"inline_keyboard": {
"type": "array",
"items": {
"type": "array"
},
"description": "Array of button rows, each represented by an Array of [InlineKeyboardButton](https://core.telegram.org/bots/api#inlinekeyboardbutton) objects"
}
},
"required": [
"inline_keyboard"
]
}
},
"required": [
"PCID",
"chat_id",
"message_id"
]
}
telegram_content_upload_sticker_file
DescribesuploadStickerFile method
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sticker | 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. |
sticker_format | string | Yes | — | Format of the sticker, must be one of “static”, “animated”, “video” |
user_id | integer | Yes | — | User identifier of sticker file owner |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"sticker": {
"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."
},
"sticker_format": {
"type": "string",
"description": "Format of the sticker, must be one of “static”, “animated”, “video”"
},
"user_id": {
"type": "integer",
"description": "User identifier of sticker file owner"
}
},
"required": [
"PCID",
"sticker",
"sticker_format",
"user_id"
]
}