Creates a new VoiceAgent call with specified parameters and properties. Call properties are optional and can be used to configure the call.
The call is queued and dialed shortly after; a 200 means it was queued, not that it was answered.
The contact being called. Without contact_id, CloudTalk looks up the dialed call_number among the company’s contacts and uses the first match; when none matches, or the lookup fails, the call goes ahead without a contact. With contact_id, the call uses exactly that contact and the number is not looked up. The contact fills the {{contact.*}} variables of the prompt, greeting, skills, scenarios and custom tools, appears in the post-call analysis as ct_call_context.contact, and its e-mails are where the calendar invite goes by default. When the agent books on Calendly or Cal.com, the invite goes to the first valid e-mail in the variable the booking skill names (contact.emails unless you change it): a non-empty value you send for that variable in call_properties.system_prompt.variables replaces the contact’s.
HTTP Basic Authentication. Use your API Access Key ID as the username and your API Access Key Secret as the password. Generate keys in the CloudTalk Dashboard under Account -> Settings -> API Keys (https://dashboard.cloudtalk.io/menu/account/settings/API-keys).
Optional. ID of the CloudTalk contact (or lead) being called, as a string of digits or as an integer; "123" and 123 are the same contact. The call then uses exactly this contact instead of the one matched by call_number, and goes ahead even when the contact's phone numbers do not include call_number.
The contact fills the {{contact.*}} variables and appears in the post-call analysis as ct_call_context.contact; its e-mails are where the calendar invite goes by default. A non-empty value you send for a contact.* variable in call_properties.system_prompt.variables wins over the contact's value for that variable in what the agent is told, in what it sends to custom tools and, for the variable the booking skill takes the invite e-mail from (contact.emails by default), in where the calendar invite goes. ct_call_context.contact stays this contact's.
A contact that does not exist in your company, belongs to another company or was deleted is refused with 422contact_not_found, and no call is queued. Fractional numbers (for example 1.5), zero, negative numbers, null, integers above 9223372036854775807, and strings that are empty, start with a zero, contain anything but digits or are longer than 19 digits (for example "012" or "1.0") are refused with 422. A whole number written as 123.0 or 1.23e2 is the same contact as 123.
ID of the queued call session. Quote it when you contact CloudTalk support about this call.
Example:
"6640f1a2c3d4e5f60718293a"
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"CloudTalk Help Center","description":"CloudTalk developer documentation — REST API reference and integration guides.","colors":{"primary":"#0527FF","light":"#8495FF","dark":"#0420D5"},"logo":{"light":"https://mintcdn.com/cloudtalk/M_FX1uE099dO0_78/logo/light.svg?fit=max\u0026auto=format\u0026n=M_FX1uE099dO0_78\u0026q=85\u0026s=9efde0e0ef215d0b41a2f8f92056e144","dark":"https://mintcdn.com/cloudtalk/M_FX1uE099dO0_78/logo/dark.svg?fit=max\u0026auto=format\u0026n=M_FX1uE099dO0_78\u0026q=85\u0026s=4f13ec15ddcb5aaaac1005fe27b20494"},"favicon":"https://mintcdn.com/cloudtalk/M_FX1uE099dO0_78/favicon.svg?fit=max\u0026auto=format\u0026n=M_FX1uE099dO0_78\u0026q=85\u0026s=b8634fcc454e4f7d772d4c384046ec0b","api":{"examples":{"prefill":true,"autogenerate":true}},"background":{"color":{"light":"#F9FAFB","dark":"#1A1B1E"}},"navbar":{"links":[{"href":"https://support.cloudtalk.io/","label":"Support"}],"primary":{"type":"button","label":"Log in","href":"https://dashboard.cloudtalk.io/"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/cloudtalk.io","youtube":"https://www.youtube.com/channel/UCIVoouQBQ9u6ahSJJ7f5orQ","facebook":"https://www.facebook.com/CloudTalkCallCenter","instagram":"https://www.instagram.com/cloudtalk_io"},"links":[{"header":"Product","items":[{"label":"Pricing","href":"https://www.cloudtalk.io/pricing"},{"label":"AI Voice Agents","href":"https://www.cloudtalk.io/ai-voice-agents"},{"label":"AI Sales Dialer","href":"https://www.cloudtalk.io/dialer"},{"label":"AI Receptionist","href":"https://www.cloudtalk.io/ai-receptionist"},{"label":"Inbound Call Center","href":"https://www.cloudtalk.io/inbound-support-center"},{"label":"Outbound Call Center","href":"https://www.cloudtalk.io/outbound-sales"}]},{"header":"Support","items":[{"label":"Help Center","href":"https://help.cloudtalk.io/en"},{"label":"Status Page","href":"https://status.cloudtalk.io/"},{"label":"Contact Us","href":"https://www.cloudtalk.io/contact"},{"label":"Request a Free Trial","href":"https://www.cloudtalk.io/signup"}]},{"header":"Company","items":[{"label":"Our Story","href":"https://www.cloudtalk.io/our-story"},{"label":"Careers","href":"https://www.cloudtalk.io/careers"},{"label":"Security","href":"https://www.cloudtalk.io/security"},{"label":"Trust Center","href":"https://trust.cloudtalk.io/"},{"label":"Brand Assets","href":"https://www.cloudtalk.io/brand-assets"}]},{"header":"Legal","items":[{"label":"Terms \u0026 Conditions","href":"https://www.cloudtalk.io/terms-and-conditions"},{"label":"Privacy Notice","href":"https://www.cloudtalk.io/privacy-notice"}]}]},"fonts":{"family":"Public Sans"},"styling":{"codeblocks":"system","latex":true},"integrations":{"ga4":{"measurementId":"G-FMQKD83J1Q"}},"contextual":{"options":["copy","view","mcp","cursor","vscode","chatgpt","claude","perplexity"],"display":"header"},"markdown":{"schema":false},"navigation":{"languages":[{"language":"en","href":"en"},{"language":"de","href":"de"},{"language":"es","href":"es"},{"language":"fr","href":"fr"},{"language":"nl","href":"nl"},{"language":"pt","href":"pt"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cloudtalk","hasAudioNarration":false,"actualSubdomain":"cloudtalk","customDomains":["help.cloudtalk.io"],"gitSource":{"type":"github","owner":"cloudtalk-io","repo":"developer-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6aeb6572edeafab81dc5bb56","collectionId":"ff5268bf-c894-49c0-8aa9-3204af5b5aca","liveDeploymentHistoryId":"6aeb6572edeafab81dc5bb56","schemaVersion":"v3"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6aeb67560e1827ae617b1005","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"en","tag":"Help Center","count":450},{"language":"de","tag":"Hilfecenter","count":449},{"language":"es","tag":"Centro de ayuda","count":449},{"language":"fr","tag":"Centre d'aide","count":449},{"language":"nl","tag":"Helpcentrum","count":449},{"language":"pt","tag":"Centro de ajuda","count":449},{"language":"en","tag":"API","count":116},{"language":"en","tag":"API Reference","count":108},{"language":"en","tag":"Integrations","count":97},{"language":"de","tag":"Integrationen","count":97},{"language":"es","tag":"Integraciones","count":97},{"language":"fr","tag":"Intégrations","count":97},{"language":"nl","tag":"Integraties","count":97},{"language":"pt","tag":"Integrações","count":97},{"language":"en","tag":"Dashboard","count":89},{"language":"de","tag":"Dashboard","count":89},{"language":"es","tag":"Dashboard","count":89},{"language":"fr","tag":"Dashboard","count":89},{"language":"nl","tag":"Dashboard","count":89},{"language":"pt","tag":"Dashboard","count":89},{"language":"en","tag":"Numbers \u0026 porting","count":66},{"language":"de","tag":"Nummern \u0026 Portierung","count":66},{"language":"es","tag":"Números y portabilidad","count":66},{"language":"fr","tag":"Numéros et portabilité","count":66},{"language":"nl","tag":"Nummers \u0026 portering","count":66},{"language":"pt","tag":"Números e portabilidade","count":66},{"language":"en","tag":"CRM","count":51},{"language":"de","tag":"CRM","count":51},{"language":"es","tag":"CRM","count":51},{"language":"fr","tag":"CRM","count":51},{"language":"nl","tag":"CRM","count":51},{"language":"pt","tag":"CRM","count":51},{"language":"en","tag":"AI","count":43},{"language":"de","tag":"KI","count":42},{"language":"es","tag":"IA","count":42},{"language":"fr","tag":"IA","count":42},{"language":"nl","tag":"AI","count":42},{"language":"pt","tag":"IA","count":42},{"language":"en","tag":"Porting by country","count":40},{"language":"de","tag":"Portierung nach Land","count":40},{"language":"es","tag":"Portabilidad por país","count":40},{"language":"fr","tag":"Portabilité par pays","count":40},{"language":"nl","tag":"Portering per land","count":40},{"language":"pt","tag":"Portabilidade por país","count":40},{"language":"en","tag":"CloudTalk Phone \u0026 Go","count":38},{"language":"de","tag":"CloudTalk Phone \u0026 Go","count":38},{"language":"es","tag":"CloudTalk Phone y Go","count":38},{"language":"fr","tag":"CloudTalk Phone et Go","count":38},{"language":"nl","tag":"CloudTalk Phone \u0026 Go","count":38},{"language":"pt","tag":"CloudTalk Phone e Go","count":38},{"language":"de","tag":"Erste Schritte","count":33},{"language":"es","tag":"Primeros pasos","count":33},{"language":"fr","tag":"Premiers pas","count":33},{"language":"nl","tag":"Aan de slag","count":33},{"language":"pt","tag":"Primeiros passos","count":33},{"language":"de","tag":"Abrechnung \u0026 Abonnement","count":29},{"language":"es","tag":"Facturación y suscripción","count":29},{"language":"fr","tag":"Facturation et abonnement","count":29},{"language":"nl","tag":"Facturering \u0026 abonnement","count":29},{"language":"pt","tag":"Faturação e subscrição","count":29}],"searchSettings":{"maxResults":8,"showContentSnippets":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"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":"rbac-expansion","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":"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":"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}],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"html:not(.dark) #navbar>div:first-child{background:#f5f5f5}#navbar img.nav-logo{height:1.3125rem}#navbar a[href^=\"https://dashboard.cloudtalk.io\"],#navbar a[href^=\"https://dashboard.cloudtalk.io\"] *{color:#fff!important}#navbar a[href^=\"https://dashboard.cloudtalk.io\"]{background:#0420d5;height:2.25rem;padding:0 .875rem;border-radius:.625rem;font-weight:600}#navbar a[href^=\"https://dashboard.cloudtalk.io\"]:hover{background:#031aaa;color:#fff!important}.dark #navbar a[href^=\"https://dashboard.cloudtalk.io\"]{background:#0527ff}.dark #navbar a[href^=\"https://dashboard.cloudtalk.io\"]:hover{background:#304cff}#navbar a[href^=\"https://support.cloudtalk.io\"]{background:0 0;color:#181d27!important;box-shadow:inset 0 0 0 1px #d5d7da;height:2.25rem;padding:0 .875rem;border-radius:.625rem;font-weight:600}#navbar a[href^=\"https://support.cloudtalk.io\"]:hover{background:#e9eaeb;color:#181d27!important}.dark #navbar a[href^=\"https://support.cloudtalk.io\"]{background:0 0;color:#ececed!important;box-shadow:inset 0 0 0 1px #373a41}.dark #navbar a[href^=\"https://support.cloudtalk.io\"]:hover{background:#2b303b;color:#ececed!important}html:not(.dark) #assistant-entry{background:#fff}#navbar nav[aria-label=Main]>ul>li:not(:last-child){margin-inline-end:.75rem}#sidebar-content>button,#sidebar-content>div.border-t{display:none}nav#sidebar-content{border-right:0}@media (min-width:1024px){main#content-container{padding-left:3rem!important}}"}],"page":{"pagePath":"api-reference/voiceagent/initiate-voiceagent-call","slug":"/api-reference/voiceagent/initiate-voiceagent-call","pageMetadata":{"title":"Initiate VoiceAgent call","description":"Creates a new VoiceAgent call with specified parameters and properties. Call properties are optional and can be used to configure the call.\n\nThe call is queued and dialed shortly after; a `200` means it was queued, not that it was answered.\n\n**The contact being called.** Without `contact_id`, CloudTalk looks up the dialed `call_number` among the company's contacts and uses the first match; when none matches, or the lookup fails, the call goes ahead without a contact. With `contact_id`, the call uses exactly that contact and the number is not looked up. The contact fills the `{{contact.*}}` variables of the prompt, greeting, skills, scenarios and custom tools, appears in the post-call analysis as `ct_call_context.contact`, and its e-mails are where the calendar invite goes by default. When the agent books on Calendly or Cal.com, the invite goes to the first valid e-mail in the variable the booking skill names (`contact.emails` unless you change it): a non-empty value you send for that variable in `call_properties.system_prompt.variables` replaces the contact's.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /voice-agent/calls","href":"/api-reference/voiceagent/initiate-voiceagent-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 code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Creates a new VoiceAgent call with specified parameters and properties. Call properties are optional and can be used to configure the call.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The call is queued and dialed shortly after; a \", _jsx(_components.code, {\n children: \"200\"\n }), \" means it was queued, not that it was answered.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"The contact being called.\"\n }), \" Without \", _jsx(_components.code, {\n children: \"contact_id\"\n }), \", CloudTalk looks up the dialed \", _jsx(_components.code, {\n children: \"call_number\"\n }), \" among the company’s contacts and uses the first match; when none matches, or the lookup fails, the call goes ahead without a contact. With \", _jsx(_components.code, {\n children: \"contact_id\"\n }), \", the call uses exactly that contact and the number is not looked up. The contact fills the \", _jsx(_components.code, {\n children: \"{{contact.*}}\"\n }), \" variables of the prompt, greeting, skills, scenarios and custom tools, appears in the post-call analysis as \", _jsx(_components.code, {\n children: \"ct_call_context.contact\"\n }), \", and its e-mails are where the calendar invite goes by default. When the agent books on Calendly or Cal.com, the invite goes to the first valid e-mail in the variable the booking skill names (\", _jsx(_components.code, {\n children: \"contact.emails\"\n }), \" unless you change it): a non-empty value you send for that variable in \", _jsx(_components.code, {\n children: \"call_properties.system_prompt.variables\"\n }), \" replaces the contact’s.\"]\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":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Initiate VoiceAgent call","description":"Creates a new VoiceAgent call with specified parameters and properties. Call properties are optional and can be used to configure the call.\n\nThe call is queued and dialed shortly after; a `200` means it was queued, not that it was answered.\n\n**The contact being called.** Without `contact_id`, CloudTalk looks up the dialed `call_number` among the company's contacts and uses the first match; when none matches, or the lookup fails, the call goes ahead without a contact. With `contact_id`, the call uses exactly that contact and the number is not looked up. The contact fills the `{{contact.*}}` variables of the prompt, greeting, skills, scenarios and custom tools, appears in the post-call analysis as `ct_call_context.contact`, and its e-mails are where the calendar invite goes by default. When the agent books on Calendly or Cal.com, the invite goes to the first valid e-mail in the variable the booking skill names (`contact.emails` unless you change it): a non-empty value you send for that variable in `call_properties.system_prompt.variables` replaces the contact's.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /voice-agent/calls","href":"/api-reference/voiceagent/initiate-voiceagent-call","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/cloudtalk/3405988015c78c5c/theme-toggle.js"],"openApiReferenceData":{"operation":{"servers":["317f5ec1-3723-4ad8-a239-b36525de0e77"],"tags":["VoiceAgent"],"summary":"Initiate VoiceAgent call","description":"Creates a new VoiceAgent call with specified parameters and properties. Call properties are optional and can be used to configure the call.\n\nThe call is queued and dialed shortly after; a `200` means it was queued, not that it was answered.\n\n**The contact being called.** Without `contact_id`, CloudTalk looks up the dialed `call_number` among the company's contacts and uses the first match; when none matches, or the lookup fails, the call goes ahead without a contact. With `contact_id`, the call uses exactly that contact and the number is not looked up. The contact fills the `{{contact.*}}` variables of the prompt, greeting, skills, scenarios and custom tools, appears in the post-call analysis as `ct_call_context.contact`, and its e-mails are where the calendar invite goes by default. When the agent books on Calendly or Cal.com, the invite goes to the first valid e-mail in the variable the booking skill names (`contact.emails` unless you change it): a non-empty value you send for that variable in `call_properties.system_prompt.variables` replaces the contact's.","operationId":"createVoiceAgentCall","requestBody":"8672bb27-3f38-4725-9ae0-75ab66be3721","responses":{"200":"2d13dede-f5e0-464c-bded-e04fc506de9c","400":"ecbe79d2-a72d-429d-b4eb-8f9fb9a4c739","401":"b6954f9c-7844-4d4f-91e9-cdd196e4de4f","403":"89700abd-d3ed-4ead-849c-798ade4720f9","404":"61661c64-92fa-49d1-a7c8-3fd3e20e2722","422":"2802fafc-23b0-48a4-a0dc-33cf23f441b5","500":"3b206fd8-4398-4524-b3af-5c312c7e49bf","503":"c3eeb712-c983-4706-a5a2-0d7e2a8085da"},"method":"post","type":"path","security":["6d96e362-8e79-44bd-a2f9-bb735965af53"],"path":"/voice-agent/calls","baseUrlOptions":["https://api.cloudtalk.io/v1"],"title":"Initiate VoiceAgent call","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.call_number":"+421000000000","body.voice_agent_id":"681b0639876543cfbc3d6b55","body.contact_id.oneOf.0":"123456","body.call_properties.output.variables":{"external_contact_id":12345},"body.call_properties.system_prompt.variables":{"name":"John Doe","company":"CloudTalk"}}]},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["call_number","voice_agent_id"],"properties":{"call_number":{"type":"string","description":"The phone number to call","example":"+421000000000","isRequired":true,"uniqueKey":"call_number","typeLabel":"string"},"voice_agent_id":{"type":"string","description":"ID of the VoiceAgent to use for the call","example":"681b0639876543cfbc3d6b55","isRequired":true,"uniqueKey":"voice_agent_id","typeLabel":"string"},"contact_id":{"oneOf":[{"type":"string","description":"Optional. ID of the CloudTalk contact (or lead) being called, as a string of digits or as an integer; `\"123\"` and `123` are the same contact. The call then uses exactly this contact instead of the one matched by `call_number`, and goes ahead even when the contact's phone numbers do not include `call_number`.\n\nThe contact fills the `{{contact.*}}` variables and appears in the post-call analysis as `ct_call_context.contact`; its e-mails are where the calendar invite goes by default. A non-empty value you send for a `contact.*` variable in `call_properties.system_prompt.variables` wins over the contact's value for that variable in what the agent is told, in what it sends to custom tools and, for the variable the booking skill takes the invite e-mail from (`contact.emails` by default), in where the calendar invite goes. `ct_call_context.contact` stays this contact's.\n\nA contact that does not exist in your company, belongs to another company or was deleted is refused with `422` `contact_not_found`, and no call is queued. Fractional numbers (for example `1.5`), zero, negative numbers, `null`, integers above 9223372036854775807, and strings that are empty, start with a zero, contain anything but digits or are longer than 19 digits (for example `\"012\"` or `\"1.0\"`) are refused with `422`. A whole number written as `123.0` or `1.23e2` is the same contact as `123`.","pattern":"^[1-9][0-9]{0,18}$","example":"123456","uniqueKey":"contact_id.oneOf.0","typeLabel":"string"},{"type":"integer","description":"Optional. ID of the CloudTalk contact (or lead) being called, as a string of digits or as an integer; `\"123\"` and `123` are the same contact. The call then uses exactly this contact instead of the one matched by `call_number`, and goes ahead even when the contact's phone numbers do not include `call_number`.\n\nThe contact fills the `{{contact.*}}` variables and appears in the post-call analysis as `ct_call_context.contact`; its e-mails are where the calendar invite goes by default. A non-empty value you send for a `contact.*` variable in `call_properties.system_prompt.variables` wins over the contact's value for that variable in what the agent is told, in what it sends to custom tools and, for the variable the booking skill takes the invite e-mail from (`contact.emails` by default), in where the calendar invite goes. `ct_call_context.contact` stays this contact's.\n\nA contact that does not exist in your company, belongs to another company or was deleted is refused with `422` `contact_not_found`, and no call is queued. Fractional numbers (for example `1.5`), zero, negative numbers, `null`, integers above 9223372036854775807, and strings that are empty, start with a zero, contain anything but digits or are longer than 19 digits (for example `\"012\"` or `\"1.0\"`) are refused with `422`. A whole number written as `123.0` or `1.23e2` is the same contact as `123`.","format":"int64","minimum":1,"example":"123456","uniqueKey":"contact_id.oneOf.1","typeLabel":"integer\u003cint64>"}],"uniqueKey":"contact_id","typeLabel":"string | integer\u003cint64>"},"call_properties":{"type":"object","description":"Additional properties for configuring the VoiceAgent call","properties":{"output":{"type":"object","description":"Variables that will be included in the VoiceAgent call analysis output","properties":{"variables":{"type":"object","additionalProperties":true,"description":"Variables that will be included in the call analysis output","example":{"external_contact_id":12345},"uniqueKey":"call_properties.output.variables","typeLabel":"object"}},"uniqueKey":"call_properties.output","typeLabel":"object"},"system_prompt":{"type":"object","description":"Variables that will be used during the actual call by the VoiceAgent","properties":{"variables":{"type":"object","additionalProperties":true,"description":"Variables that will be used in the VoiceAgent's system prompt during the call","example":{"name":"John Doe","company":"CloudTalk"},"uniqueKey":"call_properties.system_prompt.variables","typeLabel":"object"}},"uniqueKey":"call_properties.system_prompt","typeLabel":"object"}},"uniqueKey":"call_properties","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"call_number":"+421000000000","voice_agent_id":"681b0639876543cfbc3d6b55","contact_id":"123456","call_properties":{"output":{"variables":{"external_contact_id":12345}},"system_prompt":{"variables":{"name":"John Doe","company":"CloudTalk"}}}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"2d13dede-f5e0-464c-bded-e04fc506de9c":{"description":"The call was queued.","content":{"application/json":{"schema":{"type":"object","required":["session_id"],"properties":{"session_id":{"type":"string","description":"ID of the queued call session. Quote it when you contact CloudTalk support about this call.","example":"6640f1a2c3d4e5f60718293a","isRequired":true,"uniqueKey":"session_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"session_id":"6640f1a2c3d4e5f60718293a"}}},"exampleType":"generated"}},"exampleType":"generated"},"ecbe79d2-a72d-429d-b4eb-8f9fb9a4c739":{"description":"No call was queued. The body is missing or is not valid JSON, `voice_agent_id` is malformed (`detail` `invalid voice_agent_id`, no `errors` entry), `call_number` is not a valid phone number (`invalid_call_number`), `call_properties` has more than 100 top-level keys (`too_many_properties`), or one of its values is larger than 512 KB once serialized as JSON (`property_too_large`). A missing or empty `voice_agent_id` or `call_number` is a `422`.","content":{"application/problem+json":{"schema":{"type":"object","description":"Error body of `POST /voice-agent/calls` and `POST /voice-agent/outbound/kill` (RFC 9457 problem details). Match on `status` and on `errors[].message`, which carries a stable code (such as `contact_not_found`) for the failures the operation names, `internal_error` on a `500`. Some errors carry no `errors`: a `400` for a missing body or a malformed `voice_agent_id` on a call, and the kill switch's `400` `Invalid request`, `404` and `503`. A malformed `call_number` carries `invalid_call_number`; a missing `voice_agent_id` or `call_number` is a `422` that names the property.","properties":{"title":{"type":"string","description":"HTTP status text.","example":"Unprocessable Entity","uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code.","example":422,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable explanation.","example":"Contact not found","uniqueKey":"detail","typeLabel":"string"},"errors":{"type":"array","description":"Details of the failure.","items":{"type":"object","properties":{"message":{"type":"string","description":"A stable code such as `contact_not_found` or `internal_error`, or the validation message for a request-schema error.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"location":{"type":"string","description":"The request part the error refers to, for example `body.contact_id`. Absent when the error is not about one field.","uniqueKey":"errors.items.[INDEX].location","typeLabel":"string"},"value":{"description":"The value that failed validation, on request-schema errors.","uniqueKey":"errors.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"too_many_properties":{"title":"too_many_properties","value":{"title":"Bad Request","status":400,"detail":"Too many properties in map","errors":[{"message":"too_many_properties"}]}},"property_too_large":{"title":"property_too_large","value":{"title":"Bad Request","status":400,"detail":"Property value exceeds size limit of 512KB","errors":[{"message":"property_too_large"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"b6954f9c-7844-4d4f-91e9-cdd196e4de4f":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","description":"Error envelope returned by the authentication layer in front of the `api.cloudtalk.io/v1` surface. It differs from the per-service error shapes used for other statuses.","properties":{"code":{"type":"string","description":"Error code","example":"UNAUTHORIZED","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Error message","example":"You are not authorized to access this resource.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"","typeLabel":"object"},"example":{"code":"UNAUTHORIZED","message":"You are not authorized to access this resource."},"examples":{"Example":{"title":"Example","value":{"code":"UNAUTHORIZED","message":"You are not authorized to access this resource."}}},"exampleType":"examples"}},"exampleType":"examples"},"89700abd-d3ed-4ead-849c-798ade4720f9":{"description":"No call was queued: the company's billing check refused the call (`deny`), or VoiceAgent is not enabled for the company (`feature_not_enabled`).","content":{"application/problem+json":{"schema":{"type":"object","description":"Error body of `POST /voice-agent/calls` and `POST /voice-agent/outbound/kill` (RFC 9457 problem details). Match on `status` and on `errors[].message`, which carries a stable code (such as `contact_not_found`) for the failures the operation names, `internal_error` on a `500`. Some errors carry no `errors`: a `400` for a missing body or a malformed `voice_agent_id` on a call, and the kill switch's `400` `Invalid request`, `404` and `503`. A malformed `call_number` carries `invalid_call_number`; a missing `voice_agent_id` or `call_number` is a `422` that names the property.","properties":{"title":{"type":"string","description":"HTTP status text.","example":"Unprocessable Entity","uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code.","example":422,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable explanation.","example":"Contact not found","uniqueKey":"detail","typeLabel":"string"},"errors":{"type":"array","description":"Details of the failure.","items":{"type":"object","properties":{"message":{"type":"string","description":"A stable code such as `contact_not_found` or `internal_error`, or the validation message for a request-schema error.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"location":{"type":"string","description":"The request part the error refers to, for example `body.contact_id`. Absent when the error is not about one field.","uniqueKey":"errors.items.[INDEX].location","typeLabel":"string"},"value":{"description":"The value that failed validation, on request-schema errors.","uniqueKey":"errors.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"deny":{"title":"deny","value":{"title":"Forbidden","status":403,"detail":"Billing check failed","errors":[{"message":"deny"}]}},"feature_not_enabled":{"title":"feature_not_enabled","value":{"title":"Forbidden","status":403,"detail":"Feature not enabled","errors":[{"message":"feature_not_enabled"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"61661c64-92fa-49d1-a7c8-3fd3e20e2722":{"description":"No call was queued: `voice_agent_id` names no VoiceAgent of your company (`voice_agent_not_found`).","content":{"application/problem+json":{"schema":{"type":"object","description":"Error body of `POST /voice-agent/calls` and `POST /voice-agent/outbound/kill` (RFC 9457 problem details). Match on `status` and on `errors[].message`, which carries a stable code (such as `contact_not_found`) for the failures the operation names, `internal_error` on a `500`. Some errors carry no `errors`: a `400` for a missing body or a malformed `voice_agent_id` on a call, and the kill switch's `400` `Invalid request`, `404` and `503`. A malformed `call_number` carries `invalid_call_number`; a missing `voice_agent_id` or `call_number` is a `422` that names the property.","properties":{"title":{"type":"string","description":"HTTP status text.","example":"Unprocessable Entity","uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code.","example":422,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable explanation.","example":"Contact not found","uniqueKey":"detail","typeLabel":"string"},"errors":{"type":"array","description":"Details of the failure.","items":{"type":"object","properties":{"message":{"type":"string","description":"A stable code such as `contact_not_found` or `internal_error`, or the validation message for a request-schema error.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"location":{"type":"string","description":"The request part the error refers to, for example `body.contact_id`. Absent when the error is not about one field.","uniqueKey":"errors.items.[INDEX].location","typeLabel":"string"},"value":{"description":"The value that failed validation, on request-schema errors.","uniqueKey":"errors.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"voice_agent_not_found":{"title":"voice_agent_not_found","value":{"title":"Not Found","status":404,"detail":"Voice Agent not found","errors":[{"message":"voice_agent_not_found"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"2802fafc-23b0-48a4-a0dc-33cf23f441b5":{"description":"No call was queued. Either the request body does not match the schema (for example a missing `voice_agent_id` or `call_number`, an invalid `contact_id`, or a property that is not part of this request), or `contact_id` names no contact of your company (`contact_not_found`). A contact that does not exist, belongs to another company or was deleted gets the same response.","content":{"application/problem+json":{"schema":{"type":"object","description":"Error body of `POST /voice-agent/calls` and `POST /voice-agent/outbound/kill` (RFC 9457 problem details). Match on `status` and on `errors[].message`, which carries a stable code (such as `contact_not_found`) for the failures the operation names, `internal_error` on a `500`. Some errors carry no `errors`: a `400` for a missing body or a malformed `voice_agent_id` on a call, and the kill switch's `400` `Invalid request`, `404` and `503`. A malformed `call_number` carries `invalid_call_number`; a missing `voice_agent_id` or `call_number` is a `422` that names the property.","properties":{"title":{"type":"string","description":"HTTP status text.","example":"Unprocessable Entity","uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code.","example":422,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable explanation.","example":"Contact not found","uniqueKey":"detail","typeLabel":"string"},"errors":{"type":"array","description":"Details of the failure.","items":{"type":"object","properties":{"message":{"type":"string","description":"A stable code such as `contact_not_found` or `internal_error`, or the validation message for a request-schema error.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"location":{"type":"string","description":"The request part the error refers to, for example `body.contact_id`. Absent when the error is not about one field.","uniqueKey":"errors.items.[INDEX].location","typeLabel":"string"},"value":{"description":"The value that failed validation, on request-schema errors.","uniqueKey":"errors.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"contact_not_found":{"title":"contact_not_found","value":{"title":"Unprocessable Entity","status":422,"detail":"Contact not found","errors":[{"message":"contact_not_found","location":"body.contact_id"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"3b206fd8-4398-4524-b3af-5c312c7e49bf":{"description":"The call could not be initiated because of an internal failure. `errors[].message` is `internal_error`.","content":{"application/problem+json":{"schema":{"type":"object","description":"Error body of `POST /voice-agent/calls` and `POST /voice-agent/outbound/kill` (RFC 9457 problem details). Match on `status` and on `errors[].message`, which carries a stable code (such as `contact_not_found`) for the failures the operation names, `internal_error` on a `500`. Some errors carry no `errors`: a `400` for a missing body or a malformed `voice_agent_id` on a call, and the kill switch's `400` `Invalid request`, `404` and `503`. A malformed `call_number` carries `invalid_call_number`; a missing `voice_agent_id` or `call_number` is a `422` that names the property.","properties":{"title":{"type":"string","description":"HTTP status text.","example":"Unprocessable Entity","uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code.","example":422,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable explanation.","example":"Contact not found","uniqueKey":"detail","typeLabel":"string"},"errors":{"type":"array","description":"Details of the failure.","items":{"type":"object","properties":{"message":{"type":"string","description":"A stable code such as `contact_not_found` or `internal_error`, or the validation message for a request-schema error.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"location":{"type":"string","description":"The request part the error refers to, for example `body.contact_id`. Absent when the error is not about one field.","uniqueKey":"errors.items.[INDEX].location","typeLabel":"string"},"value":{"description":"The value that failed validation, on request-schema errors.","uniqueKey":"errors.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"internal_error":{"title":"internal_error","value":{"title":"Internal Server Error","status":500,"detail":"Failed to initiate call","errors":[{"message":"internal_error"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"c3eeb712-c983-4706-a5a2-0d7e2a8085da":{"description":"Sent only when the request has `contact_id`: the contact could not be looked up. The call was **not** queued, so the request is safe to retry.","content":{"application/problem+json":{"schema":{"type":"object","description":"Error body of `POST /voice-agent/calls` and `POST /voice-agent/outbound/kill` (RFC 9457 problem details). Match on `status` and on `errors[].message`, which carries a stable code (such as `contact_not_found`) for the failures the operation names, `internal_error` on a `500`. Some errors carry no `errors`: a `400` for a missing body or a malformed `voice_agent_id` on a call, and the kill switch's `400` `Invalid request`, `404` and `503`. A malformed `call_number` carries `invalid_call_number`; a missing `voice_agent_id` or `call_number` is a `422` that names the property.","properties":{"title":{"type":"string","description":"HTTP status text.","example":"Unprocessable Entity","uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code.","example":422,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable explanation.","example":"Contact not found","uniqueKey":"detail","typeLabel":"string"},"errors":{"type":"array","description":"Details of the failure.","items":{"type":"object","properties":{"message":{"type":"string","description":"A stable code such as `contact_not_found` or `internal_error`, or the validation message for a request-schema error.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"location":{"type":"string","description":"The request part the error refers to, for example `body.contact_id`. Absent when the error is not about one field.","uniqueKey":"errors.items.[INDEX].location","typeLabel":"string"},"value":{"description":"The value that failed validation, on request-schema errors.","uniqueKey":"errors.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"contact_lookup_unavailable":{"title":"contact_lookup_unavailable","value":{"title":"Service Unavailable","status":503,"detail":"Contacts service unavailable, the call was NOT queued","errors":[{"message":"contact_lookup_unavailable"}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"6d96e362-8e79-44bd-a2f9-bb735965af53":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic Authentication. Use your API Access Key ID as the username and your API Access Key Secret as the password. Generate keys in the CloudTalk Dashboard under Account -> Settings -> API Keys (https://dashboard.cloudtalk.io/menu/account/settings/API-keys).","scopes":[],"schemeName":"basicAuth"}}},"servers":{"317f5ec1-3723-4ad8-a239-b36525de0e77":{"url":"https://api.cloudtalk.io/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","description":"HTTP Basic Authentication. Use your API Access Key ID as the username and your API Access Key Secret as the password. Generate keys in the CloudTalk Dashboard under Account -> Settings -> API Keys (https://dashboard.cloudtalk.io/menu/account/settings/API-keys).","scopes":[],"schemeName":"basicAuth"},"schema":{"title":"Basic Auth","type":"object","description":"HTTP Basic Authentication. Use your API Access Key ID as the username and your API Access Key Secret as the password. Generate keys in the CloudTalk Dashboard under Account -> Settings -> API Keys (https://dashboard.cloudtalk.io/menu/account/settings/API-keys).","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"basicAuth","name":"Authorization"}],"title":"basicAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"cloudtalk","siteName":"CloudTalk Help Center","title":"Initiate VoiceAgent call - CloudTalk Help Center","relatedPagesConfig":{"enabled":true,"limit":3,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/voiceagent/initiate-voiceagent-call","matchLevel":0},"de":{"href":"/de","matchLevel":4},"es":{"href":"/es","matchLevel":4},"fr":{"href":"/fr","matchLevel":4},"nl":{"href":"/nl","matchLevel":4},"pt":{"href":"/pt","matchLevel":4}}},"lastModified":"2026-11-04T13:03:45.973Z","originalFileLocation":"api-reference/voiceagent/initiate-voiceagent-call.mdx","locale":"en"},"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=\"Creates a new VoiceAgent call with specified parameters and properties. Call properties are optional and can be used to configure the call. The call is queued and dialed shortly after; a 200 means it was queued, not that it was answered. The contact being called. Without contact_id, CloudTalk looks up the dialed call_number among the company\u0026#x27;s contacts and uses the first match; when none matches, or the lookup fails, the call goes ahead without a contact. With contact_id, the call uses exactly that contact and the number is not looked up. The contact fills the {{contact.*}} variables of the prompt, greeting, skills, scenarios and custom tools, appears in the post-call analysis as ct_call_context.contact, and its e-mails are where the calendar invite goes by default. When the agent books on Calendly or Cal.com, the invite goes to the first valid e-mail in the variable the booking skill names (contact.emails unless you change it): a non-empty value you send for that variable in call_properties.system_prompt.variables replaces the contact\u0026#x27;s.\">\u003cmeta data-mint-head name=\"application-name\" content=\"CloudTalk Help Center\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cloudtalk/VvADT62SW6ZfhiGL/_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/cloudtalk/VvADT62SW6ZfhiGL/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cloudtalk/VvADT62SW6ZfhiGL/_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/cloudtalk/VvADT62SW6ZfhiGL/_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/cloudtalk/VvADT62SW6ZfhiGL/_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/cloudtalk/VvADT62SW6ZfhiGL/_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/cloudtalk/VvADT62SW6ZfhiGL/_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/cloudtalk/VvADT62SW6ZfhiGL/_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/cloudtalk/VvADT62SW6ZfhiGL/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Initiate VoiceAgent call - CloudTalk Help Center\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a new VoiceAgent call with specified parameters and properties. Call properties are optional and can be used to configure the call. The call is queued and dialed shortly after; a 200 means it was queued, not that it was answered. The contact being called. Without contact_id, CloudTalk looks up the dialed call_number among the company\u0026#x27;s contacts and uses the first match; when none matches, or the lookup fails, the call goes ahead without a contact. With contact_id, the call uses exactly that contact and the number is not looked up. The contact fills the {{contact.*}} variables of the prompt, greeting, skills, scenarios and custom tools, appears in the post-call analysis as ct_call_context.contact, and its e-mails are where the calendar invite goes by default. When the agent books on Calendly or Cal.com, the invite goes to the first valid e-mail in the variable the booking skill names (contact.emails unless you change it): a non-empty value you send for that variable in call_properties.system_prompt.variables replaces the contact\u0026#x27;s.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"CloudTalk Help Center\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://help.cloudtalk.io/api-reference/voiceagent/initiate-voiceagent-call\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cloudtalk.mintlify.app/_mintlify/api/og/v2?division=VoiceAgent\u0026amp;title=Initiate+VoiceAgent+call\u0026amp;description=Creates+a+new+VoiceAgent+call+with+specified+parameters+and+properties.+Call+properties+are+optional+and+can+be+used+to+configure+the+call.%0A%0AThe+call+is+queued+\u0026amp;theme=1e2a8314c967ca8053f46579\u0026amp;signature=83c1f079470bdfcf925532fbd7b7095fa866d762485ffe95b285ac28f946b4a7\">\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=\"Initiate VoiceAgent call - CloudTalk Help Center\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a new VoiceAgent call with specified parameters and properties. Call properties are optional and can be used to configure the call. The call is queued and dialed shortly after; a 200 means it was queued, not that it was answered. The contact being called. Without contact_id, CloudTalk looks up the dialed call_number among the company\u0026#x27;s contacts and uses the first match; when none matches, or the lookup fails, the call goes ahead without a contact. With contact_id, the call uses exactly that contact and the number is not looked up. The contact fills the {{contact.*}} variables of the prompt, greeting, skills, scenarios and custom tools, appears in the post-call analysis as ct_call_context.contact, and its e-mails are where the calendar invite goes by default. When the agent books on Calendly or Cal.com, the invite goes to the first valid e-mail in the variable the booking skill names (contact.emails unless you change it): a non-empty value you send for that variable in call_properties.system_prompt.variables replaces the contact\u0026#x27;s.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cloudtalk.mintlify.app/_mintlify/api/og/v2?division=VoiceAgent\u0026amp;title=Initiate+VoiceAgent+call\u0026amp;description=Creates+a+new+VoiceAgent+call+with+specified+parameters+and+properties.+Call+properties+are+optional+and+can+be+used+to+configure+the+call.%0A%0AThe+call+is+queued+\u0026amp;theme=1e2a8314c967ca8053f46579\u0026amp;signature=83c1f079470bdfcf925532fbd7b7095fa866d762485ffe95b285ac28f946b4a7\">\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/cloudtalk/VvADT62SW6ZfhiGL/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"CloudTalk Help Center\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0527FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://help.cloudtalk.io/api-reference/voiceagent/initiate-voiceagent-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/voiceagent/initiate-voiceagent-call.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://help.cloudtalk.io/#organization\",\"name\":\"CloudTalk Help Center\",\"url\":\"https://help.cloudtalk.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cloudtalk/M_FX1uE099dO0_78/logo/light.svg?fit=max\u0026auto=format\u0026n=M_FX1uE099dO0_78\u0026q=85\u0026s=9efde0e0ef215d0b41a2f8f92056e144\"}},{\"@type\":\"WebSite\",\"@id\":\"https://help.cloudtalk.io#website\",\"name\":\"CloudTalk Help Center\",\"url\":\"https://help.cloudtalk.io\",\"publisher\":{\"@id\":\"https://help.cloudtalk.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://help.cloudtalk.io/api-reference/voiceagent/initiate-voiceagent-call#webpage\",\"url\":\"https://help.cloudtalk.io/api-reference/voiceagent/initiate-voiceagent-call\",\"name\":\"Initiate VoiceAgent call\",\"description\":\"Creates a new VoiceAgent call with specified parameters and properties. Call properties are optional and can be used to configure the call. The call is queued and dialed shortly after; a 200 means it was queued, not that it was answered. The contact being called. Without contact_id, CloudTalk looks up the dialed call_number among the company's contacts and uses the first match; when none matches, or the lookup fails, the call goes ahead without a contact. With contact_id, the call uses exactly that contact and the number is not looked up. The contact fills the {{contact.*}} variables of the prompt, greeting, skills, scenarios and custom tools, appears in the post-call analysis as ct_call_context.contact, and its e-mails are where the calendar invite goes by default. When the agent books on Calendly or Cal.com, the invite goes to the first valid e-mail in the variable the booking skill names (contact.emails unless you change it): a non-empty value you send for that variable in call_properties.system_prompt.variables replaces the contact's.\",\"dateModified\":\"2026-11-04T13:03:45.973Z\",\"isPartOf\":{\"@id\":\"https://help.cloudtalk.io#website\"},\"breadcrumb\":{\"@id\":\"https://help.cloudtalk.io/api-reference/voiceagent/initiate-voiceagent-call#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://help.cloudtalk.io/api-reference/voiceagent/initiate-voiceagent-call#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://help.cloudtalk.io/api-reference/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Initiate VoiceAgent call\",\"item\":\"https://help.cloudtalk.io/api-reference/voiceagent/initiate-voiceagent-call\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://help.cloudtalk.io/api-reference/voiceagent/initiate-voiceagent-call#apireference\",\"headline\":\"Initiate VoiceAgent call\",\"name\":\"Initiate VoiceAgent call\",\"description\":\"Creates a new VoiceAgent call with specified parameters and properties. Call properties are optional and can be used to configure the call. The call is queued and dialed shortly after; a 200 means it was queued, not that it was answered. The contact being called. Without contact_id, CloudTalk looks up the dialed call_number among the company's contacts and uses the first match; when none matches, or the lookup fails, the call goes ahead without a contact. With contact_id, the call uses exactly that contact and the number is not looked up. The contact fills the {{contact.*}} variables of the prompt, greeting, skills, scenarios and custom tools, appears in the post-call analysis as ct_call_context.contact, and its e-mails are where the calendar invite goes by default. When the agent books on Calendly or Cal.com, the invite goes to the first valid e-mail in the variable the booking skill names (contact.emails unless you change it): a non-empty value you send for that variable in call_properties.system_prompt.variables replaces the contact's.\",\"url\":\"https://help.cloudtalk.io/api-reference/voiceagent/initiate-voiceagent-call\",\"mainEntityOfPage\":{\"@id\":\"https://help.cloudtalk.io/api-reference/voiceagent/initiate-voiceagent-call#webpage\"},\"dateModified\":\"2026-11-04T13:03:45.973Z\",\"publisher\":{\"@id\":\"https://help.cloudtalk.io/#organization\"},\"isPartOf\":{\"@id\":\"https://help.cloudtalk.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"CloudTalk Help Center\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"CloudTalk Help Center","nav":{"global":null,"languages":[{"language":"en","tabs":[{"tab":"Help Center","pages":[{"title":"Help Center","href":"/en"}]},{"tab":"API","groups":[{"group":"Getting Started","pages":[{"title":"CloudTalk Developer Documentation","sidebarTitle":"Home","href":"/developers"},{"title":"CloudTalk REST API: Call Center Automation Platform","sidebarTitle":"Introduction","href":"/guides/introduction"},{"title":"How to Authenticate Requests to the CloudTalk REST API","sidebarTitle":"Authentication","href":"/guides/authentication"},{"title":"Quickstart: Make Your First CloudTalk REST API Call","sidebarTitle":"Quickstart","href":"/guides/quickstart"}]},{"group":"API Concepts","pages":[{"title":"CloudTalk API Response Envelope Formats and Schema","sidebarTitle":"Response Envelopes","href":"/guides/response-envelopes"},{"title":"How to Paginate CloudTalk API Collection Responses","sidebarTitle":"Pagination","href":"/guides/pagination"},{"title":"CloudTalk API Rate Limits, Headers, and Throttling","sidebarTitle":"Rate Limiting","href":"/guides/rate-limiting"},{"title":"CloudTalk API HTTP Error Codes: Causes and Resolutions","sidebarTitle":"Error Codes","href":"/guides/error-codes"}]},{"group":"API Reference","pages":[{"title":"CloudTalk REST API v1.7 — Complete Developer Reference","sidebarTitle":"Overview","href":"/api-reference/overview"},{"group":"CueCard","pages":[{"title":"Create CueCard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /cuecards","href":"/api-reference/cuecard/create-cuecard"}]},{"group":"Agents","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/index.json","href":"/api-reference/agents/list-agents"},{"title":"Add an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /agents/add.json","href":"/api-reference/agents/add-an-agent"},{"title":"Edit an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/edit/{agentId}.json","href":"/api-reference/agents/edit-an-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /agents/delete/{agentId}.json","href":"/api-reference/agents/delete-an-agent"}]},{"group":"Groups","pages":[{"title":"List groups","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /groups/index.json","href":"/api-reference/groups/list-groups"},{"title":"Add agent to group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /groups/add.json","href":"/api-reference/groups/add-agent-to-group"},{"title":"Remove agent from group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /groups/delete/{agent_id}.json","href":"/api-reference/groups/remove-agent-from-group"}]},{"group":"Bulks","pages":[{"title":"Contact actions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /bulk/contacts.json","href":"/api-reference/bulks/contact-actions"}]},{"group":"Campaigns","pages":[{"title":"List campaigns","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/index.json","href":"/api-reference/campaigns/list-campaigns"},{"title":"Add campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /campaigns/add.json","href":"/api-reference/campaigns/add-campaign"},{"title":"Edit campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/edit/{id}.json","href":"/api-reference/campaigns/edit-campaign"},{"title":"Delete campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /campaigns/delete/{id}.json","href":"/api-reference/campaigns/delete-campaign"}]},{"group":"Contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /contacts/index.json","href":"/api-reference/contacts/list-contacts"},{"title":"Add contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /contacts/add.json","href":"/api-reference/contacts/add-contact"},{"title":"Edit contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /contacts/edit/{contactId}.json","href":"/api-reference/contacts/edit-contact"},{"title":"Delete contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /contacts/delete/{contactId}.json","href":"/api-reference/contacts/delete-contact"},{"title":"Inspect a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /contacts/show/{contactId}.json","href":"/api-reference/contacts/inspect-a-contact"},{"title":"Attributes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /contacts/attributes.json","href":"/api-reference/contacts/attributes"},{"title":"Assign contact tags","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /contacts/addTags/{contactId}.json","href":"/api-reference/contacts/assign-contact-tags"},{"title":"Unassign contact tags","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /contacts/removeTags/{contactId}.json","href":"/api-reference/contacts/unassign-contact-tags"},{"title":"List notes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /notes/index.json","href":"/api-reference/contacts/list-notes"},{"title":"Add note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /notes/add/{contactId}.json","href":"/api-reference/contacts/add-note"},{"title":"Edit note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /notes/edit/{noteId}.json","href":"/api-reference/contacts/edit-note"},{"title":"Delete note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /notes/delete/{noteId}.json","href":"/api-reference/contacts/delete-note"},{"title":"List activities","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /activity/index.json","href":"/api-reference/contacts/list-activities"},{"title":"Add activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /activity/add/{contactId}.json","href":"/api-reference/contacts/add-activity"},{"title":"Edit activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /activity/edit/{activityId}.json","href":"/api-reference/contacts/edit-activity"},{"title":"Delete activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /activity/delete/{activityId}.json","href":"/api-reference/contacts/delete-activity"}]},{"group":"Numbers","pages":[{"title":"List numbers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /numbers/index.json","href":"/api-reference/numbers/list-numbers"},{"title":"Edit a number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /numbers/edit/{id}.json","href":"/api-reference/numbers/edit-a-number"},{"title":"Unregister a number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /numbers/clear/{id}.json","href":"/api-reference/numbers/unregister-a-number"}]},{"group":"Utilities","pages":[{"title":"List countries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /countries/index.json","href":"/api-reference/utilities/list-countries"},{"title":"List blacklist","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /blacklist/index.json","href":"/api-reference/utilities/list-blacklist"},{"title":"Add number to blacklist","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /blacklist/add.json","href":"/api-reference/utilities/add-number-to-blacklist"},{"title":"Edit number on blacklist","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /blacklist/edit/{id}.json","href":"/api-reference/utilities/edit-number-on-blacklist"},{"title":"Delete number from blacklist","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /blacklist/delete/{id}.json","href":"/api-reference/utilities/delete-number-from-blacklist"}]},{"group":"Sms","pages":[{"title":"Send sms","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/send.json","href":"/api-reference/sms/send-sms"}]},{"group":"Calls","pages":[{"title":"Call history","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calls/index.json","href":"/api-reference/calls/call-history"},{"title":"Get call details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calls/{callId}","href":"/api-reference/calls/get-call-details"},{"title":"Recording media","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calls/recording/{callId}.json","href":"/api-reference/calls/recording-media"},{"title":"Delete call recording","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /recordings/delete/{callId}.json","href":"/api-reference/calls/delete-call-recording"},{"title":"Make a call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /calls/create.json","href":"/api-reference/calls/make-a-call"},{"title":"Group statistics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /statistics/realtime/groups.json","href":"/api-reference/calls/group-statistics"}]},{"group":"Contact tags","pages":[{"title":"List contact tags","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tags/index.json","href":"/api-reference/contact-tags/list-contact-tags"},{"title":"Add a contact tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /tags/add.json","href":"/api-reference/contact-tags/add-a-contact-tag"},{"title":"Edit a contact tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /tags/edit/{id}.json","href":"/api-reference/contact-tags/edit-a-contact-tag"},{"title":"Delete a contact tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /tags/delete/{id}.json","href":"/api-reference/contact-tags/delete-a-contact-tag"}]},{"group":"Conversation Intelligence","pages":[{"title":"Summary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /ai/calls/{callId}/summary","href":"/api-reference/conversation-intelligence/summary"},{"title":"Overall sentiment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /ai/calls/{callId}/overall-sentiment","href":"/api-reference/conversation-intelligence/overall-sentiment"},{"title":"Talk-listen ratio","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /ai/calls/{callId}/talk-listen-ratio","href":"/api-reference/conversation-intelligence/talk-listen-ratio"},{"title":"Topics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /ai/calls/{callId}/topics","href":"/api-reference/conversation-intelligence/topics"},{"title":"Transcription","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /ai/calls/{callId}/transcription","href":"/api-reference/conversation-intelligence/transcription"},{"title":"Smart notes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /ai/calls/{callId}/smart-notes","href":"/api-reference/conversation-intelligence/smart-notes"},{"title":"Call details link","description":"Returns a link to the call's detail page in CloudTalk analytics.\n\nConversation Intelligence runs on `api.cloudtalk.io/v1` and returns its payload at the top level — these responses are **not** wrapped in the core API's `responseData` envelope.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /ai/calls/{callId}/details-link","href":"/api-reference/conversation-intelligence/call-details-link"}]},{"group":"VoiceAgent","pages":[{"title":"Initiate VoiceAgent call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /voice-agent/calls","href":"/api-reference/voiceagent/initiate-voiceagent-call"},{"title":"Stop outbound VoiceAgent calls","description":"Emergency stop for outbound VoiceAgent dialing.\n\nQueued calls are cancelled and calls already in progress are ended within a few seconds, through the normal call-end path — billing, call records and analytics stay correct. **Inbound calls are unaffected**, as is the outbound traffic of every other company.\n\nThe stop **expires on its own** after `duration_seconds`, so a forgotten stop cannot silence an account indefinitely. Sending the request again overwrites the window; sending `duration_seconds: 0` lifts it early.\n\nBy default the stop covers all of the company's outbound calls. Supply `voice_agent_id` to stop a single VoiceAgent while the others keep dialing.\n\nQueued calls cancelled by a stop are **not dialed later** when the window expires — they are marked declined and removed.\n\nThis endpoint is rate limited to **10 requests per minute per company**, below the API-wide default of 60 — a single request already stops the whole company.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /voice-agent/outbound/kill","href":"/api-reference/voiceagent/stop-outbound-voiceagent-calls"},{"title":"List voice agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /voice-agents","href":"/api-reference/voiceagent/list-voice-agents"},{"title":"Create a voice agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /voice-agents","href":"/api-reference/voiceagent/create-a-voice-agent"},{"title":"Get a voice agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /voice-agents/{voiceAgentId}","href":"/api-reference/voiceagent/get-a-voice-agent"},{"title":"Replace a voice agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /voice-agents/{voiceAgentId}","href":"/api-reference/voiceagent/replace-a-voice-agent"},{"title":"Delete a voice agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /voice-agents/{voiceAgentId}","href":"/api-reference/voiceagent/delete-a-voice-agent"},{"title":"Attach a knowledge base to a voice agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /voice-agents/{voiceAgentId}/knowledge-bases/{knowledgeBaseId}","href":"/api-reference/voiceagent/attach-a-knowledge-base-to-a-voice-agent"},{"title":"Detach a knowledge base from a voice agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /voice-agents/{voiceAgentId}/knowledge-bases/{knowledgeBaseId}","href":"/api-reference/voiceagent/detach-a-knowledge-base-from-a-voice-agent"},{"title":"List knowledge bases","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /knowledge-bases","href":"/api-reference/voiceagent/list-knowledge-bases"},{"title":"Create a knowledge base","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /knowledge-bases","href":"/api-reference/voiceagent/create-a-knowledge-base"},{"title":"Upload a knowledge base file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /knowledge-bases/files","href":"/api-reference/voiceagent/upload-a-knowledge-base-file"},{"title":"Delete a knowledge base","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /knowledge-bases/{knowledgeBaseId}","href":"/api-reference/voiceagent/delete-a-knowledge-base"}]},{"group":"Dialer","pages":[{"title":"List dialer campaigns","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /dialer/campaigns","href":"/api-reference/dialer/list-dialer-campaigns"},{"title":"Create a dialer campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /dialer/campaigns","href":"/api-reference/dialer/create-a-dialer-campaign"},{"title":"Get a dialer campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /dialer/campaigns/{campaignId}","href":"/api-reference/dialer/get-a-dialer-campaign"},{"title":"Delete a dialer campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /dialer/campaigns/{campaignId}","href":"/api-reference/dialer/delete-a-dialer-campaign"},{"title":"Update a dialer campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /dialer/campaigns/{campaignId}","href":"/api-reference/dialer/update-a-dialer-campaign"},{"title":"Get a campaign's associations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /dialer/campaigns/{campaignId}/associations","href":"/api-reference/dialer/get-a-campaigns-associations"},{"title":"Replace a campaign's associations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /dialer/campaigns/{campaignId}/associations","href":"/api-reference/dialer/replace-a-campaigns-associations"},{"title":"Get a campaign's disposition buttons","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /dialer/campaigns/{campaignId}/disposition-buttons","href":"/api-reference/dialer/get-a-campaigns-disposition-buttons"},{"title":"Replace a campaign's disposition buttons","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /dialer/campaigns/{campaignId}/disposition-buttons","href":"/api-reference/dialer/replace-a-campaigns-disposition-buttons"},{"title":"List disposition tags","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /dialer/disposition-tags","href":"/api-reference/dialer/list-disposition-tags"},{"title":"Get a campaign's statistics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /dialer/campaigns/{campaignId}/statistics","href":"/api-reference/dialer/get-a-campaigns-statistics"},{"title":"List a campaign's contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /dialer/campaigns/{campaignId}/contacts","href":"/api-reference/dialer/list-a-campaigns-contacts"},{"title":"Peek at the next contacts to be dialed","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /dialer/campaigns/{campaignId}/contacts/next","href":"/api-reference/dialer/peek-at-the-next-contacts-to-be-dialed"},{"title":"Get one campaign contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /dialer/campaigns/{campaignId}/contacts/{campaignContactId}","href":"/api-reference/dialer/get-one-campaign-contact"},{"title":"Request a campaign data export","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /dialer/campaigns/{campaignId}/exports","href":"/api-reference/dialer/request-a-campaign-data-export"},{"title":"Get an export job's status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /dialer/exports/{jobId}","href":"/api-reference/dialer/get-an-export-jobs-status"},{"title":"Get a download link for a completed export","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /dialer/exports/{jobId}/download","href":"/api-reference/dialer/get-a-download-link-for-a-completed-export"},{"title":"List call scripts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /dialer/scripts","href":"/api-reference/dialer/list-call-scripts"},{"title":"Create a call script","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /dialer/scripts","href":"/api-reference/dialer/create-a-call-script"},{"title":"Get a call script","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /dialer/scripts/{scriptId}","href":"/api-reference/dialer/get-a-call-script"},{"title":"Archive a call script","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /dialer/scripts/{scriptId}","href":"/api-reference/dialer/archive-a-call-script"},{"title":"Update a call script","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /dialer/scripts/{scriptId}","href":"/api-reference/dialer/update-a-call-script"},{"title":"List surveys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /dialer/surveys","href":"/api-reference/dialer/list-surveys"},{"title":"Create a survey","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /dialer/surveys","href":"/api-reference/dialer/create-a-survey"},{"title":"Get a survey","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /dialer/surveys/{surveyId}","href":"/api-reference/dialer/get-a-survey"},{"title":"Rename or archive a survey","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /dialer/surveys/{surveyId}","href":"/api-reference/dialer/rename-or-archive-a-survey"},{"title":"Replace a survey's questions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /dialer/surveys/{surveyId}/questions","href":"/api-reference/dialer/replace-a-surveys-questions"}]},{"group":"Webhooks","pages":[{"title":"List webhook event types","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /webhooks/event-types","href":"/api-reference/webhooks/list-webhook-event-types"},{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /webhooks/endpoints","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /webhooks/endpoints","href":"/api-reference/webhooks/create-a-webhook-endpoint"},{"title":"Get a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /webhooks/endpoints/{endpointId}","href":"/api-reference/webhooks/get-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /webhooks/endpoints/{endpointId}","href":"/api-reference/webhooks/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /webhooks/endpoints/{endpointId}","href":"/api-reference/webhooks/update-a-webhook-endpoint"},{"title":"Get the signing secret","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /webhooks/endpoints/{endpointId}/secret","href":"/api-reference/webhooks/get-the-signing-secret"},{"title":"Rotate the signing secret","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /webhooks/endpoints/{endpointId}/secret/rotate","href":"/api-reference/webhooks/rotate-the-signing-secret"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /webhooks/endpoints/{endpointId}/test","href":"/api-reference/webhooks/send-a-test-event"},{"title":"List deliveries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /webhooks/endpoints/{endpointId}/deliveries","href":"/api-reference/webhooks/list-deliveries"},{"title":"Get a delivery","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /webhooks/endpoints/{endpointId}/deliveries/{deliveryId}","href":"/api-reference/webhooks/get-a-delivery"},{"title":"Retry a delivery","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /webhooks/endpoints/{endpointId}/deliveries/{deliveryId}/retry","href":"/api-reference/webhooks/retry-a-delivery"}]}]}]},{"tab":"Webhooks","pages":[{"title":"Webhooks","href":"/guides/webhooks/overview"}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/guides/mcp/overview"}]},{"tab":"What's new","pages":[{"title":"What's new","href":"/changelog"}]}]},{"language":"de","pages":[{"title":"de","href":"/de"}]},{"language":"es","pages":[{"title":"es","href":"/es"}]},{"language":"fr","pages":[{"title":"fr","href":"/fr"}]},{"language":"nl","pages":[{"title":"nl","href":"/nl"}]},{"language":"pt","pages":[{"title":"pt","href":"/pt"}]}]},"basePath":"","title":"Initiate VoiceAgent call - CloudTalk Help Center","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","Page-Buji1S4J.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","clsx-B2v50t8t.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DJnKvr0g.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BHrrjR1K.js"]}