retell-sdk 5.10.2 → 5.11.0

package/resources/call.d.mts

@@ -2194,6 +2194,10 @@ export declare namespace CallCreatePhoneCallParams {
              * agent output and user input.
              */
             guardrail_config?: Agent.GuardrailConfig;
+            /**
+             * Toggle behavior presets on/off to influence agent response style and behaviors.
+             */
+            handbook_config?: Agent.HandbookConfig;
             /**
              * Controls how sensitive the agent is to user interruptions. Value ranging from
              * [0,1]. Lower value means it will take longer / more words for user to interrupt
@@ -2251,7 +2255,7 @@ export declare namespace CallCreatePhoneCallParams {
              * pre-defined variables extracted in the call analysis. This will be available
              * after the call ends.
              */
-            post_call_analysis_data?: Array<Agent.StringAnalysisData | Agent.EnumAnalysisData | Agent.BooleanAnalysisData | Agent.NumberAnalysisData> | null;
+            post_call_analysis_data?: Array<Agent.StringAnalysisData | Agent.EnumAnalysisData | Agent.BooleanAnalysisData | Agent.NumberAnalysisData | Agent.CallPresetAnalysisData> | null;
             /**
              * The model to use for post call analysis. Default to gpt-4.1-mini.
              */
@@ -2305,6 +2309,11 @@ export declare namespace CallCreatePhoneCallParams {
              * Default to fast mode. When set to custom, custom_stt_config must be provided.
              */
             stt_mode?: 'fast' | 'accurate' | 'custom';
+            /**
+             * IANA timezone for the agent (e.g. America/New_York). Defaults to
+             * America/Los_Angeles if not set.
+             */
+            timezone?: string | null;
             user_dtmf_options?: Agent.UserDtmfOptions | null;
             /**
              * Optional description of the agent version. Used for your own reference and
@@ -2421,6 +2430,49 @@ export declare namespace CallCreatePhoneCallParams {
                  */
                 output_topics?: Array<'harassment' | 'self_harm' | 'sexual_exploitation' | 'violence' | 'defense_and_national_security' | 'illicit_and_harmful_activity' | 'gambling' | 'regulated_professional_advice' | 'child_safety_and_exploitation'> | null;
             }
+            /**
+             * Toggle behavior presets on/off to influence agent response style and behaviors.
+             */
+            interface HandbookConfig {
+                /**
+                 * When asked, acknowledge being a virtual assistant.
+                 */
+                ai_disclosure?: boolean;
+                /**
+                 * Professional call center rep baseline.
+                 */
+                default_personality?: boolean;
+                /**
+                 * Repeat back and confirm important details (voice only).
+                 */
+                echo_verification?: boolean;
+                /**
+                 * Warm acknowledgment of caller concerns.
+                 */
+                high_empathy?: boolean;
+                /**
+                 * Spell using NATO phonetic alphabet style (voice only).
+                 */
+                nato_phonetic_alphabet?: boolean;
+                /**
+                 * Sprinkle natural speech fillers like "um", "you know" for a more human,
+                 * conversational tone.
+                 */
+                natural_filler_words?: boolean;
+                /**
+                 * Stay within prompt/context scope, don't invent details.
+                 */
+                scope_boundaries?: boolean;
+                /**
+                 * Treat near-match similar words as same entity to reduce impact of transcription
+                 * error (voice only).
+                 */
+                smart_matching?: boolean;
+                /**
+                 * Convert numbers/dates/currency to spoken forms (voice only).
+                 */
+                speech_normalization?: boolean;
+            }
             /**
              * If this option is set, the call will try to detect IVR in the first 3 minutes of
              * the call. Actions defined will be applied when the IVR is detected. Set this to
@@ -2460,6 +2512,12 @@ export declare namespace CallCreatePhoneCallParams {
                  * Type of the variable to extract.
                  */
                 type: 'string';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated in
+                 * the analysis. If not set, the field is always included. If required is true,
+                 * this is ignored.
+                 */
+                conditional_prompt?: string;
                 /**
                  * Examples of the variable value to teach model the style and syntax.
                  */
@@ -2487,6 +2545,12 @@ export declare namespace CallCreatePhoneCallParams {
                  * Type of the variable to extract.
                  */
                 type: 'enum';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated in
+                 * the analysis. If not set, the field is always included. If required is true,
+                 * this is ignored.
+                 */
+                conditional_prompt?: string;
                 /**
                  * Whether this data is required. If true and the data is not extracted, the call
                  * will be marked as unsuccessful.
@@ -2506,6 +2570,12 @@ export declare namespace CallCreatePhoneCallParams {
                  * Type of the variable to extract.
                  */
                 type: 'boolean';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated in
+                 * the analysis. If not set, the field is always included. If required is true,
+                 * this is ignored.
+                 */
+                conditional_prompt?: string;
                 /**
                  * Whether this data is required. If true and the data is not extracted, the call
                  * will be marked as unsuccessful.
@@ -2525,12 +2595,46 @@ export declare namespace CallCreatePhoneCallParams {
                  * Type of the variable to extract.
                  */
                 type: 'number';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated in
+                 * the analysis. If not set, the field is always included. If required is true,
+                 * this is ignored.
+                 */
+                conditional_prompt?: string;
                 /**
                  * Whether this data is required. If true and the data is not extracted, the call
                  * will be marked as unsuccessful.
                  */
                 required?: boolean;
             }
+            /**
+             * System preset for post-call analysis (voice agents). Use in
+             * post_call_analysis_data to override prompts or mark fields optional.
+             */
+            interface CallPresetAnalysisData {
+                /**
+                 * Preset identifier for voice agent analysis.
+                 */
+                name: 'call_summary' | 'call_successful' | 'user_sentiment';
+                /**
+                 * Identifies this item as a system preset.
+                 */
+                type: 'system-presets';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated. If
+                 * not set, the field is always included.
+                 */
+                conditional_prompt?: string;
+                /**
+                 * Prompt or description for this preset.
+                 */
+                description?: string;
+                /**
+                 * If false, this field is optional in the analysis. If true or unset, the field is
+                 * required.
+                 */
+                required?: boolean;
+            }
             interface PronunciationDictionary {
                 /**
                  * The phonetic alphabet to be used for pronunciation.
@@ -3006,6 +3110,10 @@ export declare namespace CallCreateWebCallParams {
              * agent output and user input.
              */
             guardrail_config?: Agent.GuardrailConfig;
+            /**
+             * Toggle behavior presets on/off to influence agent response style and behaviors.
+             */
+            handbook_config?: Agent.HandbookConfig;
             /**
              * Controls how sensitive the agent is to user interruptions. Value ranging from
              * [0,1]. Lower value means it will take longer / more words for user to interrupt
@@ -3063,7 +3171,7 @@ export declare namespace CallCreateWebCallParams {
              * pre-defined variables extracted in the call analysis. This will be available
              * after the call ends.
              */
-            post_call_analysis_data?: Array<Agent.StringAnalysisData | Agent.EnumAnalysisData | Agent.BooleanAnalysisData | Agent.NumberAnalysisData> | null;
+            post_call_analysis_data?: Array<Agent.StringAnalysisData | Agent.EnumAnalysisData | Agent.BooleanAnalysisData | Agent.NumberAnalysisData | Agent.CallPresetAnalysisData> | null;
             /**
              * The model to use for post call analysis. Default to gpt-4.1-mini.
              */
@@ -3117,6 +3225,11 @@ export declare namespace CallCreateWebCallParams {
              * Default to fast mode. When set to custom, custom_stt_config must be provided.
              */
             stt_mode?: 'fast' | 'accurate' | 'custom';
+            /**
+             * IANA timezone for the agent (e.g. America/New_York). Defaults to
+             * America/Los_Angeles if not set.
+             */
+            timezone?: string | null;
             user_dtmf_options?: Agent.UserDtmfOptions | null;
             /**
              * Optional description of the agent version. Used for your own reference and
@@ -3233,6 +3346,49 @@ export declare namespace CallCreateWebCallParams {
                  */
                 output_topics?: Array<'harassment' | 'self_harm' | 'sexual_exploitation' | 'violence' | 'defense_and_national_security' | 'illicit_and_harmful_activity' | 'gambling' | 'regulated_professional_advice' | 'child_safety_and_exploitation'> | null;
             }
+            /**
+             * Toggle behavior presets on/off to influence agent response style and behaviors.
+             */
+            interface HandbookConfig {
+                /**
+                 * When asked, acknowledge being a virtual assistant.
+                 */
+                ai_disclosure?: boolean;
+                /**
+                 * Professional call center rep baseline.
+                 */
+                default_personality?: boolean;
+                /**
+                 * Repeat back and confirm important details (voice only).
+                 */
+                echo_verification?: boolean;
+                /**
+                 * Warm acknowledgment of caller concerns.
+                 */
+                high_empathy?: boolean;
+                /**
+                 * Spell using NATO phonetic alphabet style (voice only).
+                 */
+                nato_phonetic_alphabet?: boolean;
+                /**
+                 * Sprinkle natural speech fillers like "um", "you know" for a more human,
+                 * conversational tone.
+                 */
+                natural_filler_words?: boolean;
+                /**
+                 * Stay within prompt/context scope, don't invent details.
+                 */
+                scope_boundaries?: boolean;
+                /**
+                 * Treat near-match similar words as same entity to reduce impact of transcription
+                 * error (voice only).
+                 */
+                smart_matching?: boolean;
+                /**
+                 * Convert numbers/dates/currency to spoken forms (voice only).
+                 */
+                speech_normalization?: boolean;
+            }
             /**
              * If this option is set, the call will try to detect IVR in the first 3 minutes of
              * the call. Actions defined will be applied when the IVR is detected. Set this to
@@ -3272,6 +3428,12 @@ export declare namespace CallCreateWebCallParams {
                  * Type of the variable to extract.
                  */
                 type: 'string';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated in
+                 * the analysis. If not set, the field is always included. If required is true,
+                 * this is ignored.
+                 */
+                conditional_prompt?: string;
                 /**
                  * Examples of the variable value to teach model the style and syntax.
                  */
@@ -3299,6 +3461,12 @@ export declare namespace CallCreateWebCallParams {
                  * Type of the variable to extract.
                  */
                 type: 'enum';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated in
+                 * the analysis. If not set, the field is always included. If required is true,
+                 * this is ignored.
+                 */
+                conditional_prompt?: string;
                 /**
                  * Whether this data is required. If true and the data is not extracted, the call
                  * will be marked as unsuccessful.
@@ -3318,6 +3486,12 @@ export declare namespace CallCreateWebCallParams {
                  * Type of the variable to extract.
                  */
                 type: 'boolean';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated in
+                 * the analysis. If not set, the field is always included. If required is true,
+                 * this is ignored.
+                 */
+                conditional_prompt?: string;
                 /**
                  * Whether this data is required. If true and the data is not extracted, the call
                  * will be marked as unsuccessful.
@@ -3337,12 +3511,46 @@ export declare namespace CallCreateWebCallParams {
                  * Type of the variable to extract.
                  */
                 type: 'number';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated in
+                 * the analysis. If not set, the field is always included. If required is true,
+                 * this is ignored.
+                 */
+                conditional_prompt?: string;
                 /**
                  * Whether this data is required. If true and the data is not extracted, the call
                  * will be marked as unsuccessful.
                  */
                 required?: boolean;
             }
+            /**
+             * System preset for post-call analysis (voice agents). Use in
+             * post_call_analysis_data to override prompts or mark fields optional.
+             */
+            interface CallPresetAnalysisData {
+                /**
+                 * Preset identifier for voice agent analysis.
+                 */
+                name: 'call_summary' | 'call_successful' | 'user_sentiment';
+                /**
+                 * Identifies this item as a system preset.
+                 */
+                type: 'system-presets';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated. If
+                 * not set, the field is always included.
+                 */
+                conditional_prompt?: string;
+                /**
+                 * Prompt or description for this preset.
+                 */
+                description?: string;
+                /**
+                 * If false, this field is optional in the analysis. If true or unset, the field is
+                 * required.
+                 */
+                required?: boolean;
+            }
             interface PronunciationDictionary {
                 /**
                  * The phonetic alphabet to be used for pronunciation.
@@ -3817,6 +4025,10 @@ export declare namespace CallRegisterPhoneCallParams {
              * agent output and user input.
              */
             guardrail_config?: Agent.GuardrailConfig;
+            /**
+             * Toggle behavior presets on/off to influence agent response style and behaviors.
+             */
+            handbook_config?: Agent.HandbookConfig;
             /**
              * Controls how sensitive the agent is to user interruptions. Value ranging from
              * [0,1]. Lower value means it will take longer / more words for user to interrupt
@@ -3874,7 +4086,7 @@ export declare namespace CallRegisterPhoneCallParams {
              * pre-defined variables extracted in the call analysis. This will be available
              * after the call ends.
              */
-            post_call_analysis_data?: Array<Agent.StringAnalysisData | Agent.EnumAnalysisData | Agent.BooleanAnalysisData | Agent.NumberAnalysisData> | null;
+            post_call_analysis_data?: Array<Agent.StringAnalysisData | Agent.EnumAnalysisData | Agent.BooleanAnalysisData | Agent.NumberAnalysisData | Agent.CallPresetAnalysisData> | null;
             /**
              * The model to use for post call analysis. Default to gpt-4.1-mini.
              */
@@ -3928,6 +4140,11 @@ export declare namespace CallRegisterPhoneCallParams {
              * Default to fast mode. When set to custom, custom_stt_config must be provided.
              */
             stt_mode?: 'fast' | 'accurate' | 'custom';
+            /**
+             * IANA timezone for the agent (e.g. America/New_York). Defaults to
+             * America/Los_Angeles if not set.
+             */
+            timezone?: string | null;
             user_dtmf_options?: Agent.UserDtmfOptions | null;
             /**
              * Optional description of the agent version. Used for your own reference and
@@ -4044,6 +4261,49 @@ export declare namespace CallRegisterPhoneCallParams {
                  */
                 output_topics?: Array<'harassment' | 'self_harm' | 'sexual_exploitation' | 'violence' | 'defense_and_national_security' | 'illicit_and_harmful_activity' | 'gambling' | 'regulated_professional_advice' | 'child_safety_and_exploitation'> | null;
             }
+            /**
+             * Toggle behavior presets on/off to influence agent response style and behaviors.
+             */
+            interface HandbookConfig {
+                /**
+                 * When asked, acknowledge being a virtual assistant.
+                 */
+                ai_disclosure?: boolean;
+                /**
+                 * Professional call center rep baseline.
+                 */
+                default_personality?: boolean;
+                /**
+                 * Repeat back and confirm important details (voice only).
+                 */
+                echo_verification?: boolean;
+                /**
+                 * Warm acknowledgment of caller concerns.
+                 */
+                high_empathy?: boolean;
+                /**
+                 * Spell using NATO phonetic alphabet style (voice only).
+                 */
+                nato_phonetic_alphabet?: boolean;
+                /**
+                 * Sprinkle natural speech fillers like "um", "you know" for a more human,
+                 * conversational tone.
+                 */
+                natural_filler_words?: boolean;
+                /**
+                 * Stay within prompt/context scope, don't invent details.
+                 */
+                scope_boundaries?: boolean;
+                /**
+                 * Treat near-match similar words as same entity to reduce impact of transcription
+                 * error (voice only).
+                 */
+                smart_matching?: boolean;
+                /**
+                 * Convert numbers/dates/currency to spoken forms (voice only).
+                 */
+                speech_normalization?: boolean;
+            }
             /**
              * If this option is set, the call will try to detect IVR in the first 3 minutes of
              * the call. Actions defined will be applied when the IVR is detected. Set this to
@@ -4083,6 +4343,12 @@ export declare namespace CallRegisterPhoneCallParams {
                  * Type of the variable to extract.
                  */
                 type: 'string';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated in
+                 * the analysis. If not set, the field is always included. If required is true,
+                 * this is ignored.
+                 */
+                conditional_prompt?: string;
                 /**
                  * Examples of the variable value to teach model the style and syntax.
                  */
@@ -4110,6 +4376,12 @@ export declare namespace CallRegisterPhoneCallParams {
                  * Type of the variable to extract.
                  */
                 type: 'enum';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated in
+                 * the analysis. If not set, the field is always included. If required is true,
+                 * this is ignored.
+                 */
+                conditional_prompt?: string;
                 /**
                  * Whether this data is required. If true and the data is not extracted, the call
                  * will be marked as unsuccessful.
@@ -4129,6 +4401,12 @@ export declare namespace CallRegisterPhoneCallParams {
                  * Type of the variable to extract.
                  */
                 type: 'boolean';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated in
+                 * the analysis. If not set, the field is always included. If required is true,
+                 * this is ignored.
+                 */
+                conditional_prompt?: string;
                 /**
                  * Whether this data is required. If true and the data is not extracted, the call
                  * will be marked as unsuccessful.
@@ -4148,12 +4426,46 @@ export declare namespace CallRegisterPhoneCallParams {
                  * Type of the variable to extract.
                  */
                 type: 'number';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated in
+                 * the analysis. If not set, the field is always included. If required is true,
+                 * this is ignored.
+                 */
+                conditional_prompt?: string;
                 /**
                  * Whether this data is required. If true and the data is not extracted, the call
                  * will be marked as unsuccessful.
                  */
                 required?: boolean;
             }
+            /**
+             * System preset for post-call analysis (voice agents). Use in
+             * post_call_analysis_data to override prompts or mark fields optional.
+             */
+            interface CallPresetAnalysisData {
+                /**
+                 * Preset identifier for voice agent analysis.
+                 */
+                name: 'call_summary' | 'call_successful' | 'user_sentiment';
+                /**
+                 * Identifies this item as a system preset.
+                 */
+                type: 'system-presets';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated. If
+                 * not set, the field is always included.
+                 */
+                conditional_prompt?: string;
+                /**
+                 * Prompt or description for this preset.
+                 */
+                description?: string;
+                /**
+                 * If false, this field is optional in the analysis. If true or unset, the field is
+                 * required.
+                 */
+                required?: boolean;
+            }
             interface PronunciationDictionary {
                 /**
                  * The phonetic alphabet to be used for pronunciation.