VocalDocscontracts 1.65.0

EffectiveSettings

The settings a Session runs on, resolved across the layers.

An object with 9 fields.

Fields

FieldTypeRequiredDescription
call_controlobjectyes
call_control.answering_machine_detectionobjectnoThe 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_msintegeryes
call_control.answering_machine_detection.enabledbooleanyes
call_control.answering_machine_detection.messagestring or nullyesThe 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_machineAnsweringMachineOnMachineyes
call_control.answering_machine_detection.sensitivityAnsweringMachineSensitivityyes
call_control.model_actionsobjectyes
call_control.model_actions.end_callbooleanyes
call_control.transferobjectnoThe 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_noteContextNoteModeyes
call_control.transfer.presented_caller_idPresentedCallerIdyes
limitsobjectyes
limits.max_duration_sintegeryes
listeningobjectyes
listening.end_of_turnobjectyes
listening.end_of_turn.adaptivebooleanyes
listening.end_of_turn.after_question_window_enabledbooleannoAbsent from an api older than 1.41.0, when the worker takes the default.
listening.end_of_turn.after_question_window_msintegernoAbsent from an api older than 1.39.0, when the worker keeps its own value.
listening.end_of_turn.confirmation_enabledbooleannoAbsent from an api older than 1.41.0, when the worker takes the default.
listening.end_of_turn.confirmation_on_finalConfirmationOnFinalEffectiveno
listening.end_of_turn.confirmation_on_interimConfirmationOnInterimEffectiveno
listening.end_of_turn.confirmation_phrasesarray of LexiconPhrasenoAbsent from an api older than 1.39.0, when the worker keeps its own value.
listening.end_of_turn.detectorEndOfTurnDetectoryes
listening.end_of_turn.hold_on_numberbooleanyes
listening.end_of_turn.hold_without_punctuationbooleanyes
listening.end_of_turn.max_wait_msintegeryes
listening.end_of_turn.min_wait_msintegeryes
listening.end_of_turn.reply_end_window_enabledbooleannoAbsent from an api older than 1.41.0, when the worker takes the default.
listening.end_of_turn.reply_end_window_msintegernoAbsent from an api older than 1.39.0, when the worker keeps its own value.
listening.end_of_turn.resume_mergeResumeMergeEffectiveno
listening.end_of_turn.thresholdnumber or nullyes
listening.end_of_turn.vad_only_replyVadOnlyReplyEffectiveno
listening.end_of_turn.wait_curveWaitCurveEffectiveno
listening.interruptionobjectyes
listening.interruption.backchannel_pauseBackchannelPauseEffectiveno
listening.interruption.backoff_msintegeryes
listening.interruption.confirm_wordsintegeryes
listening.interruption.continue_phrasesarray of LexiconPhrasenoAbsent from an api older than 1.39.0, when the worker keeps its own value.
listening.interruption.cut_reply_context_enabledbooleannoAbsent from an api older than 1.41.0, when the worker takes the default.
listening.interruption.false_timeout_msintegeryes
listening.interruption.ignore_phrasesarray of stringyes
listening.interruption.ignore_phrases_enabledbooleannoAbsent from an api older than 1.41.0, when the worker takes the default.
listening.interruption.min_speech_msintegeryes
listening.interruption.modeInterruptionModeyes
listening.interruption.remainder_max_age_msintegernoAbsent from an api older than 1.41.0, when the worker takes the default.
listening.interruption.resume_after_falsebooleanyes
listening.interruption.resume_on_continue_phrasebooleannoAbsent from an api older than 1.41.0, when the worker takes the default.
listening.silenceobjectyes
listening.silence.end_after_msintegeryes
listening.silence.end_linestringyes
listening.silence.max_repromptsintegeryes
listening.silence.repromptSilenceRepromptyes
listening.silence.reprompt_after_msintegeryes
listening.stt_min_confidencenumberyes
listening.vadobjectyes
listening.vad.min_silence_msintegeryes
listening.vad.min_speech_msintegeryes
listening.vad.prefix_padding_msintegeryes
listening.vad.thresholdnumberyes
outboundobjectyes
outbound.default_fromPhoneNumberId or nullyes
outbound.ring_timeout_sintegeryes
reasoningobjectyes
reasoning.max_reply_tokensintegeryes
reasoning.max_tool_roundsintegernoThe 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.
recordingobjectyes
recording.announcementstringnoThe 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.preferenceRecordingPreferenceyes
safetyobjectyes
safety.disclosureobjectyes
safety.disclosure.placementDisclosurePlacementyes
safety.disclosure.requiredbooleanyes
safety.disclosure.scriptstringyes
speechobjectyes
speech.closing_linestringyes
speech.greetingobjectyes
speech.greeting.interruptiblebooleanyes
speech.greeting.modeGreetingModeyes
speech.greeting.textstring or nullyes
speech.greeting.wait_msintegeryes
speech.limit_messagestringyes
speech.recovery_linestringyes
speech.speaking_ratenumberyes
tuningobjectyes
tuning.echo_check_similaritynumber or nullyes
tuning.echo_check_window_msinteger or nullyes
tuning.leading_silence_trim_floor_msinteger or nullyes
tuning.max_chunk_charsinteger or nullyes
tuning.min_chunk_charsinteger or nullyes
tuning.prewarm_providersbooleanyes
tuning.tts_first_chunk_charsinteger or nullyes