telnyx 7.23.0 → 7.25.0

package/src/resources/calls/actions.ts

@@ -18,6 +18,8 @@ export class Actions extends APIResource {
    *
    * **Expected Webhooks:**
    *
+   * - [`call.conversation.created`](/api-reference/callbacks/call-conversation-created)
+   *   includes `conversation_id` during startup
    * - `call.conversation.ended`
    * - `call.conversation_insights.generated`
    *
@@ -60,9 +62,33 @@ export class Actions extends APIResource {
    * Answer an incoming call. You must issue this command before executing subsequent
    * commands on an incoming call.
    *
+   * To answer with an AI assistant, include `assistant.id` and any per-call
+   * overrides in the `assistant` object. Telnyx attempts to warm up the assistant
+   * before answering the call, then starts the assistant automatically when the call
+   * is answered. Do not also send `ai_assistant_start` for this flow. The HTTP
+   * success response can arrive before the call is answered; use the `call.answered`
+   * webhook to track the answer. If warm-up fails, Telnyx falls back to starting the
+   * assistant after answering.
+   *
+   * When `assistant.id` is supplied, obtain the conversation ID from
+   * `data.payload.conversation_id` in the
+   * [call.conversation.created](/api-reference/callbacks/call-conversation-created)
+   * webhook and correlate it using `data.payload.call_control_id`. The `answer` HTTP
+   * response does not include `conversation_id`. The created event is emitted during
+   * assistant startup and does not indicate that the assistant is ready to speak.
+   *
+   * Set the assistant voice with `assistant.voice_settings.voice` and speech-to-text
+   * settings with `assistant.transcription`. You can reuse one stored assistant with
+   * different per-call settings. Warm-up prepares assistant configuration and
+   * dependencies; it does not wait for the greeting audio to be ready or guarantee
+   * zero silence after answer. A plain `answer` followed by `ai_assistant_start`
+   * performs assistant startup after the call has already been answered.
+   *
    * **Expected Webhooks:**
    *
    * - `call.answered`
+   * - `call.conversation.created` when the requested assistant conversation is
+   *   created
    * - `call.hold` and `call.unhold` if the call is held/unheld
    * - `call.deepfake_detection.result` if `deepfake_detection` was enabled
    * - `call.deepfake_detection.error` if `deepfake_detection` was enabled and an
@@ -266,6 +292,8 @@ export class Actions extends APIResource {
    *
    * **Expected Webhooks:**
    *
+   * - [`call.conversation.created`](/api-reference/callbacks/call-conversation-created)
+   *   includes `conversation_id` during startup
    * - `call.ai_gather.ended`
    * - `call.conversation.ended`
    * - `call.ai_gather.partial_results` (if `send_partial_results` is set to `true`)
@@ -888,6 +916,9 @@ export class Actions extends APIResource {
    *   `answering_machine_detection=premium` was requested
    * - `call.machine.premium.greeting.ended` if `answering_machine_detection=premium`
    *   was requested and a beep was detected
+   * - `call.machine.premium.call_screening.detected` if
+   *   `answering_machine_detection=premium_ios_call_screening_detection` was
+   *   requested and an Apple Call Screening tone was detected
    *
    * @example
    * ```ts
@@ -1483,6 +1514,23 @@ export namespace PayPromptValue {
   }
 }
 
+export interface SonioxVoiceSettings {
+  /**
+   * Voice settings provider type
+   */
+  type: 'soniox';
+
+  /**
+   * Shortens the pauses between words.
+   */
+  reduce_silence?: boolean;
+
+  /**
+   * Speaking rate. 1.0 is normal speed.
+   */
+  speed?: number;
+}
+
 export interface StopRecordingRequest {
   /**
    * Use this field to add state to every subsequent webhook. It must be a valid
@@ -1635,9 +1683,10 @@ export interface TelnyxVoiceSettings {
   type: 'telnyx';
 
   /**
-   * The voice speed to be used for the voice. The voice speed must be between 0.1
-   * and 2.0. Default value is 1.0. Not supported for `Telnyx.Bayan.*` or
-   * `Telnyx.Sukhan.*` voices.
+   * The voice speed to be used for the voice. Telnyx `Ultra` voices accept values
+   * from 0.6 to 1.5; values outside that range are rejected by the synthesis engine.
+   * `Qwen3TTS` and `KokoroTTS` accept the field but do not apply it. Default value
+   * is 1.0. Not supported for `Telnyx.Bayan.*` or `Telnyx.Sukhan.*` voices.
    */
   voice_speed?: number;
 }
@@ -2522,9 +2571,11 @@ export interface ActionUpdateClientStateResponse {
 
 export interface ActionStartAIAssistantParams {
   /**
-   * AI Assistant configuration. All fields except `id` are optional — the
-   * assistant's stored configuration will be used as fallback for any omitted
-   * fields.
+   * AI Assistant configuration and per-call overrides. All fields except `id` are
+   * optional. Omitted assistant fields use the stored configuration. Supplied
+   * `voice_settings` and `transcription` objects replace their stored objects rather
+   * than merging individual settings; include every setting you want to retain.
+   * `dynamic_variables` are merged, with request values taking precedence.
    */
   assistant?: CallsAPI.CallAssistantRequest;
 
@@ -2596,9 +2647,11 @@ export interface ActionStopAIAssistantParams {
 
 export interface ActionAnswerParams {
   /**
-   * AI Assistant configuration. All fields except `id` are optional — the
-   * assistant's stored configuration will be used as fallback for any omitted
-   * fields.
+   * AI Assistant configuration and per-call overrides. All fields except `id` are
+   * optional. Omitted assistant fields use the stored configuration. Supplied
+   * `voice_settings` and `transcription` objects replace their stored objects rather
+   * than merging individual settings; include every setting you want to retain.
+   * `dynamic_variables` are merged, with request values taking precedence.
    */
   assistant?: CallsAPI.CallAssistantRequest;
 
@@ -2749,7 +2802,9 @@ export interface ActionAnswerParams {
   stream_url?: string;
 
   /**
-   * Enable transcription upon call answer. The default value is false.
+   * Enable standalone call transcription upon call answer. The default value is
+   * false. Configure this feature with `transcription_config`. To configure speech
+   * recognition for an AI assistant, use `assistant.transcription` instead.
    */
   transcription?: boolean;
 
@@ -3276,6 +3331,12 @@ export interface ActionGatherUsingAIParams {
    * - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
    *   `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
    *   `s1`. `VoiceId` is a Fish Voice-Library reference ID.
+   * - **Soniox:** Use `Soniox.<ModelId>.<VoiceId>` (e.g., `Soniox.tts-rt-v2.Emma`).
+   *   Supported model: `tts-rt-v2`. Browse the catalog via the
+   *   [Voices API](https://developers.telnyx.com/api-reference/text-to-speech-commands/list-available-voices).
+   *   Every voice speaks all supported languages; set `language` to the two-letter
+   *   ISO 639-1 code of the text, for example `it`. SSML is not supported. Use
+   *   `voice_settings` to configure `speed` (0.7 to 1.3) and `reduce_silence`.
    * - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
    *   `ara`, `rex`, `sal`, `leo`.
    * - **Humain:** Use `Humain.<VoiceId>` (e.g., `Humain.sara-ar`). Available voices:
@@ -3294,7 +3355,8 @@ export interface ActionGatherUsingAIParams {
     | AwsVoiceSettings
     | Shared.AzureVoiceSettings
     | Shared.ResembleVoiceSettings
-    | Shared.XaiVoiceSettings;
+    | Shared.XaiVoiceSettings
+    | SonioxVoiceSettings;
 }
 
 export namespace ActionGatherUsingAIParams {
@@ -3447,6 +3509,12 @@ export interface ActionGatherUsingSpeakParams {
    * - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
    *   `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
    *   `s1`. `VoiceId` is a Fish Voice-Library reference ID.
+   * - **Soniox:** Use `Soniox.<ModelId>.<VoiceId>` (e.g., `Soniox.tts-rt-v2.Emma`).
+   *   Supported model: `tts-rt-v2`. Browse the catalog via the
+   *   [Voices API](https://developers.telnyx.com/api-reference/text-to-speech-commands/list-available-voices).
+   *   Every voice speaks all supported languages; set `language` to the two-letter
+   *   ISO 639-1 code of the text, for example `it`. SSML is not supported. Use
+   *   `voice_settings` to configure `speed` (0.7 to 1.3) and `reduce_silence`.
    * - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
    *   `ara`, `rex`, `sal`, `leo`.
    * - **Humain:** Use `Humain.<VoiceId>` (e.g., `Humain.sara-ar`). Available voices:
@@ -3576,7 +3644,8 @@ export interface ActionGatherUsingSpeakParams {
     | Shared.AzureVoiceSettings
     | Shared.ResembleVoiceSettings
     | Shared.InworldVoiceSettings
-    | Shared.XaiVoiceSettings;
+    | Shared.XaiVoiceSettings
+    | SonioxVoiceSettings;
 }
 
 export interface ActionHangupParams {
@@ -4161,9 +4230,12 @@ export interface ActionReferParams {
 
 export interface ActionRejectParams {
   /**
-   * Cause for call rejection.
+   * Cause for call rejection. The cause sets the SIP response the caller receives:
+   * `USER_BUSY` sends 486 User Busy, `CALL_REJECTED` sends 603 Decline, `NOT_FOUND`
+   * sends 404 Not Found, and `TEMPORARILY_UNAVAILABLE` sends 480 Temporarily
+   * Unavailable.
    */
-  cause: 'CALL_REJECTED' | 'USER_BUSY';
+  cause: 'CALL_REJECTED' | 'NOT_FOUND' | 'TEMPORARILY_UNAVAILABLE' | 'USER_BUSY';
 
   /**
    * Use this field to add state to every subsequent webhook. It must be a valid
@@ -4337,6 +4409,12 @@ export interface ActionSpeakParams {
    * - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
    *   `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
    *   `s1`. `VoiceId` is a Fish Voice-Library reference ID.
+   * - **Soniox:** Use `Soniox.<ModelId>.<VoiceId>` (e.g., `Soniox.tts-rt-v2.Emma`).
+   *   Supported model: `tts-rt-v2`. Browse the catalog via the
+   *   [Voices API](https://developers.telnyx.com/api-reference/text-to-speech-commands/list-available-voices).
+   *   Every voice speaks all supported languages; set `language` to the two-letter
+   *   ISO 639-1 code of the text, for example `it`. SSML is not supported. Use
+   *   `voice_settings` to configure `speed` (0.7 to 1.3) and `reduce_silence`.
    * - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
    *   `ara`, `rex`, `sal`, `leo`.
    * - **Humain:** Use `Humain.<VoiceId>` (e.g., `Humain.sara-ar`). Available voices:
@@ -4438,7 +4516,8 @@ export interface ActionSpeakParams {
     | Shared.AzureVoiceSettings
     | Shared.ResembleVoiceSettings
     | Shared.InworldVoiceSettings
-    | Shared.XaiVoiceSettings;
+    | Shared.XaiVoiceSettings
+    | SonioxVoiceSettings;
 }
 
 export interface ActionStartStreamingParams {
@@ -4757,10 +4836,20 @@ export interface ActionTransferParams {
    * 'greeting_end' or 'detect_words' is used and a 'machine' is detected, you will
    * receive another 'call.machine.greeting.ended' webhook when the answering machine
    * greeting ends with a beep or silence. If `detect_beep` is used, you will only
-   * receive 'call.machine.greeting.ended' if a beep is detected.
+   * receive 'call.machine.greeting.ended' if a beep is detected. If
+   * `answering_machine_detection` is set to `premium_ios_call_screening_detection`,
+   * Premium AMD runs with iOS Call Screening support: after an initial `machine`
+   * result, Telnyx listens for the iOS call-screening prompt to end or for an Apple
+   * Call Screening tone, sends `call.machine.premium.greeting.ended` with
+   * `result=prompt_ended` or `call.machine.premium.call_screening.detected` with
+   * `result=screening` respectively. When the Apple Call Screening tone is detected,
+   * Premium AMD is restarted on the screened call and a
+   * `call.machine.premium.detection.ended` webhook with the post-screening
+   * classification follows.
    */
   answering_machine_detection?:
     | 'premium'
+    | 'premium_ios_call_screening_detection'
     | 'detect'
     | 'detect_beep'
     | 'detect_words'
@@ -4771,7 +4860,8 @@ export interface ActionTransferParams {
    * Optional configuration parameters to modify 'answering_machine_detection'
    * performance. Only `total_analysis_time_millis` and `greeting_duration_millis`
    * parameters are applicable when `premium` is selected as
-   * answering_machine_detection.
+   * answering_machine_detection. `prompt_end_timeout_millis` is additionally
+   * applicable when `premium_ios_call_screening_detection` is selected.
    */
   answering_machine_detection_config?: ActionTransferParams.AnsweringMachineDetectionConfig;
 
@@ -5039,7 +5129,8 @@ export namespace ActionTransferParams {
    * Optional configuration parameters to modify 'answering_machine_detection'
    * performance. Only `total_analysis_time_millis` and `greeting_duration_millis`
    * parameters are applicable when `premium` is selected as
-   * answering_machine_detection.
+   * answering_machine_detection. `prompt_end_timeout_millis` is additionally
+   * applicable when `premium_ios_call_screening_detection` is selected.
    */
   export interface AnsweringMachineDetectionConfig {
     /**
@@ -5139,6 +5230,14 @@ export namespace ActionTransferParams {
      */
     maximum_word_length_millis?: number;
 
+    /**
+     * Maximum time Telnyx waits, in milliseconds, for the iOS call-screening prompt to
+     * end after Premium AMD initially detects a `machine`. Used when
+     * `answering_machine_detection` is `premium_ios_call_screening_detection`.
+     * Defaults to 5000 milliseconds.
+     */
+    prompt_end_timeout_millis?: number;
+
     /**
      * Minimum noise threshold for any analysis.
      */
@@ -5375,6 +5474,12 @@ export interface ActionStartConversationRelayParams {
    * - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
    *   `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
    *   `s1`. `VoiceId` is a Fish Voice-Library reference ID.
+   * - **Soniox:** Use `Soniox.<ModelId>.<VoiceId>` (e.g., `Soniox.tts-rt-v2.Emma`).
+   *   Supported model: `tts-rt-v2`. Browse the catalog via the
+   *   [Voices API](https://developers.telnyx.com/api-reference/text-to-speech-commands/list-available-voices).
+   *   Every voice speaks all supported languages; set `language` to the two-letter
+   *   ISO 639-1 code of the text, for example `it`. SSML is not supported. Use
+   *   `voice_settings` to configure `speed` (0.7 to 1.3) and `reduce_silence`.
    * - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
    *   `ara`, `rex`, `sal`, `leo`.
    * - **Humain:** Use `Humain.<VoiceId>` (e.g., `Humain.sara-ar`). Available voices:
@@ -5395,7 +5500,8 @@ export interface ActionStartConversationRelayParams {
     | Shared.AzureVoiceSettings
     | Shared.ResembleVoiceSettings
     | Shared.InworldVoiceSettings
-    | Shared.XaiVoiceSettings;
+    | Shared.XaiVoiceSettings
+    | SonioxVoiceSettings;
 }
 
 export namespace ActionStartConversationRelayParams {
@@ -5624,6 +5730,7 @@ export declare namespace Actions {
     type InterruptionSettings as InterruptionSettings,
     type Loopcount as Loopcount,
     type PayPromptValue as PayPromptValue,
+    type SonioxVoiceSettings as SonioxVoiceSettings,
     type StopRecordingRequest as StopRecordingRequest,
     type SystemMessage as SystemMessage,
     type TelnyxTranscriptionLanguage as TelnyxTranscriptionLanguage,

package/src/resources/calls/calls.ts

@@ -101,6 +101,7 @@ import {
   InterruptionSettings,
   Loopcount,
   PayPromptValue,
+  SonioxVoiceSettings,
   StopRecordingRequest,
   SystemMessage,
   TelnyxTranscriptionLanguage,
@@ -149,6 +150,9 @@ export class Calls extends APIResource {
    *   `answering_machine_detection=premium` was requested
    * - `call.machine.premium.greeting.ended` if `answering_machine_detection=premium`
    *   was requested and a beep was detected
+   * - `call.machine.premium.call_screening.detected` if
+   *   `answering_machine_detection=premium_ios_call_screening_detection` was
+   *   requested and an Apple Call Screening tone was detected
    * - `call.deepfake_detection.result` if `deepfake_detection` was enabled
    * - `call.deepfake_detection.error` if `deepfake_detection` was enabled and an
    *   error occurred
@@ -187,9 +191,11 @@ export class Calls extends APIResource {
 }
 
 /**
- * AI Assistant configuration. All fields except `id` are optional — the
- * assistant's stored configuration will be used as fallback for any omitted
- * fields.
+ * AI Assistant configuration and per-call overrides. All fields except `id` are
+ * optional. Omitted assistant fields use the stored configuration. Supplied
+ * `voice_settings` and `transcription` objects replace their stored objects rather
+ * than merging individual settings; include every setting you want to retain.
+ * `dynamic_variables` are merged, with request values taking precedence.
  */
 export interface CallAssistantRequest {
   /**
@@ -281,6 +287,19 @@ export interface CallAssistantRequest {
     | Shared.CallControlRetrievalTool
   >;
 
+  /**
+   * Per-call speech-to-text configuration for the assistant. If omitted, the stored
+   * assistant transcription configuration is used. If supplied, this object replaces
+   * the stored transcription settings. This is separate from the top-level
+   * `transcription` boolean on answer and dial commands.
+   */
+  transcription?: ActionsAPI.TranscriptionConfig;
+
+  /**
+   * Per-call voice configuration. Set the voice identifier in
+   * `voice_settings.voice`, not in `assistant.voice`. If supplied, this object
+   * replaces the stored voice settings.
+   */
   voice_settings?: AssistantsAPI.VoiceSettings;
 }
 
@@ -536,6 +555,12 @@ export interface ConversationRelayEmbeddedConfig {
    * - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
    *   `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
    *   `s1`. `VoiceId` is a Fish Voice-Library reference ID.
+   * - **Soniox:** Use `Soniox.<ModelId>.<VoiceId>` (e.g., `Soniox.tts-rt-v2.Emma`).
+   *   Supported model: `tts-rt-v2`. Browse the catalog via the
+   *   [Voices API](https://developers.telnyx.com/api-reference/text-to-speech-commands/list-available-voices).
+   *   Every voice speaks all supported languages; set `language` to the two-letter
+   *   ISO 639-1 code of the text, for example `it`. SSML is not supported. Use
+   *   `voice_settings` to configure `speed` (0.7 to 1.3) and `reduce_silence`.
    * - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
    *   `ara`, `rex`, `sal`, `leo`.
    * - **Humain:** Use `Humain.<VoiceId>` (e.g., `Humain.sara-ar`). Available voices:
@@ -556,7 +581,8 @@ export interface ConversationRelayEmbeddedConfig {
     | Shared.AzureVoiceSettings
     | Shared.ResembleVoiceSettings
     | Shared.InworldVoiceSettings
-    | Shared.XaiVoiceSettings;
+    | Shared.XaiVoiceSettings
+    | ActionsAPI.SonioxVoiceSettings;
 }
 
 /**
@@ -661,7 +687,8 @@ export interface ConversationRelayLanguage {
     | Shared.AzureVoiceSettings
     | Shared.ResembleVoiceSettings
     | Shared.InworldVoiceSettings
-    | Shared.XaiVoiceSettings;
+    | Shared.XaiVoiceSettings
+    | ActionsAPI.SonioxVoiceSettings;
 }
 
 export interface CustomSipHeader {
@@ -912,10 +939,20 @@ export interface CallDialParams {
    * `greeting_end` or `detect_words` is used and a `machine` is detected, you will
    * receive another `call.machine.greeting.ended` webhook when the answering machine
    * greeting ends with a beep or silence. If `detect_beep` is used, you will only
-   * receive `call.machine.greeting.ended` if a beep is detected.
+   * receive `call.machine.greeting.ended` if a beep is detected. If
+   * `answering_machine_detection` is set to `premium_ios_call_screening_detection`,
+   * Premium AMD runs with iOS Call Screening support: after an initial `machine`
+   * result, Telnyx listens for the iOS call-screening prompt to end or for an Apple
+   * Call Screening tone, sends `call.machine.premium.greeting.ended` with
+   * `result=prompt_ended` or `call.machine.premium.call_screening.detected` with
+   * `result=screening` respectively. When the Apple Call Screening tone is detected,
+   * Premium AMD is restarted on the screened call and a
+   * `call.machine.premium.detection.ended` webhook with the post-screening
+   * classification follows.
    */
   answering_machine_detection?:
     | 'premium'
+    | 'premium_ios_call_screening_detection'
     | 'detect'
     | 'detect_beep'
     | 'detect_words'
@@ -926,14 +963,17 @@ export interface CallDialParams {
    * Optional configuration parameters to modify 'answering_machine_detection'
    * performance. Only `total_analysis_time_millis` and `greeting_duration_millis`
    * parameters are applicable when `premium` is selected as
-   * answering_machine_detection.
+   * answering_machine_detection. `prompt_end_timeout_millis` is additionally
+   * applicable when `premium_ios_call_screening_detection` is selected.
    */
   answering_machine_detection_config?: CallDialParams.AnsweringMachineDetectionConfig;
 
   /**
-   * AI Assistant configuration. All fields except `id` are optional — the
-   * assistant's stored configuration will be used as fallback for any omitted
-   * fields.
+   * AI Assistant configuration and per-call overrides. All fields except `id` are
+   * optional. Omitted assistant fields use the stored configuration. Supplied
+   * `voice_settings` and `transcription` objects replace their stored objects rather
+   * than merging individual settings; include every setting you want to retain.
+   * `dynamic_variables` are merged, with request values taking precedence.
    */
   assistant?: CallAssistantRequest;
 
@@ -1320,7 +1360,8 @@ export namespace CallDialParams {
    * Optional configuration parameters to modify 'answering_machine_detection'
    * performance. Only `total_analysis_time_millis` and `greeting_duration_millis`
    * parameters are applicable when `premium` is selected as
-   * answering_machine_detection.
+   * answering_machine_detection. `prompt_end_timeout_millis` is additionally
+   * applicable when `premium_ios_call_screening_detection` is selected.
    */
   export interface AnsweringMachineDetectionConfig {
     /**
@@ -1420,6 +1461,14 @@ export namespace CallDialParams {
      */
     maximum_word_length_millis?: number;
 
+    /**
+     * Maximum time Telnyx waits, in milliseconds, for the iOS call-screening prompt to
+     * end after Premium AMD initially detects a `machine`. Used when
+     * `answering_machine_detection` is `premium_ios_call_screening_detection`.
+     * Defaults to 5000 milliseconds.
+     */
+    prompt_end_timeout_millis?: number;
+
     /**
      * Minimum noise threshold for any analysis.
      */
@@ -1602,6 +1651,7 @@ export declare namespace Calls {
     type InterruptionSettings as InterruptionSettings,
     type Loopcount as Loopcount,
     type PayPromptValue as PayPromptValue,
+    type SonioxVoiceSettings as SonioxVoiceSettings,
     type StopRecordingRequest as StopRecordingRequest,
     type SystemMessage as SystemMessage,
     type TelnyxTranscriptionLanguage as TelnyxTranscriptionLanguage,

package/src/resources/calls/index.ts

@@ -16,6 +16,7 @@ export {
   type InterruptionSettings,
   type Loopcount,
   type PayPromptValue,
+  type SonioxVoiceSettings,
   type StopRecordingRequest,
   type SystemMessage,
   type TelnyxTranscriptionLanguage,

package/src/resources/conferences/actions.ts

@@ -797,6 +797,12 @@ export interface ActionSpeakParams {
    * - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
    *   `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
    *   `s1`. `VoiceId` is a Fish Voice-Library reference ID.
+   * - **Soniox:** Use `Soniox.<ModelId>.<VoiceId>` (e.g., `Soniox.tts-rt-v2.Emma`).
+   *   Supported model: `tts-rt-v2`. Browse the catalog via the
+   *   [Voices API](https://developers.telnyx.com/api-reference/text-to-speech-commands/list-available-voices).
+   *   Every voice speaks all supported languages; set `language` to the two-letter
+   *   ISO 639-1 code of the text, for example `it`. SSML is not supported. Use
+   *   `voice_settings` to configure `speed` (0.7 to 1.3) and `reduce_silence`.
    * - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
    *   `ara`, `rex`, `sal`, `leo`.
    * - **Humain:** Use `Humain.<VoiceId>` (e.g., `Humain.sara-ar`). Available voices:
@@ -880,7 +886,8 @@ export interface ActionSpeakParams {
     | Shared.AzureVoiceSettings
     | Shared.ResembleVoiceSettings
     | Shared.InworldVoiceSettings
-    | Shared.XaiVoiceSettings;
+    | Shared.XaiVoiceSettings
+    | ActionsAPI.SonioxVoiceSettings;
 }
 
 export interface ActionStopParams {