telnyx 7.25.0 → 7.27.0

package/src/resources/ai/tools.ts

@@ -108,13 +108,22 @@ export interface PayToolParams {
    */
   connector_name: string;
 
+  /**
+   * Custom key/value parameters forwarded to the pay connector as `parameters` in
+   * the processor request. String values may use `{{dynamic_variable}}` templating,
+   * resolved per call.
+   */
+  connector_parameters?: { [key: string]: unknown };
+
   /**
    * Default currency for payments processed by this tool.
    */
   currency?: string;
 
   /**
-   * Optional description of the pay tool that will be passed to the assistant.
+   * Description of the pay tool shown to the assistant so it knows when to call the
+   * tool. Not sent to the payment connector — the per-call `description` argument
+   * the assistant passes is what reaches the processor.
    */
   description?: string | null;
 
@@ -122,6 +131,15 @@ export interface PayToolParams {
    * Default payment method for payments processed by this tool.
    */
   payment_method?: string;
+
+  /**
+   * Restricts accepted card numbers to the listed card types. When the caller enters
+   * a card number that does not match one of the listed types, Pay treats the input
+   * as invalid and re-prompts for the card number.
+   */
+  valid_card_types?: Array<
+    'visa' | 'mastercard' | 'amex' | 'maestro' | 'discover' | 'optima' | 'jcb' | 'diners-club' | 'enroute'
+  >;
 }
 
 export interface SharedToolResponse {
@@ -184,6 +202,14 @@ export namespace UpdateDynamicVariablesToolParams {
   }
 }
 
+export interface VisionToolParams {
+  /**
+   * Frames received longer ago than this many seconds are not shown to the
+   * assistant, so it never describes a frozen or disconnected camera as live.
+   */
+  max_frame_age_secs?: number;
+}
+
 export interface ToolListParams extends DefaultFlatPaginationParams {
   /**
    * Filter results by filter name.
@@ -247,6 +273,11 @@ export interface ToolCreateParams {
    */
   update_dynamic_variables?: UpdateDynamicVariablesToolParams;
 
+  /**
+   * Body param
+   */
+  vision?: VisionToolParams;
+
   /**
    * Body param
    */
@@ -291,6 +322,8 @@ export interface ToolUpdateParams {
    */
   update_dynamic_variables?: UpdateDynamicVariablesToolParams;
 
+  vision?: VisionToolParams;
+
   webhook?: { [key: string]: unknown };
 
   [k: string]: unknown;
@@ -301,6 +334,7 @@ export declare namespace Tools {
     type PayToolParams as PayToolParams,
     type SharedToolResponse as SharedToolResponse,
     type UpdateDynamicVariablesToolParams as UpdateDynamicVariablesToolParams,
+    type VisionToolParams as VisionToolParams,
     type SharedToolResponsesDefaultFlatPagination as SharedToolResponsesDefaultFlatPagination,
     type ToolListParams as ToolListParams,
     type ToolCreateParams as ToolCreateParams,

package/src/resources/calls/actions.ts

@@ -1180,6 +1180,42 @@ export interface CallControlCommandResultWithConversationID {
  */
 export type ConversationRelayInterruptible = 'none' | 'any' | 'speech' | 'dtmf';
 
+/**
+ * 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. With Deepgram Flux (`deepgram/flux`),
+ * `interim_results`, `eot_threshold` and `eager_eot_threshold` control the interim
+ * prompts and the `eagerEndOfTurn` and `turnResumed` frames sent to your WebSocket
+ * server.
+ */
+export interface ConversationRelayTranscriptionEngineConfig {
+  /**
+   * Deepgram Flux: confidence at which an `eagerEndOfTurn` frame is sent before the
+   * final prompt, followed by `turnResumed` if the caller keeps talking. When
+   * omitted, these frames are not sent.
+   */
+  eager_eot_threshold?: number;
+
+  /**
+   * Deepgram Flux: confidence required to end the caller's turn.
+   */
+  eot_threshold?: number;
+
+  /**
+   * Deepgram Flux: send interim transcripts as `prompt` frames with `last: false`.
+   */
+  interim_results?: boolean;
+
+  [k: string]: unknown;
+}
+
+/**
+ * Language to transcribe. Deepgram's medical and phonecall models support English
+ * only.
+ */
+export type DeepgramEnglishTranscriptionLanguage = 'en' | 'en-US' | 'en-AU' | 'en-GB' | 'en-IN' | 'en-NZ';
+
 export interface DeepgramNova2Config {
   transcription_engine: 'deepgram/nova-2';
 
@@ -1187,8 +1223,9 @@ export interface DeepgramNova2Config {
 
   /**
    * Nova-2 keyword biasing without intensifiers. Up to 100 terms to bias recognition
-   * toward. For weighted biasing, use `keywords_boosting` instead. Nova-2-only; use
-   * `keyterms` on Nova-3.
+   * toward. For weighted biasing, use `keywords_boosting` instead. Supported on
+   * Nova-2 models only (`deepgram/nova-2`, `deepgram/nova-2-medical`,
+   * `deepgram/nova-2-phonecall`); use `keyterms` on Nova-3 and Flux.
    */
   hints?: Array<string>;
 
@@ -1282,8 +1319,10 @@ export interface DeepgramNova3Config {
   interim_results?: boolean;
 
   /**
-   * Nova-3 keyterm prompting. Up to 100 domain-specific terms or brand names to bias
-   * recognition toward. Nova-3-only; use `hints` on Nova-2.
+   * Keyterm prompting. Up to 100 domain-specific terms or brand names to bias
+   * recognition toward. Supported on Nova-3 and Flux models (`deepgram/nova-3`,
+   * `deepgram/nova-3-medical`, `deepgram/flux`, `deepgram/flux-multi`); use `hints`
+   * on Nova-2.
    */
   keyterms?: Array<string>;
 
@@ -1741,7 +1780,11 @@ export interface TranscriptionConfig {
    * detection, and the language codes `nl`, `en`, `fr`, `fy`, `de`, `it`, `pl`,
    * `pt`, `es`, and `sv` to fix the transcription language. For `cohere/ar-stt`,
    * supported values are `ar` and `en`; unlike other models, this model does not
-   * auto-detect and defaults to `ar` when `language` is omitted.
+   * auto-detect and defaults to `ar` when `language` is omitted. For
+   * `speechmatics/linden-1`, there is no auto-detect; set a code from Speechmatics'
+   * Realtime language list (see `SpeechmaticsTranscriptionLanguage`); unset defaults
+   * to `en`, while an explicit `auto`, `auto_beta`, or `multi` is rejected (unlike
+   * `speechmatics/standard`, which defaults to `en`).
    */
   language?: string;
 
@@ -1753,6 +1796,9 @@ export interface TranscriptionConfig {
    * - `deepgram/nova-3` and `deepgram/nova-2` for live streaming transcription.
    * - `speechmatics/standard` and `speechmatics/enhanced` for live streaming
    *   transcription.
+   * - `speechmatics/linden-1` (preview, vendor-hosted) for live streaming
+   *   transcription; no auto-detect, so set `language` from Speechmatics' Realtime
+   *   language list (defaults to `en`).
    * - `assemblyai/universal-3-5-pro` for live streaming transcription. The legacy
    *   alias `assemblyai/universal-streaming` is still accepted and resolves to the
    *   same model.
@@ -1783,6 +1829,7 @@ export interface TranscriptionConfig {
     | 'deepgram/nova-2'
     | 'speechmatics/standard'
     | 'speechmatics/enhanced'
+    | 'speechmatics/linden-1'
     | 'assemblyai/universal-3-5-pro'
     | 'assemblyai/universal-streaming'
     | 'xai/grok-stt'
@@ -2030,7 +2077,183 @@ export interface TranscriptionEngineCohereConfig {
   transcription_model?: 'cohere/ar-stt';
 }
 
-export type TranscriptionEngineDeepgramConfig = DeepgramNova2Config | DeepgramNova3Config;
+/**
+ * Deepgram Nova-2 specialty models: `deepgram/nova-2-medical` (medical vocabulary)
+ * and `deepgram/nova-2-phonecall` (low-bandwidth phone audio). English only.
+ */
+export type TranscriptionEngineDeepgramConfig =
+  | DeepgramNova2Config
+  | TranscriptionEngineDeepgramConfig.DeepgramNova2SpecialtyConfig
+  | DeepgramNova3Config
+  | TranscriptionEngineDeepgramConfig.DeepgramNova3MedicalConfig
+  | TranscriptionEngineDeepgramConfig.DeepgramFluxConfig
+  | TranscriptionEngineDeepgramConfig.DeepgramFluxMultiConfig;
+
+export namespace TranscriptionEngineDeepgramConfig {
+  /**
+   * Deepgram Nova-2 specialty models: `deepgram/nova-2-medical` (medical vocabulary)
+   * and `deepgram/nova-2-phonecall` (low-bandwidth phone audio). English only.
+   */
+  export interface DeepgramNova2SpecialtyConfig {
+    transcription_engine: 'Deepgram';
+
+    transcription_model: 'deepgram/nova-2-medical' | 'deepgram/nova-2-phonecall';
+
+    /**
+     * Nova-2 keyword biasing without intensifiers. Up to 100 terms to bias recognition
+     * toward. For weighted biasing, use `keywords_boosting` instead. Supported on
+     * Nova-2 models only (`deepgram/nova-2`, `deepgram/nova-2-medical`,
+     * `deepgram/nova-2-phonecall`); use `keyterms` on Nova-3 and Flux.
+     */
+    hints?: Array<string>;
+
+    /**
+     * Whether to send also interim results. If set to false, only final results will
+     * be sent.
+     */
+    interim_results?: boolean;
+
+    /**
+     * Keywords and their respective intensifiers (boosting values) to improve
+     * transcription accuracy for specific words or phrases. The intensifier should be
+     * a numeric value. Example: `{"snuffleupagus": 5, "systrom": 2, "krieger": 1}`.
+     */
+    keywords_boosting?: { [key: string]: number };
+
+    /**
+     * Language to transcribe. Deepgram's medical and phonecall models support English
+     * only.
+     */
+    language?: ActionsAPI.DeepgramEnglishTranscriptionLanguage;
+
+    /**
+     * Enable Deepgram's smart formatting (capitalization, punctuation, and digit
+     * normalization). Note: Telnyx defaults this to `true`, overriding Deepgram's
+     * underlying default of `false` — omit the field to get a smart-formatted
+     * transcript, or set it to `false` to receive the raw lowercase transcript without
+     * punctuation.
+     */
+    smart_format?: boolean;
+
+    /**
+     * Number of milliseconds of silence to consider an utterance ended. Ranges from 0
+     * to 5000 ms.
+     */
+    utterance_end_ms?: number;
+  }
+
+  /**
+   * Deepgram Nova-3 medical model, tuned for medical vocabulary. English only.
+   */
+  export interface DeepgramNova3MedicalConfig {
+    transcription_engine: 'Deepgram';
+
+    transcription_model: 'deepgram/nova-3-medical';
+
+    /**
+     * Whether to send also interim results. If set to false, only final results will
+     * be sent.
+     */
+    interim_results?: boolean;
+
+    /**
+     * Keyterm prompting. Up to 100 domain-specific terms or brand names to bias
+     * recognition toward. Supported on Nova-3 and Flux models (`deepgram/nova-3`,
+     * `deepgram/nova-3-medical`, `deepgram/flux`, `deepgram/flux-multi`); use `hints`
+     * on Nova-2.
+     */
+    keyterms?: Array<string>;
+
+    /**
+     * Keywords and their respective intensifiers (boosting values) to improve
+     * transcription accuracy for specific words or phrases. The intensifier should be
+     * a numeric value. Example: `{"snuffleupagus": 5, "systrom": 2, "krieger": 1}`.
+     */
+    keywords_boosting?: { [key: string]: number };
+
+    /**
+     * Language to transcribe. Deepgram's medical and phonecall models support English
+     * only.
+     */
+    language?: ActionsAPI.DeepgramEnglishTranscriptionLanguage;
+
+    /**
+     * Enable Deepgram's smart formatting (capitalization, punctuation, and digit
+     * normalization). Note: Telnyx defaults this to `true`, overriding Deepgram's
+     * underlying default of `false` — omit the field to get a smart-formatted
+     * transcript, or set it to `false` to receive the raw lowercase transcript without
+     * punctuation.
+     */
+    smart_format?: boolean;
+
+    /**
+     * Number of milliseconds of silence to consider an utterance ended. Ranges from 0
+     * to 5000 ms.
+     */
+    utterance_end_ms?: number;
+  }
+
+  /**
+   * Deepgram Flux (English), a conversational speech recognition model with built-in
+   * end-of-turn detection. `smart_format`, `utterance_end_ms`, `hints` and
+   * `keywords_boosting` do not apply to Flux.
+   */
+  export interface DeepgramFluxConfig {
+    transcription_engine: 'Deepgram';
+
+    transcription_model: 'deepgram/flux';
+
+    /**
+     * Whether to send also interim results. If set to false, only final results will
+     * be sent.
+     */
+    interim_results?: boolean;
+
+    /**
+     * Keyterm prompting. Up to 100 domain-specific terms or brand names to bias
+     * recognition toward. Supported on Nova-3 and Flux models (`deepgram/nova-3`,
+     * `deepgram/nova-3-medical`, `deepgram/flux`, `deepgram/flux-multi`); use `hints`
+     * on Nova-2.
+     */
+    keyterms?: Array<string>;
+
+    /**
+     * Language to transcribe. `deepgram/flux` supports English only.
+     */
+    language?: 'en';
+  }
+
+  /**
+   * Deepgram Flux multilingual, a conversational speech recognition model with
+   * built-in end-of-turn detection. `smart_format`, `utterance_end_ms`, `hints` and
+   * `keywords_boosting` do not apply to Flux.
+   */
+  export interface DeepgramFluxMultiConfig {
+    transcription_engine: 'Deepgram';
+
+    transcription_model: 'deepgram/flux-multi';
+
+    /**
+     * Whether to send also interim results. If set to false, only final results will
+     * be sent.
+     */
+    interim_results?: boolean;
+
+    /**
+     * Keyterm prompting. Up to 100 domain-specific terms or brand names to bias
+     * recognition toward. Supported on Nova-3 and Flux models (`deepgram/nova-3`,
+     * `deepgram/nova-3-medical`, `deepgram/flux`, `deepgram/flux-multi`); use `hints`
+     * on Nova-2.
+     */
+    keyterms?: Array<string>;
+
+    /**
+     * Language to transcribe. Flux-multi uses the language as a hint; `auto` lets Flux
+     * detect the language.
+     */
+    language?: 'en' | 'es' | 'fr' | 'de' | 'hi' | 'ru' | 'pt' | 'ja' | 'it' | 'nl' | 'auto';
+  }
+}
 
 export interface TranscriptionEngineGoogleConfig {
   /**
@@ -2207,7 +2430,21 @@ export interface TranscriptionEngineSpeechmaticsConfig {
   interim_results?: boolean;
 
   /**
-   * Language to use for speech recognition
+   * Language to use for speech recognition. Accepted values depend on the selected
+   * `transcription_model`. `speechmatics/standard` supports: `en`, `ba`, `eu`, `gl`,
+   * `ga`, `mt`, `mn`, `sw`, `ug`, `cy`, `ar_en`, `cmn_en`, `en_ms`, `en_ta`, `tl`,
+   * `es-bilingual-en`, `cmn_en_ms_ta`. `speechmatics/linden-1` (preview) supports
+   * the same languages as Speechmatics Realtime: `ar`, `ar_en`, `ba`, `be`, `bg`,
+   * `bn`, `ca`, `cmn`, `cmn_en`, `cmn_en_ms_ta`, `cs`, `cy`, `da`, `de`, `el`, `en`,
+   * `en_ms`, `en_ta`, `eo`, `es`, `es-bilingual-en`, `et`, `eu`, `fa`, `fi`, `fr`,
+   * `ga`, `gl`, `he`, `hi`, `hr`, `hu`, `ia`, `id`, `it`, `ja`, `ko`, `lt`, `lv`,
+   * `mn`, `mr`, `ms`, `mt`, `nl`, `no`, `pl`, `pt`, `ro`, `ru`, `sk`, `sl`, `sv`,
+   * `sw`, `ta`, `th`, `tl`, `tr`, `ug`, `uk`, `ur`, `vi`, `yue`, plus the spelling
+   * and script variants `en-US`, `en-GB`, `en-AU`, `cmn-Hans`, and `cmn-Hant` (`en`
+   * alone uses the default spelling). A value outside the selected model's list is
+   * rejected. For `speechmatics/standard`, unset, blank, `auto`, `auto_beta`, or
+   * `multi` defaults to `en`; for `speechmatics/linden-1`, only an unset language
+   * defaults to `en`, and `auto`, `auto_beta`, or `multi` is rejected.
    */
   language?:
     | 'en'
@@ -2226,7 +2463,57 @@ export interface TranscriptionEngineSpeechmaticsConfig {
     | 'en_ta'
     | 'tl'
     | 'es-bilingual-en'
-    | 'cmn_en_ms_ta';
+    | 'cmn_en_ms_ta'
+    | 'ar'
+    | 'be'
+    | 'bg'
+    | 'bn'
+    | 'ca'
+    | 'cmn'
+    | 'cs'
+    | 'da'
+    | 'de'
+    | 'el'
+    | 'eo'
+    | 'es'
+    | 'et'
+    | 'fa'
+    | 'fi'
+    | 'fr'
+    | 'he'
+    | 'hi'
+    | 'hr'
+    | 'hu'
+    | 'ia'
+    | 'id'
+    | 'it'
+    | 'ja'
+    | 'ko'
+    | 'lt'
+    | 'lv'
+    | 'mr'
+    | 'ms'
+    | 'nl'
+    | 'no'
+    | 'pl'
+    | 'pt'
+    | 'ro'
+    | 'ru'
+    | 'sk'
+    | 'sl'
+    | 'sv'
+    | 'ta'
+    | 'th'
+    | 'tr'
+    | 'uk'
+    | 'ur'
+    | 'vi'
+    | 'yue'
+    | 'en-US'
+    | 'en-GB'
+    | 'en-AU'
+    | 'cmn-Hans'
+    | 'cmn-Hant';
 
   /**
    * Engine identifier for Speechmatics transcription service
@@ -2234,9 +2521,10 @@ export interface TranscriptionEngineSpeechmaticsConfig {
   transcription_engine?: 'Speechmatics';
 
   /**
-   * The model to use for transcription.
+   * The model to use for transcription. `speechmatics/linden-1` is a preview,
+   * vendor-hosted model with its own language support (see `language`).
    */
-  transcription_model?: 'speechmatics/standard';
+  transcription_model?: 'speechmatics/standard' | 'speechmatics/linden-1';
 }
 
 export interface TranscriptionEngineTelnyxConfig {
@@ -3313,10 +3601,10 @@ export interface ActionGatherUsingAIParams {
    *   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).)
+   * - **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
@@ -3665,6 +3953,18 @@ export interface ActionHangupParams {
    * Custom headers to be added to the SIP BYE message.
    */
   custom_headers?: Array<CallsAPI.CustomSipHeader>;
+
+  /**
+   * Text for the SIP `Reason` header (RFC 3326) sent when cancelling an unanswered
+   * outbound leg. The SIP CANCEL carries `Reason: SIP;cause=200;text="<reason>"`;
+   * phones such as Poly and Yealink use it to suppress the missed-call entry for a
+   * call answered elsewhere. Has no effect on an answered leg or an inbound leg. A
+   * hangup sent before the leg's `call.initiated` webhook still hangs up the leg,
+   * but without the `Reason` header. Must not contain `"`, `\`, control characters,
+   * or characters outside the Basic Multilingual Plane (such as emoji); invalid
+   * values are rejected with a 422.
+   */
+  reason?: string;
 }
 
 export interface ActionLeaveQueueParams {
@@ -5429,9 +5729,12 @@ export interface ActionStartConversationRelayParams {
    * 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.
+   * repeated inside this object. With Deepgram Flux (`deepgram/flux`),
+   * `interim_results`, `eot_threshold` and `eager_eot_threshold` control the interim
+   * prompts and the `eagerEndOfTurn` and `turnResumed` frames sent to your WebSocket
+   * server.
    */
-  transcription_engine_config?: { [key: string]: unknown };
+  transcription_engine_config?: ConversationRelayTranscriptionEngineConfig;
 
   /**
    * Text-to-speech provider. If omitted, Telnyx derives it from `voice` or
@@ -5456,10 +5759,10 @@ export interface ActionStartConversationRelayParams {
    *   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).)
+   * - **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
@@ -5622,6 +5925,15 @@ export interface ActionPayParams {
    */
   metadata?: { [key: string]: unknown };
 
+  /**
+   * Minimum number of digits the caller must enter when collecting a credit-card
+   * billing postal code. Applies only when `postal_code` is `true` or `"true"` and
+   * no `payment_token` is supplied. The default is 1. The maximum number of digits
+   * collected is the greater of 10 and this value. This does not validate the length
+   * of a postal code supplied directly in `postal_code`.
+   */
+  min_postal_code_length?: number;
+
   /**
    * Additional parameters forwarded to the Pay connector.
    */
@@ -5637,6 +5949,18 @@ export interface ActionPayParams {
    */
   payment_token?: string;
 
+  /**
+   * Controls billing postal code collection for credit-card payments when no
+   * `payment_token` is supplied. Set to `true` or the string `"true"` (the default)
+   * to prompt the caller for a postal code. Set to `false` or the string `"false"`
+   * to skip the postal code prompt without supplying a postal code to the payment
+   * connector. Supply any other non-empty string, such as `"90210"`, to use that
+   * postal code without prompting. Empty or whitespace-only strings are rejected.
+   * This option does not affect ACH debit payments or payments using an existing
+   * token.
+   */
+  postal_code?: string | boolean;
+
   /**
    * Custom text-to-speech prompts keyed by payment collection step.
    */
@@ -5722,6 +6046,8 @@ export declare namespace Actions {
     type CallControlCommandResult as CallControlCommandResult,
     type CallControlCommandResultWithConversationID as CallControlCommandResultWithConversationID,
     type ConversationRelayInterruptible as ConversationRelayInterruptible,
+    type ConversationRelayTranscriptionEngineConfig as ConversationRelayTranscriptionEngineConfig,
+    type DeepgramEnglishTranscriptionLanguage as DeepgramEnglishTranscriptionLanguage,
     type DeepgramNova2Config as DeepgramNova2Config,
     type DeepgramNova3Config as DeepgramNova3Config,
     type DeveloperMessage as DeveloperMessage,

package/src/resources/calls/calls.ts

@@ -93,6 +93,8 @@ import {
   CallControlCommandResult,
   CallControlCommandResultWithConversationID,
   ConversationRelayInterruptible,
+  ConversationRelayTranscriptionEngineConfig,
+  DeepgramEnglishTranscriptionLanguage,
   DeepgramNova2Config,
   DeepgramNova3Config,
   DeveloperMessage,
@@ -138,10 +140,18 @@ export class Calls extends APIResource {
    * include a `call_leg_id` which can be used to correlate the command with
    * subsequent webhooks.
    *
+   * To place the call with an AI assistant from the start, include `assistant.id`
+   * and any per-call overrides in the `assistant` object; Telnyx attempts to warm up
+   * the assistant before placing the call and starts it automatically when the
+   * called party answers.
+   *
    * **Expected Webhooks:**
    *
    * - `call.initiated`
    * - `call.answered` or `call.hangup`
+   * - `call.conversation.created` when the requested assistant conversation is
+   *   created, or `call.conversation.start_failed` when it could not be started
+   *   after the called party answered
    * - `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
@@ -516,9 +526,12 @@ export interface ConversationRelayEmbeddedConfig {
    * 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.
+   * repeated inside this object. With Deepgram Flux (`deepgram/flux`),
+   * `interim_results`, `eot_threshold` and `eager_eot_threshold` control the interim
+   * prompts and the `eagerEndOfTurn` and `turnResumed` frames sent to your WebSocket
+   * server.
    */
-  transcription_engine_config?: { [key: string]: unknown };
+  transcription_engine_config?: ActionsAPI.ConversationRelayTranscriptionEngineConfig;
 
   /**
    * Text-to-speech provider. If omitted, Telnyx derives it from `voice` or
@@ -537,10 +550,10 @@ export interface ConversationRelayEmbeddedConfig {
    *   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).)
+   * - **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
@@ -655,9 +668,12 @@ export interface ConversationRelayLanguage {
    * 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.
+   * repeated inside this object. With Deepgram Flux (`deepgram/flux`),
+   * `interim_results`, `eot_threshold` and `eager_eot_threshold` control the interim
+   * prompts and the `eagerEndOfTurn` and `turnResumed` frames sent to your WebSocket
+   * server.
    */
-  transcription_engine_config?: { [key: string]: unknown };
+  transcription_engine_config?: ActionsAPI.ConversationRelayTranscriptionEngineConfig;
 
   /**
    * Conversation Relay transcription provider name. Prefer `transcription_engine`
@@ -1643,6 +1659,8 @@ export declare namespace Calls {
     type CallControlCommandResult as CallControlCommandResult,
     type CallControlCommandResultWithConversationID as CallControlCommandResultWithConversationID,
     type ConversationRelayInterruptible as ConversationRelayInterruptible,
+    type ConversationRelayTranscriptionEngineConfig as ConversationRelayTranscriptionEngineConfig,
+    type DeepgramEnglishTranscriptionLanguage as DeepgramEnglishTranscriptionLanguage,
     type DeepgramNova2Config as DeepgramNova2Config,
     type DeepgramNova3Config as DeepgramNova3Config,
     type DeveloperMessage as DeveloperMessage,

package/src/resources/calls/index.ts

@@ -8,6 +8,8 @@ export {
   type CallControlCommandResult,
   type CallControlCommandResultWithConversationID,
   type ConversationRelayInterruptible,
+  type ConversationRelayTranscriptionEngineConfig,
+  type DeepgramEnglishTranscriptionLanguage,
   type DeepgramNova2Config,
   type DeepgramNova3Config,
   type DeveloperMessage,