{ "error": "Invalid request data", "details": [ { "field": "customerName", "message": "Customer name must be at most 40 characters", "code": "too_big" } ]}
{ "error": "Assistant not found"}
Outbound calls
Create outbound call
Starts a phone call to one number with one of a clinic’s AI agents.
{ "error": "Invalid request data", "details": [ { "field": "customerName", "message": "Customer name must be at most 40 characters", "code": "too_big" } ]}
{ "error": "Assistant not found"}
Starts one outbound call. AlloMia checks the request, records the call and starts dialing before it answers. The call belongs to the clinic that owns the number you call from (phoneNumberId).See Outbound calls for how a call goes from start to result.
Before you start
The right key. Use a clinic key created by the clinic’s owner or by a Tenant Admin of your partner account, or a partner key created by the partner account’s owner or by a Tenant Admin. Any other key gets 403 Insufficient permissions. If the clinic creates the key, send its owner to Keys for connecting other software.
An AI agent set up for this call. Its instructions say what to do on the call.
The IDs of the agent and of the clinic number to call from. See Finding IDs.
Each request starts a new call. If a request times out, check before you send it again: the call may already be under way.
Headers
string
required
Bearer followed by your API key, for example Bearer sk-....
string
application/json.
Body
string
required
The number to call. Send it in E.164 format, such as +15145550187. See Phone number format for what else AlloMia accepts.
10 to 20 characters.
Only digits, spaces, +, -, ( and ).
10 to 15 digits.
string
required
The ID (UUID) of the AI agent that makes the call. It must belong to the same clinic as phoneNumberId.
string
required
The ID (UUID) of the clinic number to call from. The person called sees this number. It must be a phone number: a SIP address can’t be used. With a clinic key, the number must belong to that clinic. With a partner key, it must belong to a clinic in your partner account.
string
The name of the person you’re calling, up to 40 characters. AlloMia keeps it with the call request. The AI agent doesn’t see it: to let the agent use the name, also send it in dynamicVariables.
object
Details for this call, as an object whose keys and values are all strings. See Dynamic variables.
{ "first_name": "Jane", "appointment_date": "Tuesday, October 14 at 2:00 PM"}
string
A URL where AlloMia sends the result when the call reaches a final status. Use an HTTPS URL. See Call-completed callback.
Phone number format
AlloMia removes spaces, dashes and parentheses, then:
A number that starts with + is used as is.
Otherwise, leading zeros are dropped. A 10-digit number gets +1 in front (Canada and the US). An 11-digit number that starts with 1 gets + in front. Any other number gets + in front, so AlloMia reads its first digits as a country code.
You send
AlloMia dials
5145550187
+15145550187
(514) 555-0187
+15145550187
1-514-555-0187
+15145550187
0015145550187
+15145550187
+33 6 12 34 56 78
+33612345678
33612345678
+33612345678
To avoid surprises, always send E.164 with the country code.
Dynamic variables
Each key in dynamicVariables becomes a variable in the AI agent’s instructions. Where the instructions contain the key between double curly braces, AlloMia puts the value in its place. For example, with "first_name": "Jane", the text {{ first_name }} in the instructions becomes Jane.
Variables work in the agent’s instructions. A fixed greeting is spoken exactly as written: variables in it aren’t replaced.
Which keys the agent expects depends on how its instructions are written. Agree on the names with whoever set up the agent.
Don’t use the keys now, date, time, month, day, year or customer. AlloMia uses those names for built-in variables.
The callback sends your dynamicVariables back to you, so you can use them to match the result to your own records.
calling when AlloMia started dialing. failed when the call couldn’t be placed.
string
Outbound call dispatched with calling. Outbound call failed to dispatch with failed.
A call that can’t be placed still returns HTTP 200, with "status": "failed". Always check status. No callback follows a failed response. Check the number you call from, then try again.
Errors
Status
error
When
400
Invalid request data
A field is missing or invalid. details lists each problem with its field, message and code.
401
Unauthorized
The key is missing, wrong or deleted.
403
Insufficient permissions
The key wasn’t created by someone allowed to start calls. See Before you start.
404
Phone number not found
phoneNumberId doesn’t exist, or belongs to a clinic your key can’t use.
404
Assistant not found
assistantId doesn’t exist, or belongs to another clinic than phoneNumberId.
This number cannot be used as an outbound caller ID. Choose a PSTN phone number.
phoneNumberId is a SIP address, not a phone number.
500
Phone number format is invalid. Please provide a valid E.164 formatted number (e.g., +15145551234).
phoneNumber isn’t a valid number once formatted, for example +0123456789.
500
Internal server error
The body isn’t valid JSON.
500
Other messages
Something went wrong on AlloMia’s side.
The three request problems above come back as 500 today, not as 4xx. Read the error message to tell them apart from a fault on AlloMia’s side. See Errors for the error format.
{ "error": "Invalid request data", "details": [ { "field": "customerName", "message": "Customer name must be at most 40 characters", "code": "too_big" } ]}
{ "error": "Assistant not found"}
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"AlloMia API Documentation","colors":{"primary":"#0A74DA","light":"#4299E1","dark":"#2B6CB0"},"logo":{"light":"https://mintcdn.com/allomia-dcfc501a/63lasYG0rgJFLjIc/logo/light.svg?fit=max\u0026auto=format\u0026n=63lasYG0rgJFLjIc\u0026q=85\u0026s=900c98f2940cc700233cd2eb0805d036","dark":"https://mintcdn.com/allomia-dcfc501a/63lasYG0rgJFLjIc/logo/dark.svg?fit=max\u0026auto=format\u0026n=63lasYG0rgJFLjIc\u0026q=85\u0026s=6e7681291bfbca9de051c56e2e6039dc"},"favicon":"https://mintcdn.com/allomia-dcfc501a/RwrqresnfxaDCl_q/favicon.svg?fit=max\u0026auto=format\u0026n=RwrqresnfxaDCl_q\u0026q=85\u0026s=06dea03ef4389e69a3728e60c558cad9","api":{"mdx":{"server":"https://allomia.com"}},"navbar":{"links":[{"href":"https://allomia.com/en/help-center","label":"Help Center"},{"href":"mailto:support@medfarsolutions.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://allomia.com/en/login"}},"footer":{"socials":{"x":"https://x.com/allomia_ai","youtube":"https://youtube.com/@allomia_ai","linkedin":"https://linkedin.com/company/allomia"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Help Center","icon":"life-ring","href":"https://allomia.com/en/help-center"},{"anchor":"AlloMia Website","icon":"globe","href":"https://allomia.com"},{"anchor":"Contact Support","icon":"envelope","href":"mailto:support@medfarsolutions.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"allomia-dcfc501a","hasAudioNarration":false,"actualSubdomain":"allomia-dcfc501a","customDomains":["docs.allomia.com"],"gitSource":{"type":"github","owner":"allomia","repo":"allomia-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae4245919da8bc2fe38177f","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"Organizations (partner keys)","count":7},{"language":"default","tag":"Get started","count":5},{"language":"default","tag":"Outbound calls","count":4},{"language":"default","tag":"Calls","count":3}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"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":"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":"editor-metadata","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":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","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}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":".mintlify-logo{transform:scale(1.5);transform-origin:left center}nav{padding-top:0.5rem;padding-bottom:0.5rem}"}],"page":{"pagePath":"api-reference/endpoint/create-outbound-call","slug":"/api-reference/endpoint/create-outbound-call","pageMetadata":{"title":"Create outbound call","api":"POST /api/outbound","description":"Starts a phone call to one number with one of a clinic's AI agents.","href":"/api-reference/endpoint/create-outbound-call"},"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: \"Starts a phone call to one number with one of a clinic’s AI agents.\"\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`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,ParamField,ResponseField,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Starts one outbound call. AlloMia checks the request, records the call and starts dialing before it answers. The call belongs to the clinic that owns the number you call from (`,_jsx(_components.code,{children:`phoneNumberId`}),`).`]}),`\n`,_jsxs(_components.p,{children:[`See `,_jsx(_components.a,{href:`/api-reference/outbound-calls`,children:`Outbound calls`}),` for how a call goes from start to result.`]}),`\n`,_jsx(Heading,{level:`3`,id:`before-you-start`,children:`Before you start`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`The right key.`}),` Use a clinic key created by the clinic’s owner or by a Tenant Admin of your partner account, or a partner key created by the partner account’s owner or by a Tenant Admin. Any other key gets `,_jsx(_components.code,{children:`403 Insufficient permissions`}),`. If the clinic creates the key, send its owner to `,_jsx(_components.a,{href:`https://allomia.com/en/help-center/how-to/tools-and-actions/keys-for-connecting-other-software`,children:`Keys for connecting other software`}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`An AI agent set up for this call.`}),` Its instructions say what to do on the call.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`The IDs`}),` of the agent and of the clinic number to call from. See `,_jsx(_components.a,{href:`/api-reference/finding-ids`,children:`Finding IDs`}),`.`]}),`\n`]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Each request starts a new call. If a request times out, check before you send it again: the call may already be under way.`})}),`\n`,_jsx(Heading,{level:`3`,id:`headers`,children:`Headers`}),`\n`,_jsx(ParamField,{header:`Authorization`,type:`string`,required:true,id:`param-authorization`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`Bearer`}),` followed by your API key, for example `,_jsx(_components.code,{children:`Bearer sk-...`}),`.`]})}),`\n`,_jsx(ParamField,{header:`Content-Type`,type:`string`,id:`param-content-type`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`application/json`}),`.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`body`,children:`Body`}),`\n`,_jsxs(ParamField,{body:`phoneNumber`,type:`string`,required:true,id:`param-phone-number`,children:[_jsxs(_components.p,{children:[`The number to call. Send it in E.164 format, such as `,_jsx(_components.code,{children:`+15145550187`}),`. See `,_jsx(_components.a,{href:`#phone-number-format`,children:`Phone number format`}),` for what else AlloMia accepts.`]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`10 to 20 characters.`}),`\n`,_jsxs(_components.li,{children:[`Only digits, spaces, `,_jsx(_components.code,{children:`+`}),`, `,_jsx(_components.code,{children:`-`}),`, `,_jsx(_components.code,{children:`(`}),` and `,_jsx(_components.code,{children:`)`}),`.`]}),`\n`,_jsx(_components.li,{children:`10 to 15 digits.`}),`\n`]})]}),`\n`,_jsx(ParamField,{body:`assistantId`,type:`string`,required:true,id:`param-assistant-id`,children:_jsxs(_components.p,{children:[`The ID (UUID) of the AI agent that makes the call. It must belong to the same clinic as `,_jsx(_components.code,{children:`phoneNumberId`}),`.`]})}),`\n`,_jsx(ParamField,{body:`phoneNumberId`,type:`string`,required:true,id:`param-phone-number-id`,children:_jsx(_components.p,{children:`The ID (UUID) of the clinic number to call from. The person called sees this number. It must be a phone number: a SIP address can’t be used. With a clinic key, the number must belong to that clinic. With a partner key, it must belong to a clinic in your partner account.`})}),`\n`,_jsx(ParamField,{body:`customerName`,type:`string`,id:`param-customer-name`,children:_jsxs(_components.p,{children:[`The name of the person you’re calling, up to 40 characters. AlloMia keeps it with the call request. The AI agent doesn’t see it: to let the agent use the name, also send it in `,_jsx(_components.code,{children:`dynamicVariables`}),`.`]})}),`\n`,_jsxs(ParamField,{body:`dynamicVariables`,type:`object`,id:`param-dynamic-variables`,children:[_jsxs(_components.p,{children:[`Details for this call, as an object whose keys and values are all strings. See `,_jsx(_components.a,{href:`#dynamic-variables`,children:`Dynamic variables`}),`.`]}),_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:` \"first_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Jane\"`}),_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_date\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Tuesday, October 14 at 2:00 PM\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]}),`\n`,_jsx(ParamField,{body:`callbackUrl`,type:`string`,id:`param-callback-url`,children:_jsxs(_components.p,{children:[`A URL where AlloMia sends the result when the call reaches a final status. Use an HTTPS URL. See `,_jsx(_components.a,{href:`/api-reference/webhooks`,children:`Call-completed callback`}),`.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`phone-number-format`,children:`Phone number format`}),`\n`,_jsx(_components.p,{children:`AlloMia removes spaces, dashes and parentheses, then:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`A number that starts with `,_jsx(_components.code,{children:`+`}),` is used as is.`]}),`\n`,_jsxs(_components.li,{children:[`Otherwise, leading zeros are dropped. A 10-digit number gets `,_jsx(_components.code,{children:`+1`}),` in front (Canada and the US). An 11-digit number that starts with `,_jsx(_components.code,{children:`1`}),` gets `,_jsx(_components.code,{children:`+`}),` in front. Any other number gets `,_jsx(_components.code,{children:`+`}),` in front, so AlloMia reads its first digits as a country code.`]}),`\n`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`You send`}),_jsx(_components.th,{children:`AlloMia dials`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`5145550187`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`+15145550187`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`(514) 555-0187`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`+15145550187`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`1-514-555-0187`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`+15145550187`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`0015145550187`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`+15145550187`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`+33 6 12 34 56 78`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`+33612345678`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`33612345678`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`+33612345678`})})]})]})]}),`\n`,_jsx(_components.p,{children:`To avoid surprises, always send E.164 with the country code.`}),`\n`,_jsx(Heading,{level:`3`,id:`dynamic-variables`,children:`Dynamic variables`}),`\n`,_jsxs(_components.p,{children:[`Each key in `,_jsx(_components.code,{children:`dynamicVariables`}),` becomes a variable in the AI agent’s instructions. Where the instructions contain the key between double curly braces, AlloMia puts the value in its place. For example, with `,_jsx(_components.code,{children:`\"first_name\": \"Jane\"`}),`, the text `,_jsx(_components.code,{children:`{{ first_name }}`}),` in the instructions becomes `,_jsx(_components.code,{children:`Jane`}),`.`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Variables work in the agent’s instructions. A fixed greeting is spoken exactly as written: variables in it aren’t replaced.`}),`\n`,_jsx(_components.li,{children:`Which keys the agent expects depends on how its instructions are written. Agree on the names with whoever set up the agent.`}),`\n`,_jsxs(_components.li,{children:[`Don’t use the keys `,_jsx(_components.code,{children:`now`}),`, `,_jsx(_components.code,{children:`date`}),`, `,_jsx(_components.code,{children:`time`}),`, `,_jsx(_components.code,{children:`month`}),`, `,_jsx(_components.code,{children:`day`}),`, `,_jsx(_components.code,{children:`year`}),` or `,_jsx(_components.code,{children:`customer`}),`. AlloMia uses those names for built-in variables.`]}),`\n`,_jsxs(_components.li,{children:[`The callback sends your `,_jsx(_components.code,{children:`dynamicVariables`}),` back to you, so you can use them to match the result to your own records.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`outboundCallId`,type:`string`,id:`param-outbound-call-id`,children:_jsxs(_components.p,{children:[`The call’s ID. Use it with `,_jsx(_components.a,{href:`/api-reference/endpoint/get-outbound-call-status`,children:`Get outbound call status`}),`. The callback carries it too.`]})}),`\n`,_jsx(ResponseField,{name:`contactId`,type:`string`,id:`param-contact-id`,children:_jsx(_components.p,{children:`The ID of the person called, within this call.`})}),`\n`,_jsx(ResponseField,{name:`status`,type:`string`,id:`param-status`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`calling`}),` when AlloMia started dialing. `,_jsx(_components.code,{children:`failed`}),` when the call couldn’t be placed.`]})}),`\n`,_jsx(ResponseField,{name:`message`,type:`string`,id:`param-message`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`Outbound call dispatched`}),` with `,_jsx(_components.code,{children:`calling`}),`. `,_jsx(_components.code,{children:`Outbound call failed to dispatch`}),` with `,_jsx(_components.code,{children:`failed`}),`.`]})}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`A call that can’t be placed still returns HTTP 200, with `,_jsx(_components.code,{children:`\"status\": \"failed\"`}),`. Always check `,_jsx(_components.code,{children:`status`}),`. No callback follows a `,_jsx(_components.code,{children:`failed`}),` response. Check the number you call from, then try again.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`errors`,children:`Errors`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:_jsx(_components.code,{children:`error`})}),_jsx(_components.th,{children:`When`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`Invalid request data`})}),_jsxs(_components.td,{children:[`A field is missing or invalid. `,_jsx(_components.code,{children:`details`}),` lists each problem with its `,_jsx(_components.code,{children:`field`}),`, `,_jsx(_components.code,{children:`message`}),` and `,_jsx(_components.code,{children:`code`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`401`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`Unauthorized`})}),_jsx(_components.td,{children:`The key is missing, wrong or deleted.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`403`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`Insufficient permissions`})}),_jsxs(_components.td,{children:[`The key wasn’t created by someone allowed to start calls. See `,_jsx(_components.a,{href:`#before-you-start`,children:`Before you start`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`404`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`Phone number not found`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`phoneNumberId`}),` doesn’t exist, or belongs to a clinic your key can’t use.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`404`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`Assistant not found`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`assistantId`}),` doesn’t exist, or belongs to another clinic than `,_jsx(_components.code,{children:`phoneNumberId`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`422`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`Organization is inactive or not found`})}),_jsxs(_components.td,{children:[`The clinic that owns `,_jsx(_components.code,{children:`phoneNumberId`}),` isn’t active.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`429`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`Too many requests`})}),_jsxs(_components.td,{children:[`You sent too many requests. See `,_jsx(_components.a,{href:`/api-reference/rate-limits`,children:`Rate limits`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`500`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`This number cannot be used as an outbound caller ID. Choose a PSTN phone number.`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`phoneNumberId`}),` is a SIP address, not a phone number.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`500`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`Phone number format is invalid. Please provide a valid E.164 formatted number (e.g., +15145551234).`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`phoneNumber`}),` isn’t a valid number once formatted, for example `,_jsx(_components.code,{children:`+0123456789`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`500`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`Internal server error`})}),_jsx(_components.td,{children:`The body isn’t valid JSON.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`500`}),_jsx(_components.td,{children:`Other messages`}),_jsx(_components.td,{children:`Something went wrong on AlloMia’s side.`})]})]})]}),`\n`,_jsxs(_components.p,{children:[`The three request problems above come back as 500 today, not as 4xx. Read the `,_jsx(_components.code,{children:`error`}),` message to tell them apart from a fault on AlloMia’s side. See `,_jsx(_components.a,{href:`/api-reference/errors`,children:`Errors`}),` for the error format.`]})]})}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":"Create outbound call","api":"POST /api/outbound","description":"Starts a phone call to one number with one of a clinic's AI agents.","href":"/api-reference/endpoint/create-outbound-call"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[388,397,"questExample,ResponseExample,ResponseFie"],[590,602,"questExample)_missingMdxReference(`RequestExample`,true);if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);if(!ResponseField)"],[17022,17450,",`\n`,_jsx(RequestExample,{children:_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`14`,language:`shellscript`,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:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`14`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://allomia.com/api/outbound\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer sk-...\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"phoneNumber\": \"+15145550187\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"assistantId\": \"34042575-74d3-4588-a3d9-8773aab96a9b\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"phoneNumberId\": \"d5d3c6cb-d0ac-4068-ace4-1b5af3fbad20\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"customerName\": \"Jane Smith\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"dynamicVariables\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"first_name\": \"Jane\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"appointment_date\": \"Tuesday, October 14 at 2:00 PM\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"callbackUrl\": \"https://partner.example.com/allomia/call-completed\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})})}),`\n`,_jsxs(ResponseExample,{children:[_jsx(CodeBlock,{filename:`200 calling`,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:` \"outboundCallId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"6ba6543b-8071-4228-a168-eaadb4f27144\"`}),_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:` \"contactId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"cd773470-1e07-49a1-beb9-ed02c3fcb129\"`}),_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:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"calling\"`}),_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:`\"Outbound call dispatched\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`200 failed`,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:` \"outboundCallId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"6ba6543b-8071-4228-a168-eaadb4f27144\"`}),_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:` \"contactId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"cd773470-1e07-49a1-beb9-ed02c3fcb129\"`}),_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:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"failed\"`}),_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:`\"Outbound call failed to dispatch\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`400`,numberOfLines:`10`,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:`10`,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:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Invalid request data\"`}),_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:` \"details\"`}),_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:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"field\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"customerName\"`}),_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:`\"Customer name must be at most 40 characters\"`}),_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:` \"code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"too_big\"`})]}),`\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`]})})}),_jsx(CodeBlock,{filename:`404`,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:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Assistant not found\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]})]})}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.\")}"]]},"mdxExtracts":{"tableOfContents":[{"title":"Before you start","slug":"before-you-start","depth":3,"children":[]},{"title":"Headers","slug":"headers","depth":3,"children":[]},{"title":"Body","slug":"body","depth":3,"children":[]},{"title":"Phone number format","slug":"phone-number-format","depth":3,"children":[]},{"title":"Dynamic variables","slug":"dynamic-variables","depth":3,"children":[]},{"title":"Response","slug":"response","depth":3,"children":[]},{"title":"Errors","slug":"errors","depth":3,"children":[]}],"codeExamples":{"request":{"type":"RequestExample","children":[{"filename":"cURL","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"shellscript\">\u003ccode language=\"shellscript\" numberOfLines=\"14\">\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#DCDCAA\">curl\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -X\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> POST\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"https://allomia.com/api/outbound\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -H\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"Authorization: Bearer sk-...\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -H\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"Content-Type: application/json\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -d\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> '{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"phoneNumber\": \"+15145550187\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"assistantId\": \"34042575-74d3-4588-a3d9-8773aab96a9b\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"phoneNumberId\": \"d5d3c6cb-d0ac-4068-ace4-1b5af3fbad20\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"customerName\": \"Jane Smith\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"dynamicVariables\": {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"first_name\": \"Jane\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"appointment_date\": \"Tuesday, October 14 at 2:00 PM\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"callbackUrl\": \"https://partner.example.com/allomia/call-completed\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }'\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]},"response":{"type":"ResponseExample","children":[{"filename":"200 calling","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"6\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"outboundCallId\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"6ba6543b-8071-4228-a168-eaadb4f27144\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"contactId\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"cd773470-1e07-49a1-beb9-ed02c3fcb129\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"status\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"calling\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"message\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Outbound call dispatched\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"200 failed","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"6\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"outboundCallId\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"6ba6543b-8071-4228-a168-eaadb4f27144\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"contactId\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"cd773470-1e07-49a1-beb9-ed02c3fcb129\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"status\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"failed\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"message\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Outbound call failed to dispatch\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"400","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"10\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"error\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Invalid request data\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"details\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"field\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"customerName\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"message\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Customer name must be at most 40 characters\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"code\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"too_big\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> ]\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"404","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"3\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"error\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Assistant not found\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}},"endpoint":{"title":"Create outbound call","path":"/api/outbound","servers":[{"url":"https://allomia.com"}],"method":"post","request":{"security":[],"parameters":{"query":{},"header":{"Authorization":{"schema":[{"type":"string","description":"`Bearer` followed by your API key, for example `Bearer sk-...` .","required":true}]},"Content-Type":{"schema":[{"type":"string","description":"`application/json` ."}]}},"cookie":{},"path":{}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"phoneNumber":[{"type":"string","description":"The number to call. Send it in E.164 format, such as `+15145550187` . See Phone number format for what else AlloMia accepts. 10 to 20 characters. Only digits, spaces, `+` , `-` , `(` and `)` . 10 to 15 digits.","required":true}],"assistantId":[{"type":"string","description":"The ID (UUID) of the AI agent that makes the call. It must belong to the same clinic as `phoneNumberId` .","required":true}],"phoneNumberId":[{"type":"string","description":"The ID (UUID) of the clinic number to call from. The person called sees this number. It must be a phone number: a SIP address can’t be used. With a clinic key, the number must belong to that clinic. With a partner key, it must belong to a clinic in your partner account.","required":true}],"customerName":[{"type":"string","description":"The name of the person you’re calling, up to 40 characters. AlloMia keeps it with the call request. The AI agent doesn’t see it: to let the agent use the name, also send it in `dynamicVariables` ."}],"dynamicVariables":[{"type":"object","properties":{},"description":"Details for this call, as an object whose keys and values are all strings. See Dynamic variables ."}],"callbackUrl":[{"type":"string","description":"A URL where AlloMia sends the result when the call reaches a final status. Use an HTTPS URL. See Call-completed callback ."}]}}],"examples":{"example":{"value":{"phoneNumber":"\u003cstring>","assistantId":"\u003cstring>","phoneNumberId":"\u003cstring>","customerName":"\u003cstring>","dynamicVariables":{},"callbackUrl":"\u003cstring>"}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"outboundCallId":[{"type":"string","description":"The call’s ID. Use it with Get outbound call status . The callback carries it too."}],"contactId":[{"type":"string","description":"The ID of the person called, within this call."}],"status":[{"type":"string","description":"`calling` when AlloMia started dialing. `failed` when the call couldn’t be placed."}],"message":[{"type":"string","description":"`Outbound call dispatched` with `calling` . `Outbound call failed to dispatch` with `failed` ."}]}}],"examples":{"example":{"value":{"outboundCallId":"\u003cstring>","contactId":"\u003cstring>","status":"\u003cstring>","message":"\u003cstring>"}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"allomia-dcfc501a","siteName":"AlloMia API Documentation","title":"Create outbound call - AlloMia API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-08T09:36:52.057Z","originalFileLocation":"api-reference/endpoint/create-outbound-call.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Starts a phone call to one number with one of a clinic\u0026#x27;s AI agents.\">\u003cmeta data-mint-head name=\"application-name\" content=\"AlloMia API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/allomia-dcfc501a/CXdvixMdh3J5Wfvu/_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/allomia-dcfc501a/CXdvixMdh3J5Wfvu/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/allomia-dcfc501a/CXdvixMdh3J5Wfvu/_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/allomia-dcfc501a/CXdvixMdh3J5Wfvu/_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/allomia-dcfc501a/CXdvixMdh3J5Wfvu/_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/allomia-dcfc501a/CXdvixMdh3J5Wfvu/_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/allomia-dcfc501a/CXdvixMdh3J5Wfvu/_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/allomia-dcfc501a/CXdvixMdh3J5Wfvu/_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/allomia-dcfc501a/CXdvixMdh3J5Wfvu/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create outbound call - AlloMia API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Starts a phone call to one number with one of a clinic\u0026#x27;s AI agents.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"AlloMia API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.allomia.com/api-reference/endpoint/create-outbound-call\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://allomia-dcfc501a.mintlify.site/_mintlify/api/og/v2?division=Outbound+calls\u0026amp;title=Create+outbound+call\u0026amp;description=Starts+a+phone+call+to+one+number+with+one+of+a+clinic%27s+AI+agents.\u0026amp;theme=f4e20f0a411c4b309413129f\u0026amp;signature=63f2176522111fe65c19cd6b87687fba7a9e5aad2aba753eea7a90007b452cc8\">\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=\"Create outbound call - AlloMia API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Starts a phone call to one number with one of a clinic\u0026#x27;s AI agents.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://allomia-dcfc501a.mintlify.site/_mintlify/api/og/v2?division=Outbound+calls\u0026amp;title=Create+outbound+call\u0026amp;description=Starts+a+phone+call+to+one+number+with+one+of+a+clinic%27s+AI+agents.\u0026amp;theme=f4e20f0a411c4b309413129f\u0026amp;signature=63f2176522111fe65c19cd6b87687fba7a9e5aad2aba753eea7a90007b452cc8\">\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/allomia-dcfc501a/CXdvixMdh3J5Wfvu/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"AlloMia API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0A74DA\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.allomia.com/api-reference/endpoint/create-outbound-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/endpoint/create-outbound-call.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.allomia.com/#organization\",\"name\":\"AlloMia API Documentation\",\"url\":\"https://docs.allomia.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/allomia-dcfc501a/63lasYG0rgJFLjIc/logo/light.svg?fit=max\u0026auto=format\u0026n=63lasYG0rgJFLjIc\u0026q=85\u0026s=900c98f2940cc700233cd2eb0805d036\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.allomia.com#website\",\"name\":\"AlloMia API Documentation\",\"url\":\"https://docs.allomia.com\",\"publisher\":{\"@id\":\"https://docs.allomia.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.allomia.com/api-reference/endpoint/create-outbound-call#webpage\",\"url\":\"https://docs.allomia.com/api-reference/endpoint/create-outbound-call\",\"name\":\"Create outbound call\",\"description\":\"Starts a phone call to one number with one of a clinic's AI agents.\",\"dateModified\":\"2026-10-08T09:36:52.057Z\",\"isPartOf\":{\"@id\":\"https://docs.allomia.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.allomia.com/api-reference/endpoint/create-outbound-call#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.allomia.com/api-reference/endpoint/create-outbound-call#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Outbound calls\",\"item\":\"https://docs.allomia.com/api-reference/outbound-calls\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create outbound call\",\"item\":\"https://docs.allomia.com/api-reference/endpoint/create-outbound-call\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.allomia.com/api-reference/endpoint/create-outbound-call#apireference\",\"headline\":\"Create outbound call\",\"name\":\"Create outbound call\",\"description\":\"Starts a phone call to one number with one of a clinic's AI agents.\",\"url\":\"https://docs.allomia.com/api-reference/endpoint/create-outbound-call\",\"mainEntityOfPage\":{\"@id\":\"https://docs.allomia.com/api-reference/endpoint/create-outbound-call#webpage\"},\"dateModified\":\"2026-10-08T09:36:52.057Z\",\"publisher\":{\"@id\":\"https://docs.allomia.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.allomia.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"AlloMia API Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"AlloMia API Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoint/create-outbound-call.md","siteName":"AlloMia API Documentation","nav":{"global":{"anchors":[{"anchor":"Help Center","icon":"life-ring","href":"https://allomia.com/en/help-center"},{"anchor":"AlloMia Website","icon":"globe","href":"https://allomia.com"},{"anchor":"Contact Support","icon":"envelope","href":"mailto:support@medfarsolutions.com"}]},"groups":[{"group":"Get started","pages":[{"title":"API overview","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Finding IDs","href":"/api-reference/finding-ids"},{"title":"Errors","href":"/api-reference/errors"},{"title":"Rate limits","href":"/api-reference/rate-limits"}]},{"group":"Organizations (partner keys)","pages":[{"title":"Organizations","href":"/api-reference/organization"},{"title":"List organizations","api":"GET /api/organization","href":"/api-reference/endpoint/list-organizations"},{"title":"Create organization","api":"POST /api/organization","href":"/api-reference/endpoint/create-organization"},{"title":"Get organization","api":"GET /api/organization/{id}","href":"/api-reference/endpoint/get-organization"},{"title":"Update organization","api":"PUT /api/organization/{id}","href":"/api-reference/endpoint/update-organization"},{"title":"Delete organization","api":"DELETE /api/organization/{id}","href":"/api-reference/endpoint/delete-organization"},{"title":"Update organization metadata","api":"PUT /api/organization/{id}/metadata","href":"/api-reference/endpoint/update-organization-metadata"}]},{"group":"Calls","pages":[{"title":"Calls","href":"/api-reference/calls"},{"title":"List calls","api":"GET /api/calls","href":"/api-reference/endpoint/list-calls"},{"title":"Get call","api":"GET /api/calls/{id}","href":"/api-reference/endpoint/get-call"}]},{"group":"Outbound calls","pages":[{"title":"Outbound calls","description":"Start a phone call from your software with one of a clinic's AI agents, then get the result.","href":"/api-reference/outbound-calls"},{"title":"Create outbound call","api":"POST /api/outbound","href":"/api-reference/endpoint/create-outbound-call"},{"title":"Get outbound call status","api":"GET /api/outbound/{id}/status","description":"Returns where an outbound call stands and, once it's over, how it ended.","href":"/api-reference/endpoint/get-outbound-call-status"},{"title":"Call-completed callback","href":"/api-reference/webhooks"}]}]},"basePath":"","title":"Create outbound call - AlloMia API Documentation","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js"]}