EffectiveSettings
The settings a Session runs on, resolved across the layers.
An object with 9 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
call_control | object | yes | |
call_control.answering_machine_detection | object | no | The resolved detection settings (1.50.0), the message rendered. The api from 1.50.0 always sends them; absent, from an older api, the worker does not detect. |
call_control.answering_machine_detection.decision_window_ms | integer | yes | |
call_control.answering_machine_detection.enabled | boolean | yes | |
call_control.answering_machine_detection.message | string or null | yes | The text left on a machine (1.50.0): a template over declared variables, {{variables.<name>}}, rendered by the api at admission like the greeting; in PHI mode it may not refer to a variable declared phi (voicemail_phi_variable), because a voicemail box is not a verified listener. |
call_control.answering_machine_detection.on_machine | AnsweringMachineOnMachine | yes | |
call_control.answering_machine_detection.sensitivity | AnsweringMachineSensitivity | yes | |
call_control.model_actions | object | yes | |
call_control.model_actions.end_call | boolean | yes | |
call_control.transfer | object | no | The resolved transfer settings (1.50.0). The api from 1.50.0 always sends them; absent, from an older api, the worker uses TRANSFER_SETTING_DEFAULTS. |
call_control.transfer.context_note | ContextNoteMode | yes | |
call_control.transfer.presented_caller_id | PresentedCallerId | yes | |
limits | object | yes | |
limits.max_duration_s | integer | yes | |
listening | object | yes | |
listening.end_of_turn | object | yes | |
listening.end_of_turn.adaptive | boolean | yes | |
listening.end_of_turn.after_question_window_enabled | boolean | no | Absent from an api older than 1.41.0, when the worker takes the default. |
listening.end_of_turn.after_question_window_ms | integer | no | Absent from an api older than 1.39.0, when the worker keeps its own value. |
listening.end_of_turn.confirmation_enabled | boolean | no | Absent from an api older than 1.41.0, when the worker takes the default. |
listening.end_of_turn.confirmation_on_final | ConfirmationOnFinalEffective | no | |
listening.end_of_turn.confirmation_on_interim | ConfirmationOnInterimEffective | no | |
listening.end_of_turn.confirmation_phrases | array of LexiconPhrase | no | Absent from an api older than 1.39.0, when the worker keeps its own value. |
listening.end_of_turn.detector | EndOfTurnDetector | yes | |
listening.end_of_turn.hold_on_number | boolean | yes | |
listening.end_of_turn.hold_without_punctuation | boolean | yes | |
listening.end_of_turn.max_wait_ms | integer | yes | |
listening.end_of_turn.min_wait_ms | integer | yes | |
listening.end_of_turn.reply_end_window_enabled | boolean | no | Absent from an api older than 1.41.0, when the worker takes the default. |
listening.end_of_turn.reply_end_window_ms | integer | no | Absent from an api older than 1.39.0, when the worker keeps its own value. |
listening.end_of_turn.resume_merge | ResumeMergeEffective | no | |
listening.end_of_turn.threshold | number or null | yes | |
listening.end_of_turn.vad_only_reply | VadOnlyReplyEffective | no | |
listening.end_of_turn.wait_curve | WaitCurveEffective | no | |
listening.interruption | object | yes | |
listening.interruption.backchannel_pause | BackchannelPauseEffective | no | |
listening.interruption.backoff_ms | integer | yes | |
listening.interruption.confirm_words | integer | yes | |
listening.interruption.continue_phrases | array of LexiconPhrase | no | Absent from an api older than 1.39.0, when the worker keeps its own value. |
listening.interruption.cut_reply_context_enabled | boolean | no | Absent from an api older than 1.41.0, when the worker takes the default. |
listening.interruption.false_timeout_ms | integer | yes | |
listening.interruption.ignore_phrases | array of string | yes | |
listening.interruption.ignore_phrases_enabled | boolean | no | Absent from an api older than 1.41.0, when the worker takes the default. |
listening.interruption.min_speech_ms | integer | yes | |
listening.interruption.mode | InterruptionMode | yes | |
listening.interruption.remainder_max_age_ms | integer | no | Absent from an api older than 1.41.0, when the worker takes the default. |
listening.interruption.resume_after_false | boolean | yes | |
listening.interruption.resume_on_continue_phrase | boolean | no | Absent from an api older than 1.41.0, when the worker takes the default. |
listening.silence | object | yes | |
listening.silence.end_after_ms | integer | yes | |
listening.silence.end_line | string | yes | |
listening.silence.max_reprompts | integer | yes | |
listening.silence.reprompt | SilenceReprompt | yes | |
listening.silence.reprompt_after_ms | integer | yes | |
listening.stt_min_confidence | number | yes | |
listening.vad | object | yes | |
listening.vad.min_silence_ms | integer | yes | |
listening.vad.min_speech_ms | integer | yes | |
listening.vad.prefix_padding_ms | integer | yes | |
listening.vad.threshold | number | yes | |
outbound | object | yes | |
outbound.default_from | PhoneNumberId or null | yes | |
outbound.ring_timeout_s | integer | yes | |
reasoning | object | yes | |
reasoning.max_reply_tokens | integer | yes | |
reasoning.max_tool_rounds | integer | no | The Tool round cap of a Turn (1.49.0). The api from 1.49.0 always sends it; absent, from an older api, the worker runs 3. |
recording | object | yes | |
recording.announcement | string | no | The recording announcement (1.32.0), rendered in the Session configuration. The api from 1.32.0 always sends it; absent, from an older api, the worker speaks the line of its own language pack. |
recording.preference | RecordingPreference | yes | |
safety | object | yes | |
safety.disclosure | object | yes | |
safety.disclosure.placement | DisclosurePlacement | yes | |
safety.disclosure.required | boolean | yes | |
safety.disclosure.script | string | yes | |
speech | object | yes | |
speech.closing_line | string | yes | |
speech.greeting | object | yes | |
speech.greeting.interruptible | boolean | yes | |
speech.greeting.mode | GreetingMode | yes | |
speech.greeting.text | string or null | yes | |
speech.greeting.wait_ms | integer | yes | |
speech.limit_message | string | yes | |
speech.recovery_line | string | yes | |
speech.speaking_rate | number | yes | |
tuning | object | yes | |
tuning.echo_check_similarity | number or null | yes | |
tuning.echo_check_window_ms | integer or null | yes | |
tuning.leading_silence_trim_floor_ms | integer or null | yes | |
tuning.max_chunk_chars | integer or null | yes | |
tuning.min_chunk_chars | integer or null | yes | |
tuning.prewarm_providers | boolean | yes | |
tuning.tts_first_chunk_chars | integer or null | yes |