Properties
| Name | Type | Description |
|---|---|---|
| beepMaxAwaitSeconds | number | This is the maximum duration from the start of the call that we will wait for a voicemail beep, before speaking our message - If we detect a voicemail beep before this, we will speak the message at th |
| provider | string | This is the provider to use for voicemail detection. |
| backoffPlan | object | This is the backoff plan for the voicemail detection. |
| type | string | This is the detection type to use for voicemail detection. - 'audio': Uses native audio models (default) - 'transcript': Uses ASR/transcript-based detection @default 'audio' (audio detection) |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/OpenAIVoicemailDetectionPlan",
"title": "OpenAIVoicemailDetectionPlan",
"type": "object",
"properties": {
"beepMaxAwaitSeconds": {
"type": "number",
"description": "This is the maximum duration from the start of the call that we will wait for a voicemail beep, before speaking our message\n\n- If we detect a voicemail beep before this, we will speak the message at that point.\n\n- Setting too low a value means that the bot will start speaking its voicemail message too early. If it does so before the actual beep, it will get cut off. You should definitely tune this to your use case.\n\n@default 30\n@min 0\n@max 60",
"minimum": 0,
"maximum": 30,
"default": 30
},
"provider": {
"type": "string",
"description": "This is the provider to use for voicemail detection.",
"enum": [
"openai"
]
},
"backoffPlan": {
"description": "This is the backoff plan for the voicemail detection.",
"allOf": [
{
"$ref": "#/components/schemas/VoicemailDetectionBackoffPlan"
}
]
},
"type": {
"type": "string",
"description": "This is the detection type to use for voicemail detection.\n- 'audio': Uses native audio models (default)\n- 'transcript': Uses ASR/transcript-based detection\n@default 'audio' (audio detection)",
"enum": [
"audio",
"transcript"
]
}
},
"required": [
"provider"
]
}