{ "openapi": "3.0.1", "info": { "title": "Communication Platforms Master", "description": "Unified Apify actor for accessing communication platform APIs including RingCentral, CallRail, Twilio & Zoom.\nSales Intelligence call data\nMarketing Attribution / campaigns drive phone calls\nCall recordings & transcripts\nBuild dashboards w/call metrics and KPIs\nEnrich leads w/communication history", "version": "1.0", "x-build-id": "6bI8HwajvcrexuGCH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alizarin_refrigerator-owner~communication-platforms-master/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alizarin_refrigerator-owner-communication-platforms-master", "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~communication-platforms-master/runs": { "post": { "operationId": "runs-sync-alizarin_refrigerator-owner-communication-platforms-master", "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~communication-platforms-master/run-sync": { "post": { "operationId": "run-sync-alizarin_refrigerator-owner-communication-platforms-master", "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": [ "task" ], "properties": { "task": { "title": "Task", "enum": [ "ringcentral_call_logs", "ringcentral_recordings", "ringcentral_sms_logs", "ringcentral_analytics", "callrail_calls", "callrail_recordings", "callrail_attribution", "callrail_trackers", "twilio_call_logs", "twilio_message_logs", "twilio_recordings", "twilio_usage", "zoom_meetings", "zoom_webinars", "zoom_participants", "zoom_recordings" ], "type": "string", "description": "The operation to perform", "default": "ringcentral_call_logs" }, "ringcentralClientId": { "title": "RingCentral Client ID", "type": "string", "description": "RingCentral OAuth client ID" }, "ringcentralClientSecret": { "title": "RingCentral Client Secret", "type": "string", "description": "RingCentral OAuth client secret" }, "ringcentralAccessToken": { "title": "RingCentral Access Token", "type": "string", "description": "RingCentral OAuth access token" }, "ringcentralAccountId": { "title": "RingCentral Account ID", "type": "string", "description": "RingCentral account ID (use ~ for current account)", "default": "~" }, "callrailApiKey": { "title": "CallRail API Key", "type": "string", "description": "CallRail API key (v3)" }, "callrailAccountId": { "title": "CallRail Account ID", "type": "string", "description": "CallRail account ID" }, "twilioAccountSid": { "title": "Twilio Account SID", "type": "string", "description": "Twilio Account SID" }, "twilioAuthToken": { "title": "Twilio Auth Token", "type": "string", "description": "Twilio Auth Token" }, "zoomAccountId": { "title": "Zoom Account ID", "type": "string", "description": "Zoom Account ID for Server-to-Server OAuth" }, "zoomClientId": { "title": "Zoom Client ID", "type": "string", "description": "Zoom OAuth client ID" }, "zoomClientSecret": { "title": "Zoom Client Secret", "type": "string", "description": "Zoom OAuth client secret" }, "zoomAccessToken": { "title": "Zoom Access Token", "type": "string", "description": "Zoom OAuth access token (if already obtained)" }, "startDate": { "title": "Start Date", "type": "string", "description": "Start date for data retrieval (ISO 8601 format)" }, "endDate": { "title": "End Date", "type": "string", "description": "End date for data retrieval (ISO 8601 format)" }, "phoneNumber": { "title": "Phone Number", "type": "string", "description": "Filter by phone number" }, "callId": { "title": "Call ID", "type": "string", "description": "Specific call ID for recording retrieval" }, "meetingId": { "title": "Meeting ID", "type": "string", "description": "Zoom meeting ID" }, "webinarId": { "title": "Webinar ID", "type": "string", "description": "Zoom webinar ID" }, "userId": { "title": "User ID", "type": "string", "description": "User ID or email for filtering" }, "extensionId": { "title": "Extension ID", "type": "string", "description": "RingCentral extension ID (use ~ for current)", "default": "~" }, "direction": { "title": "Call Direction", "enum": [ "all", "inbound", "outbound" ], "type": "string", "description": "Filter by call direction", "default": "all" }, "status": { "title": "Call Status", "enum": [ "all", "answered", "missed", "voicemail" ], "type": "string", "description": "Filter by call status", "default": "all" }, "limit": { "title": "Result Limit", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of results to return", "default": 100 }, "includeRecordings": { "title": "Include Recordings", "type": "boolean", "description": "Include recording URLs in results", "default": false }, "includeTranscripts": { "title": "Include Transcripts", "type": "boolean", "description": "Include call transcripts if available", "default": false }, "webhookUrl": { "title": "Result Webhook URL", "type": "string", "description": "URL to receive results via webhook" }, "demoMode": { "title": "Demo Mode", "type": "boolean", "description": "Run with sample data for testing (no external API calls)", "default": true } } }, "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 } } } } } } } } } }