Для AI-агентов: markdown этой страницы — /docs/mcp-content.mdиндекс документации — /llms.txt
MCP: content
Обновлено
MCP: content
Это определения инструментов из текущего ToolRegistry, включая полные inputSchema/outputSchema, scope, required_scopes (ALL), risk и версию платформы. Наличие определения не означает, что инструмент уже установлен вашим хостом или разрешён вашим credential. Обновляйте tools/list после изменения бизнеса, readiness и прав. Progressive disclosure через load_domain/describe_tool и существующий meta-dispatch описаны в MCP-руководстве. Scopes и права применяются при вызове; risk не заменяет согласие и отдельные требования денежной операции. JSON ниже — схема, а не успешный результат вызова.
get_content_draft
Read back one content draft by the tenant-scoped draftHandle publish_entity returned: its publish status (pending | publishing | published | failed | cancelled), the assigned seqNum once published, and the failure reason when it failed. This is the poll target for every async content write. 0-cost read.
{
"description": "Read back one content draft by the tenant-scoped `draftHandle` publish_entity returned: its publish status (pending | publishing | published | failed | cancelled), the assigned `seqNum` once published, and the failure reason when it failed. This is the poll target for every async content write. 0-cost read.",
"domain": "content",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"draft_handle": {
"description": "The tenant-scoped `draftHandle` returned by publish_entity.",
"pattern": "^draft_[a-f0-9]{32}$",
"type": "string"
}
},
"required": [
"draft_handle"
],
"type": "object"
},
"name": "get_content_draft",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"createdAt": {
"type": "string"
},
"draftHandle": {
"type": "string"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mediaRefs": {
"items": {
"additionalProperties": false,
"properties": {
"caption": {
"maxLength": 1024,
"type": "string"
},
"captionEntities": {
"items": {
"additionalProperties": false,
"properties": {
"custom_emoji_id": {
"type": "string"
},
"language": {
"type": "string"
},
"length": {
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
"offset": {
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
"type": {
"enum": [
"mention",
"hashtag",
"cashtag",
"bot_command",
"url",
"email",
"phone_number",
"bold",
"italic",
"underline",
"strikethrough",
"spoiler",
"blockquote",
"expandable_blockquote",
"code",
"pre",
"text_link",
"text_mention",
"custom_emoji"
],
"type": "string"
},
"url": {
"type": "string"
},
"user": {
"additionalProperties": false,
"properties": {
"firstName": {
"type": "string"
},
"id": {
"pattern": "^-?\\d+$",
"type": "string"
},
"lastName": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}
},
"required": [
"type",
"offset",
"length"
],
"type": "object"
},
"type": "array"
},
"captionHtml": {
"maxLength": 16384,
"minLength": 1,
"type": "string"
},
"expectedSizeBytes": {
"exclusiveMinimum": 0,
"maximum": 4294967296,
"type": "integer"
},
"generatedFileName": {
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"kind": {
"enum": [
"voice",
"audio",
"video_note"
],
"type": "string"
},
"mediaRef": {
"maxLength": 512,
"pattern": "^media-ingress\\/v1\\/[a-f0-9]{64}\\/[A-Za-z0-9_-]{16,128}\\/objects\\/[a-z][a-z0-9-]{0,63}\\/[a-f0-9]{64}\\/[a-f0-9]{24}\\.blob$",
"type": "string"
},
"mimeType": {
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"sha256": {
"pattern": "^[0-9a-f]{64}$",
"type": "string"
},
"type": {
"enum": [
"photo",
"video",
"document"
],
"type": "string"
}
},
"required": [
"type",
"mediaRef",
"expectedSizeBytes",
"sha256",
"mimeType"
],
"type": "object"
},
"type": "array"
},
"payloadMode": {
"enum": [
"ready_message",
"source_link"
],
"type": "string"
},
"publishedMessageIds": {
"items": {
"type": "string"
},
"type": "array"
},
"seqNum": {
"anyOf": [
{
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
{
"type": "null"
}
]
},
"source": {
"enum": [
"crm",
"hub_api",
"onboarding"
],
"type": "string"
},
"sourceUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"enum": [
"pending",
"publishing",
"published",
"failed",
"cancelled"
],
"type": "string"
},
"targetTopic": {
"enum": [
"catalog",
"order_statuses",
"marketing",
"broadcasts",
"message_chains",
"events"
],
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"updatedAt": {
"type": "string"
}
},
"required": [
"draftHandle",
"targetTopic",
"source",
"payloadMode",
"text",
"mediaRefs",
"sourceUrl",
"status",
"seqNum",
"publishedMessageIds",
"error",
"createdAt",
"updatedAt"
],
"type": "object"
},
"platform_version": "1.0.19",
"required_scopes": [
"content:read"
],
"risk": "read",
"scope": "content:read",
"title": "Get Content Draft"
}media_finalize
Step 2 of 2 — close an upload and get the media references to publish with. PREREQUISITE: every declared byte was PUT to its returned write-once URL. Returns one mediaRef per file that actually landed — pass those verbatim as media on a publish tool; they are storage references, not links, and the platform signs a fresh fetchable URL at send time. Also returns albumSendable: when false the files cannot travel as ONE Telegram album (only photos and videos mix; documents ride alone) and must be published separately. Fails if nothing was uploaded.
{
"description": "Step 2 of 2 — close an upload and get the media references to publish with. PREREQUISITE: every declared byte was PUT to its returned write-once URL. Returns one `mediaRef` per file that actually landed — pass those verbatim as media on a publish tool; they are storage references, not links, and the platform signs a fresh fetchable URL at send time. Also returns `albumSendable`: when false the files cannot travel as ONE Telegram album (only photos and videos mix; documents ride alone) and must be published separately. Fails if nothing was uploaded.",
"domain": "content",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"bot": {
"description": "Optional slug of the bot you expect to act on (get_active_bot). If the active bot differs, the call is refused with ACTIVE_BOT_CHANGED and nothing runs.",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"upload_id": {
"description": "The `uploadId` returned by media_request_upload.",
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"required": [
"upload_id"
],
"type": "object"
},
"name": "media_finalize",
"outputSchema": null,
"platform_version": "1.0.19",
"required_scopes": [
"content:write"
],
"risk": "write",
"scope": "content:write",
"title": "Media Finalize"
}media_get_status
Check which files of an upload have arrived, without closing it. Use while waiting for direct presigned PUTs to finish. An empty list means nothing has landed yet, not that the id is wrong. 0-cost read.
{
"description": "Check which files of an upload have arrived, without closing it. Use while waiting for direct presigned PUTs to finish. An empty list means nothing has landed yet, not that the id is wrong. 0-cost read.",
"domain": "content",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"upload_id": {
"description": "The `uploadId` returned by media_request_upload.",
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"required": [
"upload_id"
],
"type": "object"
},
"name": "media_get_status",
"outputSchema": null,
"platform_version": "1.0.19",
"required_scopes": [
"content:read"
],
"risk": "read",
"scope": "content:read",
"title": "Media Get Status"
}media_import_files
Import files exposed by your AI host through short-lived HTTPS download URLs. The server streams each source into immutable tenant storage, verifies it, and returns durable mediaRefs for publish tools. Never pass bytes, base64, or a local path.
{
"description": "Import files exposed by your AI host through short-lived HTTPS download URLs. The server streams each source into immutable tenant storage, verifies it, and returns durable mediaRefs for publish tools. Never pass bytes, base64, or a local path.",
"domain": "content",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"bot": {
"description": "Optional slug of the bot you expect to act on (get_active_bot). If the active bot differs, the call is refused with ACTIVE_BOT_CHANGED and nothing runs.",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"files": {
"description": "Value for files.",
"items": {
"additionalProperties": false,
"description": "Value for files item.",
"properties": {
"download_url": {
"description": "Value for download url.",
"format": "uri",
"maxLength": 8192,
"type": "string"
},
"file_id": {
"description": "Value for file id.",
"maxLength": 1024,
"minLength": 1,
"type": "string"
},
"file_name": {
"description": "Value for file name.",
"maxLength": 1024,
"minLength": 1,
"type": "string"
},
"mime_type": {
"description": "Value for mime type.",
"maxLength": 255,
"minLength": 1,
"type": "string"
}
},
"required": [
"download_url"
],
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"idempotency_key": {
"description": "Value for idempotency key.",
"maxLength": 256,
"minLength": 1,
"type": "string"
}
},
"required": [
"idempotency_key",
"files"
],
"type": "object"
},
"name": "media_import_files",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"albumSendable": {
"type": "boolean"
},
"items": {
"items": {
"additionalProperties": false,
"properties": {
"caption": {
"maxLength": 1024,
"type": "string"
},
"captionEntities": {
"items": {
"additionalProperties": false,
"properties": {
"custom_emoji_id": {
"type": "string"
},
"language": {
"type": "string"
},
"length": {
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
"offset": {
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
"type": {
"enum": [
"mention",
"hashtag",
"cashtag",
"bot_command",
"url",
"email",
"phone_number",
"bold",
"italic",
"underline",
"strikethrough",
"spoiler",
"blockquote",
"expandable_blockquote",
"code",
"pre",
"text_link",
"text_mention",
"custom_emoji"
],
"type": "string"
},
"url": {
"type": "string"
},
"user": {
"additionalProperties": false,
"properties": {
"firstName": {
"type": "string"
},
"id": {
"pattern": "^-?\\d+$",
"type": "string"
},
"lastName": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}
},
"required": [
"type",
"offset",
"length"
],
"type": "object"
},
"type": "array"
},
"captionHtml": {
"maxLength": 16384,
"minLength": 1,
"type": "string"
},
"expectedSizeBytes": {
"exclusiveMinimum": 0,
"maximum": 4294967296,
"type": "integer"
},
"generatedFileName": {
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"kind": {
"enum": [
"voice",
"audio",
"video_note"
],
"type": "string"
},
"mediaRef": {
"maxLength": 512,
"pattern": "^media-ingress\\/v1\\/[a-f0-9]{64}\\/[A-Za-z0-9_-]{16,128}\\/objects\\/[a-z][a-z0-9-]{0,63}\\/[a-f0-9]{64}\\/[a-f0-9]{24}\\.blob$",
"type": "string"
},
"mimeType": {
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"sha256": {
"pattern": "^[0-9a-f]{64}$",
"type": "string"
},
"type": {
"enum": [
"photo",
"video",
"document"
],
"type": "string"
}
},
"required": [
"type",
"mediaRef",
"expectedSizeBytes",
"sha256",
"mimeType"
],
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"state": {
"const": "COMMITTED",
"type": "string"
},
"uploadId": {
"maxLength": 128,
"minLength": 16,
"type": "string"
}
},
"required": [
"uploadId",
"state",
"items",
"albumSendable"
],
"type": "object"
},
"platform_version": "1.0.19",
"required_scopes": [
"content:write"
],
"risk": "write",
"scope": "content:write",
"title": "Media Import Files"
}media_request_upload
Step 1 of 2 — reserve immutable write-once slots for images or video. Declare each file with mime_type and exact size_bytes; the response contains an uploadId and one presigned PUT URL per file. PUT every declared byte directly, then call media_finalize.
{
"description": "Step 1 of 2 — reserve immutable write-once slots for images or video. Declare each file with `mime_type` and exact `size_bytes`; the response contains an `uploadId` and one presigned PUT URL per file. PUT every declared byte directly, then call `media_finalize`.",
"domain": "content",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"bot": {
"description": "Optional slug of the bot you expect to act on (get_active_bot). If the active bot differs, the call is refused with ACTIVE_BOT_CHANGED and nothing runs.",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"files": {
"description": "Value for files.",
"items": {
"additionalProperties": false,
"description": "Value for files item.",
"properties": {
"mime_type": {
"description": "Value for mime type.",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"size_bytes": {
"description": "Value for size bytes.",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
}
},
"required": [
"mime_type",
"size_bytes"
],
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"idempotency_key": {
"description": "Value for idempotency key.",
"maxLength": 256,
"minLength": 1,
"type": "string"
}
},
"required": [
"idempotency_key",
"files"
],
"type": "object"
},
"name": "media_request_upload",
"outputSchema": null,
"platform_version": "1.0.19",
"required_scopes": [
"content:write"
],
"risk": "write",
"scope": "content:write",
"title": "Media Request Upload"
}publish_entity
Create, replace or restore content cards in the client's Telegram Settings supergroup — catalog items, order statuses, marketing campaigns, broadcasts, message-chain steps, events. Pass items:[…]: one call imports a whole batch (mixed topics allowed), each item carrying its card text (and any mediaRefs from media_finalize) plus the config fields for its targetTopic. The reply is per element: results[i] is ok with a tenant-scoped draftHandle while publishing, or the entity seqNum when available; one bad item never aborts the rest. Poll get_content_draft with a returned draftHandle. Retrying the identical request is safe. Batch size is capped by your plan; over it, nothing is written.
{
"description": "Create, replace or restore content cards in the client's Telegram Settings supergroup — catalog items, order statuses, marketing campaigns, broadcasts, message-chain steps, events. Pass `items:[…]`: one call imports a whole batch (mixed topics allowed), each item carrying its card text (and any `mediaRefs` from media_finalize) plus the `config` fields for its targetTopic. The reply is per element: `results[i]` is `ok` with a tenant-scoped `draftHandle` while publishing, or the entity `seqNum` when available; one bad item never aborts the rest. Poll `get_content_draft` with a returned `draftHandle`. Retrying the identical request is safe. Batch size is capped by your plan; over it, nothing is written.",
"domain": "content",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"bot": {
"description": "Optional slug of the bot you expect to act on (get_active_bot). If the active bot differs, the call is refused with ACTIVE_BOT_CHANGED and nothing runs.",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"items": {
"description": "Value for items.",
"items": {
"additionalProperties": false,
"description": "Value for items item.",
"properties": {
"config": {
"anyOf": [
{
"additionalProperties": false,
"description": "Value for config option.",
"properties": {
"buttons": {
"additionalProperties": false,
"description": "Value for buttons.",
"properties": {
"button_target": {
"description": "Value for button target.",
"oneOf": [
{
"additionalProperties": false,
"description": "Value for button target option.",
"properties": {
"kind": {
"const": "delivery_message",
"description": "Value for kind.",
"type": "string"
}
},
"required": [
"kind"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for button target option.",
"properties": {
"kind": {
"const": "url",
"description": "Value for kind.",
"type": "string"
},
"url": {
"description": "Value for url.",
"format": "uri",
"type": "string"
}
},
"required": [
"kind",
"url"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for button target option.",
"properties": {
"kind": {
"const": "web_app",
"description": "Value for kind.",
"type": "string"
},
"web_app_url": {
"description": "Value for web app url.",
"format": "uri",
"type": "string"
}
},
"required": [
"kind",
"web_app_url"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for button target option.",
"properties": {
"kind": {
"const": "section_root",
"description": "Value for kind.",
"type": "string"
},
"section": {
"description": "Value for section.",
"enum": [
"catalog",
"booking",
"events"
],
"type": "string"
}
},
"required": [
"kind",
"section"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for button target option.",
"properties": {
"entity_seq": {
"description": "Value for entity seq.",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
"entity_type": {
"description": "Value for entity type.",
"enum": [
"product",
"catalog_group",
"menu_group",
"event",
"resource",
"chain_step",
"marketing_campaign",
"marketing_link",
"form"
],
"type": "string"
},
"kind": {
"const": "deeplink",
"description": "Value for kind.",
"type": "string"
}
},
"required": [
"kind",
"entity_type",
"entity_seq"
],
"type": "object"
}
]
},
"button_title": {
"description": "Value for button title.",
"maxLength": 100,
"type": "string"
}
},
"type": "object"
},
"delivery": {
"additionalProperties": false,
"description": "Value for delivery.",
"properties": {
"message_content_seq_num": {
"description": "Value for message content seq num.",
"exclusiveMinimum": 0,
"maximum": 2147483647,
"type": "integer"
}
},
"type": "object"
},
"flags": {
"additionalProperties": false,
"description": "Value for flags.",
"properties": {
"is_active": {
"description": "Value for is active.",
"type": "boolean"
},
"is_create_order_on_click": {
"description": "Value for is create order on click.",
"type": "boolean"
},
"is_deferred_payment": {
"description": "Value for is deferred payment.",
"type": "boolean"
},
"is_private_access": {
"description": "Value for is private access.",
"type": "boolean"
},
"is_public": {
"description": "Value for is public.",
"type": "boolean"
},
"is_public_subscription_required": {
"description": "Value for is public subscription required.",
"type": "boolean"
},
"purchase_limit_per_user": {
"description": "Value for purchase limit per user.",
"maximum": 9007199254740991,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"item_type": {
"description": "Value for item type.",
"enum": [
"product",
"service",
"digital",
"delivery"
],
"type": "string"
},
"measurement_unit": {
"description": "Value for measurement unit.",
"maxLength": 32,
"type": "string"
},
"prices": {
"description": "Value for prices.",
"items": {
"description": "Value for prices item.",
"oneOf": [
{
"additionalProperties": false,
"description": "Value for prices item option.",
"properties": {
"amount": {
"anyOf": [
{
"description": "Value for amount option.",
"maxLength": 32,
"pattern": "^\\d+(?:\\.\\d{1,2})?$",
"type": "string"
},
{
"description": "Value for amount option.",
"type": "null"
}
],
"description": "Value for amount."
},
"currency": {
"description": "Value for currency.",
"enum": [
"RUB",
"USD",
"EUR"
],
"type": "string"
},
"trial_amount": {
"anyOf": [
{
"description": "Value for trial amount option.",
"maxLength": 32,
"pattern": "^\\d+(?:\\.\\d{1,2})?$",
"type": "string"
},
{
"description": "Value for trial amount option.",
"type": "null"
}
],
"description": "Value for trial amount."
}
},
"required": [
"currency",
"amount",
"trial_amount"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for prices item option.",
"properties": {
"amount": {
"anyOf": [
{
"description": "Value for amount option.",
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
{
"description": "Value for amount option.",
"type": "null"
}
],
"description": "Value for amount."
},
"currency": {
"const": "XTR",
"description": "Value for currency.",
"type": "string"
},
"trial_amount": {
"description": "Value for trial amount.",
"type": "null"
}
},
"required": [
"currency",
"amount",
"trial_amount"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for prices item option.",
"properties": {
"amount": {
"anyOf": [
{
"description": "Value for amount option.",
"maxLength": 32,
"pattern": "^\\d+(?:\\.\\d{1,8})?$",
"type": "string"
},
{
"description": "Value for amount option.",
"type": "null"
}
],
"description": "Value for amount."
},
"currency": {
"description": "Value for currency.",
"enum": [
"USDT",
"TON",
"BTC",
"ETH",
"LTC",
"BNB",
"TRX",
"USDC"
],
"type": "string"
},
"trial_amount": {
"description": "Value for trial amount.",
"type": "null"
}
},
"required": [
"currency",
"amount",
"trial_amount"
],
"type": "object"
}
]
},
"type": "array"
},
"requires_postal_code": {
"description": "Value for requires postal code.",
"type": "boolean"
},
"sku_code": {
"anyOf": [
{
"description": "Value for sku code option.",
"maxLength": 64,
"type": "string"
},
{
"description": "Value for sku code option.",
"type": "null"
}
],
"description": "Value for sku code."
},
"subscription": {
"additionalProperties": false,
"description": "Value for subscription.",
"properties": {
"enabled": {
"description": "Value for enabled.",
"type": "boolean"
},
"period_days": {
"description": "Value for period days.",
"maximum": 365,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"title": {
"description": "Value for title.",
"maxLength": 200,
"minLength": 1,
"type": "string"
},
"trial": {
"additionalProperties": false,
"description": "Value for trial.",
"properties": {
"days": {
"description": "Value for days.",
"maximum": 365,
"minimum": 1,
"type": "integer"
},
"enabled": {
"description": "Value for enabled.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for config option.",
"properties": {
"autoSendDeferredPayment": {
"description": "Value for auto Send Deferred Payment.",
"type": "boolean"
},
"buttonIconCustomEmojiId": {
"anyOf": [
{
"description": "Value for button Icon Custom Emoji Id option.",
"maxLength": 32,
"type": "string"
},
{
"description": "Value for button Icon Custom Emoji Id option.",
"type": "null"
}
],
"description": "Value for button Icon Custom Emoji Id."
},
"buttonStyle": {
"anyOf": [
{
"description": "Value for button Style option.",
"maxLength": 16,
"type": "string"
},
{
"description": "Value for button Style option.",
"type": "null"
}
],
"description": "Value for button Style."
},
"buttonTarget": {
"anyOf": [
{
"description": "Value for button Target option.",
"oneOf": [
{
"additionalProperties": false,
"description": "Value for button Target option option.",
"properties": {
"kind": {
"const": "delivery_message",
"description": "Value for kind.",
"type": "string"
}
},
"required": [
"kind"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for button Target option option.",
"properties": {
"kind": {
"const": "url",
"description": "Value for kind.",
"type": "string"
},
"url": {
"description": "Value for url.",
"format": "uri",
"type": "string"
}
},
"required": [
"kind",
"url"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for button Target option option.",
"properties": {
"kind": {
"const": "web_app",
"description": "Value for kind.",
"type": "string"
},
"web_app_url": {
"description": "Value for web app url.",
"format": "uri",
"type": "string"
}
},
"required": [
"kind",
"web_app_url"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for button Target option option.",
"properties": {
"kind": {
"const": "section_root",
"description": "Value for kind.",
"type": "string"
},
"section": {
"description": "Value for section.",
"enum": [
"catalog",
"booking",
"events"
],
"type": "string"
}
},
"required": [
"kind",
"section"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for button Target option option.",
"properties": {
"entity_seq": {
"description": "Value for entity seq.",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
"entity_type": {
"description": "Value for entity type.",
"enum": [
"product",
"catalog_group",
"menu_group",
"event",
"resource",
"chain_step",
"marketing_campaign",
"marketing_link",
"form"
],
"type": "string"
},
"kind": {
"const": "deeplink",
"description": "Value for kind.",
"type": "string"
}
},
"required": [
"kind",
"entity_type",
"entity_seq"
],
"type": "object"
}
]
},
{
"description": "Value for button Target option.",
"type": "null"
}
],
"description": "Value for button Target."
},
"buttonTitle": {
"anyOf": [
{
"description": "Value for button Title option.",
"maxLength": 100,
"type": "string"
},
{
"description": "Value for button Title option.",
"type": "null"
}
],
"description": "Value for button Title."
},
"buttonUrl": {
"description": "Value for button Url.",
"not": {}
},
"description": {
"anyOf": [
{
"description": "Value for description option.",
"type": "string"
},
{
"description": "Value for description option.",
"type": "null"
}
],
"description": "Value for description."
},
"group": {
"description": "Value for group.",
"enum": [
"in_progress",
"success",
"fail"
],
"type": "string"
},
"isUserNotificationEnabled": {
"description": "Value for is User Notification Enabled.",
"type": "boolean"
},
"sort": {
"description": "Value for sort.",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"title": {
"description": "Value for title.",
"maxLength": 100,
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for config option.",
"properties": {
"buttonIconCustomEmojiId": {
"anyOf": [
{
"description": "Value for button Icon Custom Emoji Id option.",
"maxLength": 32,
"type": "string"
},
{
"description": "Value for button Icon Custom Emoji Id option.",
"type": "null"
}
],
"description": "Value for button Icon Custom Emoji Id."
},
"buttonStyle": {
"anyOf": [
{
"description": "Value for button Style option.",
"maxLength": 16,
"type": "string"
},
{
"description": "Value for button Style option.",
"type": "null"
}
],
"description": "Value for button Style."
},
"buttonTarget": {
"anyOf": [
{
"description": "Value for button Target option.",
"oneOf": [
{
"additionalProperties": false,
"description": "Value for button Target option option.",
"properties": {
"kind": {
"const": "delivery_message",
"description": "Value for kind.",
"type": "string"
}
},
"required": [
"kind"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for button Target option option.",
"properties": {
"kind": {
"const": "url",
"description": "Value for kind.",
"type": "string"
},
"url": {
"description": "Value for url.",
"format": "uri",
"type": "string"
}
},
"required": [
"kind",
"url"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for button Target option option.",
"properties": {
"kind": {
"const": "web_app",
"description": "Value for kind.",
"type": "string"
},
"web_app_url": {
"description": "Value for web app url.",
"format": "uri",
"type": "string"
}
},
"required": [
"kind",
"web_app_url"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for button Target option option.",
"properties": {
"kind": {
"const": "section_root",
"description": "Value for kind.",
"type": "string"
},
"section": {
"description": "Value for section.",
"enum": [
"catalog",
"booking",
"events"
],
"type": "string"
}
},
"required": [
"kind",
"section"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for button Target option option.",
"properties": {
"entity_seq": {
"description": "Value for entity seq.",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
"entity_type": {
"description": "Value for entity type.",
"enum": [
"product",
"catalog_group",
"menu_group",
"event",
"resource",
"chain_step",
"marketing_campaign",
"marketing_link",
"form"
],
"type": "string"
},
"kind": {
"const": "deeplink",
"description": "Value for kind.",
"type": "string"
}
},
"required": [
"kind",
"entity_type",
"entity_seq"
],
"type": "object"
}
]
},
{
"description": "Value for button Target option.",
"type": "null"
}
],
"description": "Value for button Target."
},
"buttonTitle": {
"anyOf": [
{
"description": "Value for button Title option.",
"maxLength": 100,
"type": "string"
},
{
"description": "Value for button Title option.",
"type": "null"
}
],
"description": "Value for button Title."
},
"buttonUrl": {
"description": "Value for button Url.",
"not": {}
},
"isAwaitingReply": {
"description": "Value for is Awaiting Reply.",
"type": "boolean"
},
"messageTtlMinutes": {
"anyOf": [
{
"description": "Value for message Ttl Minutes option.",
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
{
"description": "Value for message Ttl Minutes option.",
"type": "null"
}
],
"description": "Value for message Ttl Minutes."
},
"savedSegmentSeqNum": {
"anyOf": [
{
"description": "Value for saved Segment Seq Num option.",
"exclusiveMinimum": 0,
"maximum": 2147483647,
"type": "integer"
},
{
"description": "Value for saved Segment Seq Num option.",
"type": "null"
}
],
"description": "Value for saved Segment Seq Num."
},
"schedule": {
"anyOf": [
{
"description": "Value for schedule option.",
"oneOf": [
{
"additionalProperties": false,
"description": "Value for schedule option option.",
"properties": {
"atLocal": {
"description": "Value for at Local.",
"type": "string"
},
"kind": {
"const": "once",
"description": "Value for kind.",
"type": "string"
}
},
"required": [
"kind",
"atLocal"
],
"type": "object"
}
]
},
{
"description": "Value for schedule option.",
"type": "null"
}
],
"description": "Value for schedule."
},
"segmentFilter": {
"anyOf": [
{
"additionalProperties": false,
"description": "Value for segment Filter option.",
"properties": {
"exclude": {
"description": "Value for exclude.",
"items": {
"additionalProperties": false,
"description": "Value for exclude item.",
"properties": {
"amountGte": {
"description": "Value for amount Gte.",
"minimum": 0,
"type": "number"
},
"groupTargetIds": {
"description": "Value for group Target Ids.",
"items": {
"description": "Value for group Target Ids item.",
"pattern": "^\\d+$",
"type": "string"
},
"maxItems": 50,
"minItems": 1,
"type": "array"
},
"key": {
"description": "Value for key.",
"minLength": 1,
"type": "string"
},
"kind": {
"description": "Value for kind.",
"enum": [
"preset",
"recipe",
"tag",
"purchase_amount",
"user_event",
"commerce",
"event",
"booking",
"form",
"channel",
"campaign",
"chain",
"chain_step",
"broadcast",
"manual"
],
"type": "string"
},
"period": {
"description": "Value for period.",
"oneOf": [
{
"additionalProperties": false,
"description": "Value for period option.",
"properties": {
"days": {
"description": "Value for days.",
"maximum": 3650,
"minimum": 1,
"type": "integer"
},
"mode": {
"const": "last_days",
"description": "Value for mode.",
"type": "string"
}
},
"required": [
"mode",
"days"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for period option.",
"properties": {
"days": {
"description": "Value for days.",
"maximum": 3650,
"minimum": 1,
"type": "integer"
},
"mode": {
"const": "older_days",
"description": "Value for mode.",
"type": "string"
}
},
"required": [
"mode",
"days"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for period option.",
"properties": {
"from": {
"description": "Value for from.",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"type": "string"
},
"mode": {
"const": "between",
"description": "Value for mode.",
"type": "string"
},
"to": {
"description": "Value for to.",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"type": "string"
}
},
"required": [
"mode",
"from",
"to"
],
"type": "object"
}
]
},
"targetIds": {
"description": "Value for target Ids.",
"items": {
"description": "Value for target Ids item.",
"pattern": "^\\d+$",
"type": "string"
},
"maxItems": 50,
"minItems": 1,
"type": "array"
},
"userIds": {
"description": "Value for user Ids.",
"items": {
"description": "Value for user Ids item.",
"pattern": "^\\d+$",
"type": "string"
},
"maxItems": 5000,
"minItems": 1,
"type": "array"
}
},
"required": [
"kind",
"key"
],
"type": "object"
},
"maxItems": 20,
"type": "array"
},
"include": {
"description": "Value for include.",
"items": {
"additionalProperties": false,
"description": "Value for include item.",
"properties": {
"any": {
"description": "Value for any.",
"items": {
"additionalProperties": false,
"description": "Value for any item.",
"properties": {
"amountGte": {
"description": "Value for amount Gte.",
"minimum": 0,
"type": "number"
},
"groupTargetIds": {
"description": "Value for group Target Ids.",
"items": {
"description": "Value for group Target Ids item.",
"pattern": "^\\d+$",
"type": "string"
},
"maxItems": 50,
"minItems": 1,
"type": "array"
},
"key": {
"description": "Value for key.",
"minLength": 1,
"type": "string"
},
"kind": {
"description": "Value for kind.",
"enum": [
"preset",
"recipe",
"tag",
"purchase_amount",
"user_event",
"commerce",
"event",
"booking",
"form",
"channel",
"campaign",
"chain",
"chain_step",
"broadcast",
"manual"
],
"type": "string"
},
"period": {
"description": "Value for period.",
"oneOf": [
{
"additionalProperties": false,
"description": "Value for period option.",
"properties": {
"days": {
"description": "Value for days.",
"maximum": 3650,
"minimum": 1,
"type": "integer"
},
"mode": {
"const": "last_days",
"description": "Value for mode.",
"type": "string"
}
},
"required": [
"mode",
"days"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for period option.",
"properties": {
"days": {
"description": "Value for days.",
"maximum": 3650,
"minimum": 1,
"type": "integer"
},
"mode": {
"const": "older_days",
"description": "Value for mode.",
"type": "string"
}
},
"required": [
"mode",
"days"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for period option.",
"properties": {
"from": {
"description": "Value for from.",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"type": "string"
},
"mode": {
"const": "between",
"description": "Value for mode.",
"type": "string"
},
"to": {
"description": "Value for to.",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"type": "string"
}
},
"required": [
"mode",
"from",
"to"
],
"type": "object"
}
]
},
"targetIds": {
"description": "Value for target Ids.",
"items": {
"description": "Value for target Ids item.",
"pattern": "^\\d+$",
"type": "string"
},
"maxItems": 50,
"minItems": 1,
"type": "array"
},
"userIds": {
"description": "Value for user Ids.",
"items": {
"description": "Value for user Ids item.",
"pattern": "^\\d+$",
"type": "string"
},
"maxItems": 5000,
"minItems": 1,
"type": "array"
}
},
"required": [
"kind",
"key"
],
"type": "object"
},
"maxItems": 20,
"minItems": 1,
"type": "array"
}
},
"required": [
"any"
],
"type": "object"
},
"maxItems": 5,
"type": "array"
}
},
"required": [
"include",
"exclude"
],
"type": "object"
},
{
"description": "Value for segment Filter option.",
"type": "null"
}
],
"description": "Value for segment Filter."
},
"segmentLabels": {
"anyOf": [
{
"description": "Value for segment Labels option.",
"type": "string"
},
{
"description": "Value for segment Labels option.",
"type": "null"
}
],
"description": "Value for segment Labels."
},
"target": {
"anyOf": [
{
"description": "Value for target option.",
"oneOf": [
{
"additionalProperties": false,
"description": "Value for target option option.",
"properties": {
"kind": {
"const": "delivery_message",
"description": "Value for kind.",
"type": "string"
}
},
"required": [
"kind"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for target option option.",
"properties": {
"kind": {
"const": "url",
"description": "Value for kind.",
"type": "string"
},
"url": {
"description": "Value for url.",
"format": "uri",
"type": "string"
}
},
"required": [
"kind",
"url"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for target option option.",
"properties": {
"kind": {
"const": "web_app",
"description": "Value for kind.",
"type": "string"
},
"web_app_url": {
"description": "Value for web app url.",
"format": "uri",
"type": "string"
}
},
"required": [
"kind",
"web_app_url"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for target option option.",
"properties": {
"kind": {
"const": "section_root",
"description": "Value for kind.",
"type": "string"
},
"section": {
"description": "Value for section.",
"enum": [
"catalog",
"booking",
"events"
],
"type": "string"
}
},
"required": [
"kind",
"section"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for target option option.",
"properties": {
"entity_seq": {
"description": "Value for entity seq.",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
"entity_type": {
"description": "Value for entity type.",
"enum": [
"product",
"catalog_group",
"menu_group",
"event",
"resource",
"chain_step",
"marketing_campaign",
"marketing_link",
"form"
],
"type": "string"
},
"kind": {
"const": "deeplink",
"description": "Value for kind.",
"type": "string"
}
},
"required": [
"kind",
"entity_type",
"entity_seq"
],
"type": "object"
}
]
},
{
"description": "Value for target option.",
"type": "null"
}
],
"description": "Value for target."
},
"title": {
"description": "Value for title.",
"maxLength": 120,
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for config option.",
"properties": {
"buttonIconCustomEmojiId": {
"anyOf": [
{
"description": "Value for button Icon Custom Emoji Id option.",
"maxLength": 32,
"type": "string"
},
{
"description": "Value for button Icon Custom Emoji Id option.",
"type": "null"
}
],
"description": "Value for button Icon Custom Emoji Id."
},
"buttonStyle": {
"anyOf": [
{
"description": "Value for button Style option.",
"maxLength": 16,
"type": "string"
},
{
"description": "Value for button Style option.",
"type": "null"
}
],
"description": "Value for button Style."
},
"buttonTarget": {
"anyOf": [
{
"description": "Value for button Target option.",
"oneOf": [
{
"additionalProperties": false,
"description": "Value for button Target option option.",
"properties": {
"kind": {
"const": "delivery_message",
"description": "Value for kind.",
"type": "string"
}
},
"required": [
"kind"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for button Target option option.",
"properties": {
"kind": {
"const": "url",
"description": "Value for kind.",
"type": "string"
},
"url": {
"description": "Value for url.",
"format": "uri",
"type": "string"
}
},
"required": [
"kind",
"url"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for button Target option option.",
"properties": {
"kind": {
"const": "web_app",
"description": "Value for kind.",
"type": "string"
},
"web_app_url": {
"description": "Value for web app url.",
"format": "uri",
"type": "string"
}
},
"required": [
"kind",
"web_app_url"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for button Target option option.",
"properties": {
"kind": {
"const": "section_root",
"description": "Value for kind.",
"type": "string"
},
"section": {
"description": "Value for section.",
"enum": [
"catalog",
"booking",
"events"
],
"type": "string"
}
},
"required": [
"kind",
"section"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for button Target option option.",
"properties": {
"entity_seq": {
"description": "Value for entity seq.",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
"entity_type": {
"description": "Value for entity type.",
"enum": [
"product",
"catalog_group",
"menu_group",
"event",
"resource",
"chain_step",
"marketing_campaign",
"marketing_link",
"form"
],
"type": "string"
},
"kind": {
"const": "deeplink",
"description": "Value for kind.",
"type": "string"
}
},
"required": [
"kind",
"entity_type",
"entity_seq"
],
"type": "object"
}
]
},
{
"description": "Value for button Target option.",
"type": "null"
}
],
"description": "Value for button Target."
},
"buttonTitle": {
"anyOf": [
{
"description": "Value for button Title option.",
"maxLength": 100,
"type": "string"
},
{
"description": "Value for button Title option.",
"type": "null"
}
],
"description": "Value for button Title."
},
"buttonUrl": {
"description": "Value for button Url.",
"not": {}
},
"displayName": {
"description": "Value for display Name.",
"minLength": 1,
"type": "string"
},
"isActive": {
"description": "Value for is Active.",
"type": "boolean"
},
"target": {
"description": "Value for target.",
"oneOf": [
{
"additionalProperties": false,
"description": "Value for target option.",
"properties": {
"kind": {
"const": "delivery_message",
"description": "Value for kind.",
"type": "string"
}
},
"required": [
"kind"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for target option.",
"properties": {
"kind": {
"const": "url",
"description": "Value for kind.",
"type": "string"
},
"url": {
"description": "Value for url.",
"format": "uri",
"type": "string"
}
},
"required": [
"kind",
"url"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for target option.",
"properties": {
"kind": {
"const": "web_app",
"description": "Value for kind.",
"type": "string"
},
"web_app_url": {
"description": "Value for web app url.",
"format": "uri",
"type": "string"
}
},
"required": [
"kind",
"web_app_url"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for target option.",
"properties": {
"kind": {
"const": "section_root",
"description": "Value for kind.",
"type": "string"
},
"section": {
"description": "Value for section.",
"enum": [
"catalog",
"booking",
"events"
],
"type": "string"
}
},
"required": [
"kind",
"section"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for target option.",
"properties": {
"entity_seq": {
"description": "Value for entity seq.",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
"entity_type": {
"description": "Value for entity type.",
"enum": [
"product",
"catalog_group",
"menu_group",
"event",
"resource",
"chain_step",
"marketing_campaign",
"marketing_link",
"form"
],
"type": "string"
},
"kind": {
"const": "deeplink",
"description": "Value for kind.",
"type": "string"
}
},
"required": [
"kind",
"entity_type",
"entity_seq"
],
"type": "object"
}
]
}
},
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for config option.",
"properties": {
"step": {
"additionalProperties": false,
"description": "Value for step.",
"properties": {
"delayMinutes": {
"description": "Value for delay Minutes.",
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
"title": {
"anyOf": [
{
"description": "Value for title option.",
"maxLength": 255,
"type": "string"
},
{
"description": "Value for title option.",
"type": "null"
}
],
"description": "Value for title."
}
},
"type": "object"
},
"title": {
"description": "Value for title.",
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for config option.",
"properties": {
"startAt": {
"anyOf": [
{
"anyOf": [
{
"description": "Value for start At option option."
},
{
"description": "Value for start At option option.",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"type": "string"
}
],
"description": "Value for start At option."
},
{
"description": "Value for start At option.",
"type": "null"
}
],
"description": "Value for start At."
}
},
"type": "object"
}
],
"description": "Entity fields for the chosen targetTopic. Each topic admits its OWN shape; a mismatch is rejected."
},
"content": {
"additionalProperties": false,
"description": "Channel-agnostic content payload.",
"properties": {
"mediaRefs": {
"default": [],
"description": "Immutable descriptors from media_finalize. URLs and bytes are forbidden.",
"items": {
"additionalProperties": false,
"description": "Value for media Refs item.",
"properties": {
"caption": {
"description": "Value for caption.",
"maxLength": 1024,
"type": "string"
},
"captionEntities": {
"description": "Value for caption Entities.",
"items": {
"additionalProperties": false,
"description": "Value for caption Entities item.",
"properties": {
"custom_emoji_id": {
"description": "Value for custom emoji id.",
"type": "string"
},
"language": {
"description": "Value for language.",
"type": "string"
},
"length": {
"description": "Value for length.",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
"offset": {
"description": "Value for offset.",
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
"type": {
"description": "Value for type.",
"enum": [
"mention",
"hashtag",
"cashtag",
"bot_command",
"url",
"email",
"phone_number",
"bold",
"italic",
"underline",
"strikethrough",
"spoiler",
"blockquote",
"expandable_blockquote",
"code",
"pre",
"text_link",
"text_mention",
"custom_emoji"
],
"type": "string"
},
"url": {
"description": "Value for url.",
"type": "string"
},
"user": {
"additionalProperties": false,
"description": "Value for user.",
"properties": {
"firstName": {
"description": "Value for first Name.",
"type": "string"
},
"id": {
"description": "Value for id.",
"pattern": "^-?\\d+$",
"type": "string"
},
"lastName": {
"description": "Value for last Name.",
"type": "string"
},
"username": {
"description": "Value for username.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}
},
"required": [
"type",
"offset",
"length"
],
"type": "object"
},
"type": "array"
},
"captionHtml": {
"description": "Value for caption Html.",
"maxLength": 16384,
"minLength": 1,
"type": "string"
},
"expectedSizeBytes": {
"description": "Value for expected Size Bytes.",
"exclusiveMinimum": 0,
"maximum": 4294967296,
"type": "integer"
},
"generatedFileName": {
"description": "Value for generated File Name.",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"kind": {
"description": "Value for kind.",
"enum": [
"voice",
"audio",
"video_note"
],
"type": "string"
},
"mediaRef": {
"description": "Value for media Ref.",
"maxLength": 512,
"pattern": "^media-ingress\\/v1\\/[a-f0-9]{64}\\/[A-Za-z0-9_-]{16,128}\\/objects\\/[a-z][a-z0-9-]{0,63}\\/[a-f0-9]{64}\\/[a-f0-9]{24}\\.blob$",
"type": "string"
},
"mimeType": {
"description": "Value for mime Type.",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"sha256": {
"description": "Value for sha256.",
"pattern": "^[0-9a-f]{64}$",
"type": "string"
},
"type": {
"description": "Value for type.",
"enum": [
"photo",
"video",
"document"
],
"type": "string"
}
},
"required": [
"type",
"mediaRef",
"expectedSizeBytes",
"sha256",
"mimeType"
],
"type": "object"
},
"maxItems": 10,
"type": "array"
},
"sourceUrl": {
"description": "Page to parse once into the card text. No periodic sync.",
"format": "uri",
"type": "string"
},
"text": {
"description": "Telegram HTML message text. Max 4096 chars.",
"maxLength": 4096,
"type": "string"
}
},
"required": [
"mediaRefs"
],
"type": "object"
},
"intent": {
"default": "CREATE",
"description": "CREATE a new card, REPLACE the content of an existing one, or RESTORE a soft-deleted one.",
"enum": [
"CREATE",
"REPLACE",
"RESTORE"
],
"type": "string"
},
"replaceTarget": {
"additionalProperties": false,
"description": "REPLACE / RESTORE only — which existing card to swap.",
"properties": {
"kind": {
"description": "Which content to swap — the entity's own card, or its delivery message.",
"enum": [
"card",
"delivery"
],
"type": "string"
},
"seqId": {
"description": "Per-client seq of the entity to replace.",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
}
},
"required": [
"kind"
],
"type": "object"
},
"targetTopic": {
"description": "Which Settings-SG content topic this card belongs to.",
"enum": [
"catalog",
"order_statuses",
"marketing",
"broadcasts",
"message_chains",
"events"
],
"type": "string"
},
"waitResult": {
"default": false,
"description": "true = wait for the published entity and return its seqId; false = return the draftId immediately.",
"type": "boolean"
}
},
"required": [
"targetTopic",
"intent",
"content",
"waitResult"
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"items"
],
"type": "object"
},
"name": "publish_entity",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"results": {
"items": {
"additionalProperties": false,
"properties": {
"autoDisabledProviders": {
"items": {
"type": "string"
},
"type": "array"
},
"draftHandle": {
"type": "string"
},
"error": {
"type": "string"
},
"index": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"seqNum": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"status": {
"enum": [
"pending",
"publishing",
"published",
"failed",
"cancelled"
],
"type": "string"
},
"waitTimedOut": {
"type": "boolean"
}
},
"required": [
"index"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"results"
],
"type": "object"
},
"platform_version": "1.0.19",
"required_scopes": [
"content:write"
],
"risk": "write",
"scope": "content:write",
"title": "Publish Entity"
}