retell-sdk 5.36.0 → 5.38.0

package/resources/call.d.ts

@@ -143,6 +143,16 @@ export interface PhoneCallResponse {
      * Name of the agent.
      */
     agent_name?: string;
+    /**
+     * Tag pointing at the agent version used for this call, captured at call creation
+     * time and frozen thereafter (unaffected by later tag reassignments). Populated
+     * whether the caller dispatched by tag, numeric version, "latest", or
+     * "latest_published" — when the caller specified a tag, that tag wins; otherwise
+     * the most-recently- assigned tag on the resolved version is used. Absent when no
+     * tag points at the resolved version (or for calls created before this field was
+     * introduced).
+     */
+    agent_tag?: string | null;
     /**
      * Post call analysis that includes information such as sentiment, status, summary,
      * and custom defined data to extract. Available after call ends. Subscribe to
@@ -1106,6 +1116,16 @@ export interface WebCallResponse {
      * Name of the agent.
      */
     agent_name?: string;
+    /**
+     * Tag pointing at the agent version used for this call, captured at call creation
+     * time and frozen thereafter (unaffected by later tag reassignments). Populated
+     * whether the caller dispatched by tag, numeric version, "latest", or
+     * "latest_published" — when the caller specified a tag, that tag wins; otherwise
+     * the most-recently- assigned tag on the resolved version is used. Absent when no
+     * tag points at the resolved version (or for calls created before this field was
+     * introduced).
+     */
+    agent_tag?: string | null;
     /**
      * Post call analysis that includes information such as sentiment, status, summary,
      * and custom defined data to extract. Available after call ends. Subscribe to
@@ -2071,6 +2091,16 @@ export declare namespace CallListResponse {
          * Name of the agent.
          */
         agent_name?: string;
+        /**
+         * Tag pointing at the agent version used for this call, captured at call creation
+         * time and frozen thereafter (unaffected by later tag reassignments). Populated
+         * whether the caller dispatched by tag, numeric version, "latest", or
+         * "latest_published" — when the caller specified a tag, that tag wins; otherwise
+         * the most-recently- assigned tag on the resolved version is used. Absent when no
+         * tag points at the resolved version (or for calls created before this field was
+         * introduced).
+         */
+        agent_tag?: string | null;
         /**
          * Post call analysis that includes information such as sentiment, status, summary,
          * and custom defined data to extract. Available after call ends. Subscribe to
@@ -2647,6 +2677,16 @@ export declare namespace CallListResponse {
          * Name of the agent.
          */
         agent_name?: string;
+        /**
+         * Tag pointing at the agent version used for this call, captured at call creation
+         * time and frozen thereafter (unaffected by later tag reassignments). Populated
+         * whether the caller dispatched by tag, numeric version, "latest", or
+         * "latest_published" — when the caller specified a tag, that tag wins; otherwise
+         * the most-recently- assigned tag on the resolved version is used. Absent when no
+         * tag points at the resolved version (or for calls created before this field was
+         * introduced).
+         */
+        agent_tag?: string | null;
         /**
          * Post call analysis that includes information such as sentiment, status, summary,
          * and custom defined data to extract. Available after call ends. Subscribe to
@@ -3326,23 +3366,6 @@ export declare namespace CallCreatePhoneCallParams {
              * sound. If unset, default value 1 will apply.
              */
             ambient_sound_volume?: number;
-            /**
-             * Prompt to determine whether the post call or chat analysis should mark the
-             * interaction as successful. Set to null to use the default prompt.
-             */
-            analysis_successful_prompt?: string | null;
-            /**
-             * Prompt to guide how the post call or chat analysis summary should be generated.
-             * When unset, the default system prompt is used. Set to null to use the default
-             * prompt.
-             */
-            analysis_summary_prompt?: string | null;
-            /**
-             * Prompt to guide how the post call or chat analysis should evaluate user
-             * sentiment. When unset, the default system prompt is used. Set to null to use the
-             * default prompt.
-             */
-            analysis_user_sentiment_prompt?: string | null;
             /**
              * Only applicable when enable_backchannel is true. Controls how often the agent
              * would backchannel when a backchannel is possible. Value ranging from [0,1].
@@ -3423,11 +3446,30 @@ export declare namespace CallCreatePhoneCallParams {
              * speech rate and conversation context. If unset, default value false will apply.
              */
             enable_dynamic_voice_speed?: boolean;
+            /**
+             * Master toggle for expressive mode. When true, the agent may add expressive voice
+             * tags to the audio it generates. Only applicable for platform voices. If unset,
+             * defaults to false.
+             */
+            enable_expressive_mode?: boolean;
             /**
              * If users stay silent for a period after agent speech, end the call. The minimum
              * value allowed is 10,000 ms (10 s). By default, this is set to 600000 (10 min).
              */
             end_call_after_silence_ms?: number;
+            /**
+             * The expressive voice tags Retell pre-teaches the model to use when
+             * enable_expressive_mode is true. Custom tags defined in the system prompt are
+             * still allowed. If empty, the agent follows general expressive guidance without a
+             * fixed tag set.
+             */
+            expressive_emotion_tags?: Array<'empathetic' | 'excited' | 'happy' | 'curious' | 'surprised' | 'sigh' | 'clear throat' | 'pause' | 'long pause' | 'emphasis'>;
+            /**
+             * Custom expressive voice guidance to use instead of the default Retell expressive
+             * prompt when enable_expressive_mode is true. If omitted or blank, the default
+             * expressive prompt will be used.
+             */
+            expressive_mode_prompt?: string | null;
             /**
              * When TTS provider for the selected voice is experiencing outages, we would use
              * fallback voices listed here for the agent. Voice id and the fallback voice ids
@@ -3555,6 +3597,10 @@ export declare namespace CallCreatePhoneCallParams {
              * documentation.
              */
             version_description?: string | null;
+            /**
+             * Optional title of the agent version. Used for your own reference.
+             */
+            version_title?: string | null;
             /**
              * If set, determines the vocabulary set to use for transcription. This setting
              * only applies for English agents, for non English agent, this setting is a no-op.
@@ -3590,19 +3636,6 @@ export declare namespace CallCreatePhoneCallParams {
              * will apply.
              */
             voice_temperature?: number;
-            /**
-             * Configures when to stop running voicemail detection, as it becomes unlikely to
-             * hit voicemail after a couple minutes, and keep running it will only have
-             * negative impact. The minimum value allowed is 5,000 ms (5 s), and maximum value
-             * allowed is 180,000 (3 minutes). By default, this is set to 30,000 (30 s).
-             */
-            voicemail_detection_timeout_ms?: number;
-            /**
-             * The message to be played when the call enters a voicemail. Note that this
-             * feature is only available for phone calls. If you want to hangup after hitting
-             * voicemail, set this to empty string.
-             */
-            voicemail_message?: string;
             /**
              * If this option is set, the call will try to detect voicemail in the first 3
              * minutes of the call. Actions defined (hangup, or leave a message) will be
@@ -3658,13 +3691,13 @@ export declare namespace CallCreatePhoneCallParams {
             interface CustomSttConfig {
                 /**
                  * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
-                 * 500 for Soniox
+                 * 500 for Soniox, 100 for AssemblyAI.
                  */
                 endpointing_ms: number;
                 /**
                  * ASR provider name.
                  */
-                provider: 'azure' | 'deepgram' | 'soniox';
+                provider: 'azure' | 'deepgram' | 'soniox' | 'assemblyai';
             }
             /**
              * Configuration for guardrail checks to detect and prevent prohibited topics in
@@ -3691,6 +3724,12 @@ export declare namespace CallCreatePhoneCallParams {
                  * When asked, acknowledge being a virtual assistant.
                  */
                 ai_disclosure?: boolean;
