telnyx 6.83.0 → 7.1.0

package/src/resources/calls/calls.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as CallsAPI from './calls';
 import * as Shared from '../shared';
 import * as ActionsAPI from './actions';
 import {
+  AIAssistantJoinParticipant,
   ActionAddAIAssistantMessagesParams,
   ActionAddAIAssistantMessagesResponse,
   ActionAnswerParams,
@@ -86,18 +86,23 @@ import {
   ActionUpdateClientStateParams,
   ActionUpdateClientStateResponse,
   Actions,
+  AssistantMessage,
   AwsVoiceSettings,
   CallControlCommandResult,
   CallControlCommandResultWithConversationID,
+  ConversationRelayInterruptible,
   DeepgramNova2Config,
   DeepgramNova3Config,
+  DeveloperMessage,
   ElevenLabsVoiceSettings,
   GoogleTranscriptionLanguage,
   InterruptionSettings,
   Loopcount,
   StopRecordingRequest,
+  SystemMessage,
   TelnyxTranscriptionLanguage,
   TelnyxVoiceSettings,
+  ToolMessage,
   TranscriptionConfig,
   TranscriptionEngineAConfig,
   TranscriptionEngineAssemblyaiConfig,
@@ -105,11 +110,13 @@ import {
   TranscriptionEngineBConfig,
   TranscriptionEngineDeepgramConfig,
   TranscriptionEngineGoogleConfig,
+  TranscriptionEngineParakeetConfig,
   TranscriptionEngineSonioxConfig,
   TranscriptionEngineSpeechmaticsConfig,
   TranscriptionEngineTelnyxConfig,
   TranscriptionEngineXaiConfig,
   TranscriptionStartRequest,
+  UserMessage,
 } from './actions';
 import * as AssistantsAPI from '../ai/assistants/assistants';
 import { APIPromise } from '../../core/api-promise';
@@ -388,6 +395,156 @@ export namespace CallAssistantRequest {
   }
 }
 
+/**
+ * Starts a Conversation Relay session automatically when the answered/dialed call
+ * is answered. This embedded shape is supported on `answer` and `dial`. It uses
+ * public field names (`url`, `dtmf_detection`, `greeting`, `voice`, `language`,
+ * etc.) and maps them to the underlying Conversation Relay action. `client_state`,
+ * `tts_language`, and `transcription_language` inside this object are ignored; use
+ * the parent command's `client_state` and `command_id` fields instead.
+ */
+export interface ConversationRelayEmbeddedConfig {
+  /**
+   * WebSocket URL for your Conversation Relay server. Must start with `ws://` or
+   * `wss://`.
+   */
+  url: string;
+
+  /**
+   * Custom key-value parameters forwarded to the relay session as assistant dynamic
+   * variables.
+   */
+  custom_parameters?: { [key: string]: unknown };
+
+  /**
+   * Enable DTMF detection for the relay session.
+   */
+  dtmf_detection?: boolean;
+
+  /**
+   * Text played when the relay session starts.
+   */
+  greeting?: string;
+
+  /**
+   * Controls when caller input can interrupt assistant speech. `any` allows speech
+   * or DTMF interruptions; `none` disables interruptions; `speech` allows speech
+   * only; `dtmf` allows DTMF only.
+   */
+  interruptible?: ActionsAPI.ConversationRelayInterruptible;
+
+  /**
+   * Controls when caller input can interrupt assistant speech. `any` allows speech
+   * or DTMF interruptions; `none` disables interruptions; `speech` allows speech
+   * only; `dtmf` allows DTMF only.
+   */
+  interruptible_greeting?: ActionsAPI.ConversationRelayInterruptible;
+
+  /**
+   * Settings for handling caller interruptions during Conversation Relay speech.
+   */
+  interruption_settings?: ConversationRelayInterruptionSettings;
+
+  /**
+   * Default language for both text-to-speech and speech recognition.
+   */
+  language?: string;
+
+  /**
+   * Per-language TTS and transcription settings.
+   */
+  languages?: Array<ConversationRelayLanguage>;
+
+  /**
+   * Structured voice provider. Must be supplied together with `structured_provider`.
+   */
+  provider?: string;
+
+  /**
+   * Provider-specific structured voice settings. Must be supplied together with
+   * `provider`; Telnyx sends the value as the nested provider configuration for
+   * Conversation Relay.
+   */
+  structured_provider?: { [key: string]: unknown };
+
+  /**
+   * Engine to use for speech recognition. Legacy values `A` - `Google`, `B` -
+   * `Telnyx` are supported for backward compatibility. For Conversation Relay, use
+   * this field with `transcription_engine_config`; the `transcription` object is not
+   * supported.
+   */
+  transcription_engine?:
+    | 'Google'
+    | 'Telnyx'
+    | 'Deepgram'
+    | 'Azure'
+    | 'xAI'
+    | 'AssemblyAI'
+    | 'Speechmatics'
+    | 'Soniox'
+    | 'A'
+    | 'B';
+
+  /**
+   * Engine-specific transcription settings for Conversation Relay. This accepts the
+   * same provider-specific options used by the Call Transcription Start command,
+   * such as `transcription_model`, without requiring the engine discriminator to be
+   * repeated inside this object.
+   */
+  transcription_engine_config?: { [key: string]: unknown };
+
+  /**
+   * Text-to-speech provider. If omitted, Telnyx derives it from `voice` or
+   * `provider`.
+   */
+  tts_provider?: string;
+
+  /**
+   * The voice to be used by the voice assistant. Currently we support ElevenLabs,
+   * Telnyx and AWS voices.
+   *
+   * **Supported Providers:**
+   *
+   * - **AWS:** Use `AWS.Polly.<VoiceId>` (e.g., `AWS.Polly.Joanna`). For neural
+   *   voices, which provide more realistic, human-like speech, append `-Neural` to
+   *   the `VoiceId` (e.g., `AWS.Polly.Joanna-Neural`). Check the
+   *   [available voices](https://docs.aws.amazon.com/polly/latest/dg/available-voices.html)
+   *   for compatibility.
+   * - **Azure:** Use `Azure.<VoiceId>. (e.g. Azure.en-CA-ClaraNeural,
+   *   Azure.en-CA-LiamNeural, Azure.en-US-BrianMultilingualNeural,
+   *   Azure.en-US-Ava:DragonHDLatestNeural. For a complete list of voices, go to
+   *   [Azure Voice Gallery](https://speech.microsoft.com/portal/voicegallery).)
+   * - **ElevenLabs:** Use `ElevenLabs.<ModelId>.<VoiceId>` (e.g.,
+   *   `ElevenLabs.BaseModel.John`). The `ModelId` part is optional. To use
+   *   ElevenLabs, you must provide your ElevenLabs API key as an integration secret
+   *   under `"voice_settings": {"api_key_ref": "<secret_id>"}`. See
+   *   [integration secrets documentation](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
+   *   for details. Check
+   *   [available voices](https://elevenlabs.io/docs/api-reference/get-voices).
+   * - **Telnyx:** Use `Telnyx.<model_id>.<voice_id>`
+   * - **Inworld:** Use `Inworld.<ModelId>.<VoiceId>` (e.g., `Inworld.Mini.Loretta`,
+   *   `Inworld.Max.Oliver`, `Inworld.TTS2.Loretta`). Supported models: `Mini`,
+   *   `Max`, `TTS2`.
+   * - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
+   *   `ara`, `rex`, `sal`, `leo`.
+   */
+  voice?: string;
+
+  /**
+   * The settings associated with the voice selected
+   */
+  voice_settings?:
+    | ActionsAPI.ElevenLabsVoiceSettings
+    | ActionsAPI.TelnyxVoiceSettings
+    | ActionsAPI.AwsVoiceSettings
+    | Shared.MinimaxVoiceSettings
+    | Shared.AzureVoiceSettings
+    | Shared.RimeVoiceSettings
+    | Shared.ResembleVoiceSettings
+    | Shared.InworldVoiceSettings
+    | Shared.XaiVoiceSettings;
+}
+
 /**
  * Settings for handling caller interruptions during Conversation Relay speech.
  */
@@ -403,21 +560,21 @@ export interface ConversationRelayInterruptionSettings {
    * or DTMF interruptions; `none` disables interruptions; `speech` allows speech
    * only; `dtmf` allows DTMF only.
    */
-  interruptible?: 'none' | 'any' | 'speech' | 'dtmf';
+  interruptible?: ActionsAPI.ConversationRelayInterruptible;
 
   /**
    * Controls when caller input can interrupt assistant speech. `any` allows speech
    * or DTMF interruptions; `none` disables interruptions; `speech` allows speech
    * only; `dtmf` allows DTMF only.
    */
-  interruptible_greeting?: 'none' | 'any' | 'speech' | 'dtmf';
+  interruptible_greeting?: ActionsAPI.ConversationRelayInterruptible;
 
   /**
    * Controls when caller input can interrupt assistant speech. `any` allows speech
    * or DTMF interruptions; `none` disables interruptions; `speech` allows speech
    * only; `dtmf` allows DTMF only.
    */
-  welcome_greeting_interruptible?: 'none' | 'any' | 'speech' | 'dtmf';
+  welcome_greeting_interruptible?: ActionsAPI.ConversationRelayInterruptible;
 }
 
 /**
@@ -818,7 +975,7 @@ export interface CallDialParams {
    * `tts_language`, and `transcription_language` inside this object are ignored; use
    * the parent command's `client_state` and `command_id` fields instead.
    */
-  conversation_relay_config?: CallDialParams.ConversationRelayConfig;
+  conversation_relay_config?: ConversationRelayEmbeddedConfig;
 
   /**
    * Custom headers to be added to the SIP INVITE.
@@ -1279,155 +1436,6 @@ export namespace CallDialParams {
     whisper_call_control_ids?: Array<string>;
   }
 
-  /**
-   * Starts a Conversation Relay session automatically when the answered/dialed call
-   * is answered. This embedded shape is supported on `answer` and `dial`. It uses
-   * public field names (`url`, `dtmf_detection`, `greeting`, `voice`, `language`,
-   * etc.) and maps them to the underlying Conversation Relay action. `client_state`,
-   * `tts_language`, and `transcription_language` inside this object are ignored; use
-   * the parent command's `client_state` and `command_id` fields instead.
-   */
-  export interface ConversationRelayConfig {
-    /**
-     * WebSocket URL for your Conversation Relay server. Must start with `ws://` or
-     * `wss://`.
-     */
-    url: string;
-
-    /**
-     * Custom key-value parameters forwarded to the relay session as assistant dynamic
-     * variables.
-     */
-    custom_parameters?: { [key: string]: unknown };
-
-    /**
-     * Enable DTMF detection for the relay session.
-     */
-    dtmf_detection?: boolean;
-
-    /**
-     * Text played when the relay session starts.
-     */
-    greeting?: string;
-
-    /**
-     * Controls when caller input can interrupt assistant speech. `any` allows speech
-     * or DTMF interruptions; `none` disables interruptions; `speech` allows speech
-     * only; `dtmf` allows DTMF only.
-     */
-    interruptible?: 'none' | 'any' | 'speech' | 'dtmf';
-
-    /**
-     * Controls when caller input can interrupt assistant speech. `any` allows speech
-     * or DTMF interruptions; `none` disables interruptions; `speech` allows speech
-     * only; `dtmf` allows DTMF only.
-     */
-    interruptible_greeting?: 'none' | 'any' | 'speech' | 'dtmf';
-
-    /**
-     * Settings for handling caller interruptions during Conversation Relay speech.
-     */
-    interruption_settings?: CallsAPI.ConversationRelayInterruptionSettings;
-
-    /**
-     * Default language for both text-to-speech and speech recognition.
-     */
-    language?: string;
-
-    /**
-     * Per-language TTS and transcription settings.
-     */
-    languages?: Array<CallsAPI.ConversationRelayLanguage>;
-
-    /**
-     * Structured voice provider. Must be supplied together with `structured_provider`.
-     */
-    provider?: string;
-
-    /**
-     * Provider-specific structured voice settings. Must be supplied together with
-     * `provider`; Telnyx sends the value as the nested provider configuration for
-     * Conversation Relay.
-     */
-    structured_provider?: { [key: string]: unknown };
-
-    /**
-     * Engine to use for speech recognition. Legacy values `A` - `Google`, `B` -
-     * `Telnyx` are supported for backward compatibility. For Conversation Relay, use
-     * this field with `transcription_engine_config`; the `transcription` object is not
-     * supported.
-     */
-    transcription_engine?:
-      | 'Google'
-      | 'Telnyx'
-      | 'Deepgram'
-      | 'Azure'
-      | 'xAI'
-      | 'AssemblyAI'
-      | 'Speechmatics'
-      | 'Soniox'
-      | 'A'
-      | 'B';
-
-    /**
-     * Engine-specific transcription settings for Conversation Relay. This accepts the
-     * same provider-specific options used by the Call Transcription Start command,
-     * such as `transcription_model`, without requiring the engine discriminator to be
-     * repeated inside this object.
-     */
-    transcription_engine_config?: { [key: string]: unknown };
-
-    /**
-     * Text-to-speech provider. If omitted, Telnyx derives it from `voice` or
-     * `provider`.
-     */
-    tts_provider?: string;
-
-    /**
-     * The voice to be used by the voice assistant. Currently we support ElevenLabs,
-     * Telnyx and AWS voices.
-     *
-     * **Supported Providers:**
-     *
-     * - **AWS:** Use `AWS.Polly.<VoiceId>` (e.g., `AWS.Polly.Joanna`). For neural
-     *   voices, which provide more realistic, human-like speech, append `-Neural` to
-     *   the `VoiceId` (e.g., `AWS.Polly.Joanna-Neural`). Check the
-     *   [available voices](https://docs.aws.amazon.com/polly/latest/dg/available-voices.html)
-     *   for compatibility.
-     * - **Azure:** Use `Azure.<VoiceId>. (e.g. Azure.en-CA-ClaraNeural,
-     *   Azure.en-CA-LiamNeural, Azure.en-US-BrianMultilingualNeural,
-     *   Azure.en-US-Ava:DragonHDLatestNeural. For a complete list of voices, go to
-     *   [Azure Voice Gallery](https://speech.microsoft.com/portal/voicegallery).)
-     * - **ElevenLabs:** Use `ElevenLabs.<ModelId>.<VoiceId>` (e.g.,
-     *   `ElevenLabs.BaseModel.John`). The `ModelId` part is optional. To use
-     *   ElevenLabs, you must provide your ElevenLabs API key as an integration secret
-     *   under `"voice_settings": {"api_key_ref": "<secret_id>"}`. See
-     *   [integration secrets documentation](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
-     *   for details. Check
-     *   [available voices](https://elevenlabs.io/docs/api-reference/get-voices).
-     * - **Telnyx:** Use `Telnyx.<model_id>.<voice_id>`
-     * - **Inworld:** Use `Inworld.<ModelId>.<VoiceId>` (e.g., `Inworld.Mini.Loretta`,
-     *   `Inworld.Max.Oliver`). Supported models: `Mini`, `Max`.
-     * - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
-     *   `ara`, `rex`, `sal`, `leo`.
-     */
-    voice?: string;
-
-    /**
-     * The settings associated with the voice selected
-     */
-    voice_settings?:
-      | ActionsAPI.ElevenLabsVoiceSettings
-      | ActionsAPI.TelnyxVoiceSettings
-      | ActionsAPI.AwsVoiceSettings
-      | Shared.MinimaxVoiceSettings
-      | Shared.AzureVoiceSettings
-      | Shared.RimeVoiceSettings
-      | Shared.ResembleVoiceSettings
-      | Shared.InworldVoiceSettings
-      | Shared.XaiVoiceSettings;
-  }
-
   /**
    * Enables deepfake detection on the call. When enabled, audio from the remote
    * party is streamed to a detection service that analyzes whether the voice is
@@ -1466,6 +1474,7 @@ Calls.Actions = Actions;
 export declare namespace Calls {
   export {
     type CallAssistantRequest as CallAssistantRequest,
+    type ConversationRelayEmbeddedConfig as ConversationRelayEmbeddedConfig,
     type ConversationRelayInterruptionSettings as ConversationRelayInterruptionSettings,
     type ConversationRelayLanguage as ConversationRelayLanguage,
     type CustomSipHeader as CustomSipHeader,
@@ -1484,18 +1493,24 @@ export declare namespace Calls {
 
   export {
     Actions as Actions,
+    type AIAssistantJoinParticipant as AIAssistantJoinParticipant,
+    type AssistantMessage as AssistantMessage,
     type AwsVoiceSettings as AwsVoiceSettings,
     type CallControlCommandResult as CallControlCommandResult,
     type CallControlCommandResultWithConversationID as CallControlCommandResultWithConversationID,
+    type ConversationRelayInterruptible as ConversationRelayInterruptible,
     type DeepgramNova2Config as DeepgramNova2Config,
     type DeepgramNova3Config as DeepgramNova3Config,
+    type DeveloperMessage as DeveloperMessage,
     type ElevenLabsVoiceSettings as ElevenLabsVoiceSettings,
     type GoogleTranscriptionLanguage as GoogleTranscriptionLanguage,
     type InterruptionSettings as InterruptionSettings,
     type Loopcount as Loopcount,
     type StopRecordingRequest as StopRecordingRequest,
+    type SystemMessage as SystemMessage,
     type TelnyxTranscriptionLanguage as TelnyxTranscriptionLanguage,
     type TelnyxVoiceSettings as TelnyxVoiceSettings,
+    type ToolMessage as ToolMessage,
     type TranscriptionConfig as TranscriptionConfig,
     type TranscriptionEngineAConfig as TranscriptionEngineAConfig,
     type TranscriptionEngineAssemblyaiConfig as TranscriptionEngineAssemblyaiConfig,
@@ -1503,11 +1518,13 @@ export declare namespace Calls {
     type TranscriptionEngineBConfig as TranscriptionEngineBConfig,
     type TranscriptionEngineDeepgramConfig as TranscriptionEngineDeepgramConfig,
     type TranscriptionEngineGoogleConfig as TranscriptionEngineGoogleConfig,
+    type TranscriptionEngineParakeetConfig as TranscriptionEngineParakeetConfig,
     type TranscriptionEngineSonioxConfig as TranscriptionEngineSonioxConfig,
     type TranscriptionEngineSpeechmaticsConfig as TranscriptionEngineSpeechmaticsConfig,
     type TranscriptionEngineTelnyxConfig as TranscriptionEngineTelnyxConfig,
     type TranscriptionEngineXaiConfig as TranscriptionEngineXaiConfig,
     type TranscriptionStartRequest as TranscriptionStartRequest,
+    type UserMessage as UserMessage,
     type ActionAddAIAssistantMessagesResponse as ActionAddAIAssistantMessagesResponse,
     type ActionAnswerResponse as ActionAnswerResponse,
     type ActionBridgeResponse as ActionBridgeResponse,

package/src/resources/calls/index.ts

@@ -2,18 +2,24 @@
 
 export {
   Actions,
+  type AIAssistantJoinParticipant,
+  type AssistantMessage,
   type AwsVoiceSettings,
   type CallControlCommandResult,
   type CallControlCommandResultWithConversationID,
+  type ConversationRelayInterruptible,
   type DeepgramNova2Config,
   type DeepgramNova3Config,
+  type DeveloperMessage,
   type ElevenLabsVoiceSettings,
   type GoogleTranscriptionLanguage,
   type InterruptionSettings,
   type Loopcount,
   type StopRecordingRequest,
+  type SystemMessage,
   type TelnyxTranscriptionLanguage,
   type TelnyxVoiceSettings,
+  type ToolMessage,
   type TranscriptionConfig,
   type TranscriptionEngineAConfig,
   type TranscriptionEngineAssemblyaiConfig,
@@ -21,11 +27,13 @@ export {
   type TranscriptionEngineBConfig,
   type TranscriptionEngineDeepgramConfig,
   type TranscriptionEngineGoogleConfig,
+  type TranscriptionEngineParakeetConfig,
   type TranscriptionEngineSonioxConfig,
   type TranscriptionEngineSpeechmaticsConfig,
   type TranscriptionEngineTelnyxConfig,
   type TranscriptionEngineXaiConfig,
   type TranscriptionStartRequest,
+  type UserMessage,
   type ActionAddAIAssistantMessagesResponse,
   type ActionAnswerResponse,
   type ActionBridgeResponse,
@@ -110,6 +118,7 @@ export {
 export {
   Calls,
   type CallAssistantRequest,
+  type ConversationRelayEmbeddedConfig,
   type ConversationRelayInterruptionSettings,
   type ConversationRelayLanguage,
   type CustomSipHeader,

package/src/resources/channel-zones.ts

@@ -20,7 +20,7 @@ export class ChannelZones extends APIResource {
     channelZoneID: string,
     body: ChannelZoneUpdateParams,
     options?: RequestOptions,
-  ): APIPromise<ChannelZoneUpdateResponse> {
+  ): APIPromise<GcbChannelZone> {
     return this._client.put(path`/channel_zones/${channelZoneID}`, { body, ...options });
   }
 
@@ -34,43 +34,17 @@ export class ChannelZones extends APIResource {
   list(
     query: ChannelZoneListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<ChannelZoneListResponsesDefaultFlatPagination, ChannelZoneListResponse> {
-    return this._client.getAPIList('/channel_zones', DefaultFlatPagination<ChannelZoneListResponse>, {
+  ): PagePromise<GcbChannelZonesDefaultFlatPagination, GcbChannelZone> {
+    return this._client.getAPIList('/channel_zones', DefaultFlatPagination<GcbChannelZone>, {
       query,
       ...options,
     });
   }
 }
 
-export type ChannelZoneListResponsesDefaultFlatPagination = DefaultFlatPagination<ChannelZoneListResponse>;
+export type GcbChannelZonesDefaultFlatPagination = DefaultFlatPagination<GcbChannelZone>;
 
-export interface ChannelZoneUpdateResponse {
-  id: string;
-
-  channels: number;
-
-  /**
-   * List of countries (in ISO 3166-2, capitalized) members of the billing channel
-   * zone
-   */
-  countries: Array<string>;
-
-  name: string;
-
-  record_type: 'channel_zone';
-
-  /**
-   * ISO 8601 formatted date of when the channel zone was created
-   */
-  created_at?: string;
-
-  /**
-   * ISO 8601 formatted date of when the channel zone was updated
-   */
-  updated_at?: string;
-}
-
-export interface ChannelZoneListResponse {
+export interface GcbChannelZone {
   id: string;
 
   channels: number;
@@ -107,9 +81,8 @@ export interface ChannelZoneListParams extends DefaultFlatPaginationParams {}
 
 export declare namespace ChannelZones {
   export {
-    type ChannelZoneUpdateResponse as ChannelZoneUpdateResponse,
-    type ChannelZoneListResponse as ChannelZoneListResponse,
-    type ChannelZoneListResponsesDefaultFlatPagination as ChannelZoneListResponsesDefaultFlatPagination,
+    type GcbChannelZone as GcbChannelZone,
+    type GcbChannelZonesDefaultFlatPagination as GcbChannelZonesDefaultFlatPagination,
     type ChannelZoneUpdateParams as ChannelZoneUpdateParams,
     type ChannelZoneListParams as ChannelZoneListParams,
   };