{ "info": { "_postman_id": "50fb2b20-2a60-48f1-9c6a-5f67c402ad2a", "name": "Voice API", "description": "Voice API documentation\n\nContact Support:\n Name: 8x8 Inc\n Email: cpaas-support@8x8.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "lastUpdatedBy": "35240", "uid": "35240-50fb2b20-2a60-48f1-9c6a-5f67c402ad2a" }, "item": [ { "name": "api", "item": [ { "name": "v1", "item": [ { "name": "subaccounts", "item": [ { "name": "{subAccountId}", "item": [ { "name": "callflows", "item": [ { "name": "Send Callflow", "id": "cd1a634b-b466-4da9-a648-799905b1fb14", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"validUntil\": \"2024-07-03T05:59:32.226Z\",\n \"callflow\": [\n {\n \"action\": \"makeCall\",\n \"params\": {\n \"source\": \"6512345678\",\n \"destination\": \"6590000000\"\n }\n },\n {\n \"action\": \"say\",\n \"params\": {\n \"text\": \"Hi, This is a test message from 8x8\",\n \"voiceProfile\": \"en-GB-Emma\",\n \"repetition\": 1,\n \"speed\": 1\n }\n },\n {\n \"action\": \"hangup\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/callflows", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "callflows" ], "variable": [ { "id": "6f038445-5d4f-4c79-8a93-315fb9382ada", "key": "subAccountId", "value": "&5gM9oMce760", "description": "(Required) You must replace {subAccountId} with the subaccountid that you want to use. By default this is generated once you have completed the voice onboarding." } ] }, "description": "**Note:** For all API requests that include a `source` parameter, CLID whitelisting is mandatory. Please contact your account manager or email cpaas-support@8x8.com if you have a voice account with 8x8 CPaaS.\n\n## Use Cases\n\nThe Callflows API enables you to build sophisticated voice solutions:\n\n**Interactive Voice Response (IVR)**\n\nCreate interactive menu systems with DTMF capture, conditional routing, and voice prompts.\n- [Simple IVR Guide](/connect/docs/voice/ivr/simple-ivr-guide) - Basic IVR implementation\n- [Advanced IVR Guide](/connect/docs/voice/ivr/advanced-ivr-guide) - Complex IVR with conditional logic\n\n**Voice Messaging**\n\nDeliver automated voice messages using text-to-speech (TTS) or pre-recorded audio files.\n- [Voice Messaging Guide](/connect/docs/voice/voice-messaging/voice-messaging-guide)\n\n**Custom Call Scenarios**\n\nBuild tailored call flows by combining multiple actions (makeCall, say, playFile, sayAndCapture, hangup) to meet your specific business requirements.\n\n---\n\n## API Examples\n\n### Example 1: IVR with DTMF Capture\n\n```json\n{\n \"callflow\": [\n {\n \"action\": \"makeCall\",\n \"params\": {\n \"source\": \"+6588000000\",\n \"destination\": \"+6590000000\"\n }\n },\n {\n \"action\": \"sayAndCapture\",\n \"params\": {\n \"promptMessage\": \"Press 1 for Sales, Press 2 for Support\",\n \"voiceProfile\": \"en-US-Neural2-C\",\n \"minDigits\": 1,\n \"maxDigits\": 1,\n \"digitTimeout\": 5000,\n \"completeOnHash\": false\n }\n }\n ]\n}\n```\n\n### Example 2: Voice Message (Text-to-Speech)\n\n```json\n{\n \"callflow\": [\n {\n \"action\": \"makeCall\",\n \"params\": {\n \"source\": \"+6588000000\",\n \"destination\": \"+6590000000\"\n }\n },\n {\n \"action\": \"say\",\n \"params\": {\n \"text\": \"Hello, this is a reminder about your appointment tomorrow at 2 PM.\",\n \"voiceProfile\": \"en-GB-Emma\",\n \"repetition\": 1,\n \"speed\": 1\n }\n },\n {\n \"action\": \"hangup\"\n }\n ]\n}\n```\n\n### Example 3: Voice Message (Audio File)\n\n```json\n{\n \"callflow\": [\n {\n \"action\": \"makeCall\",\n \"params\": {\n \"source\": \"+6588000000\",\n \"destination\": \"+6590000000\"\n }\n },\n {\n \"action\": \"playFile\",\n \"params\": {\n \"fileUrl\": \"https://example.com/audio/notification.mp3\",\n \"repetition\": 1\n }\n },\n {\n \"action\": \"hangup\"\n }\n ]\n}\n```" }, "response": [ { "id": "175929be-3bbe-4460-853e-d084083a2081", "name": "Should the request authenticate successfully and pass all validation, the response will contain an updated Voice Message Object. The following is an example response:", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"validUntil\": \"2024-07-03T05:59:32.226Z\",\n \"callflow\": [\n {\n \"action\": \"makeCall\",\n \"params\": {\n \"source\": \"6512345678\",\n \"destination\": \"6590000000\"\n }\n },\n {\n \"action\": \"say\",\n \"params\": {\n \"text\": \"Hi, This is a test message from 8x8\",\n \"voiceProfile\": \"en-GB-Emma\",\n \"repetition\": 1,\n \"speed\": 1\n }\n },\n {\n \"action\": \"hangup\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/callflows", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "callflows" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"sessionId\": \"\",\n \"sessionStatus\": \"\",\n \"callFlowRequestId\": \"\",\n \"statusCode\": \"\",\n \"statusMessage\": \"\",\n \"validUntil\": \"\"\n}", "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-175929be-3bbe-4460-853e-d084083a2081" }, { "id": "d3046ded-77d9-4d95-ae1b-e577d69c4517", "name": "New Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"validUntil\": \"2024-07-03T05:59:32.226Z\",\n \"callflow\": [\n {\n \"action\": \"makeCall\",\n \"params\": {\n \"source\": \"6512345678\",\n \"destination\": \"6590000000\"\n }\n },\n {\n \"action\": \"say\",\n \"params\": {\n \"text\": \"Hi, This is a test message from 8x8\",\n \"voiceProfile\": \"en-GB-Emma\",\n \"repetition\": 1,\n \"speed\": 1\n }\n },\n {\n \"action\": \"hangup\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/callflows", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "callflows" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"sessionStatus\": \"\",\n \"callFlowRequestId\": \"\",\n \"statusCode\": \"\",\n \"statusMessage\": \"\"\n}", "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-d3046ded-77d9-4d95-ae1b-e577d69c4517" }, { "id": "ce830ac8-efdc-4d4b-ba67-98501b2a75c9", "name": "New Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"validUntil\": \"2024-07-03T05:59:32.226Z\",\n \"callflow\": [\n {\n \"action\": \"makeCall\",\n \"params\": {\n \"source\": \"6512345678\",\n \"destination\": \"6590000000\"\n }\n },\n {\n \"action\": \"say\",\n \"params\": {\n \"text\": \"Hi, This is a test message from 8x8\",\n \"voiceProfile\": \"en-GB-Emma\",\n \"repetition\": 1,\n \"speed\": 1\n }\n },\n {\n \"action\": \"hangup\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/callflows", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "callflows" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"sessionStatus\": \"\",\n \"callFlowRequestId\": \"\",\n \"statusCode\": \"\",\n \"statusMessage\": \"\"\n}", "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-ce830ac8-efdc-4d4b-ba67-98501b2a75c9" }, { "id": "b26157c8-6235-4f26-bf92-2d051ccb0686", "name": "New Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"validUntil\": \"2024-07-03T05:59:32.226Z\",\n \"callflow\": [\n {\n \"action\": \"makeCall\",\n \"params\": {\n \"source\": \"6512345678\",\n \"destination\": \"6590000000\"\n }\n },\n {\n \"action\": \"say\",\n \"params\": {\n \"text\": \"Hi, This is a test message from 8x8\",\n \"voiceProfile\": \"en-GB-Emma\",\n \"repetition\": 1,\n \"speed\": 1\n }\n },\n {\n \"action\": \"hangup\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/callflows", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "callflows" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"sessionStatus\": \"\",\n \"callFlowRequestId\": \"\",\n \"statusCode\": \"\",\n \"statusMessage\": \"\"\n}", "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-b26157c8-6235-4f26-bf92-2d051ccb0686" }, { "id": "1711b2f3-d785-4bf1-bd19-b45593a764eb", "name": "New Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"validUntil\": \"2024-07-03T05:59:32.226Z\",\n \"callflow\": [\n {\n \"action\": \"makeCall\",\n \"params\": {\n \"source\": \"6512345678\",\n \"destination\": \"6590000000\"\n }\n },\n {\n \"action\": \"say\",\n \"params\": {\n \"text\": \"Hi, This is a test message from 8x8\",\n \"voiceProfile\": \"en-GB-Emma\",\n \"repetition\": 1,\n \"speed\": 1\n }\n },\n {\n \"action\": \"hangup\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/callflows", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "callflows" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"sessionStatus\": \"\",\n \"callFlowRequestId\": \"\",\n \"statusCode\": \"\",\n \"statusMessage\": \"\"\n}", "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-1711b2f3-d785-4bf1-bd19-b45593a764eb" }, { "id": "7011218a-daed-440d-b7ec-d75bac12de1b", "name": "New Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"validUntil\": \"2024-07-03T05:59:32.226Z\",\n \"callflow\": [\n {\n \"action\": \"makeCall\",\n \"params\": {\n \"source\": \"6512345678\",\n \"destination\": \"6590000000\"\n }\n },\n {\n \"action\": \"say\",\n \"params\": {\n \"text\": \"Hi, This is a test message from 8x8\",\n \"voiceProfile\": \"en-GB-Emma\",\n \"repetition\": 1,\n \"speed\": 1\n }\n },\n {\n \"action\": \"hangup\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/callflows", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "callflows" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"sessionStatus\": \"\",\n \"callFlowRequestId\": \"\",\n \"statusCode\": \"\",\n \"statusMessage\": \"\"\n}", "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-7011218a-daed-440d-b7ec-d75bac12de1b" } ], "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-cd1a634b-b466-4da9-a648-799905b1fb14" } ], "id": "b716a0c3-bbd1-4343-9a75-a9d87f3bfd8e", "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-b716a0c3-bbd1-4343-9a75-a9d87f3bfd8e" }, { "name": "speech-profiles", "item": [ { "name": "Get speech profiles for your account", "id": "5d5416e2-b0b5-4faf-b617-e367c4360df6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/speech-profiles", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "speech-profiles" ], "variable": [ { "id": "e6ef8083-e6ba-403d-a542-b27d9eafacf9", "key": "subAccountId", "value": "&5gM9oMce760", "description": "(Required) You must replace {subAccountId} with the subaccountid that you want to use. By default this is generated once you have completed the voice onboarding." } ] } }, "response": [ { "id": "3110a2fe-5236-42ce-9fca-e8094756f9b9", "name": "Request succeeded", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/speech-profiles", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "speech-profiles" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"speechProfiles\": [\n {\n \"speechProfileCode\": \"\",\n \"localeCode\": \"\",\n \"localeDescription\": \"\",\n \"gender\": \"\"\n },\n {\n \"speechProfileCode\": \"\",\n \"localeCode\": \"\",\n \"localeDescription\": \"\",\n \"gender\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"statusMessage\": \"\"\n}", "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-3110a2fe-5236-42ce-9fca-e8094756f9b9" }, { "id": "e146ce73-5eb0-453d-b8b5-709b82e35bc3", "name": "API key not found or invalid", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/speech-profiles", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "speech-profiles" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-e146ce73-5eb0-453d-b8b5-709b82e35bc3" }, { "id": "ddc71af1-e891-42cd-bb03-750cf6095ad1", "name": "Resource not accessible", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/speech-profiles", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "speech-profiles" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-ddc71af1-e891-42cd-bb03-750cf6095ad1" }, { "id": "109ec5a8-8297-484a-adda-738da22d60d7", "name": "Resource not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/speech-profiles", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "speech-profiles" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-109ec5a8-8297-484a-adda-738da22d60d7" }, { "id": "c5852652-dad1-4e1f-b21d-9e5916c24fcf", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/speech-profiles", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "speech-profiles" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-c5852652-dad1-4e1f-b21d-9e5916c24fcf" } ], "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-5d5416e2-b0b5-4faf-b617-e367c4360df6" } ], "id": "2a17bc20-f8b3-4f75-a78e-eb277a046125", "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-2a17bc20-f8b3-4f75-a78e-eb277a046125" }, { "name": "webhooks", "item": [ { "name": "{webhook-type}", "item": [ { "name": "Delete a specific type of webhook", "id": "8bd6a491-902a-4a8f-9d11-d41f58bbe0b2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/webhooks/:webhook-type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "webhooks", ":webhook-type" ], "variable": [ { "id": "c6e49ba3-2ac3-4cf2-bfcb-66e305b8c2d9", "key": "subAccountId", "value": "&5gM9oMce760", "description": "(Required) You must replace {subAccountId} with the subaccountid that you want to use. By default this is generated once you have completed the voice onboarding." }, { "id": "20c5274f-6a4a-4090-a3eb-73abff501ede", "key": "webhook-type", "value": "VRU", "description": "(Required) webhook type to delete" } ] } }, "response": [ { "id": "1c4154c8-f0e2-439c-be16-a5c437766294", "name": "Request succeeded", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/webhooks/:webhook-type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "webhooks", ":webhook-type" ], "variable": [ { "key": "subAccountId" }, { "key": "webhook-type" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"allOf\": {\n \"type\": \"\",\n \"url\": \"\",\n \"enabled\": \"\",\n \"httpAuthHeaderAvailable\": \"\"\n },\n \"statusCode\": \"\",\n \"statusMessage\": \"\"\n}", "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-1c4154c8-f0e2-439c-be16-a5c437766294" }, { "id": "bbc46f0a-bc19-4b1c-a249-2cfbd546020c", "name": "API key not found or invalid", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/webhooks/:webhook-type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "webhooks", ":webhook-type" ], "variable": [ { "key": "subAccountId" }, { "key": "webhook-type" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-bbc46f0a-bc19-4b1c-a249-2cfbd546020c" }, { "id": "4e0940c4-797d-4093-9a96-1c45674a262a", "name": "Resource not accessible", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/webhooks/:webhook-type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "webhooks", ":webhook-type" ], "variable": [ { "key": "subAccountId" }, { "key": "webhook-type" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-4e0940c4-797d-4093-9a96-1c45674a262a" }, { "id": "1e62b4fa-4bce-44b4-b09b-ebd537a36dad", "name": "Resource not found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/webhooks/:webhook-type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "webhooks", ":webhook-type" ], "variable": [ { "key": "subAccountId" }, { "key": "webhook-type" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-1e62b4fa-4bce-44b4-b09b-ebd537a36dad" }, { "id": "8d75370c-4ae2-4b88-a910-6b646cc12293", "name": "Server error", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/webhooks/:webhook-type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "webhooks", ":webhook-type" ], "variable": [ { "key": "subAccountId" }, { "key": "webhook-type" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-8d75370c-4ae2-4b88-a910-6b646cc12293" } ], "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-8bd6a491-902a-4a8f-9d11-d41f58bbe0b2" } ], "id": "6306883b-2819-454c-bcc3-336120df9025", "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-6306883b-2819-454c-bcc3-336120df9025" }, { "name": "Get webhook information for your account", "id": "ec97a937-bfca-4560-b11d-489b7e0fed9f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "webhooks" ], "variable": [ { "id": "7c88b5ab-7c76-4b83-aae7-3b8f73b351bc", "key": "subAccountId", "value": "&5gM9oMce760", "description": "(Required) You must replace {subAccountId} with the subaccountid that you want to use. By default this is generated once you have completed the voice onboarding." } ] } }, "response": [ { "id": "e0ca28da-81ef-4791-bc10-43e28ead89a9", "name": "Request succeeded", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "webhooks" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"subAccountId\": \"\",\n \"count\": \"\",\n \"webhooks\": [\n {\n \"type\": \"\",\n \"url\": \"\",\n \"enabled\": \"\",\n \"httpAuthHeaderAvailable\": \"\"\n },\n {\n \"type\": \"\",\n \"url\": \"\",\n \"enabled\": \"\",\n \"httpAuthHeaderAvailable\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"statusMessage\": \"\"\n}", "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-e0ca28da-81ef-4791-bc10-43e28ead89a9" }, { "id": "20440e7f-8bc6-42d6-8174-05fd48ae3e1b", "name": "API key not found or invalid", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "webhooks" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-20440e7f-8bc6-42d6-8174-05fd48ae3e1b" }, { "id": "9d1122d6-307e-497b-a0a4-83492b61007f", "name": "Resource not accessible", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "webhooks" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-9d1122d6-307e-497b-a0a4-83492b61007f" }, { "id": "d2e4ece9-0dbf-4e49-b910-1523f41ae07e", "name": "Resource not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "webhooks" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-d2e4ece9-0dbf-4e49-b910-1523f41ae07e" }, { "id": "c2af09e8-e305-4773-90bc-f425ed031472", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "webhooks" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-c2af09e8-e305-4773-90bc-f425ed031472" } ], "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-ec97a937-bfca-4560-b11d-489b7e0fed9f" }, { "name": "Create a new webhook", "id": "eb92b131-eb96-4caa-a4cd-eac62cba5e3b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"VCS\",\n \"url\": \"\",\n \"httpAuthHeader\": \"\",\n \"enabled\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "webhooks" ], "variable": [ { "id": "a8ffab96-8769-4e33-966d-f0b99c96d3b2", "key": "subAccountId", "value": "&5gM9oMce760", "description": "(Required) You must replace {subAccountId} with the subaccountid that you want to use. By default this is generated once you have completed the voice onboarding." } ] } }, "response": [ { "id": "b15510ff-ab88-4832-9380-2c25b4e70cda", "name": "Request succeeded", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"VCS\",\n \"url\": \"\",\n \"httpAuthHeader\": \"\",\n \"enabled\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "webhooks" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"subAccountId\": \"\",\n \"count\": \"\",\n \"webhooks\": [\n {\n \"type\": \"\",\n \"url\": \"\",\n \"enabled\": \"\",\n \"httpAuthHeaderAvailable\": \"\"\n },\n {\n \"type\": \"\",\n \"url\": \"\",\n \"enabled\": \"\",\n \"httpAuthHeaderAvailable\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"statusMessage\": \"\"\n}", "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-b15510ff-ab88-4832-9380-2c25b4e70cda" }, { "id": "a37c07c9-76ab-46f3-af17-464a6ec9b14f", "name": "API key not found or invalid", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"VCS\",\n \"url\": \"\",\n \"httpAuthHeader\": \"\",\n \"enabled\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "webhooks" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-a37c07c9-76ab-46f3-af17-464a6ec9b14f" }, { "id": "21535cba-6edf-4b43-bcfe-e2f0a48b78ec", "name": "Resource not accessible", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"VCS\",\n \"url\": \"\",\n \"httpAuthHeader\": \"\",\n \"enabled\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "webhooks" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-21535cba-6edf-4b43-bcfe-e2f0a48b78ec" }, { "id": "432a71ac-8909-4d2a-8086-2f356747dd5e", "name": "Resource not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"VCS\",\n \"url\": \"\",\n \"httpAuthHeader\": \"\",\n \"enabled\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "webhooks" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-432a71ac-8909-4d2a-8086-2f356747dd5e" }, { "id": "d2956d0f-95a9-4ece-bb0b-cff77d635dc8", "name": "Invalid param", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"VCS\",\n \"url\": \"\",\n \"httpAuthHeader\": \"\",\n \"enabled\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "webhooks" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorId\": \"\",\n \"statusCode\": \"\",\n \"statusMessage\": \"\",\n \"timestamp\": \"\"\n}", "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-d2956d0f-95a9-4ece-bb0b-cff77d635dc8" }, { "id": "cae64d36-d38d-44e6-964f-92e8d4220a9e", "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"VCS\",\n \"url\": \"\",\n \"httpAuthHeader\": \"\",\n \"enabled\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "webhooks" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-cae64d36-d38d-44e6-964f-92e8d4220a9e" } ], "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-eb92b131-eb96-4caa-a4cd-eac62cba5e3b" } ], "id": "50c9820b-5d1d-442a-bfea-c105418a9748", "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-50c9820b-5d1d-442a-bfea-c105418a9748" }, { "name": "recording-push-config", "item": [ { "name": "Get recording push config for your account", "id": "6cef69df-5411-4c61-a49b-672a8e71c24d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/recording-push-config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "recording-push-config" ], "variable": [ { "id": "50791d12-de80-4cc1-b2c6-2ffbfa34548d", "key": "subAccountId", "value": "&5gM9oMce760", "description": "(Required) You must replace {subAccountId} with the subaccountid that you want to use. By default this is generated once you have completed the voice onboarding." } ] } }, "response": [ { "id": "6bf9a23e-1281-4f16-9203-8818af54fbec", "name": "Request succeeded", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/recording-push-config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "recording-push-config" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"subAccountId\": \"\",\n \"protocol\": \"\",\n \"host\": \"\",\n \"port\": \"\",\n \"username\": \"\",\n \"passwordSet\": \"\",\n \"path\": \"\",\n \"statusCode\": \"\",\n \"statusMessage\": \"\"\n}", "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-6bf9a23e-1281-4f16-9203-8818af54fbec" }, { "id": "3e775b8f-b951-4c99-8458-11ab388dd375", "name": "API key not found or invalid", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/recording-push-config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "recording-push-config" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-3e775b8f-b951-4c99-8458-11ab388dd375" }, { "id": "849b39d9-41c9-4bc1-9d0a-b9a224a420a6", "name": "Resource not accessible", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/recording-push-config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "recording-push-config" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-849b39d9-41c9-4bc1-9d0a-b9a224a420a6" }, { "id": "c7304ab9-8ac3-4e36-a301-1d542afda900", "name": "Resource not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/recording-push-config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "recording-push-config" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-c7304ab9-8ac3-4e36-a301-1d542afda900" }, { "id": "c7464f6f-fe8e-4720-8ca7-587ca2004f4f", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/recording-push-config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "recording-push-config" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-c7464f6f-fe8e-4720-8ca7-587ca2004f4f" } ], "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-6cef69df-5411-4c61-a49b-672a8e71c24d" }, { "name": "Create a new recording push config", "id": "4bcb24de-3008-42d3-8d8e-b1e6b5ae233a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"protocol\": \"S3\",\n \"host\": \"ap-southeast-2\",\n \"port\": 13,\n \"username\": \"myusername\",\n \"password\": \"mypassword\",\n \"path\": \"/my-recordings-path/\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/recording-push-config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "recording-push-config" ], "variable": [ { "id": "43f827b1-af88-4dbc-972f-7cbacd4db9dd", "key": "subAccountId", "value": "&5gM9oMce760", "description": "(Required) You must replace {subAccountId} with the subaccountid that you want to use. By default this is generated once you have completed the voice onboarding." } ] } }, "response": [ { "id": "9f551189-7d8e-44b8-adaa-df646a008b03", "name": "Request succeeded", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"protocol\": \"S3\",\n \"host\": \"ap-southeast-2\",\n \"port\": 13,\n \"username\": \"myusername\",\n \"password\": \"mypassword\",\n \"path\": \"/my-recordings-path/\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/recording-push-config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "recording-push-config" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"delete\": \"\",\n \"subAccountId\": \"\",\n \"protocol\": \"\",\n \"host\": \"\",\n \"port\": \"\",\n \"username\": \"\",\n \"passwordSet\": \"\",\n \"path\": \"\",\n \"statusCode\": \"\",\n \"statusMessage\": \"\"\n}", "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-9f551189-7d8e-44b8-adaa-df646a008b03" }, { "id": "45708fef-26df-490e-b935-b0fd4064aacb", "name": "API key not found or invalid", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"protocol\": \"S3\",\n \"host\": \"ap-southeast-2\",\n \"port\": 13,\n \"username\": \"myusername\",\n \"password\": \"mypassword\",\n \"path\": \"/my-recordings-path/\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/recording-push-config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "recording-push-config" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-45708fef-26df-490e-b935-b0fd4064aacb" }, { "id": "c2c66965-0a31-42bc-ab14-a5d26581d333", "name": "Resource not accessible", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"protocol\": \"S3\",\n \"host\": \"ap-southeast-2\",\n \"port\": 13,\n \"username\": \"myusername\",\n \"password\": \"mypassword\",\n \"path\": \"/my-recordings-path/\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/recording-push-config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "recording-push-config" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-c2c66965-0a31-42bc-ab14-a5d26581d333" }, { "id": "9aac7058-43ef-4b00-8417-3bcb513e22ae", "name": "Resource not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"protocol\": \"S3\",\n \"host\": \"ap-southeast-2\",\n \"port\": 13,\n \"username\": \"myusername\",\n \"password\": \"mypassword\",\n \"path\": \"/my-recordings-path/\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/recording-push-config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "recording-push-config" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-9aac7058-43ef-4b00-8417-3bcb513e22ae" }, { "id": "a6a909af-cfad-4e16-9b15-6cc3631bcbb7", "name": "Invalid param", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"protocol\": \"S3\",\n \"host\": \"ap-southeast-2\",\n \"port\": 13,\n \"username\": \"myusername\",\n \"password\": \"mypassword\",\n \"path\": \"/my-recordings-path/\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/recording-push-config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "recording-push-config" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorId\": \"\",\n \"statusCode\": \"\",\n \"statusMessage\": \"\",\n \"timestamp\": \"\"\n}", "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-a6a909af-cfad-4e16-9b15-6cc3631bcbb7" }, { "id": "b85bb4fc-2a22-467b-ba18-cb6451c653a2", "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"protocol\": \"S3\",\n \"host\": \"ap-southeast-2\",\n \"port\": 13,\n \"username\": \"myusername\",\n \"password\": \"mypassword\",\n \"path\": \"/my-recordings-path/\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/recording-push-config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "recording-push-config" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-b85bb4fc-2a22-467b-ba18-cb6451c653a2" } ], "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-4bcb24de-3008-42d3-8d8e-b1e6b5ae233a" }, { "name": "Delete recording push config", "id": "facaa088-7058-45af-8096-3411fad1157e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/recording-push-config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "recording-push-config" ], "variable": [ { "id": "6a66e5b8-bd51-4302-b823-ea462a432919", "key": "subAccountId", "value": "&5gM9oMce760", "description": "(Required) You must replace {subAccountId} with the subaccountid that you want to use. By default this is generated once you have completed the voice onboarding." } ] } }, "response": [ { "id": "06f667a3-576e-4fd3-ae62-1b0417dda5e5", "name": "Request succeeded", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/recording-push-config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "recording-push-config" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"delete\": \"\",\n \"subAccountId\": \"\",\n \"protocol\": \"\",\n \"host\": \"\",\n \"port\": \"\",\n \"username\": \"\",\n \"passwordSet\": \"\",\n \"path\": \"\",\n \"statusCode\": \"\",\n \"statusMessage\": \"\"\n}", "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-06f667a3-576e-4fd3-ae62-1b0417dda5e5" }, { "id": "18c1bf80-91f1-4afc-8ca7-ca7d8d12cbed", "name": "API key not found or invalid", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/recording-push-config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "recording-push-config" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-18c1bf80-91f1-4afc-8ca7-ca7d8d12cbed" }, { "id": "287dfb8d-64c2-49b1-bf9c-d78820408c5d", "name": "Resource not accessible", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/recording-push-config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "recording-push-config" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-287dfb8d-64c2-49b1-bf9c-d78820408c5d" }, { "id": "56ca3aa5-5d72-4520-a120-b9a581b6c456", "name": "Resource not found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/recording-push-config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "recording-push-config" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-56ca3aa5-5d72-4520-a120-b9a581b6c456" }, { "id": "9d82cc24-d0c3-48a7-a12a-0ba2e92e3aaa", "name": "Server error", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/recording-push-config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "recording-push-config" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-9d82cc24-d0c3-48a7-a12a-0ba2e92e3aaa" } ], "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-facaa088-7058-45af-8096-3411fad1157e" } ], "id": "dadd3929-4d59-4dcf-89f6-4b9b3001168e", "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-dadd3929-4d59-4dcf-89f6-4b9b3001168e" }, { "name": "recordings", "item": [ { "name": "{sessionId}", "item": [ { "name": "Get recording status", "id": "f737d161-279e-4969-b509-f4a6a35f8f05", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/recordings/:sessionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "recordings", ":sessionId" ], "variable": [ { "id": "7d7abd0e-9c40-4eb9-812f-621f3563208b", "key": "subAccountId", "value": "&5gM9oMce760", "description": "(Required) You must replace {subAccountId} with the subaccountid that you want to use. By default this is generated once you have completed the voice onboarding." }, { "id": "b5acc6e2-f913-4f2a-9117-7fbd3646ad8d", "key": "sessionId", "value": "D3D0b85c-07fB-F6FC-387A-22BfCb1fFc08", "description": "(Required) " } ] } }, "response": [ { "id": "201af93d-50cf-48a4-92f0-c8e8a1f5f323", "name": "Request succeeded", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/recordings/:sessionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "recordings", ":sessionId" ], "variable": [ { "key": "subAccountId" }, { "key": "sessionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"recordings\": [\n {\n \"recordingId\": \"\",\n \"sessionid\": \"\",\n \"subAccountId\": \"\",\n \"status\": \"\",\n \"externalFileUrl\": \"\",\n \"duration\": \"\",\n \"startRecordingTime\": \"\"\n },\n {\n \"recordingId\": \"\",\n \"sessionid\": \"\",\n \"subAccountId\": \"\",\n \"status\": \"\",\n \"externalFileUrl\": \"\",\n \"duration\": \"\",\n \"startRecordingTime\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"statusMessage\": \"\"\n}", "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-201af93d-50cf-48a4-92f0-c8e8a1f5f323" }, { "id": "d6380a50-77b6-43ad-bb61-7df2e82279c4", "name": "API key not found or invalid", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/recordings/:sessionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "recordings", ":sessionId" ], "variable": [ { "key": "subAccountId" }, { "key": "sessionId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-d6380a50-77b6-43ad-bb61-7df2e82279c4" }, { "id": "08631e0e-3424-4592-94ce-73fb31c4b275", "name": "Resource not accessible", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/recordings/:sessionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "recordings", ":sessionId" ], "variable": [ { "key": "subAccountId" }, { "key": "sessionId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-08631e0e-3424-4592-94ce-73fb31c4b275" }, { "id": "908ac930-f189-4225-90e2-f3b8d94b3b38", "name": "Resource not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/recordings/:sessionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "recordings", ":sessionId" ], "variable": [ { "key": "subAccountId" }, { "key": "sessionId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-908ac930-f189-4225-90e2-f3b8d94b3b38" }, { "id": "f0b4f7fe-035d-4120-8d00-c55cfd9fc433", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/recordings/:sessionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "recordings", ":sessionId" ], "variable": [ { "key": "subAccountId" }, { "key": "sessionId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-f0b4f7fe-035d-4120-8d00-c55cfd9fc433" } ], "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-f737d161-279e-4969-b509-f4a6a35f8f05" } ], "id": "625fe183-d569-4630-b6e9-39085081bd30", "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-625fe183-d569-4630-b6e9-39085081bd30" } ], "id": "629a3292-b64c-4d31-89c3-d932355c0bdb", "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-629a3292-b64c-4d31-89c3-d932355c0bdb" }, { "name": "numbers", "item": [ { "name": "{number}", "item": [ { "name": "Check Virtual Number", "id": "e249e454-dac5-4479-8383-6f3db668a3ec", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/numbers/:number", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "numbers", ":number" ], "variable": [ { "id": "59fb79b2-b966-481f-b27e-9314a7d0794b", "key": "subAccountId", "value": "&5gM9oMce760", "description": "(Required) You must replace {subAccountId} with the subaccountid that you want to use. By default this is generated once you have completed the voice onboarding." }, { "id": "cc14182c-e352-44ca-9638-aea24417ee24", "key": "number", "value": "5837250", "description": "(Required) " } ] }, "description": "Should the request be authenticated successfully and the specific number is assigned to your subaccount, the response will contain a Number object with health details for the given number.\n\n" }, "response": [ { "id": "44d3c437-d192-42d6-bff5-a221d3a3f344", "name": "Should the request authenticated successfully and the Virtual Number is assigned to your subaccount, the response will contain a Number object with health information for that given number.\nThe following is an example of successful response:", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/numbers/:number", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "numbers", ":number" ], "variable": [ { "key": "subAccountId" }, { "key": "number" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"statusMessage\": \"\",\n \"timestamp\": \"\",\n \"payload\": {\n \"referenceId\": \"\",\n \"msisdn\": \"\",\n \"countryCode\": \"\"\n }\n}", "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-44d3c437-d192-42d6-bff5-a221d3a3f344" }, { "id": "46657225-4c09-431e-8920-58615ae44e78", "name": "In case that Virtual Number does not exist or can\u2019t be found, the JSON response will contain a code and message value to explain what is wrong.\nThe following is an example of bad response:\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/numbers/:number", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "numbers", ":number" ], "variable": [ { "key": "subAccountId" }, { "key": "number" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"statusMessage\": \"\",\n \"timestamp\": \"\"\n}", "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-46657225-4c09-431e-8920-58615ae44e78" } ], "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-e249e454-dac5-4479-8383-6f3db668a3ec" } ], "id": "90e40783-64af-412e-9c82-9359f8315f11", "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-90e40783-64af-412e-9c82-9359f8315f11" }, { "name": "Get My Virtual Numbers", "id": "fdfa0686-fe91-4fa8-a99f-fd767a316664", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/numbers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "numbers" ], "variable": [ { "id": "0aeb5620-ef5f-401e-bab2-cb72a5c31fb7", "key": "subAccountId", "value": "&5gM9oMce760", "description": "(Required) You must replace {subAccountId} with the subaccountid that you want to use. By default this is generated once you have completed the voice onboarding." } ] }, "description": "The Number Health Service provides insights about the reachability/availability for the numbers assigned to your subaccount." }, "response": [ { "id": "7b66351a-ae38-42b6-bcc8-2e42fd63e1f0", "name": "Should the request be authenticated successfully and Virtual Numbers are assigned to your subaccount, the response will contain a list of Number objects with health details for the numbers.\n\nThe following is an example of successful response:", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/numbers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "numbers" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"totalNumbers\": \"\",\n \"lastUpdatedAt\": \"\",\n \"numbers\": [\n {\n \"msisdn\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\",\n \"countryCode\": \"\",\n \"operationalStatus\": \"\",\n \"referenceId\": \"\",\n \"rentalPrice\": \"\",\n \"incomingRate\": \"\",\n \"billingUnit\": \"\",\n \"uri\": \"\",\n \"numberHealthCheckEnabled\": \"\",\n \"billingCurrency\": \"\",\n \"numberType\": \"\",\n \"numberHealth\": {\n \"isHealthy\": \"\",\n \"status\": \"\",\n \"lastCheckedTime\": \"\"\n }\n },\n {\n \"msisdn\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\",\n \"countryCode\": \"\",\n \"operationalStatus\": \"\",\n \"referenceId\": \"\",\n \"rentalPrice\": \"\",\n \"incomingRate\": \"\",\n \"billingUnit\": \"\",\n \"uri\": \"\",\n \"numberHealthCheckEnabled\": \"\",\n \"billingCurrency\": \"\",\n \"numberType\": \"\",\n \"numberHealth\": {\n \"isHealthy\": \"\",\n \"status\": \"\",\n \"lastCheckedTime\": \"\"\n }\n }\n ],\n \"statusCode\": \"\",\n \"statusMessage\": \"\"\n}", "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-7b66351a-ae38-42b6-bcc8-2e42fd63e1f0" } ], "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-fdfa0686-fe91-4fa8-a99f-fd767a316664" } ], "id": "7eb1edf3-5420-42c8-87d7-6d217f860756", "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-7eb1edf3-5420-42c8-87d7-6d217f860756" }, { "name": "messages", "item": [ { "name": "exports", "item": [ { "name": "{jobId}", "item": [ { "name": "Get log export job result", "id": "9faad5cd-b60b-4a23-abc1-4d3377114c1c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://voice.wavecell.com/api/v1/subaccounts/:subAccountId/messages/exports/:jobId", "protocol": "https", "host": [ "voice", "wavecell", "com" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", "exports", ":jobId" ], "variable": [ { "id": "b710246f-abe4-4d9f-8956-bb6eec230d61", "key": "subAccountId", "value": "&5gM9oMce760", "description": "(Required) You must replace {subAccountId} with the subaccountid that you want to use. By default this is generated once you have completed the voice onboarding." }, { "id": "b604b164-d5fb-42c1-b273-3f66ace2a93b", "key": "jobId", "value": "", "description": "(Required) Export job identifier" } ] }, "description": "* Sending a **GET** request on this endpoint allows to **check the status of an Voice Logs export job** and to **get a download link** if its generation has succeeded.\n\n \n\n### URL\n\nTo define which Voice logs export you want to retrieve, you need to enter the Job ID generated by XXXXX in the path as well as the 8x8 subaccountid you used in the previous request.\n`https://voice.wavecell.com/api/v1/subaccounts/{subAccountID}/messages/exports/{jobId}`\n\n> You must replace `{jobID}` and `{subAccountId}` in the URL above with the jobID and subaccountid from the start logs export job request" }, "response": [ { "id": "da31ad55-9d84-430f-9835-53094b447a43", "name": "In case of successful request which comes with a 200 code, you will be presented with a **status** parameter value (string). Here are the possible cases and their meaning:\n\n- **queued** - request for report creation is waiting in the queue\n\n- **running** ", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "https://voice.wavecell.com/api/v1/subaccounts/:subAccountId/messages/exports/:jobId", "protocol": "https", "host": [ "voice", "wavecell", "com" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", "exports", ":jobId" ], "variable": [ { "key": "subAccountId" }, { "key": "jobId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"failed\",\n \"data\": [\n \"\",\n \"\"\n ],\n \"expires\": \"\"\n}", "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-da31ad55-9d84-430f-9835-53094b447a43" }, { "id": "b23ca96c-75d9-4968-96cf-8eeb515820a3", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "https://voice.wavecell.com/api/v1/subaccounts/:subAccountId/messages/exports/:jobId", "protocol": "https", "host": [ "voice", "wavecell", "com" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", "exports", ":jobId" ], "variable": [ { "key": "subAccountId" }, { "key": "jobId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorId\": \"\",\n \"statusCode\": \"\",\n \"statusMessage\": \"\",\n \"timestamp\": \"\"\n}", "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-b23ca96c-75d9-4968-96cf-8eeb515820a3" } ], "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-9faad5cd-b60b-4a23-abc1-4d3377114c1c" }, { "name": "Cancel the log export job ", "id": "bde38193-7b41-4495-b01b-1b0cf98ed922", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://voice.wavecell.com/api/v1/subaccounts/:subAccountId/messages/exports/:jobId", "protocol": "https", "host": [ "voice", "wavecell", "com" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", "exports", ":jobId" ], "variable": [ { "id": "133ccf6c-98ff-4a55-982d-09de96d3edcb", "key": "subAccountId", "value": "&5gM9oMce760", "description": "(Required) You must replace {subAccountId} with the subaccountid that you want to use. By default this is generated once you have completed the voice onboarding." }, { "id": "f542c975-cd08-441d-916b-53d930fdb9c5", "key": "jobId", "value": "", "description": "(Required) Export job identifier" } ] }, "description": "* Sending a **DELETE** request on this endpoint allows to **cancel a Logs export job**.\n\n\n\n### URL\n\nTo define which logs export you want to retrieve, you need to enter the Job ID generated by API in the path as well as the 8x8 subaccountid you used in the previous request.\n`https://voice.wavecell.com/api/v1/subaccounts/{subAccountID}/messages/exports/{jobId}`\n\n> You must replace `{jobID}` and `{subAccountId}` in the URL above with the jobID and subaccountid from the start logs export job request" }, "response": [ { "id": "119b81cd-dc74-4694-9347-c71906b002d0", "name": "New Response", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "https://voice.wavecell.com/api/v1/subaccounts/:subAccountId/messages/exports/:jobId", "protocol": "https", "host": [ "voice", "wavecell", "com" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", "exports", ":jobId" ], "variable": [ { "key": "subAccountId" }, { "key": "jobId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-119b81cd-dc74-4694-9347-c71906b002d0" }, { "id": "997a7d59-7ed1-4434-a3ff-3b2c2458e1a8", "name": "New Response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "https://voice.wavecell.com/api/v1/subaccounts/:subAccountId/messages/exports/:jobId", "protocol": "https", "host": [ "voice", "wavecell", "com" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", "exports", ":jobId" ], "variable": [ { "key": "subAccountId" }, { "key": "jobId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorId\": \"\",\n \"statusCode\": \"\",\n \"statusMessage\": \"\",\n \"timestamp\": \"\"\n}", "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-997a7d59-7ed1-4434-a3ff-3b2c2458e1a8" } ], "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-bde38193-7b41-4495-b01b-1b0cf98ed922" } ], "id": "a82f8c82-8602-401a-acb2-7c07dc789def", "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-a82f8c82-8602-401a-acb2-7c07dc789def" }, { "name": "Start log export job", "id": "06a4e073-6b21-42b0-9b57-c5b5c60a0bd9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"from\": \"\",\n \"to\": \"\",\n \"limit\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://voice.wavecell.com/api/v1/subaccounts/:subAccountId/messages/exports", "protocol": "https", "host": [ "voice", "wavecell", "com" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", "exports" ], "variable": [ { "id": "0290286d-14f3-4b53-bdbd-6b774d8817cd", "key": "subAccountId", "value": "&5gM9oMce760", "description": "(Required) You must replace {subAccountId} with the subaccountid that you want to use. By default this is generated once you have completed the voice onboarding." } ] }, "description": "* Sending a **POST** request on this endpoint allows to **request an Voice logs file**.\n\n### URL\n\nThe 8x8 Voice `subAccountId` needs to be provided in the URL as shown below:\n`https://voice.wavecell.com/api/v1/subaccounts/{subAccountId}/messages/exports`\n\n> You must replace `{subAccountId}` in the URL above with the subaccountid that you want to use." }, "response": [ { "id": "95b97c7f-f335-4b4a-a497-3f2a4ea84fb5", "name": "New Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"from\": \"\",\n \"to\": \"\",\n \"limit\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://voice.wavecell.com/api/v1/subaccounts/:subAccountId/messages/exports", "protocol": "https", "host": [ "voice", "wavecell", "com" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", "exports" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"jobId\": \"\"\n}", "createdAt": "2026-07-28T00:28:50.000Z", "updatedAt": "2026-07-28T00:28:50.000Z", "uid": "35240-95b97c7f-f335-4b4a-a497-3f2a4ea84fb5" } ], "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-06a4e073-6b21-42b0-9b57-c5b5c60a0bd9" } ], "id": "bf5f6e8b-0079-4d44-a35f-6b19a891e8f3", "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-bf5f6e8b-0079-4d44-a35f-6b19a891e8f3" } ], "id": "cca07ed4-a935-4e8b-8aad-6ffbfa762caf", "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-cca07ed4-a935-4e8b-8aad-6ffbfa762caf" } ], "id": "d54043b5-f601-473a-b532-e3aa2f870006", "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-d54043b5-f601-473a-b532-e3aa2f870006" } ], "id": "fe481c10-2823-4be0-8098-5032e198ff38", "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-fe481c10-2823-4be0-8098-5032e198ff38" } ], "id": "1b6ff42d-1262-4475-b43f-68d802d6deda", "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-1b6ff42d-1262-4475-b43f-68d802d6deda" } ], "id": "ace5e377-3d4e-4eca-902f-c91043d8033d", "createdAt": "2026-07-28T00:28:49.000Z", "updatedAt": "2026-07-28T00:28:49.000Z", "uid": "35240-ace5e377-3d4e-4eca-902f-c91043d8033d" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://voice.8x8.com" } ] }