retell-sdk 6.2.7 → 6.2.8

package/src/resources/conversation-flow.ts

@@ -2697,6 +2697,26 @@ export namespace ConversationFlowResponse {
          */
         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).
@@ -2734,6 +2754,33 @@ export namespace ConversationFlowResponse {
 
           type: 'template';
         }
+
+        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 CustomTool {
@@ -7120,6 +7167,18 @@ export namespace ConversationFlowResponse {
        * Optional name for display purposes
        */
       name?: string;
+
+      /**
+       * SMS destination number configuration. If omitted, the message is sent to the
+       * customer number on the call.
+       */
+      sms_destination?: SMSNode.DestinationCustomerNumber | SMSNode.DestinationPhoneNumber | unknown;
+
+      /**
+       * SMS sender number configuration. If omitted, the message is sent from the
+       * agent's phone number.
+       */
+      sms_sender?: SMSNode.SenderCurrentNumber | SMSNode.SenderRetellLongCode | unknown;
     }
 
     export namespace SMSNode {
@@ -7665,6 +7724,33 @@ export namespace ConversationFlowResponse {
          */
         ultrafast?: boolean;
       }
+
+      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 ExtractDynamicVariablesNode {
@@ -13785,6 +13871,23 @@ export namespace ConversationFlowResponse {
        */
       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).
@@ -13822,6 +13925,33 @@ export namespace ConversationFlowResponse {
 
         type: 'template';
       }
+
+      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 CustomTool {
@@ -18208,6 +18338,18 @@ export namespace ConversationFlowResponse {
      * Optional name for display purposes
      */
     name?: string;
+
+    /**
+     * SMS destination number configuration. If omitted, the message is sent to the
+     * customer number on the call.
+     */
+    sms_destination?: SMSNode.DestinationCustomerNumber | SMSNode.DestinationPhoneNumber | unknown;
+
+    /**
+     * SMS sender number configuration. If omitted, the message is sent from the
+     * agent's phone number.
+     */
+    sms_sender?: SMSNode.SenderCurrentNumber | SMSNode.SenderRetellLongCode | unknown;
   }
 
   export namespace SMSNode {
@@ -18753,6 +18895,33 @@ export namespace ConversationFlowResponse {
        */
       ultrafast?: boolean;
     }
+
+    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 ExtractDynamicVariablesNode {
@@ -24932,6 +25101,23 @@ export namespace ConversationFlowCreateParams {
        */
       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).
@@ -24969,6 +25155,33 @@ export namespace ConversationFlowCreateParams {
 
         type: 'template';
       }
+
+      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 CustomTool {
@@ -29355,6 +29568,18 @@ export namespace ConversationFlowCreateParams {
      * Optional name for display purposes
      */
     name?: string;
+
+    /**
+     * SMS destination number configuration. If omitted, the message is sent to the
+     * customer number on the call.
+     */
+    sms_destination?: SMSNode.DestinationCustomerNumber | SMSNode.DestinationPhoneNumber | unknown;
+
+    /**
+     * SMS sender number configuration. If omitted, the message is sent from the
+     * agent's phone number.
+     */
+    sms_sender?: SMSNode.SenderCurrentNumber | SMSNode.SenderRetellLongCode | unknown;
   }
 
   export namespace SMSNode {
@@ -29900,6 +30125,33 @@ export namespace ConversationFlowCreateParams {
        */
       ultrafast?: boolean;
     }
+
+    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 ExtractDynamicVariablesNode {
@@ -35582,6 +35834,26 @@ export namespace ConversationFlowCreateParams {
          */
         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).
@@ -35619,6 +35891,33 @@ export namespace ConversationFlowCreateParams {
 
           type: 'template';
         }
+
+        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 CustomTool {
@@ -40005,6 +40304,18 @@ export namespace ConversationFlowCreateParams {
        * Optional name for display purposes
        */
       name?: string;
+
+      /**
+       * SMS destination number configuration. If omitted, the message is sent to the
+       * customer number on the call.
+       */
+      sms_destination?: SMSNode.DestinationCustomerNumber | SMSNode.DestinationPhoneNumber | unknown;
+
+      /**
+       * SMS sender number configuration. If omitted, the message is sent from the
+       * agent's phone number.
+       */
+      sms_sender?: SMSNode.SenderCurrentNumber | SMSNode.SenderRetellLongCode | unknown;
     }
 
     export namespace SMSNode {
@@ -40550,6 +40861,33 @@ export namespace ConversationFlowCreateParams {
          */
         ultrafast?: boolean;
       }
+
+      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 ExtractDynamicVariablesNode {
@@ -47156,6 +47494,26 @@ export namespace ConversationFlowUpdateParams {
          */
         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).
@@ -47193,6 +47551,33 @@ export namespace ConversationFlowUpdateParams {
 
           type: 'template';
         }
+
+        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 CustomTool {
@@ -51579,6 +51964,18 @@ export namespace ConversationFlowUpdateParams {
        * Optional name for display purposes
        */
       name?: string;
+
+      /**
+       * SMS destination number configuration. If omitted, the message is sent to the
+       * customer number on the call.
+       */
+      sms_destination?: SMSNode.DestinationCustomerNumber | SMSNode.DestinationPhoneNumber | unknown;
+
+      /**
+       * SMS sender number configuration. If omitted, the message is sent from the
+       * agent's phone number.
+       */
+      sms_sender?: SMSNode.SenderCurrentNumber | SMSNode.SenderRetellLongCode | unknown;
     }
 
     export namespace SMSNode {
@@ -52124,6 +52521,33 @@ export namespace ConversationFlowUpdateParams {
          */
         ultrafast?: boolean;
       }
+
+      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 ExtractDynamicVariablesNode {
@@ -58244,6 +58668,23 @@ export namespace ConversationFlowUpdateParams {
        */
       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).
@@ -58281,6 +58722,33 @@ export namespace ConversationFlowUpdateParams {
 
         type: 'template';
       }
+
+      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 CustomTool {
@@ -62667,6 +63135,18 @@ export namespace ConversationFlowUpdateParams {
      * Optional name for display purposes
      */
     name?: string;
+
+    /**
+     * SMS destination number configuration. If omitted, the message is sent to the
+     * customer number on the call.
+     */
+    sms_destination?: SMSNode.DestinationCustomerNumber | SMSNode.DestinationPhoneNumber | unknown;
+
+    /**
+     * SMS sender number configuration. If omitted, the message is sent from the
+     * agent's phone number.
+     */
+    sms_sender?: SMSNode.SenderCurrentNumber | SMSNode.SenderRetellLongCode | unknown;
   }
 
   export namespace SMSNode {
@@ -63212,6 +63692,33 @@ export namespace ConversationFlowUpdateParams {
        */
       ultrafast?: boolean;
     }
+
+    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 ExtractDynamicVariablesNode {