Detailed reason why the web call ended, if applicable
Available options:
user_ended_call,
agent_ended_call,
call_transferred,
inactivity_timeout,
maximum_duration_exceeded,
concurrent_call_limit_reached,
invalid_payment,
potential_scam_detected,
inbound_webhook_error,
line_busy,
call_failed,
no_answer,
llm_websocket_initialization_error,
llm_websocket_connection_lost,
llm_websocket_runtime_error,
llm_websocket_payload_corruption,
twilio_error,
no_audio_input,
speech_recognition_error,
pia_platform_internal_error,
unknown_error,
user_connection_failure
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Verbex Docs","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"logo":{"light":"https://mintcdn.com/hishabsingaporepteltd/hKDJJlbuwj-_7GRI/light.png?fit=max\u0026auto=format\u0026n=hKDJJlbuwj-_7GRI\u0026q=85\u0026s=8e51283f8c4e5daa2b06e4c7b010036a","dark":"https://mintcdn.com/hishabsingaporepteltd/Bd-nkhA8cT0nKgAS/dark.png?fit=max\u0026auto=format\u0026n=Bd-nkhA8cT0nKgAS\u0026q=85\u0026s=c7eab5a32b4f7a91d7d0a702fa7aa1d1"},"favicon":"https://mintcdn.com/hishabsingaporepteltd/Bd-nkhA8cT0nKgAS/favicon.png?fit=max\u0026auto=format\u0026n=Bd-nkhA8cT0nKgAS\u0026q=85\u0026s=b848ae01a88c70cb541c5bf4ba708435","navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://console.verbex.ai/dashboard"}},"footer":{"socials":{"discord":"https://discord.gg/9c6b2GAq5t","youtube":"https://www.youtube.com/@verbexadmin","facebook":"https://web.facebook.com/hishabltd","linkedin":"https://www.linkedin.com/company/hishab"}},"fonts":{"heading":{"family":"Poppins-Thin 100"},"body":{"family":"Poppins-Thin 100"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hishabsingaporepteltd","hasAudioNarration":false,"actualSubdomain":"hishabsingaporepteltd","customDomains":["docs.verbex.ai"],"gitSource":{"type":"github","owner":"verbex-ai","repo":"verbex-platform-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ac4dccaa04ae9340921a186","collectionId":"0c147a9b-11cc-45fe-a0a7-0361e52421ef","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ac4dccaa04ae9340921a186"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae7c703706f6ab40243f401","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":74},{"language":"default","tag":"Documentation","count":39},{"language":"default","tag":"Build Your AI Agent - Step by Step","count":24},{"language":"default","tag":"Knowledge Bases","count":13},{"language":"default","tag":" Connect Tools","count":11},{"language":"default","tag":"Webhook Subscriptions","count":6},{"language":"default","tag":" Create Your AI Agent","count":5},{"language":"default","tag":" Configure Your AI Agent","count":5},{"language":"default","tag":"AI Agents v2","count":5},{"language":"default","tag":"AI Agents v3","count":5}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/calls/get-call","slug":"/api-reference/calls/get-call","pageMetadata":{"title":"Get Call","description":"Retrieve detailed information about a specific call by its ID.\n\nThis endpoint provides comprehensive information about any call (web or phone) \nincluding its current status, duration, and associated metadata.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/calls/{call_id}","href":"/api-reference/calls/get-call","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Retrieve detailed information about a specific call by its ID.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"This endpoint provides comprehensive information about any call (web or phone)\\nincluding its current status, duration, and associated metadata.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Call","description":"Retrieve detailed information about a specific call by its ID.\n\nThis endpoint provides comprehensive information about any call (web or phone) \nincluding its current status, duration, and associated metadata.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/calls/{call_id}","href":"/api-reference/calls/get-call","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Calls"],"summary":"Get Call","description":"Retrieve detailed information about a specific call by its ID.\n\nThis endpoint provides comprehensive information about any call (web or phone) \nincluding its current status, duration, and associated metadata.","operationId":"get_call_v1_calls__call_id__get","parameters":["436c9edf-eacc-456c-9e98-b492ff595f70"],"responses":{"200":"c2035699-206b-4818-b042-a6f34dac1a6e","401":"d0f19093-f0dd-4db7-9ab4-aaae5c5ed684","404":"7a2ca61c-0940-41a8-a865-2f00264bfcb1","422":"51748d8c-aac3-4d04-bbf6-4baaa1ed6d95"},"method":"get","type":"path","servers":[],"security":[],"path":"/v1/calls/{call_id}","baseUrlOptions":[],"title":"Get Call","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"436c9edf-eacc-456c-9e98-b492ff595f70":{"name":"call_id","in":"path","required":true,"schema":{"type":"string","title":"Call Id","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"c2035699-206b-4818-b042-a6f34dac1a6e":{"description":"Successful Response","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"WebCallResponse","required":["call_status"],"properties":{"call_status":{"type":"string","enum":["registered","ongoing","ended","error"],"title":"Call Status","description":"Current status of the call: 'registered' for initialized calls, 'ongoing' for active calls, 'ended' for completed calls, 'error' for failed calls","isRequired":true,"uniqueKey":"oneOf.0.call_status","typeLabel":"enum\u003cstring>"},"_id":{"type":"string","title":"Id","description":"Unique identifier for the call session, automatically generated as a MongoDB ObjectId","uniqueKey":"oneOf.0._id","typeLabel":"string"},"ai_agent_id":{"oneOf":[{"type":"string","title":"Ai Agent Id","description":"Identifier of the AI agent handling this call","uniqueKey":"oneOf.0.ai_agent_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Ai Agent Id","description":"Identifier of the AI agent handling this call","uniqueKey":"oneOf.0.ai_agent_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.ai_agent_id","typeLabel":"string | null"},"ai_agent_name":{"oneOf":[{"type":"string","title":"Ai Agent Name","description":"Name of the AI agent handling this call","uniqueKey":"oneOf.0.ai_agent_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Ai Agent Name","description":"Name of the AI agent handling this call","uniqueKey":"oneOf.0.ai_agent_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.ai_agent_name","typeLabel":"string | null"},"override_ai_agent_id":{"oneOf":[{"type":"string","title":"Override Ai Agent Id","description":"Optional identifier for an alternative AI agent handling this call","uniqueKey":"oneOf.0.override_ai_agent_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Override Ai Agent Id","description":"Optional identifier for an alternative AI agent handling this call","uniqueKey":"oneOf.0.override_ai_agent_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.override_ai_agent_id","typeLabel":"string | null"},"metadata":{"oneOf":[{"type":"object","title":"Metadata","description":"Custom key-value pairs storing additional information about the call","additionalProperties":{"type":"string","uniqueKey":"oneOf.0.metadata.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"oneOf.0.metadata.oneOf.0","typeLabel":"Metadata · object"},{"type":"null","title":"Metadata","description":"Custom key-value pairs storing additional information about the call","uniqueKey":"oneOf.0.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.metadata","typeLabel":"Metadata · object | null"},"pia_llm_dynamic_data":{"oneOf":[{"type":"object","title":"Pia Llm Dynamic Data","description":"Dynamic data used by the AI agent during the call","uniqueKey":"oneOf.0.pia_llm_dynamic_data.oneOf.0","typeLabel":"Pia Llm Dynamic Data · object"},{"type":"null","title":"Pia Llm Dynamic Data","description":"Dynamic data used by the AI agent during the call","uniqueKey":"oneOf.0.pia_llm_dynamic_data.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.pia_llm_dynamic_data","typeLabel":"Pia Llm Dynamic Data · object | null"},"call_start_time":{"oneOf":[{"type":"string","title":"Call Start Time","description":"Timestamp when the call was initiated, in UTC","format":"date-time","uniqueKey":"oneOf.0.call_start_time.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Call Start Time","description":"Timestamp when the call was initiated, in UTC","uniqueKey":"oneOf.0.call_start_time.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.call_start_time","typeLabel":"string\u003cdate-time> | null"},"call_end_time":{"oneOf":[{"type":"string","title":"Call End Time","description":"Timestamp when the call was terminated, in UTC","format":"date-time","uniqueKey":"oneOf.0.call_end_time.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Call End Time","description":"Timestamp when the call was terminated, in UTC","uniqueKey":"oneOf.0.call_end_time.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.call_end_time","typeLabel":"string\u003cdate-time> | null"},"messages":{"oneOf":[{"type":"array","items":{"properties":{"role":{"type":"string","enum":["agent","user"],"title":"Role","description":"Identifies whether the message is from the AI agent ('agent') or the human user ('user')","isRequired":true,"uniqueKey":"oneOf.0.messages.oneOf.0.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"content":{"type":"string","title":"Content","description":"The actual text content of the message exchanged during the conversation","isRequired":true,"uniqueKey":"oneOf.0.messages.oneOf.0.items.[INDEX].content","typeLabel":"string"}},"type":"object","required":["role","content"],"title":"MessageItem","uniqueKey":"oneOf.0.messages.oneOf.0.items.[INDEX]","typeLabel":"MessageItem · object"},"title":"Messages","description":"Chronological list of messages exchanged during the call","uniqueKey":"oneOf.0.messages.oneOf.0","typeLabel":"MessageItem · object[]"},{"type":"null","title":"Messages","description":"Chronological list of messages exchanged during the call","uniqueKey":"oneOf.0.messages.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.messages","typeLabel":"MessageItem · object[] | null"},"recorded_call_audio_url":{"oneOf":[{"type":"string","title":"Recorded Call Audio Url","description":"URL to access the recorded audio file of the call","uniqueKey":"oneOf.0.recorded_call_audio_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Recorded Call Audio Url","description":"URL to access the recorded audio file of the call","uniqueKey":"oneOf.0.recorded_call_audio_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.recorded_call_audio_url","typeLabel":"string | null"},"access_token":{"oneOf":[{"type":"string","title":"Access Token","description":"Security token for accessing call-related resources","uniqueKey":"oneOf.0.access_token.oneOf.0","typeLabel":"string"},{"type":"null","title":"Access Token","description":"Security token for accessing call-related resources","uniqueKey":"oneOf.0.access_token.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.access_token","typeLabel":"string | null"},"call_duration_seconds":{"oneOf":[{"type":"integer","title":"Call Duration Seconds","description":"Duration of the call in seconds","uniqueKey":"oneOf.0.call_duration_seconds.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Call Duration Seconds","description":"Duration of the call in seconds","uniqueKey":"oneOf.0.call_duration_seconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.call_duration_seconds","typeLabel":"integer | null"},"call_type":{"type":"string","const":"web_call","title":"Call Type","description":"Indicates this response is for a web-based call","default":"web_call","uniqueKey":"oneOf.0.call_type","typeLabel":"string"},"call_finish_reason":{"oneOf":[{"type":"string","title":"Call Finish Reason","description":"Detailed reason why the web call ended, if applicable","enum":["user_ended_call","agent_ended_call","call_transferred","inactivity_timeout","maximum_duration_exceeded","concurrent_call_limit_reached","invalid_payment","potential_scam_detected","inbound_webhook_error","line_busy","call_failed","no_answer","llm_websocket_initialization_error","llm_websocket_connection_lost","llm_websocket_runtime_error","llm_websocket_payload_corruption","twilio_error","no_audio_input","speech_recognition_error","pia_platform_internal_error","unknown_error","user_connection_failure"],"uniqueKey":"oneOf.0.call_finish_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Call Finish Reason","description":"Detailed reason why the web call ended, if applicable","uniqueKey":"oneOf.0.call_finish_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.call_finish_reason","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"oneOf.0","typeLabel":"WebCallResponse · object"},{"type":"object","title":"PhoneCallResponse","required":["call_status","from_number","to_number","direction"],"properties":{"call_status":{"type":"string","enum":["registered","ongoing","ended","error"],"title":"Call Status","description":"Current status of the call: 'registered' for initialized calls, 'ongoing' for active calls, 'ended' for completed calls, 'error' for failed calls","isRequired":true,"uniqueKey":"oneOf.1.call_status","typeLabel":"enum\u003cstring>"},"from_number":{"type":"string","title":"From Number","description":"The phone number that initiated the call (E.164 format)","isRequired":true,"uniqueKey":"oneOf.1.from_number","typeLabel":"string"},"to_number":{"type":"string","title":"To Number","description":"The phone number that received the call (E.164 format)","isRequired":true,"uniqueKey":"oneOf.1.to_number","typeLabel":"string"},"direction":{"type":"string","enum":["inbound","outbound"],"title":"Direction","description":"Indicates whether the call was received by or initiated from the Pia Platform","isRequired":true,"uniqueKey":"oneOf.1.direction","typeLabel":"enum\u003cstring>"},"_id":{"type":"string","title":"Id","description":"Unique identifier for the call session, automatically generated as a MongoDB ObjectId","uniqueKey":"oneOf.1._id","typeLabel":"string"},"ai_agent_id":{"oneOf":[{"type":"string","title":"Ai Agent Id","description":"Identifier of the AI agent handling this call","uniqueKey":"oneOf.1.ai_agent_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Ai Agent Id","description":"Identifier of the AI agent handling this call","uniqueKey":"oneOf.1.ai_agent_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.ai_agent_id","typeLabel":"string | null"},"ai_agent_name":{"oneOf":[{"type":"string","title":"Ai Agent Name","description":"Name of the AI agent handling this call","uniqueKey":"oneOf.1.ai_agent_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Ai Agent Name","description":"Name of the AI agent handling this call","uniqueKey":"oneOf.1.ai_agent_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.ai_agent_name","typeLabel":"string | null"},"override_ai_agent_id":{"oneOf":[{"type":"string","title":"Override Ai Agent Id","description":"Optional identifier for an alternative AI agent handling this call","uniqueKey":"oneOf.1.override_ai_agent_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Override Ai Agent Id","description":"Optional identifier for an alternative AI agent handling this call","uniqueKey":"oneOf.1.override_ai_agent_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.override_ai_agent_id","typeLabel":"string | null"},"metadata":{"oneOf":[{"type":"object","title":"Metadata","description":"Custom key-value pairs storing additional information about the call","additionalProperties":{"type":"string","uniqueKey":"oneOf.1.metadata.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"oneOf.1.metadata.oneOf.0","typeLabel":"Metadata · object"},{"type":"null","title":"Metadata","description":"Custom key-value pairs storing additional information about the call","uniqueKey":"oneOf.1.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.metadata","typeLabel":"Metadata · object | null"},"pia_llm_dynamic_data":{"oneOf":[{"type":"object","title":"Pia Llm Dynamic Data","description":"Dynamic data used by the AI agent during the call","uniqueKey":"oneOf.1.pia_llm_dynamic_data.oneOf.0","typeLabel":"Pia Llm Dynamic Data · object"},{"type":"null","title":"Pia Llm Dynamic Data","description":"Dynamic data used by the AI agent during the call","uniqueKey":"oneOf.1.pia_llm_dynamic_data.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.pia_llm_dynamic_data","typeLabel":"Pia Llm Dynamic Data · object | null"},"call_start_time":{"oneOf":[{"type":"string","title":"Call Start Time","description":"Timestamp when the call was initiated, in UTC","format":"date-time","uniqueKey":"oneOf.1.call_start_time.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Call Start Time","description":"Timestamp when the call was initiated, in UTC","uniqueKey":"oneOf.1.call_start_time.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.call_start_time","typeLabel":"string\u003cdate-time> | null"},"call_end_time":{"oneOf":[{"type":"string","title":"Call End Time","description":"Timestamp when the call was terminated, in UTC","format":"date-time","uniqueKey":"oneOf.1.call_end_time.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Call End Time","description":"Timestamp when the call was terminated, in UTC","uniqueKey":"oneOf.1.call_end_time.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.call_end_time","typeLabel":"string\u003cdate-time> | null"},"messages":{"oneOf":[{"type":"array","items":{"properties":{"role":{"type":"string","enum":["agent","user"],"title":"Role","description":"Identifies whether the message is from the AI agent ('agent') or the human user ('user')","isRequired":true,"uniqueKey":"oneOf.1.messages.oneOf.0.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"content":{"type":"string","title":"Content","description":"The actual text content of the message exchanged during the conversation","isRequired":true,"uniqueKey":"oneOf.1.messages.oneOf.0.items.[INDEX].content","typeLabel":"string"}},"type":"object","required":["role","content"],"title":"MessageItem","uniqueKey":"oneOf.1.messages.oneOf.0.items.[INDEX]","typeLabel":"MessageItem · object"},"title":"Messages","description":"Chronological list of messages exchanged during the call","uniqueKey":"oneOf.1.messages.oneOf.0","typeLabel":"MessageItem · object[]"},{"type":"null","title":"Messages","description":"Chronological list of messages exchanged during the call","uniqueKey":"oneOf.1.messages.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.messages","typeLabel":"MessageItem · object[] | null"},"recorded_call_audio_url":{"oneOf":[{"type":"string","title":"Recorded Call Audio Url","description":"URL to access the recorded audio file of the call","uniqueKey":"oneOf.1.recorded_call_audio_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Recorded Call Audio Url","description":"URL to access the recorded audio file of the call","uniqueKey":"oneOf.1.recorded_call_audio_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.recorded_call_audio_url","typeLabel":"string | null"},"access_token":{"oneOf":[{"type":"string","title":"Access Token","description":"Security token for accessing call-related resources","uniqueKey":"oneOf.1.access_token.oneOf.0","typeLabel":"string"},{"type":"null","title":"Access Token","description":"Security token for accessing call-related resources","uniqueKey":"oneOf.1.access_token.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.access_token","typeLabel":"string | null"},"call_duration_seconds":{"oneOf":[{"type":"integer","title":"Call Duration Seconds","description":"Duration of the call in seconds","uniqueKey":"oneOf.1.call_duration_seconds.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Call Duration Seconds","description":"Duration of the call in seconds","uniqueKey":"oneOf.1.call_duration_seconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.call_duration_seconds","typeLabel":"integer | null"},"call_type":{"type":"string","const":"phone_call","title":"Call Type","description":"Indicates this response is for a telephone call","default":"phone_call","uniqueKey":"oneOf.1.call_type","typeLabel":"string"},"call_finish_reason":{"oneOf":[{"type":"string","title":"Call Finish Reason","description":"Detailed reason why the phone call ended, if applicable","enum":["user_ended_call","agent_ended_call","call_transferred","voicemail_detected","inactivity_timeout","answering_machine_detected","maximum_duration_exceeded","concurrent_call_limit_reached","invalid_payment","potential_scam_detected","inbound_webhook_error","line_busy","call_failed","no_answer","llm_websocket_initialization_error","llm_websocket_connection_lost","llm_websocket_runtime_error","llm_websocket_payload_corruption","frontend_payload_corruption","twilio_service_error","no_audio_input","speech_recognition_error","verbex_service_error","unknown_error","user_connection_failure","registered_call_timed_out"],"uniqueKey":"oneOf.1.call_finish_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Call Finish Reason","description":"Detailed reason why the phone call ended, if applicable","uniqueKey":"oneOf.1.call_finish_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.call_finish_reason","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"oneOf.1","typeLabel":"PhoneCallResponse · object"}],"uniqueKey":"","typeLabel":"WebCallResponse · object | PhoneCallResponse · object"},"examples":{"Example":{"title":"Example","value":{"call_status":"registered","_id":"\u003cstring>","ai_agent_id":"\u003cstring>","ai_agent_name":"\u003cstring>","override_ai_agent_id":"\u003cstring>","metadata":{},"pia_llm_dynamic_data":{},"call_start_time":"2023-11-07T05:31:56Z","call_end_time":"2023-11-07T05:31:56Z","messages":[{"role":"agent","content":"\u003cstring>"}],"recorded_call_audio_url":"\u003cstring>","access_token":"\u003cstring>","call_duration_seconds":123,"call_type":"web_call","call_finish_reason":"user_ended_call"}}},"exampleType":"generated"}},"exampleType":"generated"},"d0f19093-f0dd-4db7-9ab4-aaae5c5ed684":{"description":"Unauthorized","content":{"application/json":{"schema":{"properties":{"error":{"type":"string","title":"Error","description":"Error code identifying the type of error that occurred","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","title":"Message","description":"Human-readable description of the error","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"type":"object","required":["error","message"],"title":"ErrorResponse","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"7a2ca61c-0940-41a8-a865-2f00264bfcb1":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"string","title":"Error","description":"Error code identifying the type of error that occurred","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","title":"Message","description":"Human-readable description of the error","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"type":"object","required":["error","message"],"title":"ErrorResponse","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Not Found","exampleType":"generated"},"51748d8c-aac3-4d04-bbf6-4baaa1ed6d95":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{}},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"hishabsingaporepteltd","siteName":"Verbex Docs","title":"Get Call - Verbex Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-01T23:11:07.094Z","originalFileLocation":"api-reference/calls/get-call.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieve detailed information about a specific call by its ID. This endpoint provides comprehensive information about any call (web or phone) including its current status, duration, and associated metadata.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Verbex Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hishabsingaporepteltd/72gxkt7gRN01IC5L/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/hishabsingaporepteltd/72gxkt7gRN01IC5L/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hishabsingaporepteltd/72gxkt7gRN01IC5L/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hishabsingaporepteltd/72gxkt7gRN01IC5L/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hishabsingaporepteltd/72gxkt7gRN01IC5L/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hishabsingaporepteltd/72gxkt7gRN01IC5L/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hishabsingaporepteltd/72gxkt7gRN01IC5L/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hishabsingaporepteltd/72gxkt7gRN01IC5L/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hishabsingaporepteltd/72gxkt7gRN01IC5L/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Call - Verbex Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve detailed information about a specific call by its ID. This endpoint provides comprehensive information about any call (web or phone) including its current status, duration, and associated metadata.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Verbex Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.verbex.ai/api-reference/calls/get-call\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hishabsingaporepteltd.mintlify.app/_mintlify/api/og/v2?division=Calls\u0026amp;title=Get+Call\u0026amp;description=Retrieve+detailed+information+about+a+specific+call+by+its+ID.%0A%0AThis+endpoint+provides+comprehensive+information+about+any+call+%28web+or+phone%29+%0Aincluding+its+cu\u0026amp;theme=70c8dcbcb80920d3074a2878\u0026amp;signature=1de2772dd527aa5bfb3902fd7e225733275bac2f21e3b2e051072fa561abcf8b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Call - Verbex Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve detailed information about a specific call by its ID. This endpoint provides comprehensive information about any call (web or phone) including its current status, duration, and associated metadata.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hishabsingaporepteltd.mintlify.app/_mintlify/api/og/v2?division=Calls\u0026amp;title=Get+Call\u0026amp;description=Retrieve+detailed+information+about+a+specific+call+by+its+ID.%0A%0AThis+endpoint+provides+comprehensive+information+about+any+call+%28web+or+phone%29+%0Aincluding+its+cu\u0026amp;theme=70c8dcbcb80920d3074a2878\u0026amp;signature=1de2772dd527aa5bfb3902fd7e225733275bac2f21e3b2e051072fa561abcf8b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/hishabsingaporepteltd/72gxkt7gRN01IC5L/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Verbex Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.verbex.ai/api-reference/calls/get-call\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/calls/get-call.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.verbex.ai/#organization\",\"name\":\"Verbex Docs\",\"url\":\"https://docs.verbex.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hishabsingaporepteltd/hKDJJlbuwj-_7GRI/light.png?fit=max\u0026auto=format\u0026n=hKDJJlbuwj-_7GRI\u0026q=85\u0026s=8e51283f8c4e5daa2b06e4c7b010036a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.verbex.ai#website\",\"name\":\"Verbex Docs\",\"url\":\"https://docs.verbex.ai\",\"publisher\":{\"@id\":\"https://docs.verbex.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.verbex.ai/api-reference/calls/get-call#webpage\",\"url\":\"https://docs.verbex.ai/api-reference/calls/get-call\",\"name\":\"Get Call\",\"description\":\"Retrieve detailed information about a specific call by its ID. This endpoint provides comprehensive information about any call (web or phone) including its current status, duration, and associated metadata.\",\"dateModified\":\"2026-11-01T23:11:07.094Z\",\"isPartOf\":{\"@id\":\"https://docs.verbex.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.verbex.ai/api-reference/calls/get-call#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.verbex.ai/api-reference/calls/get-call#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Calls\",\"item\":\"https://docs.verbex.ai/api-reference/calls/create-web-call\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Call\",\"item\":\"https://docs.verbex.ai/api-reference/calls/get-call\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.verbex.ai/api-reference/calls/get-call#apireference\",\"headline\":\"Get Call\",\"name\":\"Get Call\",\"description\":\"Retrieve detailed information about a specific call by its ID. This endpoint provides comprehensive information about any call (web or phone) including its current status, duration, and associated metadata.\",\"url\":\"https://docs.verbex.ai/api-reference/calls/get-call\",\"mainEntityOfPage\":{\"@id\":\"https://docs.verbex.ai/api-reference/calls/get-call#webpage\"},\"dateModified\":\"2026-11-01T23:11:07.094Z\",\"publisher\":{\"@id\":\"https://docs.verbex.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.verbex.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Verbex Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Verbex Docs","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"Getting an API Key","href":"/api-reference/introduction"},{"title":"Migrate from v2 to v3","href":"/api-reference/ai-agents-v3/migrate-from-v2"}]},{"group":"AI Agents v3","pages":[{"title":"List AI Agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v3/ai-agents","href":"/api-reference/ai-agents-v3/list-ai-agents"},{"title":"Create AI Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v3/ai-agents","href":"/api-reference/ai-agents-v3/create-ai-agent"},{"title":"Get AI Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v3/ai-agents/{agent_id}","href":"/api-reference/ai-agents-v3/get-ai-agent"},{"title":"Update AI Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /v3/ai-agents/{agent_id}","href":"/api-reference/ai-agents-v3/update-ai-agent"},{"title":"Delete AI Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v3/ai-agents/{agent_id}","href":"/api-reference/ai-agents-v3/delete-ai-agent"}]},{"group":"AI Agents v2","pages":[{"title":"List AI Agents","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json get /v2/ai-agents/","href":"/api-reference/ai-agents-v2/list-ai-agents"},{"title":"Create AI Agent","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json post /v2/ai-agents/","href":"/api-reference/ai-agents-v2/create-ai-agent"},{"title":"Get AI Agent","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json get /v2/ai-agents/{agent_id}","href":"/api-reference/ai-agents-v2/get-ai-agent"},{"title":"Update AI Agent","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json put /v2/ai-agents/{agent_id}","href":"/api-reference/ai-agents-v2/update-ai-agent"},{"title":"Delete AI Agent","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json delete /v2/ai-agents/{agent_id}","href":"/api-reference/ai-agents-v2/delete-ai-agent"}]},{"group":"LLM Models","pages":[{"title":"List LLM models","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/llm-models","href":"/api-reference/llm-models/list-llm-models"},{"title":"Get LLM model","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/llm-models/{llm_model_id}","href":"/api-reference/llm-models/get-llm-model"}]},{"group":"Speech Providers","pages":[{"title":"List STT providers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v3/stt/providers","href":"/api-reference/speech-providers/list-stt-providers"},{"title":"Get STT provider","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v3/stt/providers/{provider_name}","href":"/api-reference/speech-providers/get-stt-provider"},{"title":"List TTS providers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v3/tts/providers","href":"/api-reference/speech-providers/list-tts-providers"},{"title":"Get TTS provider","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v3/tts/providers/{provider_name}","href":"/api-reference/speech-providers/get-tts-provider"}]},{"group":"Built-in Tools","pages":[{"title":"List built-in tools","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/ai-agents/{ai_agent_id}/builtin-tools/","href":"/api-reference/built-in-tools/list-built-in-tools"},{"title":"Create built-in tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/ai-agents/{ai_agent_id}/builtin-tools/","href":"/api-reference/built-in-tools/create-built-in-tool"},{"title":"Get built-in tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/ai-agents/{ai_agent_id}/builtin-tools/{tool_id}","href":"/api-reference/built-in-tools/get-built-in-tool"},{"title":"Update built-in tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /v2/ai-agents/{ai_agent_id}/builtin-tools/{tool_id}","href":"/api-reference/built-in-tools/update-built-in-tool"},{"title":"Delete built-in tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v2/ai-agents/{ai_agent_id}/builtin-tools/{tool_id}","href":"/api-reference/built-in-tools/delete-built-in-tool"}]},{"group":"Custom Tools","pages":[{"title":"List custom tools","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/ai-agents/{ai_agent_id}/custom-tools/","href":"/api-reference/custom-tools/list-custom-tools"},{"title":"Create custom tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/ai-agents/{ai_agent_id}/custom-tools/","href":"/api-reference/custom-tools/create-custom-tool"},{"title":"Get custom tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/ai-agents/{ai_agent_id}/custom-tools/{tool_id}","href":"/api-reference/custom-tools/get-custom-tool"},{"title":"Update custom tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /v2/ai-agents/{ai_agent_id}/custom-tools/{tool_id}","href":"/api-reference/custom-tools/update-custom-tool"},{"title":"Delete custom tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v2/ai-agents/{ai_agent_id}/custom-tools/{tool_id}","href":"/api-reference/custom-tools/delete-custom-tool"}]},{"group":"Calls","pages":[{"title":"Create Web Call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/calls/create-web-call","href":"/api-reference/calls/create-web-call"},{"title":"Create Web Call (Public Shared)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/calls/public/create-web-call","href":"/api-reference/calls/create-web-call-public-shared"},{"title":"Dial Outbound Phone Call","description":"Initiate an outbound phone call from an AI agent to a specified phone number.\n\nThis endpoint triggers the AI agent to place a phone call to the provided number.\nUse this for scenarios where the AI needs to proactively contact users via phone.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/calls/dial-outbound-phone-call","href":"/api-reference/calls/dial-outbound-phone-call"},{"title":"Get Call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/calls/{call_id}","href":"/api-reference/calls/get-call"},{"title":"List Calls","description":"Retrieve a paginated list of calls with optional filtering and sorting.\n\nThis endpoint allows querying call history with various filters including time ranges\nand specific AI agents. Results are paginated for efficient data retrieval.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/calls/","href":"/api-reference/calls/list-calls"}]},{"group":"Call Recording","pages":[{"title":"Get Signed URL for Call Recording","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/call-recording/signed-url","href":"/api-reference/call-recording/get-signed-url-for-call-recording"},{"title":"Download Call Recording","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/call-recording/download","href":"/api-reference/call-recording/download-call-recording"}]},{"group":"Post-call Analysis","pages":[{"title":"Get post-call analysis configuration for an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/ai-agents/{ai_agent_id}/postcall-analysis","href":"/api-reference/post-call-analysis/get-post-call-analysis-configuration-for-an-agent"},{"title":"Update an existing post-call analysis configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /v2/ai-agents/{ai_agent_id}/postcall-analysis","href":"/api-reference/post-call-analysis/update-an-existing-post-call-analysis-configuration"},{"title":"Create a new post-call analysis configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/ai-agents/{ai_agent_id}/postcall-analysis","href":"/api-reference/post-call-analysis/create-a-new-post-call-analysis-configuration"},{"title":"Delete an existing post-call analysis configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v2/ai-agents/{ai_agent_id}/postcall-analysis","href":"/api-reference/post-call-analysis/delete-an-existing-post-call-analysis-configuration"},{"title":"Get Post Call Analysis Results","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/ai-agents/{ai_agent_id}/postcall-analysis/results/{call_id}","href":"/api-reference/post-call-analysis/get-post-call-analysis-results"}]},{"group":"Phone Numbers","pages":[{"title":"Retrieve a paginated list of all phone numbers configured in your PIA Platform account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/phone-numbers/","href":"/api-reference/phone-numbers/retrieve-a-paginated-list-of-all-phone-numbers-configured-in-your-pia-platform-account"},{"title":"Create a new phone number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/phone-numbers/","href":"/api-reference/phone-numbers/create-a-new-phone-number"},{"title":"Retrieve detailed information about a specific phone number configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/phone-numbers/{phone_number_id}","href":"/api-reference/phone-numbers/retrieve-detailed-information-about-a-specific-phone-number-configuration"},{"title":"Remove a phone number configuration from the PIA Platform","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/phone-numbers/{phone_number_id}","href":"/api-reference/phone-numbers/remove-a-phone-number-configuration-from-the-pia-platform"},{"title":"Update the configuration of an existing phone number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/phone-numbers/{phone_number_id}","href":"/api-reference/phone-numbers/update-the-configuration-of-an-existing-phone-number"}]},{"group":"Knowledge Bases","pages":[{"title":"List Knowledge Bases","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/knowledge-bases","href":"/api-reference/knowledge-bases/list-knowledge-bases"},{"title":"Create Knowledge Base","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/knowledge-bases","href":"/api-reference/knowledge-bases/create-knowledge-base"},{"title":"Get Knowledge Base","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/knowledge-bases/{kb_id}","href":"/api-reference/knowledge-bases/get-knowledge-base"},{"title":"Delete Knowledge Base","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/knowledge-bases/{kb_id}","href":"/api-reference/knowledge-bases/delete-knowledge-base"},{"title":"Update Knowledge Base","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/knowledge-bases/{kb_id}","href":"/api-reference/knowledge-bases/update-knowledge-base"},{"title":"Upload a File","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/knowledge-bases/{kb_id}/documents/file","href":"/api-reference/knowledge-bases/upload-a-file"},{"title":"Discover a Website's URLs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/knowledge-bases/documents/website/sitemaps","href":"/api-reference/knowledge-bases/discover-a-websites-urls"},{"title":"Crawl Web Pages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/knowledge-bases/{kb_id}/documents/website","href":"/api-reference/knowledge-bases/crawl-web-pages"},{"title":"List Documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/knowledge-bases/{kb_id}/documents","href":"/api-reference/knowledge-bases/list-documents"},{"title":"Get Document Status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/knowledge-bases/{kb_id}/documents/{document_id}/status","href":"/api-reference/knowledge-bases/get-document-status"},{"title":"Inspect Indexed Chunks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/knowledge-bases/{kb_id}/documents/{document_id}/chunks","href":"/api-reference/knowledge-bases/inspect-indexed-chunks"},{"title":"Delete a Document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/knowledge-bases/{kb_id}/documents/{document_id}","href":"/api-reference/knowledge-bases/delete-a-document"},{"title":"Semantic Search","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/vector/search","href":"/api-reference/knowledge-bases/semantic-search"}]},{"group":"Prompt Generation","pages":[{"title":"Generate Prompt","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/prompt-generation/prompt/generate","href":"/api-reference/prompt-generation/generate-prompt"}]},{"group":"Public Sharing","pages":[{"title":"Create Share","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/public-sharing/","href":"/api-reference/public-sharing/create-share"},{"title":"Get Share","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/public-sharing/{ai_agent_id}","href":"/api-reference/public-sharing/get-share"},{"title":"Delete Share","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/public-sharing/{share_id}","href":"/api-reference/public-sharing/delete-share"}]},{"group":"Webhook Subscriptions","pages":[{"title":"Create a subscription","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/public/webhook/subscription","href":"/api-reference/webhook-subscriptions/create-a-subscription"},{"title":"Get a subscription","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/public/webhook/subscription/{id}","href":"/api-reference/webhook-subscriptions/get-a-subscription"},{"title":"Update a subscription","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /v1/public/webhook/subscription/{id}","href":"/api-reference/webhook-subscriptions/update-a-subscription"},{"title":"Delete a subscription","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/public/webhook/subscription/{id}","href":"/api-reference/webhook-subscriptions/delete-a-subscription"},{"title":"Rotate the signing secret","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/public/webhook/subscription/{id}/rotate/secret","href":"/api-reference/webhook-subscriptions/rotate-the-signing-secret"},{"title":"List subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/public/webhook/subscriptions","href":"/api-reference/webhook-subscriptions/list-subscriptions"}]},{"group":"API Keys","pages":[{"title":"List API Keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/api-keys/","href":"/api-reference/api-keys/list-api-keys"},{"title":"Create API Key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/api-keys/","href":"/api-reference/api-keys/create-api-key"},{"title":"Get API Key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/api-keys/{key_id}","href":"/api-reference/api-keys/get-api-key"},{"title":"Revoke API Key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/api-keys/{key_id}/revoke","href":"/api-reference/api-keys/revoke-api-key"}]}]},{"tab":"Video Tutorials","pages":[{"title":"Video Tutorials","href":"/video-tutorials/introduction"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/changelog"}]}]},"basePath":"","title":"Get Call - Verbex Docs","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}