{ "openapi": "3.0.1", "info": { "title": "Telegram Integration - Bot Messenger", "description": "Send automated messages, alerts & reports via Telegram. Support for groups, channels & direct messages. Perfect for monitoring alerts & team notifications.", "version": "1.3", "x-build-id": "H2XLPj2pW3oa9YhYV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alizarin_refrigerator-owner~telegram-integration/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alizarin_refrigerator-owner-telegram-integration", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/alizarin_refrigerator-owner~telegram-integration/runs": { "post": { "operationId": "runs-sync-alizarin_refrigerator-owner-telegram-integration", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/alizarin_refrigerator-owner~telegram-integration/run-sync": { "post": { "operationId": "run-sync-alizarin_refrigerator-owner-telegram-integration", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "demoMode": { "title": "Demo Mode", "type": "boolean", "description": "Run in demo mode with sample data (no actual Telegram messages sent). Leave checked if you want to see how the actor works without configuring a bot. Uncheck and provide a Bot Token + Chat ID to send real messages.", "default": true }, "botToken": { "title": "Bot Token", "type": "string", "description": "Your Telegram Bot API token from @BotFather. Required when demoMode is false. Format: 123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11" }, "chatId": { "title": "Chat ID", "type": "string", "description": "Telegram chat/group/channel ID to send messages to. Use @username for public channels (e.g. @mychannel), numeric ID for users (e.g. 123456789), or -100... for groups/supergroups. Required when demoMode is false." }, "message": { "title": "Message", "type": "string", "description": "The message to send. Supports Markdown formatting (bold *text*, italic _text_, code `text`, links [text](url))." }, "parseMode": { "title": "Parse Mode", "enum": [ "Markdown", "MarkdownV2", "HTML" ], "type": "string", "description": "Message formatting mode. Markdown is the most forgiving; MarkdownV2 is stricter but supports more features; HTML supports , , , tags.", "default": "Markdown" }, "disableNotification": { "title": "Silent Message", "type": "boolean", "description": "Send the message silently (no notification sound for the recipient).", "default": false }, "disableWebPagePreview": { "title": "Disable Link Preview", "type": "boolean", "description": "Disable automatic link previews in the message.", "default": false }, "replyToMessageId": { "title": "Reply To Message ID", "type": "integer", "description": "Optional: Message ID to reply to (creates a threaded reply). Leave blank for a top-level message." }, "imageUrl": { "title": "Image URL", "type": "string", "description": "Optional: Public URL of an image to send. The 'message' field becomes the photo caption." }, "documentUrl": { "title": "Document URL", "type": "string", "description": "Optional: Public URL of a document/file to send (PDF, ZIP, etc). The 'message' field becomes the file caption." }, "webhookData": { "title": "Webhook Data", "type": "object", "description": "Optional: Data from an Apify webhook (eventType, actorId, status, etc) -- the actor formats it into a readable notification automatically. When set, this overrides 'message'." }, "webhookUrl": { "title": "Outbound Webhook URL", "type": "string", "description": "Optional: URL to POST results to after sending (Zapier, Make, n8n, etc.) for downstream automation. Not the same as the inbound webhookData -- this is where this actor sends results AFTER the Telegram message goes out." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }