retell-sdk 6.2.7 → 6.2.8

package/src/resources/batch-call.ts

@@ -481,10 +481,7 @@ export namespace BatchCallCreateBatchCallParams {
         /**
          * Specifies what language(s) the agent will operate in. Accepts either a single
          * locale (e.g. `en-US`) or an array of locales for multilingual agents (e.g.
-         * `["en-US","es-ES"]`). The scalar value `multi` is deprecated but still accepted
-         * as a scalar, and is stored and returned as the ten locales it used to mean. It
-         * must not appear inside the array form. Send an explicit locale array instead. If
-         * unset, defaults to `en-US`.
+         * `["en-US","es-ES"]`). If unset, defaults to `en-US`.
          */
         language?:
           | 'en-US'
@@ -550,7 +547,6 @@ export namespace BatchCallCreateBatchCallParams {
           | 'ur-IN'
           | 'yue-CN'
           | 'uk-UA'
-          | 'multi'
           | Array<
               | 'en-US'
               | 'en-IN'
@@ -1822,6 +1818,26 @@ export namespace BatchCallCreateBatchCallParams {
            */
           execution_message_type?: 'prompt' | 'static_text';
 
+          /**
+           * SMS destination number configuration. If omitted, the message is sent to the
+           * customer number on the call.
+           */
+          sms_destination?:
+            | SendSMSTool.DestinationCustomerNumber
+            | SendSMSTool.DestinationPhoneNumber
+            | unknown;
+
+          /**
+           * SMS sender number configuration. If omitted, the message is sent from the
+           * agent's phone number.
+           */
+          sms_sender?: SendSMSTool.SenderCurrentNumber | SendSMSTool.SenderRetellLongCode | unknown;
+
+          /**
+           * Whether the agent should speak after the SMS tool finishes execution.
+           */
+          speak_after_execution?: boolean;
+
           /**
            * If true, the agent will speak a short line before sending the SMS. If omitted,
            * defaults to true (same as end_call / transfer_call tools).
@@ -1898,6 +1914,33 @@ export namespace BatchCallCreateBatchCallParams {
               right?: string;
             }
           }
+
+          export interface DestinationCustomerNumber {
+            type: 'customer_number';
+          }
+
+          export interface DestinationPhoneNumber {
+            /**
+             * Destination phone number in E.164 format.
+             */
+            phone_number: string;
+
+            type: 'phone_number';
+
+            /**
+             * If true, skip E.164 validation for this phone number (same semantics as
+             * transfer_call ignore_e164_validation).
+             */
+            ignore_e164_validation?: boolean;
+          }
+
+          export interface SenderCurrentNumber {
+            type: 'current_number';
+          }
+
+          export interface SenderRetellLongCode {
+            type: 'retell_long_code';
+          }
         }
 
         export interface AppTool {

package/src/resources/call.ts

@@ -177,8 +177,8 @@ export class Call extends APIResource {
   /**
    * Take over an in-progress call from the AI agent. The agent stops responding and
    * the specified live-listen participant is allowed to speak directly to the
-   * caller. The call must be in ONGOING status. Gateway calls cannot be taken over
-   * while a PCI session is active.
+   * caller. The call must be in ONGOING status. Calls cannot be taken over while a
+   * PCI session is active.
    *
    * @example
    * ```ts
@@ -7405,10 +7405,7 @@ export namespace CallCreatePhoneCallParams {
       /**
        * Specifies what language(s) the agent will operate in. Accepts either a single
        * locale (e.g. `en-US`) or an array of locales for multilingual agents (e.g.
-       * `["en-US","es-ES"]`). The scalar value `multi` is deprecated but still accepted
-       * as a scalar, and is stored and returned as the ten locales it used to mean. It
-       * must not appear inside the array form. Send an explicit locale array instead. If
-       * unset, defaults to `en-US`.
+       * `["en-US","es-ES"]`). If unset, defaults to `en-US`.
        */
       language?:
         | 'en-US'
@@ -7474,7 +7471,6 @@ export namespace CallCreatePhoneCallParams {
         | 'ur-IN'
         | 'yue-CN'
         | 'uk-UA'
-        | 'multi'
         | Array<
             | 'en-US'
             | 'en-IN'
@@ -8746,6 +8742,26 @@ export namespace CallCreatePhoneCallParams {
          */
         execution_message_type?: 'prompt' | 'static_text';
 
+        /**
+         * SMS destination number configuration. If omitted, the message is sent to the
+         * customer number on the call.
+         */
+        sms_destination?:
+          | SendSMSTool.DestinationCustomerNumber
+          | SendSMSTool.DestinationPhoneNumber
+          | unknown;
+
+        /**
+         * SMS sender number configuration. If omitted, the message is sent from the
+         * agent's phone number.
+         */
+        sms_sender?: SendSMSTool.SenderCurrentNumber | SendSMSTool.SenderRetellLongCode | unknown;
+
+        /**
+         * Whether the agent should speak after the SMS tool finishes execution.
+         */
+        speak_after_execution?: boolean;
+
         /**
          * If true, the agent will speak a short line before sending the SMS. If omitted,
          * defaults to true (same as end_call / transfer_call tools).
@@ -8822,6 +8838,33 @@ export namespace CallCreatePhoneCallParams {
             right?: string;
           }
         }
+
+        export interface DestinationCustomerNumber {
+          type: 'customer_number';
+        }
+
+        export interface DestinationPhoneNumber {
+          /**
+           * Destination phone number in E.164 format.
+           */
+          phone_number: string;
+
+          type: 'phone_number';
+
+          /**
+           * If true, skip E.164 validation for this phone number (same semantics as
+           * transfer_call ignore_e164_validation).
+           */
+          ignore_e164_validation?: boolean;
+        }
+
+        export interface SenderCurrentNumber {
+          type: 'current_number';
+        }
+
+        export interface SenderRetellLongCode {
+          type: 'retell_long_code';
+        }
       }
 
       export interface AppTool {
@@ -9961,10 +10004,7 @@ export namespace CallCreateWebCallParams {
       /**
        * Specifies what language(s) the agent will operate in. Accepts either a single
        * locale (e.g. `en-US`) or an array of locales for multilingual agents (e.g.
-       * `["en-US","es-ES"]`). The scalar value `multi` is deprecated but still accepted
-       * as a scalar, and is stored and returned as the ten locales it used to mean. It
-       * must not appear inside the array form. Send an explicit locale array instead. If
-       * unset, defaults to `en-US`.
+       * `["en-US","es-ES"]`). If unset, defaults to `en-US`.
        */
       language?:
         | 'en-US'
@@ -10030,7 +10070,6 @@ export namespace CallCreateWebCallParams {
         | 'ur-IN'
         | 'yue-CN'
         | 'uk-UA'
-        | 'multi'
         | Array<
             | 'en-US'
             | 'en-IN'
@@ -11302,6 +11341,26 @@ export namespace CallCreateWebCallParams {
          */
         execution_message_type?: 'prompt' | 'static_text';
 
+        /**
+         * SMS destination number configuration. If omitted, the message is sent to the
+         * customer number on the call.
+         */
+        sms_destination?:
+          | SendSMSTool.DestinationCustomerNumber
+          | SendSMSTool.DestinationPhoneNumber
+          | unknown;
+
+        /**
+         * SMS sender number configuration. If omitted, the message is sent from the
+         * agent's phone number.
+         */
+        sms_sender?: SendSMSTool.SenderCurrentNumber | SendSMSTool.SenderRetellLongCode | unknown;
+
+        /**
+         * Whether the agent should speak after the SMS tool finishes execution.
+         */
+        speak_after_execution?: boolean;
+
         /**
          * If true, the agent will speak a short line before sending the SMS. If omitted,
          * defaults to true (same as end_call / transfer_call tools).
@@ -11378,6 +11437,33 @@ export namespace CallCreateWebCallParams {
             right?: string;
           }
         }
+
+        export interface DestinationCustomerNumber {
+          type: 'customer_number';
+        }
+
+        export interface DestinationPhoneNumber {
+          /**
+           * Destination phone number in E.164 format.
+           */
+          phone_number: string;
+
+          type: 'phone_number';
+
+          /**
+           * If true, skip E.164 validation for this phone number (same semantics as
+           * transfer_call ignore_e164_validation).
+           */
+          ignore_e164_validation?: boolean;
+        }
+
+        export interface SenderCurrentNumber {
+          type: 'current_number';
+        }
+
+        export interface SenderRetellLongCode {
+          type: 'retell_long_code';
+        }
       }
 
       export interface AppTool {
@@ -12517,10 +12603,7 @@ export namespace CallRegisterPhoneCallParams {
       /**
        * Specifies what language(s) the agent will operate in. Accepts either a single
        * locale (e.g. `en-US`) or an array of locales for multilingual agents (e.g.
-       * `["en-US","es-ES"]`). The scalar value `multi` is deprecated but still accepted
-       * as a scalar, and is stored and returned as the ten locales it used to mean. It
-       * must not appear inside the array form. Send an explicit locale array instead. If
-       * unset, defaults to `en-US`.
+       * `["en-US","es-ES"]`). If unset, defaults to `en-US`.
        */
       language?:
         | 'en-US'
@@ -12586,7 +12669,6 @@ export namespace CallRegisterPhoneCallParams {
         | 'ur-IN'
         | 'yue-CN'
         | 'uk-UA'
-        | 'multi'
         | Array<
             | 'en-US'
             | 'en-IN'
@@ -13858,6 +13940,26 @@ export namespace CallRegisterPhoneCallParams {
          */
         execution_message_type?: 'prompt' | 'static_text';
 
+        /**
+         * SMS destination number configuration. If omitted, the message is sent to the
+         * customer number on the call.
+         */
+        sms_destination?:
+          | SendSMSTool.DestinationCustomerNumber
+          | SendSMSTool.DestinationPhoneNumber
+          | unknown;
+
+        /**
+         * SMS sender number configuration. If omitted, the message is sent from the
+         * agent's phone number.
+         */
+        sms_sender?: SendSMSTool.SenderCurrentNumber | SendSMSTool.SenderRetellLongCode | unknown;
+
+        /**
+         * Whether the agent should speak after the SMS tool finishes execution.
+         */
+        speak_after_execution?: boolean;
+
         /**
          * If true, the agent will speak a short line before sending the SMS. If omitted,
          * defaults to true (same as end_call / transfer_call tools).
@@ -13934,6 +14036,33 @@ export namespace CallRegisterPhoneCallParams {
             right?: string;
           }
         }
+
+        export interface DestinationCustomerNumber {
+          type: 'customer_number';
+        }
+
+        export interface DestinationPhoneNumber {
+          /**
+           * Destination phone number in E.164 format.
+           */
+          phone_number: string;
+
+          type: 'phone_number';
+
+          /**
+           * If true, skip E.164 validation for this phone number (same semantics as
+           * transfer_call ignore_e164_validation).
+           */
+          ignore_e164_validation?: boolean;
+        }
+
+        export interface SenderCurrentNumber {
+          type: 'current_number';
+        }
+
+        export interface SenderRetellLongCode {
+          type: 'retell_long_code';
+        }
       }
 
       export interface AppTool {

package/src/resources/chat-agent.ts

@@ -261,10 +261,7 @@ export interface ChatAgentResponse {
   /**
    * Specifies what language(s) the agent will operate in. Accepts either a single
    * locale (e.g. `en-US`) or an array of locales for multilingual agents (e.g.
-   * `["en-US","es-ES"]`). The scalar value `multi` is deprecated but still accepted
-   * as a scalar, and is stored and returned as the ten locales it used to mean. It
-   * must not appear inside the array form. Send an explicit locale array instead. If
-   * unset, defaults to `en-US`.
+   * `["en-US","es-ES"]`). If unset, defaults to `en-US`.
    */
   language?:
     | 'en-US'
@@ -330,7 +327,6 @@ export interface ChatAgentResponse {
     | 'ur-IN'
     | 'yue-CN'
     | 'uk-UA'
-    | 'multi'
     | Array<
         | 'en-US'
         | 'en-IN'
@@ -1411,6 +1407,23 @@ export namespace ChatAgentResponse {
      */
     execution_message_type?: 'prompt' | 'static_text';
 
+    /**
+     * SMS destination number configuration. If omitted, the message is sent to the
+     * customer number on the call.
+     */
+    sms_destination?: SendSMSTool.DestinationCustomerNumber | SendSMSTool.DestinationPhoneNumber | unknown;
+
+    /**
+     * SMS sender number configuration. If omitted, the message is sent from the
+     * agent's phone number.
+     */
+    sms_sender?: SendSMSTool.SenderCurrentNumber | SendSMSTool.SenderRetellLongCode | unknown;
+
+    /**
+     * Whether the agent should speak after the SMS tool finishes execution.
+     */
+    speak_after_execution?: boolean;
+
     /**
      * If true, the agent will speak a short line before sending the SMS. If omitted,
      * defaults to true (same as end_call / transfer_call tools).
@@ -1487,6 +1500,33 @@ export namespace ChatAgentResponse {
         right?: string;
       }
     }
+
+    export interface DestinationCustomerNumber {
+      type: 'customer_number';
+    }
+
+    export interface DestinationPhoneNumber {
+      /**
+       * Destination phone number in E.164 format.
+       */
+      phone_number: string;
+
+      type: 'phone_number';
+
+      /**
+       * If true, skip E.164 validation for this phone number (same semantics as
+       * transfer_call ignore_e164_validation).
+       */
+      ignore_e164_validation?: boolean;
+    }
+
+    export interface SenderCurrentNumber {
+      type: 'current_number';
+    }
+
+    export interface SenderRetellLongCode {
+      type: 'retell_long_code';
+    }
   }
 
   export interface AppTool {
@@ -1998,10 +2038,7 @@ export interface ChatAgentCreateParams {
   /**
    * Specifies what language(s) the agent will operate in. Accepts either a single
    * locale (e.g. `en-US`) or an array of locales for multilingual agents (e.g.
-   * `["en-US","es-ES"]`). The scalar value `multi` is deprecated but still accepted
-   * as a scalar, and is stored and returned as the ten locales it used to mean. It
-   * must not appear inside the array form. Send an explicit locale array instead. If
-   * unset, defaults to `en-US`.
+   * `["en-US","es-ES"]`). If unset, defaults to `en-US`.
    */
   language?:
     | 'en-US'
@@ -2067,7 +2104,6 @@ export interface ChatAgentCreateParams {
     | 'ur-IN'
     | 'yue-CN'
     | 'uk-UA'
-    | 'multi'
     | Array<
         | 'en-US'
         | 'en-IN'
@@ -3143,6 +3179,23 @@ export namespace ChatAgentCreateParams {
      */
     execution_message_type?: 'prompt' | 'static_text';
 
+    /**
+     * SMS destination number configuration. If omitted, the message is sent to the
+     * customer number on the call.
+     */
+    sms_destination?: SendSMSTool.DestinationCustomerNumber | SendSMSTool.DestinationPhoneNumber | unknown;
+
+    /**
+     * SMS sender number configuration. If omitted, the message is sent from the
+     * agent's phone number.
+     */
+    sms_sender?: SendSMSTool.SenderCurrentNumber | SendSMSTool.SenderRetellLongCode | unknown;
+
+    /**
+     * Whether the agent should speak after the SMS tool finishes execution.
+     */
+    speak_after_execution?: boolean;
+
     /**
      * If true, the agent will speak a short line before sending the SMS. If omitted,
      * defaults to true (same as end_call / transfer_call tools).
@@ -3219,6 +3272,33 @@ export namespace ChatAgentCreateParams {
         right?: string;
       }
     }
+
+    export interface DestinationCustomerNumber {
+      type: 'customer_number';
+    }
+
+    export interface DestinationPhoneNumber {
+      /**
+       * Destination phone number in E.164 format.
+       */
+      phone_number: string;
+
+      type: 'phone_number';
+
+      /**
+       * If true, skip E.164 validation for this phone number (same semantics as
+       * transfer_call ignore_e164_validation).
+       */
+      ignore_e164_validation?: boolean;
+    }
+
+    export interface SenderCurrentNumber {
+      type: 'current_number';
+    }
+
+    export interface SenderRetellLongCode {
+      type: 'retell_long_code';
+    }
   }
 
   export interface AppTool {
@@ -3679,10 +3759,7 @@ export interface ChatAgentUpdateParams {
   /**
    * Body param: Specifies what language(s) the agent will operate in. Accepts either
    * a single locale (e.g. `en-US`) or an array of locales for multilingual agents
-   * (e.g. `["en-US","es-ES"]`). The scalar value `multi` is deprecated but still
-   * accepted as a scalar, and is stored and returned as the ten locales it used to
-   * mean. It must not appear inside the array form. Send an explicit locale array
-   * instead. If unset, defaults to `en-US`.
+   * (e.g. `["en-US","es-ES"]`). If unset, defaults to `en-US`.
    */
   language?:
     | 'en-US'
@@ -3748,7 +3825,6 @@ export interface ChatAgentUpdateParams {
     | 'ur-IN'
     | 'yue-CN'
     | 'uk-UA'
-    | 'multi'
     | Array<
         | 'en-US'
         | 'en-IN'
@@ -4791,6 +4867,23 @@ export namespace ChatAgentUpdateParams {
      */
     execution_message_type?: 'prompt' | 'static_text';
 
+    /**
+     * SMS destination number configuration. If omitted, the message is sent to the
+     * customer number on the call.
+     */
+    sms_destination?: SendSMSTool.DestinationCustomerNumber | SendSMSTool.DestinationPhoneNumber | unknown;
+
+    /**
+     * SMS sender number configuration. If omitted, the message is sent from the
+     * agent's phone number.
+     */
+    sms_sender?: SendSMSTool.SenderCurrentNumber | SendSMSTool.SenderRetellLongCode | unknown;
+
+    /**
+     * Whether the agent should speak after the SMS tool finishes execution.
+     */
+    speak_after_execution?: boolean;
+
     /**
      * If true, the agent will speak a short line before sending the SMS. If omitted,
      * defaults to true (same as end_call / transfer_call tools).
@@ -4867,6 +4960,33 @@ export namespace ChatAgentUpdateParams {
         right?: string;
       }
     }
+
+    export interface DestinationCustomerNumber {
+      type: 'customer_number';
+    }
+
+    export interface DestinationPhoneNumber {
+      /**
+       * Destination phone number in E.164 format.
+       */
+      phone_number: string;
+
+      type: 'phone_number';
+
+      /**
+       * If true, skip E.164 validation for this phone number (same semantics as
+       * transfer_call ignore_e164_validation).
+       */
+      ignore_e164_validation?: boolean;
+    }
+
+    export interface SenderCurrentNumber {
+      type: 'current_number';
+    }
+
+    export interface SenderRetellLongCode {
+      type: 'retell_long_code';
+    }
   }
 
   export interface AppTool {