Programmatically initiate an outbound call from one of your AI assistants to a phone number.This is one of the most powerful features of Burki - it allows you to trigger AI-powered outbound calls from your application logic, enabling use cases like appointment reminders, lead follow-ups, and proactive customer outreach.
You send a request with the source phone number, destination number, and optional customization
Burki resolves the assistant based on your parameters
The call is placed through your configured telephony provider (Twilio, Telnyx, Vonage, or SIP)
Your AI assistant handles the conversation automatically
Multi-Provider Support: This endpoint works with Twilio, Telnyx, Vonage, and BYO SIP Trunk. The system automatically uses the provider configured for the specified from_phone_number.
{ "from_phone_number": "+15551234567", "to_phone_number": "+15559876543", "welcome_message": "Hi! This is Sarah from Acme Corp calling about your recent inquiry."}
{ "from_phone_number": "+15551234567", "to_phone_number": "+15559876543", "welcome_message": "Hello {{name}}, this is a reminder about your {{appointment_type}} appointment tomorrow at {{time}}.", "agenda": "Confirm the appointment with {{name}} and answer any questions they have.", "variables": { "name": "John Smith", "appointment_type": "dental cleaning", "time": "2:30 PM" }}
{"docsConfig":{"theme":"willow","$schema":"https://mintlify.com/docs.json","name":"Burki Voice AI Docs","description":"Documentation for building, configuring, and integrating production-ready Burki voice AI assistants.","colors":{"primary":"#66D38F","light":"#66D38F","dark":"#66D38F"},"logo":{"light":"https://mintcdn.com/burki/Q6QsqhiYx_FQMiPX/logo/light.svg?fit=max\u0026auto=format\u0026n=Q6QsqhiYx_FQMiPX\u0026q=85\u0026s=5a914e25515b826dbae9f93b7c48867b","dark":"https://mintcdn.com/burki/Q6QsqhiYx_FQMiPX/logo/dark.svg?fit=max\u0026auto=format\u0026n=Q6QsqhiYx_FQMiPX\u0026q=85\u0026s=b0554736f8241524d8815cd1f22fbf41"},"favicon":"https://mintcdn.com/burki/Q6QsqhiYx_FQMiPX/favicon.svg?fit=max\u0026auto=format\u0026n=Q6QsqhiYx_FQMiPX\u0026q=85\u0026s=b1d301e705cef0a4cbfa6d2325fe5527","api":{"openapi":"api-reference/openapi.json","playground":{"display":"simple"},"examples":{"defaults":"required","autogenerate":false}},"navbar":{"links":[{"href":"mailto:info@burki.dev","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://burki.dev/dashboard"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/dev-burki"}},"seo":{"metatags":{"og:site_name":"Burki Voice AI Docs","canonical":"https://docs.burki.dev","og:url":"https://docs.burki.dev","og:type":"website"}},"integrations":{"telemetry":{"enabled":false}},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Support","icon":"envelope","href":"mailto:info@burki.dev"},{"anchor":"Community","icon":"discord","href":"https://discord.gg/burki"},{"anchor":"LLMs.txt","icon":"file-text","href":"https://docs.burki.dev/llms.txt"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"burki","hasAudioNarration":false,"actualSubdomain":"burki","customDomains":["docs.burki.dev"],"gitSource":{"type":"github","owner":"meeran03","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ac1d6af1200829d0918ccff","collectionId":"9e3b0f31-ce7d-4acb-86bd-fa2983820c1d","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ac1d6af1200829d0918ccff"},"entitlements":{},"buildId":"6ac1d6af1200829d0918ccff","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"API Reference","count":96},{"language":"default","tag":"Documentation","count":47},{"language":"default","tag":"Campaigns","count":16},{"language":"default","tag":"AI Providers","count":15},{"language":"default","tag":"Features","count":14},{"language":"default","tag":"TTS Providers","count":11},{"language":"default","tag":"Call Data","count":10},{"language":"default","tag":"Calls","count":10},{"language":"default","tag":"Assistants","count":9},{"language":"default","tag":"Messaging","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/calls/initiate","slug":"/api-reference/calls/initiate","pageMetadata":{"title":"Initiate Call","openapi":"POST /calls/initiate","description":"Initiates an outbound call from an assistant to a specified phone number.\nThis endpoint is protected and requires authentication.","href":"/api-reference/calls/initiate"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Initiates an outbound call from an assistant to a specified phone number.\\nThis endpoint is protected and requires authentication.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Info,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Programmatically initiate an outbound call from one of your AI assistants to a phone number.`}),`\n`,_jsx(_components.p,{children:`This is one of the most powerful features of Burki - it allows you to trigger AI-powered outbound calls from your application logic, enabling use cases like appointment reminders, lead follow-ups, and proactive customer outreach.`}),`\n`,_jsx(Heading,{level:`2`,id:`how-it-works`,children:`How It Works`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`You send a request`}),` with the source phone number, destination number, and optional customization`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Burki resolves the assistant`}),` based on your parameters`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`The call is placed`}),` through your configured telephony provider (Twilio, Telnyx, Vonage, or SIP)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Your AI assistant`}),` handles the conversation automatically`]}),`\n`]}),`\n`,_jsx(Info,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Multi-Provider Support`}),`: This endpoint works with Twilio, Telnyx, Vonage, and BYO SIP Trunk. The system automatically uses the provider configured for the specified `,_jsx(_components.code,{children:`from_phone_number`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`request-body`,children:`Request Body`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Parameter`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Required`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`from_phone_number`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Yes`}),_jsx(_components.td,{children:`Phone number to call from (E.164 format). Must be assigned to an assistant or ConversationFlow in your organization.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`to_phone_number`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Yes`}),_jsx(_components.td,{children:`Destination phone number (E.164 format).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`assistant_id`})}),_jsx(_components.td,{children:`integer`}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`Override the default assistant. If not provided, uses the assistant assigned to `,_jsx(_components.code,{children:`from_phone_number`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`welcome_message`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`Custom greeting for this call. Supports `,_jsx(_components.code,{children:`{{variable}}`}),` template syntax.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`agenda`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`Call objective/context for the AI. Supports `,_jsx(_components.code,{children:`{{variable}}`}),` template syntax.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`variables`})}),_jsx(_components.td,{children:`object`}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`Key-value pairs for template substitution in `,_jsx(_components.code,{children:`welcome_message`}),` and `,_jsx(_components.code,{children:`agenda`}),`.`]})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`assistant-resolution`,children:`Assistant Resolution`}),`\n`,_jsx(_components.p,{children:`The system determines which assistant handles the call:`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[_jsxs(_components.strong,{children:[`If `,_jsx(_components.code,{children:`assistant_id`}),` is provided`]}),`: Uses that specific assistant`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`If phone number has a ConversationFlow`}),`: Uses the flow’s base assistant and live flow runtime`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`If phone number has a direct assistant`}),`: Uses the assigned assistant`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`examples`,children:`Examples`}),`\n`,_jsx(Heading,{level:`3`,id:`minimal-request`,children:`Minimal Request`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"from_phone_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"+15551234567\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"to_phone_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"+15559876543\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`with-custom-welcome-message`,children:`With Custom Welcome Message`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"from_phone_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"+15551234567\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"to_phone_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"+15559876543\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"welcome_message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Hi! This is Sarah from Acme Corp calling about your recent inquiry.\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`with-template-variables`,children:`With Template Variables`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`11`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`11`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"from_phone_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"+15551234567\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"to_phone_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"+15559876543\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"welcome_message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Hello {{name}}, this is a reminder about your {{appointment_type}} appointment tomorrow at {{time}}.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"agenda\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Confirm the appointment with {{name}} and answer any questions they have.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"variables\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"John Smith\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"appointment_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"dental cleaning\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"time\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2:30 PM\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`with-assistant-override`,children:`With Assistant Override`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`6`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"from_phone_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"+15551234567\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"to_phone_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"+15559876543\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"assistant_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`456`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"welcome_message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Hi there! I'm calling from our sales team.\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Call initiated successfully\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"call_sid\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"CAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`message`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Status message`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`call_sid`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Unique identifier for the call from your telephony provider`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`error-responses`,children:`Error Responses`}),`\n`,_jsx(Heading,{level:`3`,id:`400-bad-request`,children:`400 Bad Request`}),`\n`,_jsx(_components.p,{children:`Missing or invalid parameters.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"detail\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"from_phone_number is required\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"detail\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Invalid phone number format. Use E.164 format (e.g., +1234567890)\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`402-payment-required`,children:`402 Payment Required`}),`\n`,_jsx(_components.p,{children:`Insufficient account balance.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"detail\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Insufficient balance. Please add funds to continue making calls.\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`403-forbidden`,children:`403 Forbidden`}),`\n`,_jsx(_components.p,{children:`Phone number or assistant doesn’t belong to your organization.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"detail\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Unauthorized: phone number +15551234567 does not belong to your organization\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`404-not-found`,children:`404 Not Found`}),`\n`,_jsx(_components.p,{children:`No assistant found for the phone number.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"detail\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"No assistant found for phone number +15551234567\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`use-cases`,children:`Use Cases`}),`\n`,_jsx(Heading,{level:`3`,id:`appointment-reminders`,children:`Appointment Reminders`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`19`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`19`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`def`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` send_appointment_reminder`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`patient_phone`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`patient_name`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`appointment_time`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`appointment_type`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`):`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` response `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests.post(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.burki.dev/calls/initiate\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` headers`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Authorization\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Bearer YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` json`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"from_phone_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"+15551234567\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"to_phone_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: patient_phone,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"welcome_message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Hello `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{{`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`name`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`, this is a friendly reminder about your `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{{`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`type`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` appointment scheduled for `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{{`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`time`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"agenda\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Confirm the appointment, offer rescheduling if needed, and answer any questions.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"variables\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: patient_name,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: appointment_type,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"time\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: appointment_time`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` )`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` return`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` response.json()`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`lead-follow-up`,children:`Lead Follow-up`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`18`,language:`javascript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`javascript`,children:_jsxs(_components.code,{language:`javascript`,numberOfLines:`18`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` axios`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` require`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'axios'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`);`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`async`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` function`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` followUpWithLead`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`leadPhone`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`leadName`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`productInterest`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`) {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` response`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` axios`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`post`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'https://api.burki.dev/calls/initiate'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` from_phone_number:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '+15551234567'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` to_phone_number:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` leadPhone`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` welcome_message:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:\" `Hi {{name}}! I'm following up on your interest in our {{product}}.`\"}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` agenda:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Qualify the lead, answer questions about the product, and schedule a demo if interested.'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` variables:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` name:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` leadName`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` product:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` productInterest`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }, {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` headers:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Authorization'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Bearer YOUR_API_KEY'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` });`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` `})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` return`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` response`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`data`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`bulk-outreach-with-campaign`,children:`Bulk Outreach with Campaign`}),`\n`,_jsxs(_components.p,{children:[`For large-scale outbound calling, consider using the `,_jsx(_components.a,{href:`/api-reference/campaigns`,children:`Campaigns API`}),` which provides scheduling, retry logic, and analytics.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Initiate Call","openapi":"POST /calls/initiate","description":"Initiates an outbound call from an assistant to a specified phone number.\nThis endpoint is protected and requires authentication.","href":"/api-reference/calls/initiate"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"How It Works","slug":"how-it-works","depth":2,"children":[]},{"title":"Request Body","slug":"request-body","depth":2,"children":[{"title":"Assistant Resolution","slug":"assistant-resolution","depth":3,"children":[]}]},{"title":"Examples","slug":"examples","depth":2,"children":[{"title":"Minimal Request","slug":"minimal-request","depth":3,"children":[]},{"title":"With Custom Welcome Message","slug":"with-custom-welcome-message","depth":3,"children":[]},{"title":"With Template Variables","slug":"with-template-variables","depth":3,"children":[]},{"title":"With Assistant Override","slug":"with-assistant-override","depth":3,"children":[]}]},{"title":"Response","slug":"response","depth":2,"children":[]},{"title":"Error Responses","slug":"error-responses","depth":2,"children":[{"title":"400 Bad Request","slug":"400-bad-request","depth":3,"children":[]},{"title":"402 Payment Required","slug":"402-payment-required","depth":3,"children":[]},{"title":"403 Forbidden","slug":"403-forbidden","depth":3,"children":[]},{"title":"404 Not Found","slug":"404-not-found","depth":3,"children":[]}]},{"title":"Use Cases","slug":"use-cases","depth":2,"children":[{"title":"Appointment Reminders","slug":"appointment-reminders","depth":3,"children":[]},{"title":"Lead Follow-up","slug":"lead-follow-up","depth":3,"children":[]},{"title":"Bulk Outreach with Campaign","slug":"bulk-outreach-with-campaign","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Initiate Outbound Call","description":"Initiates an outbound call from an assistant to a specified phone number.\nThis endpoint is protected and requires authentication.","operationId":"initiate_outbound_call_calls_initiate_post","requestBody":"b05405da-58f6-469e-9df1-84829d5940b8","responses":{"200":"1ad2df98-069d-4cf5-9de1-99d2acc6582b","422":"f76b7aeb-c41d-4e92-8c6c-9e3e596d6f57"},"security":["587513d1-37c3-49a7-b2c8-4e016829a415"],"method":"post","type":"path","servers":[],"path":"/calls/initiate","baseUrlOptions":[],"title":"Initiate Outbound Call","codeSamples":[],"requiredOnlyExamples":true,"disableCodeSampleGeneration":true,"responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"properties":{"to_phone_number":{"type":"string","title":"To Phone Number","isRequired":true,"uniqueKey":"to_phone_number","typeLabel":"string"},"welcome_message":{"oneOf":[{"type":"string","title":"Welcome Message","uniqueKey":"welcome_message.oneOf.0","typeLabel":"string"},{"type":"null","title":"Welcome Message","uniqueKey":"welcome_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"welcome_message","typeLabel":"string | null"},"agenda":{"oneOf":[{"type":"string","title":"Agenda","uniqueKey":"agenda.oneOf.0","typeLabel":"string"},{"type":"null","title":"Agenda","uniqueKey":"agenda.oneOf.1","typeLabel":"null"}],"uniqueKey":"agenda","typeLabel":"string | null"},"from_phone_number":{"oneOf":[{"type":"string","title":"From Phone Number","uniqueKey":"from_phone_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"From Phone Number","uniqueKey":"from_phone_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"from_phone_number","typeLabel":"string | null"},"assistant_id":{"oneOf":[{"type":"integer","title":"Assistant Id","description":"Optional: Override the default assistant attached to the phone number. If not provided, uses the assistant assigned to from_phone_number.","uniqueKey":"assistant_id.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Assistant Id","description":"Optional: Override the default assistant attached to the phone number. If not provided, uses the assistant assigned to from_phone_number.","uniqueKey":"assistant_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"assistant_id","typeLabel":"integer | null"},"variables":{"oneOf":[{"type":"object","title":"Variables","description":"Custom variables for template substitution in welcome_message and agenda using {{variable}} syntax","additionalProperties":true,"uniqueKey":"variables.oneOf.0","typeLabel":"Variables · object"},{"type":"null","title":"Variables","description":"Custom variables for template substitution in welcome_message and agenda using {{variable}} syntax","uniqueKey":"variables.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables","typeLabel":"Variables · object | null"}},"type":"object","required":["to_phone_number"],"title":"InitiateCallRequest","description":"Request model for initiating an outbound call.","uniqueKey":"","typeLabel":"InitiateCallRequest · object"},"examples":{"Example":{"title":"Example","value":{"to_phone_number":"\u003cstring>","welcome_message":"\u003cstring>","agenda":"\u003cstring>","from_phone_number":"\u003cstring>","assistant_id":123,"variables":{}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"1ad2df98-069d-4cf5-9de1-99d2acc6582b":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"message":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"call_sid":{"type":"string","title":"Call Sid","isRequired":true,"uniqueKey":"call_sid","typeLabel":"string"}},"type":"object","required":["message","call_sid"],"title":"InitiateCallResponse","description":"Response model for initiating an outbound call.","uniqueKey":"","typeLabel":"InitiateCallResponse · object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","call_sid":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"f76b7aeb-c41d-4e92-8c6c-9e3e596d6f57":{"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":{"587513d1-37c3-49a7-b2c8-4e016829a415":{"HTTPBearer":{"type":"http","scheme":"bearer","scopes":[]}}},"servers":{},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"HTTPBearer","name":"Authorization"}],"title":"HTTPBearer"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"burki","siteName":"Burki Voice AI Docs","title":"Initiate Call - Burki Voice AI Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-29T14:30:05.958Z","originalFileLocation":"api-reference/calls/initiate.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=\"Initiates an outbound call from an assistant to a specified phone number. This endpoint is protected and requires authentication.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Burki Voice AI 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/burki/B-snvMjZZCD7_1cI/_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/burki/B-snvMjZZCD7_1cI/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/burki/B-snvMjZZCD7_1cI/_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/burki/B-snvMjZZCD7_1cI/_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/burki/B-snvMjZZCD7_1cI/_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/burki/B-snvMjZZCD7_1cI/_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/burki/B-snvMjZZCD7_1cI/_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/burki/B-snvMjZZCD7_1cI/_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/burki/B-snvMjZZCD7_1cI/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Initiate Call - Burki Voice AI Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Initiates an outbound call from an assistant to a specified phone number. This endpoint is protected and requires authentication.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Burki Voice AI Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.burki.dev/api-reference/calls/initiate\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://burki.mintlify.app/_mintlify/api/og/v2?division=Calls\u0026amp;title=Initiate+Call\u0026amp;description=Initiates+an+outbound+call+from+an+assistant+to+a+specified+phone+number.%0AThis+endpoint+is+protected+and+requires+authentication.\u0026amp;theme=38623c0bee154ff5449a96a8\u0026amp;signature=3e0b8c923ed40882e0758a3e8aacbe5999bb3cbfe268f9374ef789fe06d68b6e\">\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 Call - Burki Voice AI Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Initiates an outbound call from an assistant to a specified phone number. This endpoint is protected and requires authentication.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://burki.mintlify.app/_mintlify/api/og/v2?division=Calls\u0026amp;title=Initiate+Call\u0026amp;description=Initiates+an+outbound+call+from+an+assistant+to+a+specified+phone+number.%0AThis+endpoint+is+protected+and+requires+authentication.\u0026amp;theme=38623c0bee154ff5449a96a8\u0026amp;signature=3e0b8c923ed40882e0758a3e8aacbe5999bb3cbfe268f9374ef789fe06d68b6e\">\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/burki/B-snvMjZZCD7_1cI/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Burki Voice AI Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#66D38F\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.burki.dev/api-reference/calls/initiate\">\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/initiate.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.burki.dev/#organization\",\"name\":\"Burki Voice AI Docs\",\"url\":\"https://docs.burki.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/burki/Q6QsqhiYx_FQMiPX/logo/light.svg?fit=max\u0026auto=format\u0026n=Q6QsqhiYx_FQMiPX\u0026q=85\u0026s=5a914e25515b826dbae9f93b7c48867b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.burki.dev#website\",\"name\":\"Burki Voice AI Docs\",\"url\":\"https://docs.burki.dev\",\"publisher\":{\"@id\":\"https://docs.burki.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.burki.dev/api-reference/calls/initiate#webpage\",\"url\":\"https://docs.burki.dev/api-reference/calls/initiate\",\"name\":\"Initiate Call\",\"description\":\"Initiates an outbound call from an assistant to a specified phone number. This endpoint is protected and requires authentication.\",\"dateModified\":\"2026-04-29T14:30:05.958Z\",\"isPartOf\":{\"@id\":\"https://docs.burki.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.burki.dev/api-reference/calls/initiate#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.burki.dev/api-reference/calls/initiate#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Calls\",\"item\":\"https://docs.burki.dev/api-reference/calls/list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Initiate Call\",\"item\":\"https://docs.burki.dev/api-reference/calls/initiate\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.burki.dev/api-reference/calls/initiate#apireference\",\"headline\":\"Initiate Call\",\"name\":\"Initiate Call\",\"description\":\"Initiates an outbound call from an assistant to a specified phone number. This endpoint is protected and requires authentication.\",\"url\":\"https://docs.burki.dev/api-reference/calls/initiate\",\"mainEntityOfPage\":{\"@id\":\"https://docs.burki.dev/api-reference/calls/initiate#webpage\"},\"dateModified\":\"2026-04-29T14:30:05.958Z\",\"publisher\":{\"@id\":\"https://docs.burki.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.burki.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Burki Voice AI Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Burki Voice AI Docs","nav":{"global":{"anchors":[{"anchor":"Support","icon":"envelope","href":"mailto:info@burki.dev"},{"anchor":"Community","icon":"discord","href":"https://discord.gg/burki"},{"anchor":"LLMs.txt","icon":"file-text","href":"https://docs.burki.dev/llms.txt"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"REST API introduction — authentication, base URL \u0026 conventions | Burki Docs","sidebarTitle":"API introduction","href":"/api-reference/introduction"}]},{"group":"Assistants","pages":[{"title":"Create Assistant","openapi":"POST /api/v1/assistants","href":"/api-reference/assistants/create"},{"title":"List Assistants","openapi":"GET /api/v1/assistants","href":"/api-reference/assistants/list"},{"title":"Get Assistant by ID","openapi":"GET /api/v1/assistants/{assistant_id}","href":"/api-reference/assistants/get-by-id"},{"title":"Update Assistant","openapi":"PUT /api/v1/assistants/{assistant_id}","href":"/api-reference/assistants/update"},{"title":"Delete Assistant","openapi":"DELETE /api/v1/assistants/{assistant_id}","href":"/api-reference/assistants/delete"},{"title":null,"href":"/api-reference/assistants/get-count"},{"title":"List Providers","openapi":"GET /api/v1/assistants/providers","href":"/api-reference/assistants/list-providers"},{"title":"Get Organization Info","openapi":"GET /api/v1/assistants/me/organization","href":"/api-reference/assistants/get-organization"},{"title":"Get Assistant by Phone","openapi":"GET /api/v1/assistants/by-phone/{phone_number}","href":"/api-reference/assistants/get-by-phone"}]},{"group":"Assistant Phone Numbers","pages":[{"title":"List Assigned Phone Numbers","openapi":"GET /api/v1/assistants/{assistant_id}/phone-numbers","href":"/api-reference/assistants/phonenumbers/list"},{"title":"List Available Phone Numbers","openapi":"GET /api/v1/assistants/{assistant_id}/available-phone-numbers","href":"/api-reference/assistants/phonenumbers/list-available"},{"title":"Assign Phone Number by String","openapi":"POST /api/v1/assistants/{assistant_id}/phone-numbers/assign-by-number","href":"/api-reference/assistants/phonenumbers/assign-by-number"},{"title":"Bulk Assign Phone Numbers","openapi":"POST /api/v1/assistants/{assistant_id}/phone-numbers/bulk-assign","href":"/api-reference/assistants/phonenumbers/bulk-assign"},{"title":"Unassign Phone Number by String","openapi":"POST /api/v1/assistants/{assistant_id}/phone-numbers/unassign-by-number","href":"/api-reference/assistants/phonenumbers/unassign-by-number"},{"title":"Unassign Phone Number by ID","openapi":"POST /api/v1/assistants/{assistant_id}/phone-numbers/{phone_number_id}/unassign","href":"/api-reference/assistants/phonenumbers/unassign-by-id"}]},{"group":"Assistant Documents (RAG)","pages":[{"title":"Upload Document","openapi":"POST /api/v1/assistants/{assistant_id}/documents/upload","href":"/api-reference/assistants/documents/upload"},{"title":"List Documents","openapi":"GET /api/v1/assistants/{assistant_id}/documents","href":"/api-reference/assistants/documents/list"},{"title":"Get Document Status","openapi":"GET /api/v1/assistants/{assistant_id}/documents/{document_id}/status","href":"/api-reference/assistants/documents/get-status"},{"title":"Delete Document","openapi":"DELETE /api/v1/assistants/{assistant_id}/documents/{document_id}","href":"/api-reference/assistants/documents/delete"}]},{"group":"Voice Cloning","pages":[{"title":"Upload Voice Sample","openapi":"POST /api/v1/assistants/{assistant_id}/voice-samples/upload","href":"/api-reference/assistants/voice-samples/upload"},{"title":"List Voice Samples","openapi":"GET /api/v1/assistants/{assistant_id}/voice-samples","href":"/api-reference/assistants/voice-samples/list"},{"title":"Create Cloned Voice","openapi":"POST /api/v1/assistants/{assistant_id}/cloned-voices/create","href":"/api-reference/assistants/cloned-voices/create"},{"title":"List Cloned Voices","openapi":"GET /api/v1/assistants/{assistant_id}/cloned-voices","href":"/api-reference/assistants/cloned-voices/list"},{"title":"Delete Cloned Voice","openapi":"DELETE /api/v1/assistants/{assistant_id}/cloned-voices/{voice_id}","href":"/api-reference/assistants/cloned-voices/delete"},{"title":"List Voice Cloning Providers","openapi":"GET /api/v1/assistants/{assistant_id}/voice-cloning/providers","href":"/api-reference/assistants/voice-cloning/providers"}]},{"group":"Calls","pages":[{"title":"List Calls","openapi":"GET /api/v1/calls","href":"/api-reference/calls/list"},{"title":"Get Call by ID","openapi":"GET /api/v1/calls/{call_id}","href":"/api-reference/calls/get-by-id"},{"title":"Get Call by SID","openapi":"GET /api/v1/calls/sid/{call_sid}","description":"Get a specific call by Twilio Call SID.\n\nReturns the call details if it belongs to an assistant in your organization.","href":"/api-reference/calls/get-by-sid"},{"title":"Initiate Call","openapi":"POST /calls/initiate","href":"/api-reference/calls/initiate"},{"title":"Terminate Call","openapi":"POST /api/v1/calls/{call_sid}/terminate","description":"Terminate an ongoing call.\n\nThis will hang up the call via the telephony provider (Twilio, Telnyx, or SIP).\nOnly works for calls that are currently in 'ongoing' status.","href":"/api-reference/calls/terminate"},{"title":"Get Call Count","openapi":"GET /api/v1/calls/count","href":"/api-reference/calls/get-count"},{"title":"Filter Calls","openapi":"GET /api/v1/calls","href":"/api-reference/calls/search"},{"title":"Get Call Analytics","openapi":"GET /api/v1/calls/analytics","href":"/api-reference/calls/get-analytics"},{"title":"Get Call Stats","openapi":"GET /api/v1/calls/stats","href":"/api-reference/calls/get-stats"},{"title":"Export Calls","openapi":"GET /api/v1/calls/export","href":"/api-reference/calls/export"}]},{"group":"Messaging","pages":[{"title":"Send SMS","openapi":"POST /sms/send","href":"/api-reference/messaging/send-sms"},{"title":"Get SMS Status","openapi":"GET /sms/{message_id}/status","href":"/api-reference/messaging/get-sms-status"},{"title":"Cancel SMS","openapi":"DELETE /sms/{message_id}","href":"/api-reference/messaging/cancel-sms"},{"title":"SMS Queue Stats","openapi":"GET /sms/queue/stats","href":"/api-reference/messaging/queue-stats"},{"title":"SMS Conversations API","sidebarTitle":"SMS conversations","href":"/api-reference/messaging/sms-conversations"},{"title":"SMS Logs and Debug Timeline","sidebarTitle":"SMS logs","href":"/api-reference/messaging/sms-logs"},{"title":"SMS Compliance API","sidebarTitle":"SMS compliance","href":"/api-reference/messaging/sms-compliance"},{"title":"SMS 10DLC Campaign APIs","sidebarTitle":"SMS 10DLC","href":"/api-reference/messaging/sms-10dlc"}]},{"group":"SIP Trunks","pages":[{"title":"SIP Trunks API","sidebarTitle":"SIP trunks","href":"/api-reference/sip-trunks/overview"}]},{"group":"Billing","pages":[{"title":"Billing API","sidebarTitle":"Billing API","href":"/api-reference/billing/overview"}]},{"group":"Phone Number Management","pages":[{"title":"Search Phone Numbers","openapi":"POST /api/v1/phone-numbers/search","href":"/api-reference/phone-numbers/search"},{"title":"Purchase Phone Number","openapi":"POST /api/v1/phone-numbers/purchase","href":"/api-reference/phone-numbers/purchase"},{"title":"Release Phone Number","openapi":"POST /api/v1/phone-numbers/release","href":"/api-reference/phone-numbers/release"},{"title":"List Country Codes","openapi":"GET /api/v1/phone-numbers/countries","href":"/api-reference/phone-numbers/countries"},{"title":"Update Phone Number Webhooks","openapi":"PUT /api/v1/phone-numbers/webhooks","href":"/api-reference/phone-numbers/update-webhooks"},{"title":"Get Phone Number Webhooks","openapi":"GET /api/v1/phone-numbers/{phone_number}/webhooks","href":"/api-reference/phone-numbers/get-webhooks"}]},{"group":"Call Data","pages":[{"title":"Get Transcripts by Call ID","openapi":"GET /api/v1/calls/{call_id}/transcripts","href":"/api-reference/calls/data/get-transcripts-by-id"},{"title":"Get Transcripts by Call SID","openapi":"GET /api/v1/calls/sid/{call_sid}/transcripts","href":"/api-reference/calls/data/get-transcripts-by-sid"},{"title":"Export Transcripts","openapi":"GET /api/v1/calls/{call_id}/transcripts/export","href":"/api-reference/calls/data/export-transcripts"},{"title":"Get Recordings by Call ID","openapi":"GET /api/v1/calls/{call_id}/recordings","href":"/api-reference/calls/data/get-recordings-by-id"},{"title":"Get Recordings by Call SID","openapi":"GET /api/v1/calls/sid/{call_sid}/recordings","href":"/api-reference/calls/data/get-recordings-by-sid"},{"title":"Play Call Recording","sidebarTitle":"Play recording","href":"/api-reference/calls/data/play-recording"},{"title":"Call Metrics","sidebarTitle":"Call metrics","href":"/api-reference/calls/data/metrics"},{"title":"Get Call Messages","openapi":"GET /api/v1/calls/{call_id}/messages","href":"/api-reference/calls/data/get-messages"},{"title":"Get Webhook Logs","openapi":"GET /api/v1/calls/{call_id}/webhook-logs","href":"/api-reference/calls/data/get-webhook-logs"},{"title":"Update Call Metadata","openapi":"PATCH /api/v1/calls/{call_id}/metadata","href":"/api-reference/calls/data/update-metadata"}]},{"group":"Organization","pages":[{"title":"Account and Organization API","sidebarTitle":"Account \u0026 organization","href":"/api-reference/account/overview"},{"title":"Sync Phone Numbers","openapi":"POST /api/v1/assistants/organization/phone-numbers/sync","href":"/api-reference/organization/sync-phonenumbers"},{"title":"List Organization Phone Numbers","openapi":"GET /api/v1/assistants/organization/phone-numbers","href":"/api-reference/organization/list-phonenumbers"},{"title":"List Available Phone Numbers","openapi":"GET /api/v1/assistants/organization/phone-numbers/available","href":"/api-reference/organization/list-available-phonenumbers"}]},{"group":"Webhooks \u0026 System","pages":[{"title":"Twilio TwiML Webhook","openapi":"POST /twiml","href":"/api-reference/webhooks/twilio-twiml"},{"title":"SMS Webhooks","href":"/api-reference/webhooks/sms-webhooks"},{"title":"SIP Webhooks and Prewarm","sidebarTitle":"SIP webhooks","href":"/api-reference/webhooks/sip-webhooks"},{"title":"Recording Status Webhook","openapi":"POST /recording-status","href":"/api-reference/webhooks/recording-status"},{"title":"Initiate Outbound Call","openapi":"POST /calls/initiate","href":"/api-reference/webhooks/initiate-call"}]},{"group":"Campaigns","pages":[{"title":"List Campaigns","openapi":"GET /api/v1/campaigns","href":"/api-reference/campaigns/list"},{"title":"Create Campaign","openapi":"POST /api/v1/campaigns","href":"/api-reference/campaigns/create"},{"title":"Get Campaign","openapi":"GET /api/v1/campaigns/{campaign_id}","href":"/api-reference/campaigns/get"},{"title":"Update Campaign","openapi":"PUT /api/v1/campaigns/{campaign_id}","href":"/api-reference/campaigns/update"},{"title":"Delete Campaign","openapi":"DELETE /api/v1/campaigns/{campaign_id}","href":"/api-reference/campaigns/delete"},{"title":"Start Campaign","openapi":"POST /api/v1/campaigns/{campaign_id}/start","href":"/api-reference/campaigns/start"},{"title":"Pause Campaign","openapi":"POST /api/v1/campaigns/{campaign_id}/pause","href":"/api-reference/campaigns/pause"},{"title":"Stop Campaign","openapi":"POST /api/v1/campaigns/{campaign_id}/stop","href":"/api-reference/campaigns/stop"},{"title":"Re-execute Campaign","openapi":"POST /api/v1/campaigns/{campaign_id}/re-execute","href":"/api-reference/campaigns/re-execute"},{"title":"List Campaign Contacts","openapi":"GET /api/v1/campaigns/{campaign_id}/contacts","href":"/api-reference/campaigns/contacts"},{"title":"Import Campaign Contacts","openapi":"POST /api/v1/campaigns/{campaign_id}/import-data","href":"/api-reference/campaigns/import-data"},{"title":"Get Campaign Progress","openapi":"GET /api/v1/campaigns/{campaign_id}/progress","href":"/api-reference/campaigns/progress"},{"title":"Get Campaign Executions","openapi":"GET /api/v1/campaigns/{campaign_id}/executions","href":"/api-reference/campaigns/executions"},{"title":"Get Campaign Schedule","openapi":"GET /api/v1/campaigns/{campaign_id}/schedule","href":"/api-reference/campaigns/schedule-get"},{"title":"Save Campaign Schedule","openapi":"POST /api/v1/campaigns/{campaign_id}/schedule","href":"/api-reference/campaigns/schedule-save"},{"title":"Preview Template","openapi":"POST /api/v1/campaigns/template-preview","href":"/api-reference/campaigns/template-preview"}]},{"group":"WebSockets","pages":[{"title":"Live transcript WebSocket API — endpoint, auth \u0026 message formats | Burki Docs","sidebarTitle":"Live transcript WebSocket API","href":"/api-reference/websockets/live-transcript"},{"title":"Campaign Progress WebSocket","href":"/api-reference/websockets/campaign-progress"}]},{"group":"Tools \u0026 Custom Actions","pages":[{"title":"Create Tool","openapi":"POST /api/v1/tools","href":"/api-reference/tools/create"},{"title":"List Tools","openapi":"GET /api/v1/tools","href":"/api-reference/tools/list"},{"title":"Get Tool by ID","openapi":"GET /api/v1/tools/{tool_id}","href":"/api-reference/tools/get-by-id"},{"title":"Assign Tool to Assistant","openapi":"POST /api/v1/tools/{tool_id}/assign","href":"/api-reference/tools/assign"},{"title":"Discover Lambda Functions","openapi":"POST /api/lambda/list-functions","href":"/api-reference/tools/discover-lambda"}]},{"group":"Conversation Flows","pages":[{"title":"Conversation Flows API","href":"/api-reference/flows/overview"}]},{"group":"Learning \u0026 Memory","pages":[{"title":"Learning and Memory API","sidebarTitle":"Learning \u0026 memory","href":"/api-reference/learning/overview"}]}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/sdks/overview"}]}]},"basePath":"","title":"Initiate Call - Burki Voice AI Docs","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"]}