+                /**
+                 * Enables Conversational Personality. When true, the agent uses the Conversational
+                 * Personality handbook preset, skips Professional Rep Personality during prompt
+                 * assembly, and enables internal colloquial rewrite behavior.
+                 */
+                conversational_personality?: boolean;
                 /**
                  * Professional call center rep baseline.
                  */
@@ -4271,23 +4310,6 @@ export declare namespace CallRegisterPhoneCallParams {
              * sound. If unset, default value 1 will apply.
              */
             ambient_sound_volume?: number;
-            /**
-             * Prompt to determine whether the post call or chat analysis should mark the
-             * interaction as successful. Set to null to use the default prompt.
-             */
-            analysis_successful_prompt?: string | null;
-            /**
-             * Prompt to guide how the post call or chat analysis summary should be generated.
-             * When unset, the default system prompt is used. Set to null to use the default
-             * prompt.
-             */
-            analysis_summary_prompt?: string | null;
-            /**
-             * Prompt to guide how the post call or chat analysis should evaluate user
-             * sentiment. When unset, the default system prompt is used. Set to null to use the
-             * default prompt.
-             */
-            analysis_user_sentiment_prompt?: string | null;
             /**
              * Only applicable when enable_backchannel is true. Controls how often the agent
              * would backchannel when a backchannel is possible. Value ranging from [0,1].
@@ -4368,11 +4390,30 @@ export declare namespace CallRegisterPhoneCallParams {
              * speech rate and conversation context. If unset, default value false will apply.
              */
             enable_dynamic_voice_speed?: boolean;
+            /**
+             * Master toggle for expressive mode. When true, the agent may add expressive voice
+             * tags to the audio it generates. Only applicable for platform voices. If unset,
+             * defaults to false.
+             */
+            enable_expressive_mode?: boolean;
             /**
              * If users stay silent for a period after agent speech, end the call. The minimum
              * value allowed is 10,000 ms (10 s). By default, this is set to 600000 (10 min).
              */
             end_call_after_silence_ms?: number;
+            /**
+             * The expressive voice tags Retell pre-teaches the model to use when
+             * enable_expressive_mode is true. Custom tags defined in the system prompt are
+             * still allowed. If empty, the agent follows general expressive guidance without a
+             * fixed tag set.
+             */
+            expressive_emotion_tags?: Array<'empathetic' | 'excited' | 'happy' | 'curious' | 'surprised' | 'sigh' | 'clear throat' | 'pause' | 'long pause' | 'emphasis'>;
+            /**
+             * Custom expressive voice guidance to use instead of the default Retell expressive
+             * prompt when enable_expressive_mode is true. If omitted or blank, the default
+             * expressive prompt will be used.
+             */
+            expressive_mode_prompt?: string | null;
             /**
              * When TTS provider for the selected voice is experiencing outages, we would use
              * fallback voices listed here for the agent. Voice id and the fallback voice ids
@@ -4500,6 +4541,10 @@ export declare namespace CallRegisterPhoneCallParams {
              * documentation.
              */
             version_description?: string | null;
+            /**
+             * Optional title of the agent version. Used for your own reference.
+             */
+            version_title?: string | null;
             /**
              * If set, determines the vocabulary set to use for transcription. This setting
              * only applies for English agents, for non English agent, this setting is a no-op.
@@ -4535,19 +4580,6 @@ export declare namespace CallRegisterPhoneCallParams {
              * will apply.
              */
             voice_temperature?: number;
-            /**
-             * Configures when to stop running voicemail detection, as it becomes unlikely to
-             * hit voicemail after a couple minutes, and keep running it will only have
-             * negative impact. The minimum value allowed is 5,000 ms (5 s), and maximum value
-             * allowed is 180,000 (3 minutes). By default, this is set to 30,000 (30 s).
-             */
-            voicemail_detection_timeout_ms?: number;
-            /**
-             * The message to be played when the call enters a voicemail. Note that this
-             * feature is only available for phone calls. If you want to hangup after hitting
-             * voicemail, set this to empty string.
-             */
-            voicemail_message?: string;
             /**
              * If this option is set, the call will try to detect voicemail in the first 3
              * minutes of the call. Actions defined (hangup, or leave a message) will be
@@ -4603,13 +4635,13 @@ export declare namespace CallRegisterPhoneCallParams {
             interface CustomSttConfig {
                 /**
                  * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
-                 * 500 for Soniox
+                 * 500 for Soniox, 100 for AssemblyAI.
                  */
                 endpointing_ms: number;
                 /**
                  * ASR provider name.
                  */
-                provider: 'azure' | 'deepgram' | 'soniox';
+                provider: 'azure' | 'deepgram' | 'soniox' | 'assemblyai';
             }
             /**
              * Configuration for guardrail checks to detect and prevent prohibited topics in
@@ -4636,6 +4668,12 @@ export declare namespace CallRegisterPhoneCallParams {
                  * When asked, acknowledge being a virtual assistant.
                  */
                 ai_disclosure?: boolean;
