telnyx 6.41.1 → 6.43.0

package/src/resources/calls/calls.ts

@@ -119,6 +119,7 @@ export class Calls extends APIResource {
    *
    * - `call.initiated`
    * - `call.answered` or `call.hangup`
+   * - `call.hold` and `call.unhold` if the call is held/unheld
    * - `call.machine.detection.ended` if `answering_machine_detection` was requested
    * - `call.machine.greeting.ended` if `answering_machine_detection` was requested
    *   to detect the end of machine greeting
@@ -126,6 +127,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.deepfake_detection.result` if `deepfake_detection` was enabled
+   * - `call.deepfake_detection.error` if `deepfake_detection` was enabled and an
+   *   error occurred
    * - `streaming.started`, `streaming.stopped` or `streaming.failed` if `stream_url`
    *   was set
    *
@@ -184,12 +188,12 @@ export interface CallAssistantRequest {
   /**
    * External LLM configuration for bringing your own LLM endpoint.
    */
-  external_llm?: { [key: string]: unknown };
+  external_llm?: CallAssistantRequest.ExternalLlm;
 
   /**
    * Fallback LLM configuration used when the primary LLM provider is unavailable.
    */
-  fallback_config?: { [key: string]: unknown };
+  fallback_config?: CallAssistantRequest.FallbackConfig;
 
   /**
    * Initial greeting text spoken when the assistant starts. Can be plain text for
@@ -256,6 +260,125 @@ export interface CallAssistantRequest {
   >;
 }
 
+export namespace CallAssistantRequest {
+  /**
+   * External LLM configuration for bringing your own LLM endpoint.
+   */
+  export interface ExternalLlm {
+    /**
+     * Authentication method used when connecting to the external LLM endpoint.
+     */
+    authentication_method?: 'token' | 'certificate';
+
+    /**
+     * Base URL for the external LLM endpoint.
+     */
+    base_url?: string;
+
+    /**
+     * Integration secret identifier for the client certificate used with certificate
+     * authentication.
+     */
+    certificate_ref?: string;
+
+    /**
+     * When enabled, Telnyx forwards the assistant's dynamic variables to the external
+     * LLM endpoint. Defaults to false. The chat completion request includes a
+     * top-level `extra_metadata` object when dynamic variables are available. For
+     * example:
+     * `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+     */
+    forward_metadata?: boolean;
+
+    /**
+     * Integration secret identifier for the external LLM API key.
+     */
+    llm_api_key_ref?: string;
+
+    /**
+     * Model identifier to use with the external LLM endpoint.
+     */
+    model?: string;
+
+    /**
+     * URL used to retrieve an access token when certificate authentication is enabled.
+     */
+    token_retrieval_url?: string;
+
+    [k: string]: unknown;
+  }
+
+  /**
+   * Fallback LLM configuration used when the primary LLM provider is unavailable.
+   */
+  export interface FallbackConfig {
+    /**
+     * External LLM fallback configuration.
+     */
+    external_llm?: FallbackConfig.ExternalLlm;
+
+    /**
+     * Integration secret identifier for the fallback model API key.
+     */
+    llm_api_key_ref?: string;
+
+    /**
+     * Fallback Telnyx-hosted model to use when the primary LLM provider is
+     * unavailable.
+     */
+    model?: string;
+
+    [k: string]: unknown;
+  }
+
+  export namespace FallbackConfig {
+    /**
+     * External LLM fallback configuration.
+     */
+    export interface ExternalLlm {
+      /**
+       * Authentication method used when connecting to the external LLM endpoint.
+       */
+      authentication_method?: 'token' | 'certificate';
+
+      /**
+       * Base URL for the external LLM endpoint.
+       */
+      base_url?: string;
+
+      /**
+       * Integration secret identifier for the client certificate used with certificate
+       * authentication.
+       */
+      certificate_ref?: string;
+
+      /**
+       * When enabled, Telnyx forwards the assistant's dynamic variables to the external
+       * LLM endpoint. Defaults to false. The chat completion request includes a
+       * top-level `extra_metadata` object when dynamic variables are available. For
+       * example:
+       * `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+       */
+      forward_metadata?: boolean;
+
+      /**
+       * Integration secret identifier for the external LLM API key.
+       */
+      llm_api_key_ref?: string;
+
+      /**
+       * Model identifier to use with the external LLM endpoint.
+       */
+      model?: string;
+
+      /**
+       * URL used to retrieve an access token when certificate authentication is enabled.
+       */
+      token_retrieval_url?: string;
+    }
+  }
+}
+
 export interface CustomSipHeader {
   /**
    * The name of the header to add.
@@ -507,7 +630,9 @@ export interface CallDialParams {
 
   /**
    * Optional configuration parameters to modify 'answering_machine_detection'
-   * performance.
+   * performance. Only `total_analysis_time_millis` and `greeting_duration_millis`
+   * parameters are applicable when `premium` is selected as
+   * answering_machine_detection.
    */
   answering_machine_detection_config?: CallDialParams.AnsweringMachineDetectionConfig;
 
@@ -566,6 +691,14 @@ export interface CallDialParams {
    */
   custom_headers?: Array<CustomSipHeader>;
 
+  /**
+   * 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
+   * AI-generated. Results are delivered via the `call.deepfake_detection.result`
+   * webhook.
+   */
+  deepfake_detection?: CallDialParams.DeepfakeDetection;
+
   dialogflow_config?: DialogflowConfig;
 
   /**
@@ -802,6 +935,13 @@ export interface CallDialParams {
 
   transcription_config?: ActionsAPI.TranscriptionStartRequest;
 
+  /**
+   * A map of event types to retry policies. Each retry policy contains an array of
+   * `retries_ms` specifying the delays between retry attempts in milliseconds.
+   * Maximum 5 retries, total delay cannot exceed 60 seconds.
+   */
+  webhook_retries_policies?: { [key: string]: CallDialParams.WebhookRetriesPolicies };
+
   /**
    * Use this field to override the URL for which Telnyx will send subsequent
    * webhooks to for this call.
@@ -812,12 +952,27 @@ export interface CallDialParams {
    * HTTP request type used for `webhook_url`.
    */
   webhook_url_method?: 'POST' | 'GET';
+
+  /**
+   * A map of event types to webhook URLs. When an event of the specified type
+   * occurs, the webhook URL associated with that event type will be called instead
+   * of the default webhook URL. Events not mapped here will use the default webhook
+   * URL.
+   */
+  webhook_urls?: { [key: string]: string };
+
+  /**
+   * HTTP request method to invoke `webhook_urls`.
+   */
+  webhook_urls_method?: 'POST' | 'GET';
 }
 
 export namespace CallDialParams {
   /**
    * Optional configuration parameters to modify 'answering_machine_detection'
-   * performance.
+   * performance. Only `total_analysis_time_millis` and `greeting_duration_millis`
+   * parameters are applicable when `premium` is selected as
+   * answering_machine_detection.
    */
   export interface AnsweringMachineDetectionConfig {
     /**
@@ -974,6 +1129,38 @@ export namespace CallDialParams {
      */
     whisper_call_control_ids?: Array<string>;
   }
+
+  /**
+   * 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
+   * AI-generated. Results are delivered via the `call.deepfake_detection.result`
+   * webhook.
+   */
+  export interface DeepfakeDetection {
+    /**
+     * Whether deepfake detection is enabled.
+     */
+    enabled: boolean;
+
+    /**
+     * Maximum time in seconds to wait for RTP audio before timing out. If no audio is
+     * received within this window, detection stops with an error.
+     */
+    rtp_timeout?: number;
+
+    /**
+     * Maximum time in seconds to wait for a detection result before timing out.
+     */
+    timeout?: number;
+  }
+
+  export interface WebhookRetriesPolicies {
+    /**
+     * Array of delays in milliseconds between retry attempts. Total sum cannot exceed
+     * 60000ms.
+     */
+    retries_ms?: Array<number>;
+  }
 }
 
 Calls.Actions = Actions;

package/src/resources/index.ts

@@ -1095,17 +1095,6 @@ export {
   type ShortCodeUpdateParams,
   type ShortCodeListParams,
 } from './short-codes';
-export {
-  SpeechToText,
-  SpeechToTextWS,
-  WebSocketError as SpeechToTextWebSocketError,
-  type SpeechToTextTranscribeParams,
-  type SpeechToTextStreamParams,
-  type SttClientEvent,
-  type SttServerEvent,
-  type TranscriptFrame,
-  type SttErrorFrame,
-} from './speech-to-text';
 export {
   SimCardDataUsageNotifications,
   type SimCardDataUsageNotification,
@@ -1230,13 +1219,13 @@ export {
 } from './texml-applications';
 export {
   TextToSpeech,
-  TextToSpeechWS,
   type TextToSpeechGenerateResponse,
   type TextToSpeechListVoicesResponse,
   type StreamClientEvent,
   type StreamServerEvent,
   type TextToSpeechGenerateParams,
   type TextToSpeechListVoicesParams,
+  type TextToSpeechStreamParams,
 } from './text-to-speech';
 export {
   TrafficPolicyProfiles,
@@ -1428,12 +1417,15 @@ export {
   type CallConversationEndedWebhookEvent,
   type CallConversationInsightsGeneratedWebhookEvent,
   type CallCostWebhookEvent,
+  type CallDeepfakeDetectionErrorWebhookEvent,
+  type CallDeepfakeDetectionResultWebhookEvent,
   type CallDtmfReceivedWebhookEvent,
   type CallEnqueuedWebhookEvent,
   type CallForkStartedWebhookEvent,
   type CallForkStoppedWebhookEvent,
   type CallGatherEndedWebhookEvent,
   type CallHangupWebhookEvent,
+  type CallHoldWebhookEvent,
   type CallInitiatedWebhookEvent,
   type CallLeftQueueWebhookEvent,
   type CallMachineDetectionEndedWebhookEvent,
@@ -1456,6 +1448,7 @@ export {
   type CallStreamingFailedWebhookEvent,
   type CallStreamingStartedWebhookEvent,
   type CallStreamingStoppedWebhookEvent,
+  type CallUnholdWebhookEvent,
   type ConferenceCreatedWebhookEvent,
   type ConferenceEndedWebhookEvent,
   type ConferenceParticipantJoinedWebhookEvent,
@@ -1470,6 +1463,7 @@ export {
   type ConferenceSpeakEndedWebhookEvent,
   type ConferenceSpeakStartedWebhookEvent,
   type DeliveryUpdateWebhookEvent,
+  type HostedNumberOrderEventWebhookEvent,
   type InboundMessageWebhookEvent,
   type ReplacedLinkClickWebhookEvent,
   type TranscriptionWebhookEvent,

package/src/resources/messages/messages.ts

@@ -2070,6 +2070,11 @@ export interface MessageSendWhatsappParams {
 
   whatsapp_message: WhatsappMessageContent;
 
+  /**
+   * Messaging profile ID - required if the 'from' number is not SMS-enabled
+   */
+  messaging_profile_id?: string;
+
   /**
    * Message type - must be set to "WHATSAPP"
    */

package/src/resources/session-analysis/session-analysis.ts

@@ -135,11 +135,6 @@ export namespace EventNode {
 export interface SessionAnalysisRetrieveResponse {
   cost: SessionAnalysisRetrieveResponse.Cost;
 
-  /**
-   * When the session started.
-   */
-  created_at: string;
-
   meta: SessionAnalysisRetrieveResponse.Meta;
 
   root: EventNode;
@@ -148,16 +143,6 @@ export interface SessionAnalysisRetrieveResponse {
    * Identifier for the analyzed session.
    */
   session_id: string;
-
-  /**
-   * Analysis status (e.g. "completed").
-   */
-  status: string;
-
-  /**
-   * When the session completed.
-   */
-  completed_at?: string | null;
 }
 
 export namespace SessionAnalysisRetrieveResponse {
@@ -193,7 +178,9 @@ export interface SessionAnalysisRetrieveParams {
   record_type: string;
 
   /**
-   * Query param: ISO 8601 timestamp to narrow index selection for faster lookups.
+   * Query param: ISO 8601 timestamp or date to narrow index selection for faster
+   * lookups. Accepts full datetime (e.g., 2026-03-17T10:00:00Z) or date-only format
+   * (e.g., 2026-03-17).
    */
   date_time?: string;
 

package/src/resources/texml/accounts/calls/calls.ts

@@ -735,6 +735,24 @@ export namespace CallCallsParams {
      */
     CustomHeaders?: Array<WithURL.CustomHeader>;
 
+    /**
+     * Enables Deepfake Detection on the dialed call. When enabled, audio from the
+     * remote party is analyzed to determine whether the voice is AI-generated. Results
+     * are delivered asynchronously via a callback.
+     */
+    DeepfakeDetection?: 'Enable';
+
+    /**
+     * HTTP request type used for `DeepfakeDetectionCallbackUrl`.
+     */
+    DeepfakeDetectionCallbackMethod?: 'GET' | 'POST';
+
+    /**
+     * URL destination for Telnyx to send deepfake detection callback events to for the
+     * call.
+     */
+    DeepfakeDetectionCallbackUrl?: string;
+
     /**
      * Allows you to chose between Premium and Standard detections.
      */
@@ -985,6 +1003,24 @@ export namespace CallCallsParams {
      */
     CustomHeaders?: Array<WithTeXml.CustomHeader>;
 
+    /**
+     * Enables Deepfake Detection on the dialed call. When enabled, audio from the
+     * remote party is analyzed to determine whether the voice is AI-generated. Results
+     * are delivered asynchronously via a callback.
+     */
+    DeepfakeDetection?: 'Enable';
+
+    /**
+     * HTTP request type used for `DeepfakeDetectionCallbackUrl`.
+     */
+    DeepfakeDetectionCallbackMethod?: 'GET' | 'POST';
+
+    /**
+     * URL destination for Telnyx to send deepfake detection callback events to for the
+     * call.
+     */
+    DeepfakeDetectionCallbackUrl?: string;
+
     /**
      * Allows you to chose between Premium and Standard detections.
      */
@@ -1229,6 +1265,24 @@ export namespace CallCallsParams {
      */
     CustomHeaders?: Array<ApplicationDefault.CustomHeader>;
 
+    /**
+     * Enables Deepfake Detection on the dialed call. When enabled, audio from the
+     * remote party is analyzed to determine whether the voice is AI-generated. Results
+     * are delivered asynchronously via a callback.
+     */
+    DeepfakeDetection?: 'Enable';
+
+    /**
+     * HTTP request type used for `DeepfakeDetectionCallbackUrl`.
+     */
+    DeepfakeDetectionCallbackMethod?: 'GET' | 'POST';
+
+    /**
+     * URL destination for Telnyx to send deepfake detection callback events to for the
+     * call.
+     */
+    DeepfakeDetectionCallbackUrl?: string;
+
     /**
      * Allows you to chose between Premium and Standard detections.
      */

package/src/resources/text-to-speech/index.ts

@@ -10,4 +10,5 @@ export {
   type TextToSpeechListVoicesParams,
   type TextToSpeechStreamParams,
 } from './text-to-speech';
-export { TextToSpeechWS } from './ws';
+export { TextToSpeechWS, type TextToSpeechWSClientOptions } from './ws';
+export { type TextToSpeechWSReconnectOptions } from './ws-base';

package/src/resources/text-to-speech/internal-base.ts

@@ -1,97 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as TextToSpeechAPI from './text-to-speech';
-import { Telnyx } from '../../client';
-import { EventEmitter } from '../../core/EventEmitter';
-import { TelnyxError } from '../../core/error';
-import { stringifyQuery } from '../../internal/utils';
-
-export type TextToSpeechStreamMessage =
-  | { type: 'connecting' | 'open' | 'closing' | 'close' }
-  | { type: 'message'; message: TextToSpeechAPI.StreamServerEvent }
-  | { type: 'error'; error: WebSocketError };
-
-export class WebSocketError extends TelnyxError {
-  /**
-   * The error data that the API sent back in an error event.
-   */
-  error?: TextToSpeechAPI.StreamServerEvent.ErrorFrame | undefined;
-
-  constructor(message: string, event: TextToSpeechAPI.StreamServerEvent.ErrorFrame | null) {
-    super(message);
-
-    this.error = event ?? undefined;
-  }
-}
-
-type Simplify<T> = { [KeyType in keyof T]: T[KeyType] } & {};
-
-type WebSocketEvents = Simplify<
-  {
-    event: (event: TextToSpeechAPI.StreamServerEvent) => void;
-    error: (error: WebSocketError) => void;
-  } & {
-    [EventType in Exclude<NonNullable<TextToSpeechAPI.StreamServerEvent['type']>, 'error'>]: (
-      event: Extract<TextToSpeechAPI.StreamServerEvent, { type?: EventType }>,
-    ) => unknown;
-  }
->;
-
-export abstract class TextToSpeechEmitter extends EventEmitter<WebSocketEvents> {
-  /**
-   * Send an event to the API.
-   */
-  abstract send(event: TextToSpeechAPI.StreamClientEvent): void;
-
-  /**
-   * Close the WebSocket connection.
-   */
-  abstract close(props?: { code: number; reason: string }): void;
-
-  protected _onError(event: null, message: string, cause: any): void;
-  protected _onError(event: TextToSpeechAPI.StreamServerEvent.ErrorFrame, message?: string | undefined): void;
-  protected _onError(
-    event: TextToSpeechAPI.StreamServerEvent.ErrorFrame | null,
-    message?: string | undefined,
-    cause?: any,
-  ): void {
-    message = message ?? safeJSONStringify(event) ?? 'unknown error';
-
-    if (!this._hasListener('error')) {
-      const error = new WebSocketError(
-        message +
-          `\n\nTo resolve these unhandled rejection errors you should bind an \`error\` callback, e.g. \`ws.on('error', (error) => ...)\` `,
-        event,
-      );
-      // @ts-ignore
-      error.cause = cause;
-      Promise.reject(error);
-      return;
-    }
-
-    const error = new WebSocketError(message, event);
-    // @ts-ignore
-    error.cause = cause;
-
-    this._emit('error', error);
-  }
-}
-
-export function buildURL(client: Telnyx, query?: object | null): URL {
-  const path = '/text-to-speech/speech';
-  const baseURL = client.baseURL;
-  const url = new URL(baseURL + (baseURL.endsWith('/') ? path.slice(1) : path));
-  if (query) {
-    url.search = stringifyQuery(query);
-  }
-  url.protocol = url.protocol === 'http:' ? 'ws:' : 'wss:';
-  return url;
-}
-
-function safeJSONStringify(value: unknown): string | null {
-  try {
-    return JSON.stringify(value);
-  } catch {
-    return null;
-  }
-}
+export {
+  TextToSpeechEmitter,
+  WebSocketError,
+  buildURL,
+  type TextToSpeechStreamMessage,
+} from '../../lib/text-to-speech-ws-internal';

package/src/resources/text-to-speech/text-to-speech.ts

@@ -23,7 +23,7 @@ export class TextToSpeech extends APIResource {
    * with provider-specific parameters.
    *
    * Supported providers: `aws`, `telnyx`, `azure`, `elevenlabs`, `minimax`, `rime`,
-   * `resemble`, `inworld`.
+   * `resemble`, `xai`.
    *
    * The Telnyx `Ultra` model supports 44 languages with emotion control, speed
    * adjustment, and volume control. Use the `telnyx` provider-specific parameters to
@@ -281,7 +281,7 @@ export interface TextToSpeechGenerateParams {
   /**
    * TTS provider. Required unless `voice` is provided.
    */
-  provider?: 'aws' | 'telnyx' | 'azure' | 'elevenlabs' | 'minimax' | 'rime' | 'resemble' | 'inworld';
+  provider?: 'aws' | 'telnyx' | 'azure' | 'elevenlabs' | 'minimax' | 'rime' | 'resemble' | 'inworld' | 'xai';
 
   /**
    * Resemble AI provider-specific parameters.
@@ -325,6 +325,11 @@ export interface TextToSpeechGenerateParams {
    * provider-specific parameter objects below.
    */
   voice_settings?: { [key: string]: unknown };
+
+  /**
+   * xAI provider-specific parameters.
+   */
+  xai?: TextToSpeechGenerateParams.Xai;
 }
 
 export namespace TextToSpeechGenerateParams {
@@ -535,6 +540,31 @@ export namespace TextToSpeechGenerateParams {
      */
     volume?: number;
   }
+
+  /**
+   * xAI provider-specific parameters.
+   */
+  export interface Xai {
+    /**
+     * xAI voice identifier.
+     */
+    voice_id: 'eve' | 'ara' | 'rex' | 'sal' | 'leo';
+
+    /**
+     * Language code, or `auto` to detect.
+     */
+    language?: string;
+
+    /**
+     * Audio output format.
+     */
+    output_format?: 'mp3' | 'wav' | 'pcm' | 'mulaw' | 'alaw';
+
+    /**
+     * Audio sample rate in Hz.
+     */
+    sample_rate?: 8000 | 16000 | 22050 | 24000 | 44100 | 48000;
+  }
 }
 
 export interface TextToSpeechListVoicesParams {
@@ -546,7 +576,7 @@ export interface TextToSpeechListVoicesParams {
   /**
    * Filter voices by provider. If omitted, voices from all providers are returned.
    */
-  provider?: 'aws' | 'telnyx' | 'azure' | 'elevenlabs' | 'minimax' | 'rime' | 'resemble' | 'inworld';
+  provider?: 'aws' | 'telnyx' | 'azure' | 'elevenlabs' | 'minimax' | 'rime' | 'resemble' | 'inworld' | 'xai';
 }
 
 export declare namespace TextToSpeech {

package/src/resources/text-to-speech/ws-base.ts

@@ -0,0 +1,7 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  TextToSpeechWSBase,
+  type TextToSpeechWSBaseOptions,
+  type TextToSpeechWSReconnectOptions,
+} from '../../lib/text-to-speech-ws-base';