retell-sdk 6.2.7 → 6.2.8

package/resources/conversation-flow.d.ts

@@ -1889,6 +1889,20 @@ export declare namespace ConversationFlowResponse {
                  * to "prompt".
                  */
                 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).
@@ -1920,6 +1934,27 @@ export declare namespace ConversationFlowResponse {
                     template: 'info_collection';
                     type: 'template';
                 }
+                interface DestinationCustomerNumber {
+                    type: 'customer_number';
+                }
+                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;
+                }
+                interface SenderCurrentNumber {
+                    type: 'current_number';
+                }
+                interface SenderRetellLongCode {
+                    type: 'retell_long_code';
+                }
             }
             interface CustomTool {
                 /**
@@ -4991,6 +5026,16 @@ export declare 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;
         }
         namespace SMSNode {
             /**
@@ -5343,6 +5388,27 @@ export declare namespace ConversationFlowResponse {
                  */
                 ultrafast?: boolean;
             }
+            interface DestinationCustomerNumber {
+                type: 'customer_number';
+            }
+            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;
+            }
+            interface SenderCurrentNumber {
+                type: 'current_number';
+            }
+            interface SenderRetellLongCode {
+                type: 'retell_long_code';
+            }
         }
         interface ExtractDynamicVariablesNode {
             /**
@@ -9587,6 +9653,20 @@ export declare namespace ConversationFlowResponse {
              * to "prompt".
              */
             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).
@@ -9618,6 +9698,27 @@ export declare namespace ConversationFlowResponse {
                 template: 'info_collection';
                 type: 'template';
             }
+            interface DestinationCustomerNumber {
+                type: 'customer_number';
+            }
+            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;
+            }
+            interface SenderCurrentNumber {
+                type: 'current_number';
+            }
+            interface SenderRetellLongCode {
+                type: 'retell_long_code';
+            }
         }
         interface CustomTool {
             /**
@@ -12689,6 +12790,16 @@ export declare 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;
     }
     namespace SMSNode {
         /**
@@ -13041,6 +13152,27 @@ export declare namespace ConversationFlowResponse {
              */
             ultrafast?: boolean;
         }
+        interface DestinationCustomerNumber {
+            type: 'customer_number';
+        }
+        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;
+        }
+        interface SenderCurrentNumber {
+            type: 'current_number';
+        }
+        interface SenderRetellLongCode {
+            type: 'retell_long_code';
+        }
     }
     interface ExtractDynamicVariablesNode {
         /**
@@ -17313,6 +17445,20 @@ export declare namespace ConversationFlowCreateParams {
              * to "prompt".
              */
             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).
@@ -17344,6 +17490,27 @@ export declare namespace ConversationFlowCreateParams {
                 template: 'info_collection';
                 type: 'template';
             }
+            interface DestinationCustomerNumber {
+                type: 'customer_number';
+            }
+            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;
+            }
+            interface SenderCurrentNumber {
+                type: 'current_number';
+            }
+            interface SenderRetellLongCode {
+                type: 'retell_long_code';
+            }
         }
         interface CustomTool {
             /**
@@ -20415,6 +20582,16 @@ export declare 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;
     }
     namespace SMSNode {
         /**
@@ -20767,6 +20944,27 @@ export declare namespace ConversationFlowCreateParams {
              */
             ultrafast?: boolean;
         }
+        interface DestinationCustomerNumber {
+            type: 'customer_number';
+        }
+        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;
+        }
+        interface SenderCurrentNumber {
+            type: 'current_number';
+        }
+        interface SenderRetellLongCode {
+            type: 'retell_long_code';
+        }
     }
     interface ExtractDynamicVariablesNode {
         /**
@@ -24641,6 +24839,20 @@ export declare namespace ConversationFlowCreateParams {
                  * to "prompt".
                  */
                 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).
@@ -24672,6 +24884,27 @@ export declare namespace ConversationFlowCreateParams {
                     template: 'info_collection';
                     type: 'template';
                 }
+                interface DestinationCustomerNumber {
+                    type: 'customer_number';
+                }
+                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;
+                }
+                interface SenderCurrentNumber {
+                    type: 'current_number';
+                }
+                interface SenderRetellLongCode {
+                    type: 'retell_long_code';
+                }
             }
             interface CustomTool {
                 /**
@@ -27743,6 +27976,16 @@ export declare 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;
         }
         namespace SMSNode {
             /**
@@ -28095,6 +28338,27 @@ export declare namespace ConversationFlowCreateParams {
                  */
                 ultrafast?: boolean;
             }
+            interface DestinationCustomerNumber {
+                type: 'customer_number';
+            }
+            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;
+            }
+            interface SenderCurrentNumber {
+                type: 'current_number';
+            }
+            interface SenderRetellLongCode {
+                type: 'retell_long_code';
+            }
         }
         interface ExtractDynamicVariablesNode {
             /**
@@ -32763,6 +33027,20 @@ export declare namespace ConversationFlowUpdateParams {
                  * to "prompt".
                  */
                 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).
@@ -32794,6 +33072,27 @@ export declare namespace ConversationFlowUpdateParams {
                     template: 'info_collection';
                     type: 'template';
                 }
+                interface DestinationCustomerNumber {
+                    type: 'customer_number';
+                }
+                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;
+                }
+                interface SenderCurrentNumber {
+                    type: 'current_number';
+                }
+                interface SenderRetellLongCode {
+                    type: 'retell_long_code';
+                }
             }
             interface CustomTool {
                 /**
@@ -35865,6 +36164,16 @@ export declare 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;
         }
         namespace SMSNode {
             /**
@@ -36217,6 +36526,27 @@ export declare namespace ConversationFlowUpdateParams {
                  */
                 ultrafast?: boolean;
             }
+            interface DestinationCustomerNumber {
+                type: 'customer_number';
+            }
+            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;
+            }
+            interface SenderCurrentNumber {
+                type: 'current_number';
+            }
+            interface SenderRetellLongCode {
+                type: 'retell_long_code';
+            }
         }
         interface ExtractDynamicVariablesNode {
             /**
@@ -40461,6 +40791,20 @@ export declare namespace ConversationFlowUpdateParams {
              * to "prompt".
              */
             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).
@@ -40492,6 +40836,27 @@ export declare namespace ConversationFlowUpdateParams {
                 template: 'info_collection';
                 type: 'template';
             }
+            interface DestinationCustomerNumber {
+                type: 'customer_number';
+            }
+            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;
+            }
+            interface SenderCurrentNumber {
+                type: 'current_number';
+            }
+            interface SenderRetellLongCode {
+                type: 'retell_long_code';
+            }
         }
         interface CustomTool {
             /**
@@ -43563,6 +43928,16 @@ export declare 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;
     }
     namespace SMSNode {
         /**
@@ -43915,6 +44290,27 @@ export declare namespace ConversationFlowUpdateParams {
              */
             ultrafast?: boolean;
         }
+        interface DestinationCustomerNumber {
+            type: 'customer_number';
+        }
+        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;
+        }
+        interface SenderCurrentNumber {
+            type: 'current_number';
+        }
+        interface SenderRetellLongCode {
+            type: 'retell_long_code';
+        }
     }
     interface ExtractDynamicVariablesNode {
         /**