+                /**
+                 * Enables Conversational Personality. When true, the agent uses the Conversational
+                 * Personality handbook preset, skips Professional Rep Personality during prompt
+                 * assembly, and enables internal colloquial rewrite behavior.
+                 */
+                conversational_personality?: boolean;
                 /**
                  * Professional call center rep baseline.
                  */
@@ -5217,23 +5255,6 @@ export declare namespace CallCreateWebCallParams {
              * sound. If unset, default value 1 will apply.
              */
             ambient_sound_volume?: number;
-            /**
-             * Prompt to determine whether the post call or chat analysis should mark the
-             * interaction as successful. Set to null to use the default prompt.
-             */
-            analysis_successful_prompt?: string | null;
-            /**
-             * Prompt to guide how the post call or chat analysis summary should be generated.
-             * When unset, the default system prompt is used. Set to null to use the default
-             * prompt.
-             */
-            analysis_summary_prompt?: string | null;
-            /**
-             * Prompt to guide how the post call or chat analysis should evaluate user
-             * sentiment. When unset, the default system prompt is used. Set to null to use the
-             * default prompt.
-             */
-            analysis_user_sentiment_prompt?: string | null;
             /**
              * Only applicable when enable_backchannel is true. Controls how often the agent
              * would backchannel when a backchannel is possible. Value ranging from [0,1].
@@ -5314,11 +5335,30 @@ export declare namespace CallCreateWebCallParams {
              * speech rate and conversation context. If unset, default value false will apply.
              */
             enable_dynamic_voice_speed?: boolean;
+            /**
+             * Master toggle for expressive mode. When true, the agent may add expressive voice
+             * tags to the audio it generates. Only applicable for platform voices. If unset,
+             * defaults to false.
+             */
+            enable_expressive_mode?: boolean;
             /**
              * If users stay silent for a period after agent speech, end the call. The minimum
              * value allowed is 10,000 ms (10 s). By default, this is set to 600000 (10 min).
              */
             end_call_after_silence_ms?: number;
+            /**
+             * The expressive voice tags Retell pre-teaches the model to use when
+             * enable_expressive_mode is true. Custom tags defined in the system prompt are
+             * still allowed. If empty, the agent follows general expressive guidance without a
+             * fixed tag set.
+             */
+            expressive_emotion_tags?: Array<'empathetic' | 'excited' | 'happy' | 'curious' | 'surprised' | 'sigh' | 'clear throat' | 'pause' | 'long pause' | 'emphasis'>;
+            /**
+             * Custom expressive voice guidance to use instead of the default Retell expressive
+             * prompt when enable_expressive_mode is true. If omitted or blank, the default
+             * expressive prompt will be used.
+             */
+            expressive_mode_prompt?: string | null;
             /**
              * When TTS provider for the selected voice is experiencing outages, we would use
              * fallback voices listed here for the agent. Voice id and the fallback voice ids
@@ -5446,6 +5486,10 @@ export declare namespace CallCreateWebCallParams {
              * documentation.
              */
             version_description?: string | null;
+            /**
+             * Optional title of the agent version. Used for your own reference.
+             */
+            version_title?: string | null;
             /**
              * If set, determines the vocabulary set to use for transcription. This setting
              * only applies for English agents, for non English agent, this setting is a no-op.
@@ -5481,19 +5525,6 @@ export declare namespace CallCreateWebCallParams {
              * will apply.
              */
             voice_temperature?: number;
-            /**
-             * Configures when to stop running voicemail detection, as it becomes unlikely to
-             * hit voicemail after a couple minutes, and keep running it will only have
-             * negative impact. The minimum value allowed is 5,000 ms (5 s), and maximum value
-             * allowed is 180,000 (3 minutes). By default, this is set to 30,000 (30 s).
-             */
-            voicemail_detection_timeout_ms?: number;
-            /**
-             * The message to be played when the call enters a voicemail. Note that this
-             * feature is only available for phone calls. If you want to hangup after hitting
-             * voicemail, set this to empty string.
-             */
-            voicemail_message?: string;
             /**
              * If this option is set, the call will try to detect voicemail in the first 3
              * minutes of the call. Actions defined (hangup, or leave a message) will be
@@ -5549,13 +5580,13 @@ export declare namespace CallCreateWebCallParams {
             interface CustomSttConfig {
                 /**
                  * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
-                 * 500 for Soniox
+                 * 500 for Soniox, 100 for AssemblyAI.
                  */
                 endpointing_ms: number;
                 /**
                  * ASR provider name.
                  */
-                provider: 'azure' | 'deepgram' | 'soniox';
+                provider: 'azure' | 'deepgram' | 'soniox' | 'assemblyai';
             }
             /**
              * Configuration for guardrail checks to detect and prevent prohibited topics in
@@ -5582,6 +5613,12 @@ export declare namespace CallCreateWebCallParams {
                  * When asked, acknowledge being a virtual assistant.
                  */
                 ai_disclosure?: boolean;
+                /**
+                 * Enables Conversational Personality. When true, the agent uses the Conversational
+                 * Personality handbook preset, skips Professional Rep Personality during prompt
+                 * assembly, and enables internal colloquial rewrite behavior.
+                 */
+                conversational_personality?: boolean;
                 /**
                  * Professional call center rep baseline.
                  */
@@ -6599,18 +6636,22 @@ export declare namespace CallListParams {
             value: string;
         }
         interface ToolCall {
-            /**
-             * The tool call name to filter on.
-             */
-            name: string;
             /**
              * Filter by tool call latency in milliseconds.
              */
             latency_ms?: ToolCall.NumberFilter | ToolCall.RangeFilter;
+            /**
+             * The tool call name to filter on.
+             */
+            name?: string;
             /**
              * Filter by tool call success status.
              */
             success?: ToolCall.Success;
+            /**
+             * The tool call type to filter on.
+             */
+            type?: string;
         }
         namespace ToolCall {
             interface NumberFilter {