This is the fallback destination an inbound call will be transferred to if:
assistantId is not set
squadId is not set
and, assistant-request message to the serverUrl fails
If this is not set and above conditions are met, the inbound call is hung up with an error message.
NumberTransferDestination
SipTransferDestination
Show child attributes
hooks
PhoneNumberHookCallRinging · object[]
This is the hooks that will be used for incoming calls to this phone number.
Show child attributes
numberE164CheckEnabled
boolean
default:true
This is the flag to toggle the E164 check for the number field. This is an advanced property which should be used if you know your use case requires it.
Use cases:
false: To allow non-E164 numbers like +001234567890, 1234, or abc. This is useful for dialing out to non-E164 numbers on your SIP trunks.
true (default): To allow only E164 numbers like +14155551234. This is standard for PSTN calls.
If false, the number is still required to only contain alphanumeric characters (regex: /^\+?[a-zA-Z0-9]+$/).
@default true (E164 check is enabled)
name
string
This is the name of the phone number. This is just for your own reference.
Maximum string length: 40
assistantId
string
This is the assistant that will be used for incoming calls to this phone number.
If neither assistantId, squadId nor workflowId is set, assistant-request will be sent to your Server URL. Check ServerMessage and ServerMessageResponse for the shape of the message and response that is expected.
workflowId
string
This is the workflow that will be used for incoming calls to this phone number.
If neither assistantId, squadId, nor workflowId is set, assistant-request will be sent to your Server URL. Check ServerMessage and ServerMessageResponse for the shape of the message and response that is expected.
squadId
string
This is the squad that will be used for incoming calls to this phone number.
If neither assistantId, squadId, nor workflowId is set, assistant-request will be sent to your Server URL. Check ServerMessage and ServerMessageResponse for the shape of the message and response that is expected.
server
object
This is where cozmox will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.
The order of precedence is:
assistant.server
phoneNumber.server
org.server
Show child attributes
number
string
This is the number of the customer.
Required string length: 3 - 40
credentialId
string
This is the credential of your own SIP trunk or Carrier (type byo-sip-trunk) which can be used to make calls to this phone number.
You can add the SIP trunk or Carrier credential in the Provider Credentials page on the Dashboard to get the credentialId.
Response
200 - application/json
ByoPhoneNumber
TwilioPhoneNumber
VonagePhoneNumber
cozmoxPhoneNumber
TelnyxPhoneNumber
provider
enum<string>
required
This is to bring your own phone numbers from your own SIP trunks or Carriers.
Available options:
byo-phone-number
id
string
required
This is the unique identifier for the phone number.
orgId
string
required
This is the unique identifier for the org that this phone number belongs to.
createdAt
string<date-time>
required
This is the ISO 8601 date-time string of when the phone number was created.
updatedAt
string<date-time>
required
This is the ISO 8601 date-time string of when the phone number was last updated.
credentialId
string
required
This is the credential of your own SIP trunk or Carrier (type byo-sip-trunk) which can be used to make calls to this phone number.
You can add the SIP trunk or Carrier credential in the Provider Credentials page on the Dashboard to get the credentialId.
fallbackDestination
NumberTransferDestination · object
This is the fallback destination an inbound call will be transferred to if:
assistantId is not set
squadId is not set
and, assistant-request message to the serverUrl fails
If this is not set and above conditions are met, the inbound call is hung up with an error message.
NumberTransferDestination
SipTransferDestination
Show child attributes
hooks
PhoneNumberHookCallRinging · object[]
This is the hooks that will be used for incoming calls to this phone number.
Show child attributes
numberE164CheckEnabled
boolean
default:true
This is the flag to toggle the E164 check for the number field. This is an advanced property which should be used if you know your use case requires it.
Use cases:
false: To allow non-E164 numbers like +001234567890, 1234, or abc. This is useful for dialing out to non-E164 numbers on your SIP trunks.
true (default): To allow only E164 numbers like +14155551234. This is standard for PSTN calls.
If false, the number is still required to only contain alphanumeric characters (regex: /^\+?[a-zA-Z0-9]+$/).
@default true (E164 check is enabled)
status
enum<string>
This is the status of the phone number.
Available options:
active,
activating,
blocked
name
string
This is the name of the phone number. This is just for your own reference.
Maximum string length: 40
assistantId
string
This is the assistant that will be used for incoming calls to this phone number.
If neither assistantId, squadId nor workflowId is set, assistant-request will be sent to your Server URL. Check ServerMessage and ServerMessageResponse for the shape of the message and response that is expected.
workflowId
string
This is the workflow that will be used for incoming calls to this phone number.
If neither assistantId, squadId, nor workflowId is set, assistant-request will be sent to your Server URL. Check ServerMessage and ServerMessageResponse for the shape of the message and response that is expected.
squadId
string
This is the squad that will be used for incoming calls to this phone number.
If neither assistantId, squadId, nor workflowId is set, assistant-request will be sent to your Server URL. Check ServerMessage and ServerMessageResponse for the shape of the message and response that is expected.
server
object
This is where cozmox will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.
The order of precedence is:
assistant.server
phoneNumber.server
org.server
Show child attributes
number
string
This is the number of the customer.
Required string length: 3 - 40
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Cozmox-AI Nebula SDK","colors":{"primary":"#FF5911","light":"#FF5911","dark":"#c44b09"},"favicon":"/logo/favicon.png","logo":{"light":"https://mintlify.s3.us-west-1.amazonaws.com/czmx/logo/logo_light.svg","dark":"https://mintlify.s3.us-west-1.amazonaws.com/czmx/logo/logo_dark.svg"},"navbar":{"links":[{"label":"Support","href":"mailto:development@cozmox.ai"}],"primary":{"type":"button","label":"Dashboard","href":"https://cozmox.ai"}},"footer":{"socials":{"x":"https://x.com/cozmoxai","linkedin":"https://www.linkedin.com/company/cozmox-ai/"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"czmx","hasAudioNarration":false,"actualSubdomain":"czmx","customDomains":["docs.cozmox.cloud"],"gitSource":{"type":"github","owner":"zywa-co","repo":"sdk-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae9248dc5f2fcf249014baf:success","clientVersion":"0.0.4160","searchFilterCounts":[{"language":"default","tag":"API Reference","count":120},{"language":"default","tag":"Assistants","count":5},{"language":"default","tag":"Calls","count":5},{"language":"default","tag":"Campaigns","count":5},{"language":"default","tag":"Chats","count":5},{"language":"default","tag":"Files","count":5},{"language":"default","tag":"Knowledge Base","count":5},{"language":"default","tag":"Phone Numbers","count":5},{"language":"default","tag":"Sessions","count":5},{"language":"default","tag":"Tools","count":5}]},"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":[],"page":{"pagePath":"api-reference/phone-numbers/update-phone-number","slug":"/api-reference/phone-numbers/update-phone-number","pageMetadata":{"openapi":"patch /phone-number/{id}","title":"Update Phone Number","description":null,"href":"/api-reference/phone-numbers/update-phone-number"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"patch /phone-number/{id}","title":"Update Phone Number","description":null,"href":"/api-reference/phone-numbers/update-phone-number"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"PhoneNumberController_update","summary":"Update Phone Number","parameters":["c2164921-42b3-4620-aa53-de37626ba433"],"requestBody":"117fee2a-3686-4a99-9233-623182e63ed6","responses":{"200":"64edb631-37b6-45ec-9c00-e09775a74476"},"tags":["Phone Numbers"],"security":["3bede193-7672-415c-a0ac-364a13737695"],"method":"patch","type":"path","servers":["b5b8326a-680d-4e65-bd4d-46e31c9c1334","1698761f-fe56-43c1-839e-05ab7d829049"],"path":"/phone-number/{id}","baseUrlOptions":["https://api.cozmox.ai","https://api.cozmox.ai"],"title":"Update Phone Number","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"c2164921-42b3-4620-aa53-de37626ba433":{"name":"id","required":true,"in":"path","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"ByoPhoneNumber","properties":{"fallbackDestination":{"oneOf":[{"type":"object","title":"NumberTransferDestination","description":"This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.description","typeLabel":"string"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0","typeLabel":"NumberTransferDestination · object"},{"type":"object","title":"SipTransferDestination","description":"This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.description","typeLabel":"string"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1","typeLabel":"SipTransferDestination · object"}],"uniqueKey":"oneOf.0.fallbackDestination","typeLabel":"NumberTransferDestination · object | SipTransferDestination · object"},"hooks":{"type":"array","description":"This is the hooks that will be used for incoming calls to this phone number.","items":{"type":"object","title":"PhoneNumberHookCallRinging","required":["on","do"],"properties":{"on":{"type":"string","description":"This is the event to trigger the hook on","enum":["call.ringing"],"maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].on","typeLabel":"enum\u003cstring>"},"do":{"type":"array","description":"This is the set of actions to perform when the hook triggers","items":{"oneOf":[{"type":"object","title":"TransferPhoneNumberHookAction","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of action - must be \"transfer\"","enum":["transfer"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"destination":{"oneOf":[{"type":"object","title":"NumberTransferDestination","description":"This is the destination details for the transfer - can be a phone number or SIP URI","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.description","typeLabel":"string"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0","typeLabel":"NumberTransferDestination · object"},{"type":"object","title":"SipTransferDestination","description":"This is the destination details for the transfer - can be a phone number or SIP URI","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.description","typeLabel":"string"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1","typeLabel":"SipTransferDestination · object"}],"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination","typeLabel":"NumberTransferDestination · object | SipTransferDestination · object"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0","typeLabel":"TransferPhoneNumberHookAction · object"},{"type":"object","title":"SayPhoneNumberHookAction","required":["type","exact"],"properties":{"type":{"type":"string","description":"This is the type of action - must be \"say\"","enum":["say"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"exact":{"type":"string","description":"This is the message to say","maxLength":4000,"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.1.exact","typeLabel":"string"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.1","typeLabel":"SayPhoneNumberHookAction · object"}],"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX]","typeLabel":"TransferPhoneNumberHookAction · object | SayPhoneNumberHookAction · object"},"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do","typeLabel":"(TransferPhoneNumberHookAction · object | SayPhoneNumberHookAction · object)[]"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX]","typeLabel":"PhoneNumberHookCallRinging · object"},"uniqueKey":"oneOf.0.hooks","typeLabel":"PhoneNumberHookCallRinging · object[]"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"oneOf.0.numberE164CheckEnabled","typeLabel":"boolean"},"name":{"type":"string","description":"This is the name of the phone number. This is just for your own reference.","maxLength":40,"uniqueKey":"oneOf.0.name","typeLabel":"string"},"assistantId":{"type":"string","description":"This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.0.assistantId","typeLabel":"string"},"workflowId":{"type":"string","description":"This is the workflow that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.0.workflowId","typeLabel":"string"},"squadId":{"type":"string","description":"This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.0.squadId","typeLabel":"string"},"server":{"type":"object","description":"This is where cozmox will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"oneOf.0.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"oneOf.0.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"oneOf.0.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"oneOf.0.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"oneOf.0.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"oneOf.0.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"oneOf.0.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"oneOf.0.server","typeLabel":"object"},"number":{"type":"string","description":"This is the number of the customer.","minLength":3,"maxLength":40,"uniqueKey":"oneOf.0.number","typeLabel":"string"},"credentialId":{"type":"string","description":"This is the credential of your own SIP trunk or Carrier (type `byo-sip-trunk`) which can be used to make calls to this phone number.\n\nYou can add the SIP trunk or Carrier credential in the Provider Credentials page on the Dashboard to get the credentialId.","uniqueKey":"oneOf.0.credentialId","typeLabel":"string"}},"uniqueKey":"oneOf.0","typeLabel":"ByoPhoneNumber · object"},{"type":"object","title":"TwilioPhoneNumber","properties":{"fallbackDestination":{"oneOf":[{"type":"object","title":"NumberTransferDestination","description":"This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.description","typeLabel":"string"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0","typeLabel":"NumberTransferDestination · object"},{"type":"object","title":"SipTransferDestination","description":"This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.description","typeLabel":"string"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1","typeLabel":"SipTransferDestination · object"}],"uniqueKey":"oneOf.1.fallbackDestination","typeLabel":"NumberTransferDestination · object | SipTransferDestination · object"},"hooks":{"type":"array","description":"This is the hooks that will be used for incoming calls to this phone number.","items":{"type":"object","title":"PhoneNumberHookCallRinging","required":["on","do"],"properties":{"on":{"type":"string","description":"This is the event to trigger the hook on","enum":["call.ringing"],"maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].on","typeLabel":"enum\u003cstring>"},"do":{"type":"array","description":"This is the set of actions to perform when the hook triggers","items":{"oneOf":[{"type":"object","title":"TransferPhoneNumberHookAction","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of action - must be \"transfer\"","enum":["transfer"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"destination":{"oneOf":[{"type":"object","title":"NumberTransferDestination","description":"This is the destination details for the transfer - can be a phone number or SIP URI","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.description","typeLabel":"string"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0","typeLabel":"NumberTransferDestination · object"},{"type":"object","title":"SipTransferDestination","description":"This is the destination details for the transfer - can be a phone number or SIP URI","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.description","typeLabel":"string"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1","typeLabel":"SipTransferDestination · object"}],"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination","typeLabel":"NumberTransferDestination · object | SipTransferDestination · object"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0","typeLabel":"TransferPhoneNumberHookAction · object"},{"type":"object","title":"SayPhoneNumberHookAction","required":["type","exact"],"properties":{"type":{"type":"string","description":"This is the type of action - must be \"say\"","enum":["say"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"exact":{"type":"string","description":"This is the message to say","maxLength":4000,"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.1.exact","typeLabel":"string"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.1","typeLabel":"SayPhoneNumberHookAction · object"}],"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX]","typeLabel":"TransferPhoneNumberHookAction · object | SayPhoneNumberHookAction · object"},"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do","typeLabel":"(TransferPhoneNumberHookAction · object | SayPhoneNumberHookAction · object)[]"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX]","typeLabel":"PhoneNumberHookCallRinging · object"},"uniqueKey":"oneOf.1.hooks","typeLabel":"PhoneNumberHookCallRinging · object[]"},"smsEnabled":{"type":"boolean","description":"Controls whether cozmox sets the messaging webhook URL on the Twilio number during import.\n\nIf set to `false`, cozmox will not update the Twilio messaging URL, leaving it as is.\nIf `true` or omitted (default), cozmox will configure both the voice and messaging URLs.\n\n@default true","default":true,"uniqueKey":"oneOf.1.smsEnabled","typeLabel":"boolean"},"name":{"type":"string","description":"This is the name of the phone number. This is just for your own reference.","maxLength":40,"uniqueKey":"oneOf.1.name","typeLabel":"string"},"assistantId":{"type":"string","description":"This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.1.assistantId","typeLabel":"string"},"workflowId":{"type":"string","description":"This is the workflow that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.1.workflowId","typeLabel":"string"},"squadId":{"type":"string","description":"This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.1.squadId","typeLabel":"string"},"server":{"type":"object","description":"This is where cozmox will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"oneOf.1.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"oneOf.1.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"oneOf.1.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"oneOf.1.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"oneOf.1.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"oneOf.1.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"oneOf.1.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"oneOf.1.server","typeLabel":"object"},"number":{"type":"string","description":"These are the digits of the phone number you own on your Twilio.","uniqueKey":"oneOf.1.number","typeLabel":"string"},"twilioAccountSid":{"type":"string","description":"This is the Twilio Account SID for the phone number.","uniqueKey":"oneOf.1.twilioAccountSid","typeLabel":"string"},"twilioAuthToken":{"type":"string","description":"This is the Twilio Auth Token for the phone number.","uniqueKey":"oneOf.1.twilioAuthToken","typeLabel":"string"},"twilioApiKey":{"type":"string","description":"This is the Twilio API Key for the phone number.","uniqueKey":"oneOf.1.twilioApiKey","typeLabel":"string"},"twilioApiSecret":{"type":"string","description":"This is the Twilio API Secret for the phone number.","uniqueKey":"oneOf.1.twilioApiSecret","typeLabel":"string"}},"uniqueKey":"oneOf.1","typeLabel":"TwilioPhoneNumber · object"},{"type":"object","title":"VonagePhoneNumber","properties":{"fallbackDestination":{"oneOf":[{"type":"object","title":"NumberTransferDestination","description":"This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.description","typeLabel":"string"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0","typeLabel":"NumberTransferDestination · object"},{"type":"object","title":"SipTransferDestination","description":"This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.description","typeLabel":"string"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1","typeLabel":"SipTransferDestination · object"}],"uniqueKey":"oneOf.2.fallbackDestination","typeLabel":"NumberTransferDestination · object | SipTransferDestination · object"},"hooks":{"type":"array","description":"This is the hooks that will be used for incoming calls to this phone number.","items":{"type":"object","title":"PhoneNumberHookCallRinging","required":["on","do"],"properties":{"on":{"type":"string","description":"This is the event to trigger the hook on","enum":["call.ringing"],"maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].on","typeLabel":"enum\u003cstring>"},"do":{"type":"array","description":"This is the set of actions to perform when the hook triggers","items":{"oneOf":[{"type":"object","title":"TransferPhoneNumberHookAction","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of action - must be \"transfer\"","enum":["transfer"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"destination":{"oneOf":[{"type":"object","title":"NumberTransferDestination","description":"This is the destination details for the transfer - can be a phone number or SIP URI","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.description","typeLabel":"string"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0","typeLabel":"NumberTransferDestination · object"},{"type":"object","title":"SipTransferDestination","description":"This is the destination details for the transfer - can be a phone number or SIP URI","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.description","typeLabel":"string"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1","typeLabel":"SipTransferDestination · object"}],"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination","typeLabel":"NumberTransferDestination · object | SipTransferDestination · object"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0","typeLabel":"TransferPhoneNumberHookAction · object"},{"type":"object","title":"SayPhoneNumberHookAction","required":["type","exact"],"properties":{"type":{"type":"string","description":"This is the type of action - must be \"say\"","enum":["say"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"exact":{"type":"string","description":"This is the message to say","maxLength":4000,"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.1.exact","typeLabel":"string"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.1","typeLabel":"SayPhoneNumberHookAction · object"}],"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX]","typeLabel":"TransferPhoneNumberHookAction · object | SayPhoneNumberHookAction · object"},"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do","typeLabel":"(TransferPhoneNumberHookAction · object | SayPhoneNumberHookAction · object)[]"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX]","typeLabel":"PhoneNumberHookCallRinging · object"},"uniqueKey":"oneOf.2.hooks","typeLabel":"PhoneNumberHookCallRinging · object[]"},"name":{"type":"string","description":"This is the name of the phone number. This is just for your own reference.","maxLength":40,"uniqueKey":"oneOf.2.name","typeLabel":"string"},"assistantId":{"type":"string","description":"This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.2.assistantId","typeLabel":"string"},"workflowId":{"type":"string","description":"This is the workflow that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.2.workflowId","typeLabel":"string"},"squadId":{"type":"string","description":"This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.2.squadId","typeLabel":"string"},"server":{"type":"object","description":"This is where cozmox will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"oneOf.2.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"oneOf.2.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"oneOf.2.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"oneOf.2.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"oneOf.2.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"oneOf.2.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"oneOf.2.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"oneOf.2.server","typeLabel":"object"},"number":{"type":"string","description":"These are the digits of the phone number you own on your Vonage.","uniqueKey":"oneOf.2.number","typeLabel":"string"},"credentialId":{"type":"string","description":"This is the credential you added in dashboard.cozmox.ai/keys. This is used to configure the number to send inbound calls to cozmox, make outbound calls and do live call updates like transfers and hangups.","uniqueKey":"oneOf.2.credentialId","typeLabel":"string"}},"uniqueKey":"oneOf.2","typeLabel":"VonagePhoneNumber · object"},{"type":"object","title":"cozmoxPhoneNumber","properties":{"fallbackDestination":{"oneOf":[{"type":"object","title":"NumberTransferDestination","description":"This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.description","typeLabel":"string"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0","typeLabel":"NumberTransferDestination · object"},{"type":"object","title":"SipTransferDestination","description":"This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.description","typeLabel":"string"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1","typeLabel":"SipTransferDestination · object"}],"uniqueKey":"oneOf.3.fallbackDestination","typeLabel":"NumberTransferDestination · object | SipTransferDestination · object"},"hooks":{"type":"array","description":"This is the hooks that will be used for incoming calls to this phone number.","items":{"type":"object","title":"PhoneNumberHookCallRinging","required":["on","do"],"properties":{"on":{"type":"string","description":"This is the event to trigger the hook on","enum":["call.ringing"],"maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].on","typeLabel":"enum\u003cstring>"},"do":{"type":"array","description":"This is the set of actions to perform when the hook triggers","items":{"oneOf":[{"type":"object","title":"TransferPhoneNumberHookAction","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of action - must be \"transfer\"","enum":["transfer"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"destination":{"oneOf":[{"type":"object","title":"NumberTransferDestination","description":"This is the destination details for the transfer - can be a phone number or SIP URI","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.description","typeLabel":"string"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0","typeLabel":"NumberTransferDestination · object"},{"type":"object","title":"SipTransferDestination","description":"This is the destination details for the transfer - can be a phone number or SIP URI","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.description","typeLabel":"string"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1","typeLabel":"SipTransferDestination · object"}],"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination","typeLabel":"NumberTransferDestination · object | SipTransferDestination · object"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0","typeLabel":"TransferPhoneNumberHookAction · object"},{"type":"object","title":"SayPhoneNumberHookAction","required":["type","exact"],"properties":{"type":{"type":"string","description":"This is the type of action - must be \"say\"","enum":["say"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"exact":{"type":"string","description":"This is the message to say","maxLength":4000,"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.1.exact","typeLabel":"string"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.1","typeLabel":"SayPhoneNumberHookAction · object"}],"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX]","typeLabel":"TransferPhoneNumberHookAction · object | SayPhoneNumberHookAction · object"},"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do","typeLabel":"(TransferPhoneNumberHookAction · object | SayPhoneNumberHookAction · object)[]"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX]","typeLabel":"PhoneNumberHookCallRinging · object"},"uniqueKey":"oneOf.3.hooks","typeLabel":"PhoneNumberHookCallRinging · object[]"},"name":{"type":"string","description":"This is the name of the phone number. This is just for your own reference.","maxLength":40,"uniqueKey":"oneOf.3.name","typeLabel":"string"},"assistantId":{"type":"string","description":"This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.3.assistantId","typeLabel":"string"},"workflowId":{"type":"string","description":"This is the workflow that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.3.workflowId","typeLabel":"string"},"squadId":{"type":"string","description":"This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.3.squadId","typeLabel":"string"},"server":{"type":"object","description":"This is where cozmox will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"oneOf.3.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"oneOf.3.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"oneOf.3.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"oneOf.3.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"oneOf.3.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"oneOf.3.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"oneOf.3.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"oneOf.3.server","typeLabel":"object"},"sipUri":{"type":"string","description":"This is the SIP URI of the phone number. You can SIP INVITE this. The assistant attached to this number will answer.\n\nThis is case-insensitive.","uniqueKey":"oneOf.3.sipUri","typeLabel":"string"},"authentication":{"type":"object","description":"This enables authentication for incoming SIP INVITE requests to the `sipUri`.\n\nIf not set, any username/password to the 401 challenge of the SIP INVITE will be accepted.","required":["username","password"],"properties":{"username":{"type":"string","description":"This will be expected in the `username` field of the `authorization` header of the SIP INVITE.","minLength":20,"maxLength":40,"isRequired":true,"uniqueKey":"oneOf.3.authentication.username","typeLabel":"string"},"password":{"type":"string","description":"This will be expected to generate the `response` field of the `authorization` header of the SIP INVITE, through digest authentication.","minLength":20,"maxLength":40,"isRequired":true,"uniqueKey":"oneOf.3.authentication.password","typeLabel":"string"},"realm":{"type":"string","description":"This will be expected in the `realm` field of the `authorization` header of the SIP INVITE. Defaults to sip.cozmox.ai.","uniqueKey":"oneOf.3.authentication.realm","typeLabel":"string"}},"uniqueKey":"oneOf.3.authentication","typeLabel":"object"}},"uniqueKey":"oneOf.3","typeLabel":"cozmoxPhoneNumber · object"},{"type":"object","title":"TelnyxPhoneNumber","properties":{"fallbackDestination":{"oneOf":[{"type":"object","title":"NumberTransferDestination","description":"This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.description","typeLabel":"string"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0","typeLabel":"NumberTransferDestination · object"},{"type":"object","title":"SipTransferDestination","description":"This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.description","typeLabel":"string"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1","typeLabel":"SipTransferDestination · object"}],"uniqueKey":"oneOf.4.fallbackDestination","typeLabel":"NumberTransferDestination · object | SipTransferDestination · object"},"hooks":{"type":"array","description":"This is the hooks that will be used for incoming calls to this phone number.","items":{"type":"object","title":"PhoneNumberHookCallRinging","required":["on","do"],"properties":{"on":{"type":"string","description":"This is the event to trigger the hook on","enum":["call.ringing"],"maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].on","typeLabel":"enum\u003cstring>"},"do":{"type":"array","description":"This is the set of actions to perform when the hook triggers","items":{"oneOf":[{"type":"object","title":"TransferPhoneNumberHookAction","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of action - must be \"transfer\"","enum":["transfer"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"destination":{"oneOf":[{"type":"object","title":"NumberTransferDestination","description":"This is the destination details for the transfer - can be a phone number or SIP URI","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.description","typeLabel":"string"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0","typeLabel":"NumberTransferDestination · object"},{"type":"object","title":"SipTransferDestination","description":"This is the destination details for the transfer - can be a phone number or SIP URI","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.description","typeLabel":"string"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1","typeLabel":"SipTransferDestination · object"}],"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination","typeLabel":"NumberTransferDestination · object | SipTransferDestination · object"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0","typeLabel":"TransferPhoneNumberHookAction · object"},{"type":"object","title":"SayPhoneNumberHookAction","required":["type","exact"],"properties":{"type":{"type":"string","description":"This is the type of action - must be \"say\"","enum":["say"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"exact":{"type":"string","description":"This is the message to say","maxLength":4000,"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.1.exact","typeLabel":"string"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.1","typeLabel":"SayPhoneNumberHookAction · object"}],"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX]","typeLabel":"TransferPhoneNumberHookAction · object | SayPhoneNumberHookAction · object"},"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do","typeLabel":"(TransferPhoneNumberHookAction · object | SayPhoneNumberHookAction · object)[]"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX]","typeLabel":"PhoneNumberHookCallRinging · object"},"uniqueKey":"oneOf.4.hooks","typeLabel":"PhoneNumberHookCallRinging · object[]"},"name":{"type":"string","description":"This is the name of the phone number. This is just for your own reference.","maxLength":40,"uniqueKey":"oneOf.4.name","typeLabel":"string"},"assistantId":{"type":"string","description":"This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.4.assistantId","typeLabel":"string"},"workflowId":{"type":"string","description":"This is the workflow that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.4.workflowId","typeLabel":"string"},"squadId":{"type":"string","description":"This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.4.squadId","typeLabel":"string"},"server":{"type":"object","description":"This is where cozmox will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"oneOf.4.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"oneOf.4.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"oneOf.4.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"oneOf.4.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"oneOf.4.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"oneOf.4.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"oneOf.4.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"oneOf.4.server","typeLabel":"object"},"number":{"type":"string","description":"These are the digits of the phone number you own on your Telnyx.","uniqueKey":"oneOf.4.number","typeLabel":"string"},"credentialId":{"type":"string","description":"This is the credential you added in dashboard.cozmox.ai/keys. This is used to configure the number to send inbound calls to cozmox, make outbound calls and do live call updates like transfers and hangups.","uniqueKey":"oneOf.4.credentialId","typeLabel":"string"}},"uniqueKey":"oneOf.4","typeLabel":"TelnyxPhoneNumber · object"}],"uniqueKey":"","typeLabel":"ByoPhoneNumber · object | TwilioPhoneNumber · object | VonagePhoneNumber · object | cozmoxPhoneNumber · object | TelnyxPhoneNumber · object"},"examples":{"Example":{"title":"Example","value":{"fallbackDestination":{"type":"number","number":"\u003cstring>","message":"\u003cstring>","numberE164CheckEnabled":true,"extension":"\u003cstring>","callerId":"\u003cstring>","description":"\u003cstring>"},"hooks":[{"on":"call.ringing","do":[{"type":"transfer","destination":{"type":"number","number":"\u003cstring>","message":"\u003cstring>","numberE164CheckEnabled":true,"extension":"\u003cstring>","callerId":"\u003cstring>","description":"\u003cstring>"}}]}],"numberE164CheckEnabled":true,"name":"\u003cstring>","assistantId":"\u003cstring>","workflowId":"\u003cstring>","squadId":"\u003cstring>","server":{"timeoutSeconds":20,"url":"\u003cstring>","headers":{}},"number":"\u003cstring>","credentialId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"64edb631-37b6-45ec-9c00-e09775a74476":{"description":"","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"ByoPhoneNumber","required":["provider","id","orgId","createdAt","updatedAt","credentialId"],"properties":{"provider":{"type":"string","description":"This is to bring your own phone numbers from your own SIP trunks or Carriers.","enum":["byo-phone-number"],"isRequired":true,"uniqueKey":"oneOf.0.provider","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"This is the unique identifier for the phone number.","isRequired":true,"uniqueKey":"oneOf.0.id","typeLabel":"string"},"orgId":{"type":"string","description":"This is the unique identifier for the org that this phone number belongs to.","isRequired":true,"uniqueKey":"oneOf.0.orgId","typeLabel":"string"},"createdAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the phone number was created.","isRequired":true,"uniqueKey":"oneOf.0.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the phone number was last updated.","isRequired":true,"uniqueKey":"oneOf.0.updatedAt","typeLabel":"string\u003cdate-time>"},"credentialId":{"type":"string","description":"This is the credential of your own SIP trunk or Carrier (type `byo-sip-trunk`) which can be used to make calls to this phone number.\n\nYou can add the SIP trunk or Carrier credential in the Provider Credentials page on the Dashboard to get the credentialId.","isRequired":true,"uniqueKey":"oneOf.0.credentialId","typeLabel":"string"},"fallbackDestination":{"oneOf":[{"type":"object","title":"NumberTransferDestination","description":"This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.0.fallbackDestination.oneOf.0.description","typeLabel":"string"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.0","typeLabel":"NumberTransferDestination · object"},{"type":"object","title":"SipTransferDestination","description":"This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.0.fallbackDestination.oneOf.1.description","typeLabel":"string"}},"uniqueKey":"oneOf.0.fallbackDestination.oneOf.1","typeLabel":"SipTransferDestination · object"}],"uniqueKey":"oneOf.0.fallbackDestination","typeLabel":"NumberTransferDestination · object | SipTransferDestination · object"},"hooks":{"type":"array","description":"This is the hooks that will be used for incoming calls to this phone number.","items":{"type":"object","title":"PhoneNumberHookCallRinging","required":["on","do"],"properties":{"on":{"type":"string","description":"This is the event to trigger the hook on","enum":["call.ringing"],"maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].on","typeLabel":"enum\u003cstring>"},"do":{"type":"array","description":"This is the set of actions to perform when the hook triggers","items":{"oneOf":[{"type":"object","title":"TransferPhoneNumberHookAction","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of action - must be \"transfer\"","enum":["transfer"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"destination":{"oneOf":[{"type":"object","title":"NumberTransferDestination","description":"This is the destination details for the transfer - can be a phone number or SIP URI","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.description","typeLabel":"string"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0","typeLabel":"NumberTransferDestination · object"},{"type":"object","title":"SipTransferDestination","description":"This is the destination details for the transfer - can be a phone number or SIP URI","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.description","typeLabel":"string"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1","typeLabel":"SipTransferDestination · object"}],"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination","typeLabel":"NumberTransferDestination · object | SipTransferDestination · object"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.0","typeLabel":"TransferPhoneNumberHookAction · object"},{"type":"object","title":"SayPhoneNumberHookAction","required":["type","exact"],"properties":{"type":{"type":"string","description":"This is the type of action - must be \"say\"","enum":["say"],"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"exact":{"type":"string","description":"This is the message to say","maxLength":4000,"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.1.exact","typeLabel":"string"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX].oneOf.1","typeLabel":"SayPhoneNumberHookAction · object"}],"uniqueKey":"oneOf.0.hooks.items.[INDEX].do.items.[INDEX]","typeLabel":"TransferPhoneNumberHookAction · object | SayPhoneNumberHookAction · object"},"isRequired":true,"uniqueKey":"oneOf.0.hooks.items.[INDEX].do","typeLabel":"(TransferPhoneNumberHookAction · object | SayPhoneNumberHookAction · object)[]"}},"uniqueKey":"oneOf.0.hooks.items.[INDEX]","typeLabel":"PhoneNumberHookCallRinging · object"},"uniqueKey":"oneOf.0.hooks","typeLabel":"PhoneNumberHookCallRinging · object[]"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"oneOf.0.numberE164CheckEnabled","typeLabel":"boolean"},"status":{"type":"string","description":"This is the status of the phone number.","enum":["active","activating","blocked"],"uniqueKey":"oneOf.0.status","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"This is the name of the phone number. This is just for your own reference.","maxLength":40,"uniqueKey":"oneOf.0.name","typeLabel":"string"},"assistantId":{"type":"string","description":"This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.0.assistantId","typeLabel":"string"},"workflowId":{"type":"string","description":"This is the workflow that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.0.workflowId","typeLabel":"string"},"squadId":{"type":"string","description":"This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.0.squadId","typeLabel":"string"},"server":{"type":"object","description":"This is where cozmox will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"oneOf.0.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"oneOf.0.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"oneOf.0.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"oneOf.0.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"oneOf.0.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"oneOf.0.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"oneOf.0.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"oneOf.0.server","typeLabel":"object"},"number":{"type":"string","description":"This is the number of the customer.","minLength":3,"maxLength":40,"uniqueKey":"oneOf.0.number","typeLabel":"string"}},"uniqueKey":"oneOf.0","typeLabel":"ByoPhoneNumber · object"},{"type":"object","title":"TwilioPhoneNumber","required":["provider","id","orgId","createdAt","updatedAt","number","twilioAccountSid"],"properties":{"provider":{"type":"string","description":"This is to use numbers bought on Twilio.","enum":["twilio"],"isRequired":true,"uniqueKey":"oneOf.1.provider","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"This is the unique identifier for the phone number.","isRequired":true,"uniqueKey":"oneOf.1.id","typeLabel":"string"},"orgId":{"type":"string","description":"This is the unique identifier for the org that this phone number belongs to.","isRequired":true,"uniqueKey":"oneOf.1.orgId","typeLabel":"string"},"createdAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the phone number was created.","isRequired":true,"uniqueKey":"oneOf.1.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the phone number was last updated.","isRequired":true,"uniqueKey":"oneOf.1.updatedAt","typeLabel":"string\u003cdate-time>"},"number":{"type":"string","description":"These are the digits of the phone number you own on your Twilio.","isRequired":true,"uniqueKey":"oneOf.1.number","typeLabel":"string"},"twilioAccountSid":{"type":"string","description":"This is the Twilio Account SID for the phone number.","isRequired":true,"uniqueKey":"oneOf.1.twilioAccountSid","typeLabel":"string"},"fallbackDestination":{"oneOf":[{"type":"object","title":"NumberTransferDestination","description":"This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.1.fallbackDestination.oneOf.0.description","typeLabel":"string"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.0","typeLabel":"NumberTransferDestination · object"},{"type":"object","title":"SipTransferDestination","description":"This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.1.fallbackDestination.oneOf.1.description","typeLabel":"string"}},"uniqueKey":"oneOf.1.fallbackDestination.oneOf.1","typeLabel":"SipTransferDestination · object"}],"uniqueKey":"oneOf.1.fallbackDestination","typeLabel":"NumberTransferDestination · object | SipTransferDestination · object"},"hooks":{"type":"array","description":"This is the hooks that will be used for incoming calls to this phone number.","items":{"type":"object","title":"PhoneNumberHookCallRinging","required":["on","do"],"properties":{"on":{"type":"string","description":"This is the event to trigger the hook on","enum":["call.ringing"],"maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].on","typeLabel":"enum\u003cstring>"},"do":{"type":"array","description":"This is the set of actions to perform when the hook triggers","items":{"oneOf":[{"type":"object","title":"TransferPhoneNumberHookAction","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of action - must be \"transfer\"","enum":["transfer"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"destination":{"oneOf":[{"type":"object","title":"NumberTransferDestination","description":"This is the destination details for the transfer - can be a phone number or SIP URI","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.description","typeLabel":"string"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0","typeLabel":"NumberTransferDestination · object"},{"type":"object","title":"SipTransferDestination","description":"This is the destination details for the transfer - can be a phone number or SIP URI","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.description","typeLabel":"string"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1","typeLabel":"SipTransferDestination · object"}],"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination","typeLabel":"NumberTransferDestination · object | SipTransferDestination · object"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.0","typeLabel":"TransferPhoneNumberHookAction · object"},{"type":"object","title":"SayPhoneNumberHookAction","required":["type","exact"],"properties":{"type":{"type":"string","description":"This is the type of action - must be \"say\"","enum":["say"],"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"exact":{"type":"string","description":"This is the message to say","maxLength":4000,"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.1.exact","typeLabel":"string"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX].oneOf.1","typeLabel":"SayPhoneNumberHookAction · object"}],"uniqueKey":"oneOf.1.hooks.items.[INDEX].do.items.[INDEX]","typeLabel":"TransferPhoneNumberHookAction · object | SayPhoneNumberHookAction · object"},"isRequired":true,"uniqueKey":"oneOf.1.hooks.items.[INDEX].do","typeLabel":"(TransferPhoneNumberHookAction · object | SayPhoneNumberHookAction · object)[]"}},"uniqueKey":"oneOf.1.hooks.items.[INDEX]","typeLabel":"PhoneNumberHookCallRinging · object"},"uniqueKey":"oneOf.1.hooks","typeLabel":"PhoneNumberHookCallRinging · object[]"},"smsEnabled":{"type":"boolean","description":"Controls whether cozmox sets the messaging webhook URL on the Twilio number during import.\n\nIf set to `false`, cozmox will not update the Twilio messaging URL, leaving it as is.\nIf `true` or omitted (default), cozmox will configure both the voice and messaging URLs.\n\n@default true","default":true,"uniqueKey":"oneOf.1.smsEnabled","typeLabel":"boolean"},"status":{"type":"string","description":"This is the status of the phone number.","enum":["active","activating","blocked"],"uniqueKey":"oneOf.1.status","typeLabel":"enum\u003cstring>"},"twilioAuthToken":{"type":"string","description":"This is the Twilio Auth Token for the phone number.","uniqueKey":"oneOf.1.twilioAuthToken","typeLabel":"string"},"twilioApiKey":{"type":"string","description":"This is the Twilio API Key for the phone number.","uniqueKey":"oneOf.1.twilioApiKey","typeLabel":"string"},"twilioApiSecret":{"type":"string","description":"This is the Twilio API Secret for the phone number.","uniqueKey":"oneOf.1.twilioApiSecret","typeLabel":"string"},"name":{"type":"string","description":"This is the name of the phone number. This is just for your own reference.","maxLength":40,"uniqueKey":"oneOf.1.name","typeLabel":"string"},"assistantId":{"type":"string","description":"This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.1.assistantId","typeLabel":"string"},"workflowId":{"type":"string","description":"This is the workflow that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.1.workflowId","typeLabel":"string"},"squadId":{"type":"string","description":"This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.1.squadId","typeLabel":"string"},"server":{"type":"object","description":"This is where cozmox will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"oneOf.1.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"oneOf.1.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"oneOf.1.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"oneOf.1.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"oneOf.1.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"oneOf.1.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"oneOf.1.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"oneOf.1.server","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"TwilioPhoneNumber · object"},{"type":"object","title":"VonagePhoneNumber","required":["provider","id","orgId","createdAt","updatedAt","number","credentialId"],"properties":{"provider":{"type":"string","description":"This is to use numbers bought on Vonage.","enum":["vonage"],"isRequired":true,"uniqueKey":"oneOf.2.provider","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"This is the unique identifier for the phone number.","isRequired":true,"uniqueKey":"oneOf.2.id","typeLabel":"string"},"orgId":{"type":"string","description":"This is the unique identifier for the org that this phone number belongs to.","isRequired":true,"uniqueKey":"oneOf.2.orgId","typeLabel":"string"},"createdAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the phone number was created.","isRequired":true,"uniqueKey":"oneOf.2.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the phone number was last updated.","isRequired":true,"uniqueKey":"oneOf.2.updatedAt","typeLabel":"string\u003cdate-time>"},"number":{"type":"string","description":"These are the digits of the phone number you own on your Vonage.","isRequired":true,"uniqueKey":"oneOf.2.number","typeLabel":"string"},"credentialId":{"type":"string","description":"This is the credential you added in dashboard.cozmox.ai/keys. This is used to configure the number to send inbound calls to cozmox, make outbound calls and do live call updates like transfers and hangups.","isRequired":true,"uniqueKey":"oneOf.2.credentialId","typeLabel":"string"},"fallbackDestination":{"oneOf":[{"type":"object","title":"NumberTransferDestination","description":"This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.2.fallbackDestination.oneOf.0.description","typeLabel":"string"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.0","typeLabel":"NumberTransferDestination · object"},{"type":"object","title":"SipTransferDestination","description":"This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.2.fallbackDestination.oneOf.1.description","typeLabel":"string"}},"uniqueKey":"oneOf.2.fallbackDestination.oneOf.1","typeLabel":"SipTransferDestination · object"}],"uniqueKey":"oneOf.2.fallbackDestination","typeLabel":"NumberTransferDestination · object | SipTransferDestination · object"},"hooks":{"type":"array","description":"This is the hooks that will be used for incoming calls to this phone number.","items":{"type":"object","title":"PhoneNumberHookCallRinging","required":["on","do"],"properties":{"on":{"type":"string","description":"This is the event to trigger the hook on","enum":["call.ringing"],"maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].on","typeLabel":"enum\u003cstring>"},"do":{"type":"array","description":"This is the set of actions to perform when the hook triggers","items":{"oneOf":[{"type":"object","title":"TransferPhoneNumberHookAction","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of action - must be \"transfer\"","enum":["transfer"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"destination":{"oneOf":[{"type":"object","title":"NumberTransferDestination","description":"This is the destination details for the transfer - can be a phone number or SIP URI","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.description","typeLabel":"string"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0","typeLabel":"NumberTransferDestination · object"},{"type":"object","title":"SipTransferDestination","description":"This is the destination details for the transfer - can be a phone number or SIP URI","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.description","typeLabel":"string"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1","typeLabel":"SipTransferDestination · object"}],"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination","typeLabel":"NumberTransferDestination · object | SipTransferDestination · object"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.0","typeLabel":"TransferPhoneNumberHookAction · object"},{"type":"object","title":"SayPhoneNumberHookAction","required":["type","exact"],"properties":{"type":{"type":"string","description":"This is the type of action - must be \"say\"","enum":["say"],"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"exact":{"type":"string","description":"This is the message to say","maxLength":4000,"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.1.exact","typeLabel":"string"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX].oneOf.1","typeLabel":"SayPhoneNumberHookAction · object"}],"uniqueKey":"oneOf.2.hooks.items.[INDEX].do.items.[INDEX]","typeLabel":"TransferPhoneNumberHookAction · object | SayPhoneNumberHookAction · object"},"isRequired":true,"uniqueKey":"oneOf.2.hooks.items.[INDEX].do","typeLabel":"(TransferPhoneNumberHookAction · object | SayPhoneNumberHookAction · object)[]"}},"uniqueKey":"oneOf.2.hooks.items.[INDEX]","typeLabel":"PhoneNumberHookCallRinging · object"},"uniqueKey":"oneOf.2.hooks","typeLabel":"PhoneNumberHookCallRinging · object[]"},"status":{"type":"string","description":"This is the status of the phone number.","enum":["active","activating","blocked"],"uniqueKey":"oneOf.2.status","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"This is the name of the phone number. This is just for your own reference.","maxLength":40,"uniqueKey":"oneOf.2.name","typeLabel":"string"},"assistantId":{"type":"string","description":"This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.2.assistantId","typeLabel":"string"},"workflowId":{"type":"string","description":"This is the workflow that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.2.workflowId","typeLabel":"string"},"squadId":{"type":"string","description":"This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.2.squadId","typeLabel":"string"},"server":{"type":"object","description":"This is where cozmox will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"oneOf.2.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"oneOf.2.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"oneOf.2.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"oneOf.2.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"oneOf.2.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"oneOf.2.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"oneOf.2.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"oneOf.2.server","typeLabel":"object"}},"uniqueKey":"oneOf.2","typeLabel":"VonagePhoneNumber · object"},{"type":"object","title":"cozmoxPhoneNumber","required":["provider","id","orgId","createdAt","updatedAt"],"properties":{"provider":{"type":"string","description":"This is to create free SIP phone numbers on cozmox.","enum":["cozmox"],"isRequired":true,"uniqueKey":"oneOf.3.provider","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"This is the unique identifier for the phone number.","isRequired":true,"uniqueKey":"oneOf.3.id","typeLabel":"string"},"orgId":{"type":"string","description":"This is the unique identifier for the org that this phone number belongs to.","isRequired":true,"uniqueKey":"oneOf.3.orgId","typeLabel":"string"},"createdAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the phone number was created.","isRequired":true,"uniqueKey":"oneOf.3.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the phone number was last updated.","isRequired":true,"uniqueKey":"oneOf.3.updatedAt","typeLabel":"string\u003cdate-time>"},"fallbackDestination":{"oneOf":[{"type":"object","title":"NumberTransferDestination","description":"This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.3.fallbackDestination.oneOf.0.description","typeLabel":"string"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.0","typeLabel":"NumberTransferDestination · object"},{"type":"object","title":"SipTransferDestination","description":"This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.3.fallbackDestination.oneOf.1.description","typeLabel":"string"}},"uniqueKey":"oneOf.3.fallbackDestination.oneOf.1","typeLabel":"SipTransferDestination · object"}],"uniqueKey":"oneOf.3.fallbackDestination","typeLabel":"NumberTransferDestination · object | SipTransferDestination · object"},"hooks":{"type":"array","description":"This is the hooks that will be used for incoming calls to this phone number.","items":{"type":"object","title":"PhoneNumberHookCallRinging","required":["on","do"],"properties":{"on":{"type":"string","description":"This is the event to trigger the hook on","enum":["call.ringing"],"maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].on","typeLabel":"enum\u003cstring>"},"do":{"type":"array","description":"This is the set of actions to perform when the hook triggers","items":{"oneOf":[{"type":"object","title":"TransferPhoneNumberHookAction","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of action - must be \"transfer\"","enum":["transfer"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"destination":{"oneOf":[{"type":"object","title":"NumberTransferDestination","description":"This is the destination details for the transfer - can be a phone number or SIP URI","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.description","typeLabel":"string"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0","typeLabel":"NumberTransferDestination · object"},{"type":"object","title":"SipTransferDestination","description":"This is the destination details for the transfer - can be a phone number or SIP URI","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.description","typeLabel":"string"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1","typeLabel":"SipTransferDestination · object"}],"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination","typeLabel":"NumberTransferDestination · object | SipTransferDestination · object"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.0","typeLabel":"TransferPhoneNumberHookAction · object"},{"type":"object","title":"SayPhoneNumberHookAction","required":["type","exact"],"properties":{"type":{"type":"string","description":"This is the type of action - must be \"say\"","enum":["say"],"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"exact":{"type":"string","description":"This is the message to say","maxLength":4000,"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.1.exact","typeLabel":"string"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX].oneOf.1","typeLabel":"SayPhoneNumberHookAction · object"}],"uniqueKey":"oneOf.3.hooks.items.[INDEX].do.items.[INDEX]","typeLabel":"TransferPhoneNumberHookAction · object | SayPhoneNumberHookAction · object"},"isRequired":true,"uniqueKey":"oneOf.3.hooks.items.[INDEX].do","typeLabel":"(TransferPhoneNumberHookAction · object | SayPhoneNumberHookAction · object)[]"}},"uniqueKey":"oneOf.3.hooks.items.[INDEX]","typeLabel":"PhoneNumberHookCallRinging · object"},"uniqueKey":"oneOf.3.hooks","typeLabel":"PhoneNumberHookCallRinging · object[]"},"status":{"type":"string","description":"This is the status of the phone number.","enum":["active","activating","blocked"],"uniqueKey":"oneOf.3.status","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"These are the digits of the phone number you purchased from cozmox.","uniqueKey":"oneOf.3.number","typeLabel":"string"},"name":{"type":"string","description":"This is the name of the phone number. This is just for your own reference.","maxLength":40,"uniqueKey":"oneOf.3.name","typeLabel":"string"},"assistantId":{"type":"string","description":"This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.3.assistantId","typeLabel":"string"},"workflowId":{"type":"string","description":"This is the workflow that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.3.workflowId","typeLabel":"string"},"squadId":{"type":"string","description":"This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.3.squadId","typeLabel":"string"},"server":{"type":"object","description":"This is where cozmox will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"oneOf.3.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"oneOf.3.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"oneOf.3.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"oneOf.3.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"oneOf.3.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"oneOf.3.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"oneOf.3.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"oneOf.3.server","typeLabel":"object"},"numberDesiredAreaCode":{"type":"string","description":"This is the area code of the phone number to purchase.","minLength":3,"maxLength":3,"uniqueKey":"oneOf.3.numberDesiredAreaCode","typeLabel":"string"},"sipUri":{"type":"string","description":"This is the SIP URI of the phone number. You can SIP INVITE this. The assistant attached to this number will answer.\n\nThis is case-insensitive.","uniqueKey":"oneOf.3.sipUri","typeLabel":"string"},"authentication":{"type":"object","description":"This enables authentication for incoming SIP INVITE requests to the `sipUri`.\n\nIf not set, any username/password to the 401 challenge of the SIP INVITE will be accepted.","required":["username","password"],"properties":{"username":{"type":"string","description":"This will be expected in the `username` field of the `authorization` header of the SIP INVITE.","minLength":20,"maxLength":40,"isRequired":true,"uniqueKey":"oneOf.3.authentication.username","typeLabel":"string"},"password":{"type":"string","description":"This will be expected to generate the `response` field of the `authorization` header of the SIP INVITE, through digest authentication.","minLength":20,"maxLength":40,"isRequired":true,"uniqueKey":"oneOf.3.authentication.password","typeLabel":"string"},"realm":{"type":"string","description":"This will be expected in the `realm` field of the `authorization` header of the SIP INVITE. Defaults to sip.cozmox.ai.","uniqueKey":"oneOf.3.authentication.realm","typeLabel":"string"}},"uniqueKey":"oneOf.3.authentication","typeLabel":"object"}},"uniqueKey":"oneOf.3","typeLabel":"cozmoxPhoneNumber · object"},{"type":"object","title":"TelnyxPhoneNumber","required":["provider","id","orgId","createdAt","updatedAt","number","credentialId"],"properties":{"provider":{"type":"string","description":"This is to use numbers bought on Telnyx.","enum":["telnyx"],"isRequired":true,"uniqueKey":"oneOf.4.provider","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"This is the unique identifier for the phone number.","isRequired":true,"uniqueKey":"oneOf.4.id","typeLabel":"string"},"orgId":{"type":"string","description":"This is the unique identifier for the org that this phone number belongs to.","isRequired":true,"uniqueKey":"oneOf.4.orgId","typeLabel":"string"},"createdAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the phone number was created.","isRequired":true,"uniqueKey":"oneOf.4.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the phone number was last updated.","isRequired":true,"uniqueKey":"oneOf.4.updatedAt","typeLabel":"string\u003cdate-time>"},"number":{"type":"string","description":"These are the digits of the phone number you own on your Telnyx.","isRequired":true,"uniqueKey":"oneOf.4.number","typeLabel":"string"},"credentialId":{"type":"string","description":"This is the credential you added in dashboard.cozmox.ai/keys. This is used to configure the number to send inbound calls to cozmox, make outbound calls and do live call updates like transfers and hangups.","isRequired":true,"uniqueKey":"oneOf.4.credentialId","typeLabel":"string"},"fallbackDestination":{"oneOf":[{"type":"object","title":"NumberTransferDestination","description":"This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.4.fallbackDestination.oneOf.0.description","typeLabel":"string"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.0","typeLabel":"NumberTransferDestination · object"},{"type":"object","title":"SipTransferDestination","description":"This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.4.fallbackDestination.oneOf.1.description","typeLabel":"string"}},"uniqueKey":"oneOf.4.fallbackDestination.oneOf.1","typeLabel":"SipTransferDestination · object"}],"uniqueKey":"oneOf.4.fallbackDestination","typeLabel":"NumberTransferDestination · object | SipTransferDestination · object"},"hooks":{"type":"array","description":"This is the hooks that will be used for incoming calls to this phone number.","items":{"type":"object","title":"PhoneNumberHookCallRinging","required":["on","do"],"properties":{"on":{"type":"string","description":"This is the event to trigger the hook on","enum":["call.ringing"],"maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].on","typeLabel":"enum\u003cstring>"},"do":{"type":"array","description":"This is the set of actions to perform when the hook triggers","items":{"oneOf":[{"type":"object","title":"TransferPhoneNumberHookAction","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of action - must be \"transfer\"","enum":["transfer"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"destination":{"oneOf":[{"type":"object","title":"NumberTransferDestination","description":"This is the destination details for the transfer - can be a phone number or SIP URI","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0.description","typeLabel":"string"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.0","typeLabel":"NumberTransferDestination · object"},{"type":"object","title":"SipTransferDestination","description":"This is the destination details for the transfer - can be a phone number or SIP URI","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1.description","typeLabel":"string"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination.oneOf.1","typeLabel":"SipTransferDestination · object"}],"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0.destination","typeLabel":"NumberTransferDestination · object | SipTransferDestination · object"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.0","typeLabel":"TransferPhoneNumberHookAction · object"},{"type":"object","title":"SayPhoneNumberHookAction","required":["type","exact"],"properties":{"type":{"type":"string","description":"This is the type of action - must be \"say\"","enum":["say"],"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"exact":{"type":"string","description":"This is the message to say","maxLength":4000,"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.1.exact","typeLabel":"string"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX].oneOf.1","typeLabel":"SayPhoneNumberHookAction · object"}],"uniqueKey":"oneOf.4.hooks.items.[INDEX].do.items.[INDEX]","typeLabel":"TransferPhoneNumberHookAction · object | SayPhoneNumberHookAction · object"},"isRequired":true,"uniqueKey":"oneOf.4.hooks.items.[INDEX].do","typeLabel":"(TransferPhoneNumberHookAction · object | SayPhoneNumberHookAction · object)[]"}},"uniqueKey":"oneOf.4.hooks.items.[INDEX]","typeLabel":"PhoneNumberHookCallRinging · object"},"uniqueKey":"oneOf.4.hooks","typeLabel":"PhoneNumberHookCallRinging · object[]"},"status":{"type":"string","description":"This is the status of the phone number.","enum":["active","activating","blocked"],"uniqueKey":"oneOf.4.status","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"This is the name of the phone number. This is just for your own reference.","maxLength":40,"uniqueKey":"oneOf.4.name","typeLabel":"string"},"assistantId":{"type":"string","description":"This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.4.assistantId","typeLabel":"string"},"workflowId":{"type":"string","description":"This is the workflow that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.4.workflowId","typeLabel":"string"},"squadId":{"type":"string","description":"This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.","uniqueKey":"oneOf.4.squadId","typeLabel":"string"},"server":{"type":"object","description":"This is where cozmox will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"oneOf.4.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"oneOf.4.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"oneOf.4.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"oneOf.4.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"oneOf.4.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"oneOf.4.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"oneOf.4.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"oneOf.4.server","typeLabel":"object"}},"uniqueKey":"oneOf.4","typeLabel":"TelnyxPhoneNumber · object"}],"uniqueKey":"","typeLabel":"ByoPhoneNumber · object | TwilioPhoneNumber · object | VonagePhoneNumber · object | cozmoxPhoneNumber · object | TelnyxPhoneNumber · object"},"examples":{"Example":{"title":"Example","value":{"provider":"byo-phone-number","id":"\u003cstring>","orgId":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","credentialId":"\u003cstring>","fallbackDestination":{"type":"number","number":"\u003cstring>","message":"\u003cstring>","numberE164CheckEnabled":true,"extension":"\u003cstring>","callerId":"\u003cstring>","transferPlan":{"mode":"blind-transfer","message":"\u003cstring>","timeout":60,"sipVerb":"refer","holdAudioUrl":"\u003cstring>","transferCompleteAudioUrl":"\u003cstring>","twiml":"\u003cstring>","summaryPlan":{"messages":[{}],"enabled":true,"timeoutSeconds":30.5},"sipHeadersInReferToEnabled":true,"fallbackPlan":{"message":"\u003cstring>","endCallEnabled":true}},"description":"\u003cstring>"},"hooks":[{"on":"call.ringing","do":[{"type":"transfer","destination":{"type":"number","number":"\u003cstring>","message":"\u003cstring>","numberE164CheckEnabled":true,"extension":"\u003cstring>","callerId":"\u003cstring>","transferPlan":{"mode":"blind-transfer","message":"\u003cstring>","timeout":60,"sipVerb":"refer","holdAudioUrl":"\u003cstring>","transferCompleteAudioUrl":"\u003cstring>","twiml":"\u003cstring>","summaryPlan":{"messages":[{}],"enabled":true,"timeoutSeconds":30.5},"sipHeadersInReferToEnabled":true,"fallbackPlan":{"message":"\u003cstring>","endCallEnabled":true}},"description":"\u003cstring>"}}]}],"numberE164CheckEnabled":true,"status":"active","name":"\u003cstring>","assistantId":"\u003cstring>","workflowId":"\u003cstring>","squadId":"\u003cstring>","server":{"timeoutSeconds":20,"url":"\u003cstring>","headers":{},"backoffPlan":{"type":"fixed","maxRetries":0,"baseDelaySeconds":1}},"number":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"3bede193-7672-415c-a0ac-364a13737695":{"bearer":{"scheme":"bearer","bearerFormat":"Bearer","type":"http","description":"Retrieve your API Key from [Dashboard](dashboard.cozmox.ai).","scopes":[]}}},"servers":{"b5b8326a-680d-4e65-bd4d-46e31c9c1334":{"description":"Cozmox APIs","url":"https://api.cozmox.ai"},"1698761f-fe56-43c1-839e-05ab7d829049":{"url":"https://api.cozmox.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"scheme":"bearer","bearerFormat":"Bearer","type":"http","description":"Retrieve your API Key from [Dashboard](dashboard.cozmox.ai).","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Retrieve your API Key from [Dashboard](dashboard.cozmox.ai).","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"czmx","siteName":"Cozmox-AI Nebula SDK","title":"Update Phone Number - Cozmox-AI Nebula SDK","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"api-reference/phone-numbers/update-phone-number.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=\"application-name\" content=\"Cozmox-AI Nebula SDK\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/czmx/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/czmx/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/czmx/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/czmx/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update Phone Number - Cozmox-AI Nebula SDK\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cozmox-AI Nebula SDK\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cozmox.cloud/api-reference/phone-numbers/update-phone-number\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://czmx.mintlify.site/_mintlify/api/og/v2?division=Phone+Numbers\u0026amp;title=Update+Phone+Number\u0026amp;theme=95ed1721ed9e0ffde4c2ee1b\u0026amp;signature=32110a05b6347c2d48836ad70fe6d5cc4fa52f52b09356b64d22707587faeda1\">\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=\"Update Phone Number - Cozmox-AI Nebula SDK\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://czmx.mintlify.site/_mintlify/api/og/v2?division=Phone+Numbers\u0026amp;title=Update+Phone+Number\u0026amp;theme=95ed1721ed9e0ffde4c2ee1b\u0026amp;signature=32110a05b6347c2d48836ad70fe6d5cc4fa52f52b09356b64d22707587faeda1\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/czmx/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cozmox-AI Nebula SDK\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF5911\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.cozmox.cloud/api-reference/phone-numbers/update-phone-number\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/phone-numbers/update-phone-number.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.cozmox.cloud/#organization\",\"name\":\"Cozmox-AI Nebula SDK\",\"url\":\"https://docs.cozmox.cloud\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintlify.s3.us-west-1.amazonaws.com/czmx/logo/logo_light.svg\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.cozmox.cloud#website\",\"name\":\"Cozmox-AI Nebula SDK\",\"url\":\"https://docs.cozmox.cloud\",\"publisher\":{\"@id\":\"https://docs.cozmox.cloud/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.cozmox.cloud/api-reference/phone-numbers/update-phone-number#webpage\",\"url\":\"https://docs.cozmox.cloud/api-reference/phone-numbers/update-phone-number\",\"name\":\"Update Phone Number\",\"isPartOf\":{\"@id\":\"https://docs.cozmox.cloud#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cozmox.cloud/api-reference/phone-numbers/update-phone-number#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cozmox.cloud/api-reference/phone-numbers/update-phone-number#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Phone Numbers\",\"item\":\"https://docs.cozmox.cloud/api-reference/phone-numbers/create-phone-number\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update Phone Number\",\"item\":\"https://docs.cozmox.cloud/api-reference/phone-numbers/update-phone-number\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.cozmox.cloud/api-reference/phone-numbers/update-phone-number#apireference\",\"headline\":\"Update Phone Number\",\"name\":\"Update Phone Number\",\"url\":\"https://docs.cozmox.cloud/api-reference/phone-numbers/update-phone-number\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cozmox.cloud/api-reference/phone-numbers/update-phone-number#webpage\"},\"publisher\":{\"@id\":\"https://docs.cozmox.cloud/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cozmox.cloud#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Cozmox-AI Nebula SDK\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Cozmox-AI Nebula SDK\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/phone-numbers/update-phone-number.md","siteName":"Cozmox-AI Nebula SDK","nav":{"global":null,"tabs":[{"tab":"Documentation","anchors":[{"anchor":"API Reference","icon":"square-terminal","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Webhooks","pages":[{"title":"Introduction","href":"/api-reference/webhooks"}]},{"group":"Voice Agent UI","pages":[{"title":"Introduction","href":"/api-reference/embedded"}]},{"group":"STT Usage","pages":[{"title":"Socket STT","href":"/api-reference/socket"}]},{"group":"Endpoint Examples","pages":[{"title":"Delete file","href":"/api-reference/endpoint/delete-file"},{"openapi":"post /call","title":"Create Call","href":"/api-reference/calls/create-call"}]},{"group":"Assistants","pages":[{"openapi":"post /assistant","title":"Create Assistant","href":"/api-reference/assistants/create-assistant"},{"openapi":"delete /assistant/{id}","title":"Delete Assistant","href":"/api-reference/assistants/delete-assistant"},{"openapi":"get /assistant/{id}","title":"Get Assistant","href":"/api-reference/assistants/get-assistant"},{"openapi":"get /assistant","title":"List Assistants","href":"/api-reference/assistants/list-assistants"},{"openapi":"patch /assistant/{id}","title":"Update Assistant","href":"/api-reference/assistants/update-assistant"}]},{"group":"Calls","pages":[{"openapi":"post /call","title":"Create Call","href":"/api-reference/calls/create-call"},{"openapi":"delete /call/{id}","title":"Delete Call Data","href":"/api-reference/calls/delete-call-data"},{"openapi":"get /call/{id}","title":"Get Call","href":"/api-reference/calls/get-call"},{"openapi":"get /call","title":"List Calls","href":"/api-reference/calls/list-calls"},{"openapi":"patch /call/{id}","title":"Update Call","href":"/api-reference/calls/update-call"}]},{"group":"Campaigns","pages":[{"openapi":"post /campaign","title":"Create Campaign","href":"/api-reference/campaigns/create-campaign"},{"openapi":"delete /campaign/{id}","title":"Delete Campaign","href":"/api-reference/campaigns/delete-campaign"},{"openapi":"get /campaign/{id}","title":"Get Campaign","href":"/api-reference/campaigns/get-campaign"},{"openapi":"get /campaign","title":"List Campaigns","href":"/api-reference/campaigns/list-campaigns"},{"openapi":"patch /campaign/{id}","title":"Update Campaign","href":"/api-reference/campaigns/update-campaign"}]},{"group":"Chats","pages":[{"openapi":"post /chat/responses","title":"Create Chat (OpenAI Compatible)","href":"/api-reference/chats/create-chat-openai-compatible"},{"openapi":"post /chat","title":"Create Chat","href":"/api-reference/chats/create-chat"},{"openapi":"delete /chat/{id}","title":"Delete Chat","href":"/api-reference/chats/delete-chat"},{"openapi":"get /chat/{id}","title":"Get Chat","href":"/api-reference/chats/get-chat"},{"openapi":"get /chat","title":"List Chats","href":"/api-reference/chats/list-chats"}]},{"group":"Files","pages":[{"openapi":"delete /file/{id}","title":"Delete File","href":"/api-reference/files/delete-file"},{"openapi":"get /file/{id}","title":"Get File","href":"/api-reference/files/get-file"},{"openapi":"get /file","title":"List Files","href":"/api-reference/files/list-files"},{"openapi":"patch /file/{id}","title":"Update File","href":"/api-reference/files/update-file"},{"openapi":"post /file","title":"Upload File","href":"/api-reference/files/upload-file"}]},{"group":"Knowledge Base","pages":[{"openapi":"post /knowledge-base","title":"Create Knowledge Base","href":"/api-reference/knowledge-base/create-knowledge-base"},{"openapi":"get /knowledge-base/{id}","title":"Get Knowledge Base","href":"/api-reference/knowledge-base/get-knowledge-base"},{"openapi":"delete /knowledge-base/{id}","title":"Delete Knowledge Base","href":"/api-reference/knowledge-base/delete-knowledge-base"},{"openapi":"get /knowledge-base","title":"List Knowledge Bases","href":"/api-reference/knowledge-base/list-knowledge-bases"},{"openapi":"patch /knowledge-base/{id}","title":"Update Knowledge Base","href":"/api-reference/knowledge-base/update-knowledge-base"}]},{"group":"Logs","pages":[{"openapi":"delete /logs","deprecated":true,"title":"Delete Logs","href":"/api-reference/logs/delete-logs"},{"openapi":"get /logs","deprecated":true,"title":"Get Logs","href":"/api-reference/logs/get-logs"}]},{"group":"Phone Numbers","pages":[{"openapi":"post /phone-number","title":"Create Phone Number","href":"/api-reference/phone-numbers/create-phone-number"},{"openapi":"delete /phone-number/{id}","title":"Delete Phone Number","href":"/api-reference/phone-numbers/delete-phone-number"},{"openapi":"get /phone-number/{id}","title":"Get Phone Number","href":"/api-reference/phone-numbers/get-phone-number"},{"openapi":"get /phone-number","title":"List Phone Numbers","description":null,"href":"/api-reference/phone-numbers/list-phone-numbers"},{"openapi":"patch /phone-number/{id}","title":"Update Phone Number","href":"/api-reference/phone-numbers/update-phone-number"}]},{"group":"Sessions","pages":[{"openapi":"post /session","title":"Create Session","description":null,"href":"/api-reference/sessions/create-session"},{"openapi":"delete /session/{id}","title":"Delete Session","href":"/api-reference/sessions/delete-session"},{"openapi":"get /session/{id}","title":"Get Session","href":"/api-reference/sessions/get-session"},{"openapi":"get /session","title":"List Sessions","href":"/api-reference/sessions/list-sessions"},{"openapi":"patch /session/{id}","title":"Update Session","href":"/api-reference/sessions/update-session"}]},{"group":"Tools","pages":[{"openapi":"post /tool","title":"Create Tool","href":"/api-reference/tools/create-tool"},{"openapi":"delete /tool/{id}","title":"Delete Tool","href":"/api-reference/tools/delete-tool"},{"openapi":"get /tool/{id}","title":"Get Tool","href":"/api-reference/tools/get-tool"},{"openapi":"get /tool","title":"List Tools","href":"/api-reference/tools/list-tools"},{"openapi":"patch /tool/{id}","title":"Update Tool","href":"/api-reference/tools/update-tool"}]},{"group":"Workflow","pages":[{"openapi":"post /workflow","title":"Create Workflow","href":"/api-reference/workflow/create-workflow"},{"openapi":"delete /workflow/{id}","title":"Delete Workflow","href":"/api-reference/workflow/delete-workflow"},{"openapi":"get /workflow/{id}","title":"Get Workflow","href":"/api-reference/workflow/get-workflow"},{"openapi":"get /workflow","title":"Get Workflows","href":"/api-reference/workflow/get-workflows"},{"openapi":"patch /workflow/{id}","title":"Update Workflow","href":"/api-reference/workflow/update-workflow"}]},{"group":"SDK","pages":[{"openapi":"https://api.cozmox.cloud/api-json get /v1/nebula/hello","href":"/api-reference/sdk/hello","title":"Hello","deprecated":null,"version":null}]},{"group":"Outbound","pages":[{"openapi":"https://api.cozmox.cloud/api-json post /v1/outbound/create-call","href":"/api-reference/outbound/create-a-call","title":"Create a call","deprecated":null,"version":null},{"openapi":"https://api.cozmox.cloud/api-json post /v1/outbound/retrieve-call","href":"/api-reference/outbound/retrieve-a-call","title":"Retrieve a call","deprecated":null,"version":null}]},{"group":"Concurrency","pages":[{"openapi":"https://api.cozmox.cloud/api-json get /v1/concurrency/retrieve","href":"/api-reference/concurrency/call-concurrency","title":"Call concurrency","deprecated":null,"version":null}]}]}]},{"tab":"API Reference","anchors":[{"anchor":"API Reference","icon":"square-terminal","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Webhooks","pages":[{"title":"Introduction","href":"/api-reference/webhooks"}]},{"group":"Voice Agent UI","pages":[{"title":"Introduction","href":"/api-reference/embedded"}]},{"group":"STT Usage","pages":[{"title":"Socket STT","href":"/api-reference/socket"}]},{"group":"Endpoint Examples","pages":[{"title":"Delete file","href":"/api-reference/endpoint/delete-file"},{"openapi":"post /call","title":"Create Call","href":"/api-reference/calls/create-call"}]},{"group":"Assistants","pages":[{"openapi":"post /assistant","title":"Create Assistant","href":"/api-reference/assistants/create-assistant"},{"openapi":"delete /assistant/{id}","title":"Delete Assistant","href":"/api-reference/assistants/delete-assistant"},{"openapi":"get /assistant/{id}","title":"Get Assistant","href":"/api-reference/assistants/get-assistant"},{"openapi":"get /assistant","title":"List Assistants","href":"/api-reference/assistants/list-assistants"},{"openapi":"patch /assistant/{id}","title":"Update Assistant","href":"/api-reference/assistants/update-assistant"}]},{"group":"Calls","pages":[{"openapi":"post /call","title":"Create Call","href":"/api-reference/calls/create-call"},{"openapi":"delete /call/{id}","title":"Delete Call Data","href":"/api-reference/calls/delete-call-data"},{"openapi":"get /call/{id}","title":"Get Call","href":"/api-reference/calls/get-call"},{"openapi":"get /call","title":"List Calls","href":"/api-reference/calls/list-calls"},{"openapi":"patch /call/{id}","title":"Update Call","href":"/api-reference/calls/update-call"}]},{"group":"Campaigns","pages":[{"openapi":"post /campaign","title":"Create Campaign","href":"/api-reference/campaigns/create-campaign"},{"openapi":"delete /campaign/{id}","title":"Delete Campaign","href":"/api-reference/campaigns/delete-campaign"},{"openapi":"get /campaign/{id}","title":"Get Campaign","href":"/api-reference/campaigns/get-campaign"},{"openapi":"get /campaign","title":"List Campaigns","href":"/api-reference/campaigns/list-campaigns"},{"openapi":"patch /campaign/{id}","title":"Update Campaign","href":"/api-reference/campaigns/update-campaign"}]},{"group":"Chats","pages":[{"openapi":"post /chat/responses","title":"Create Chat (OpenAI Compatible)","href":"/api-reference/chats/create-chat-openai-compatible"},{"openapi":"post /chat","title":"Create Chat","href":"/api-reference/chats/create-chat"},{"openapi":"delete /chat/{id}","title":"Delete Chat","href":"/api-reference/chats/delete-chat"},{"openapi":"get /chat/{id}","title":"Get Chat","href":"/api-reference/chats/get-chat"},{"openapi":"get /chat","title":"List Chats","href":"/api-reference/chats/list-chats"}]},{"group":"Files","pages":[{"openapi":"delete /file/{id}","title":"Delete File","href":"/api-reference/files/delete-file"},{"openapi":"get /file/{id}","title":"Get File","href":"/api-reference/files/get-file"},{"openapi":"get /file","title":"List Files","href":"/api-reference/files/list-files"},{"openapi":"patch /file/{id}","title":"Update File","href":"/api-reference/files/update-file"},{"openapi":"post /file","title":"Upload File","href":"/api-reference/files/upload-file"}]},{"group":"Knowledge Base","pages":[{"openapi":"post /knowledge-base","title":"Create Knowledge Base","href":"/api-reference/knowledge-base/create-knowledge-base"},{"openapi":"get /knowledge-base/{id}","title":"Get Knowledge Base","href":"/api-reference/knowledge-base/get-knowledge-base"},{"openapi":"delete /knowledge-base/{id}","title":"Delete Knowledge Base","href":"/api-reference/knowledge-base/delete-knowledge-base"},{"openapi":"get /knowledge-base","title":"List Knowledge Bases","href":"/api-reference/knowledge-base/list-knowledge-bases"},{"openapi":"patch /knowledge-base/{id}","title":"Update Knowledge Base","href":"/api-reference/knowledge-base/update-knowledge-base"}]},{"group":"Logs","pages":[{"openapi":"delete /logs","deprecated":true,"title":"Delete Logs","href":"/api-reference/logs/delete-logs"},{"openapi":"get /logs","deprecated":true,"title":"Get Logs","href":"/api-reference/logs/get-logs"}]},{"group":"Phone Numbers","pages":[{"openapi":"post /phone-number","title":"Create Phone Number","href":"/api-reference/phone-numbers/create-phone-number"},{"openapi":"delete /phone-number/{id}","title":"Delete Phone Number","href":"/api-reference/phone-numbers/delete-phone-number"},{"openapi":"get /phone-number/{id}","title":"Get Phone Number","href":"/api-reference/phone-numbers/get-phone-number"},{"openapi":"get /phone-number","title":"List Phone Numbers","description":null,"href":"/api-reference/phone-numbers/list-phone-numbers"},{"openapi":"patch /phone-number/{id}","title":"Update Phone Number","href":"/api-reference/phone-numbers/update-phone-number"}]},{"group":"Sessions","pages":[{"openapi":"post /session","title":"Create Session","description":null,"href":"/api-reference/sessions/create-session"},{"openapi":"delete /session/{id}","title":"Delete Session","href":"/api-reference/sessions/delete-session"},{"openapi":"get /session/{id}","title":"Get Session","href":"/api-reference/sessions/get-session"},{"openapi":"get /session","title":"List Sessions","href":"/api-reference/sessions/list-sessions"},{"openapi":"patch /session/{id}","title":"Update Session","href":"/api-reference/sessions/update-session"}]},{"group":"Tools","pages":[{"openapi":"post /tool","title":"Create Tool","href":"/api-reference/tools/create-tool"},{"openapi":"delete /tool/{id}","title":"Delete Tool","href":"/api-reference/tools/delete-tool"},{"openapi":"get /tool/{id}","title":"Get Tool","href":"/api-reference/tools/get-tool"},{"openapi":"get /tool","title":"List Tools","href":"/api-reference/tools/list-tools"},{"openapi":"patch /tool/{id}","title":"Update Tool","href":"/api-reference/tools/update-tool"}]},{"group":"Workflow","pages":[{"openapi":"post /workflow","title":"Create Workflow","href":"/api-reference/workflow/create-workflow"},{"openapi":"delete /workflow/{id}","title":"Delete Workflow","href":"/api-reference/workflow/delete-workflow"},{"openapi":"get /workflow/{id}","title":"Get Workflow","href":"/api-reference/workflow/get-workflow"},{"openapi":"get /workflow","title":"Get Workflows","href":"/api-reference/workflow/get-workflows"},{"openapi":"patch /workflow/{id}","title":"Update Workflow","href":"/api-reference/workflow/update-workflow"}]},{"group":"SDK","pages":[{"openapi":"https://api.cozmox.cloud/api-json get /v1/nebula/hello","href":"/api-reference/sdk/hello","title":"Hello","deprecated":null,"version":null}]},{"group":"Outbound","pages":[{"openapi":"https://api.cozmox.cloud/api-json post /v1/outbound/create-call","href":"/api-reference/outbound/create-a-call","title":"Create a call","deprecated":null,"version":null},{"openapi":"https://api.cozmox.cloud/api-json post /v1/outbound/retrieve-call","href":"/api-reference/outbound/retrieve-a-call","title":"Retrieve a call","deprecated":null,"version":null}]},{"group":"Concurrency","pages":[{"openapi":"https://api.cozmox.cloud/api-json get /v1/concurrency/retrieve","href":"/api-reference/concurrency/call-concurrency","title":"Call concurrency","deprecated":null,"version":null}]}]}]}]},"basePath":"","title":"Update Phone Number - Cozmox-AI Nebula SDK","buildId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","deploymentId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BFmjTMeT.js","utils-BWr-sjpP.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-LafIDf0N.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-MJNzuxek.js","snippetPresets-DPZEtUvW.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DQ2UhGIs.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DUUJTUkE.js","shallow-BTf5bw35.js","getApiPlaygroundDisplay-h2POYYOO.js","CodeSnippet-C4qEftRe.js","CodeSnippets-CsSrOqMC.js","Page-CWFqNdGh.js","getPastedJson-DU6W6y78.js","icon-2ZYNQ78y.js","MethodPill-BMXJzYMm.js","DuplicateIcon-DNjdEpYZ.js","createIcon-WdPVhKxl.js","DynamicMarkdown-Z_y464fM.js","SectionHeading-Bcrd8azU.js","axios-vUo_bRtp.js","Markdown-BnvucbFu.js","dist-D7YyC486.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-D1I8TPjt.js"]}