Skip to main content
PATCH
Update a revision's voice call behavior settings

Authorizations

x-api-key
string
header
required

Path Parameters

agent_id
string<uuid>
required
revision_id
string<uuid>
required

Body

application/json

All-optional PATCH input for voice call settings.

Unset fields (None) mean "don't change". Only explicitly provided fields are applied by merge_patch.

interruptions_enabled
boolean | null
interruption_min_words
integer | null
Required range: 0 <= x <= 20
interruption_min_duration_ms
integer | null
Required range: 0 <= x <= 10000
interruption_backoff_ms
integer | null
Required range: 0 <= x <= 10000
interruption_trigger_phrases
string[] | null
Maximum array length: 50
interruption_hard_phrases
string[] | null
Maximum array length: 20
interruption_final_transcript_grace_ms
integer | null
Required range: 0 <= x <= 2000
dtmf_enabled
boolean | null
dtmf_termination_digit
string | null
Maximum string length: 1
dtmf_inter_digit_timeout_ms
integer | null
Required range: 250 <= x <= 60000
dtmf_max_digits
integer | null
Required range: 1 <= x <= 64
dtmf_prefix
string | null
Maximum string length: 32
max_call_duration_ms
integer | null
Required range: 1000 <= x <= 1800000
silence_timeout_ms
integer | null
Required range: 0 <= x <= 600000
silence_reminder_count
integer | null
Required range: 0 <= x <= 10
silence_reminder_mode
enum<string> | null
Available options:
static,
auto
silence_reminder_message
string | null
Maximum string length: 500
silence_end_action
enum<string> | null
Available options:
hangup_immediate,
speak_then_hangup
silence_end_message
string | null
Maximum string length: 500
voicemail_detection_mode
enum<string> | null
Available options:
off,
leave_message
voicemail_detection_timeout_ms
integer | null
Required range: 0 <= x <= 60000
voicemail_detection_model
string | null
Maximum string length: 64
voicemail_message
string | null
Maximum string length: 1000
background_audio_enabled
boolean | null
background_audio_preset
enum<string> | null
Available options:
office,
cafe,
city,
keyboard_typing,
keyboard_typing2
background_audio_volume
number | null
Required range: 0 <= x <= 1
background_audio_loop
boolean | null
recording_enabled
boolean | null
transcription_storage_enabled
boolean | null

Response

Successful Response

Complete voice call behavior settings with all defaults populated.

Stored as a JSON column on AgentRevision, Team, and Persona. Every field has a default so NULL/{} stored JSON resolves to the schema defaults — the legacy VoicePipelineConfig scalar columns these defaults once mirrored were dropped by migration 0219.

interruptions_enabled
boolean
default:true
interruption_min_words
integer
default:2
Required range: 0 <= x <= 20
interruption_min_duration_ms
integer
default:0
Required range: 0 <= x <= 10000
interruption_backoff_ms
integer
default:1000
Required range: 0 <= x <= 10000
interruption_trigger_phrases
string[]
Maximum array length: 50
interruption_hard_phrases
string[]
Maximum array length: 20
interruption_final_transcript_grace_ms
integer
default:250
Required range: 0 <= x <= 2000
dtmf_enabled
boolean
default:false
dtmf_termination_digit
string
default:#
Maximum string length: 1
dtmf_inter_digit_timeout_ms
integer
default:3000
Required range: 250 <= x <= 60000
dtmf_max_digits
integer
default:32
Required range: 1 <= x <= 64
dtmf_prefix
string
default:DTMF:
Maximum string length: 32
max_call_duration_ms
integer
default:600000
Required range: 1000 <= x <= 1800000
silence_timeout_ms
integer
default:30000
Required range: 0 <= x <= 600000
silence_reminder_count
integer
default:0
Required range: 0 <= x <= 10
silence_reminder_mode
enum<string>
default:static
Available options:
static,
auto
silence_reminder_message
string | null
Maximum string length: 500
silence_end_action
enum<string>
default:hangup_immediate
Available options:
hangup_immediate,
speak_then_hangup
silence_end_message
string | null
Maximum string length: 500
voicemail_detection_mode
enum<string>
default:off
Available options:
off,
leave_message
voicemail_detection_timeout_ms
integer
default:2000
Required range: 0 <= x <= 60000
voicemail_detection_model
string | null
Maximum string length: 64
voicemail_message
string | null
Maximum string length: 1000
background_audio_enabled
boolean
default:false
background_audio_preset
enum<string> | null
Available options:
office,
cafe,
city,
keyboard_typing,
keyboard_typing2
background_audio_volume
number
default:0.4
Required range: 0 <= x <= 1
background_audio_loop
boolean
default:true
recording_enabled
boolean
default:true
transcription_storage_enabled
boolean
default:true