{ "openapi": "3.0.1", "info": { "title": "Telegram Member Adder", "description": "Telegram group inviter for administrators who need to attempt 1 to 10 consented username or user-ID invitations through their own authenticated session. Select one accessible basic group or supergroup and receive an 11-field status receipt for every deduplicated target.", "version": "1.0", "x-build-id": "2oCCWCmDhDRc2KQlS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/agentx~telegram-member-adder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-agentx-telegram-member-adder", "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/agentx~telegram-member-adder/runs": { "post": { "operationId": "runs-sync-agentx-telegram-member-adder", "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/agentx~telegram-member-adder/run-sync": { "post": { "operationId": "run-sync-agentx-telegram-member-adder", "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", "required": [ "group_match", "usernames" ], "properties": { "session": { "title": "🔐 Session", "type": "string", "description": "Optional reusable Telethon StringSession. Leave empty for a first QR sign-in. The resulting session is sent to your own Saved Messages; store it as a secret because anyone holding it can act as your Telegram account." }, "password": { "title": "🔑 Password", "type": "string", "description": "Optional Telegram two-step-verification password used only if QR sign-in requests it. This is not your Apify password. Store it as a secret and never include it in logs or support messages." }, "group_match": { "title": "👥 Group Match", "minLength": 1, "type": "string", "description": "Select one accessible basic group or supergroup by exact @username, numeric ID, exact title, or a title fragment that matches only one dialog. Every authenticated run lists all your groups in the log with names, IDs, usernames where available, and a copyable group_match value. Paste that value here on future runs; both raw positive IDs and signed dialog IDs are accepted. The complete list is also printed when the query is ambiguous or no group matches. Broadcast channels are rejected and ambiguous titles stop the run before invitations." }, "usernames": { "title": "👤 Usernames", "minItems": 1, "maxItems": 10, "type": "array", "description": "One to 10 consented Telegram @usernames, bare usernames, or positive numeric user IDs. Values are normalized and deduplicated. Privacy, permission, bot, account, and anti-spam controls can reject an attempt; every reached target receives a status receipt.", "items": { "type": "string", "minLength": 1, "pattern": "^(?:@?(?=[A-Za-z0-9_]{5,32}$)(?=[A-Za-z0-9_]*[A-Za-z_])[A-Za-z0-9_]+|[1-9][0-9]{0,18})$" } } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }