telnyx 7.22.0 → 7.24.0

package/src/resources/meeting-sessions/meeting-sessions.ts

@@ -139,8 +139,6 @@ export class MeetingSessions extends APIResource {
   }
 
   /**
-   * **Not yet available in production** — this route is not currently routed on
-   * api.telnyx.com and returns a generic 404; it is documented ahead of rollout.
    * Irreversibly requests deletion of provider-hosted aggregate recording media
    * under the provider contract. The operation retains the Telnyx-local Meeting
    * session, transcript segments, events, artifacts, and usage records. It is
@@ -353,9 +351,20 @@ export namespace MeetingSession {
     id: string;
 
     /**
-     * Audio gating strategy for the assistant call leg.
+     * Audio gating strategy in force for the assistant call leg.
      */
-    audio_gate: 'none' | 'half_duplex';
+    audio_gate: 'half_duplex' | 'full_duplex';
+
+    /**
+     * The dynamic variables in force for this session, or null when none were
+     * supplied.
+     */
+    dynamic_variables: { [key: string]: string } | null;
+
+    /**
+     * Whether the bot leaves when the Assistant's conversation ends or fails.
+     */
+    leave_on_end: boolean;
   }
 
   /**
@@ -381,6 +390,11 @@ export namespace MeetingSession {
      */
     barge_in: boolean;
 
+    /**
+     * The message posted to chat on join, or null when unset.
+     */
+    chat_on_enter: string | null;
+
     /**
      * Text spoken on meeting entry, or null if not set.
      */
@@ -520,10 +534,10 @@ export interface MeetingSessionCreateParams {
   meeting_url: string;
 
   /**
-   * Request options for attaching a voice assistant to the session. Routing fields
-   * (`call_control_connection_id`, `from`, and `loopback_sip_uri`) are used only to
-   * establish the assistant call leg and are omitted from response objects.
-   * `audio_gate` is returned with `id` in the assistant response object.
+   * Attach a Telnyx AI Assistant to the session. Supply the Assistant's ID; the
+   * Meeting service connects it to the meeting directly. The Call Control
+   * connection, caller ID and loopback SIP URI previously required here have been
+   * removed and are now rejected as unknown fields.
    */
   assistant?: MeetingSessionCreateParams.Assistant;
 
@@ -556,6 +570,15 @@ export interface MeetingSessionCreateParams {
     | MeetingSessionCreateParams.MeetingSessionCameraImageBase64Source
     | MeetingSessionCreateParams.MeetingSessionCameraImageURLSource;
 
+  /**
+   * A message the bot posts to the meeting's chat as soon as it becomes active —
+   * typically a recording disclosure. Delivered at most once. Independent of
+   * `speak_on_enter`: both may be set, and the chat message posts first because it
+   * does not wait for text-to-speech or avatar startup. Rejected with 422
+   * `unsupported_capability` on platforms without meeting chat.
+   */
+  chat_on_enter?: string;
+
   /**
    * Client-supplied idempotency key to safely retry creation requests without
    * duplicating sessions. Lookup is scoped to the authenticated account and compares
@@ -576,7 +599,10 @@ export interface MeetingSessionCreateParams {
   metadata?: { [key: string]: unknown };
 
   /**
-   * Text the bot speaks when it enters the meeting.
+   * Text the bot speaks when it enters the meeting. **Not spoken when an `assistant`
+   * is attached**: the value is accepted and echoed back on the session, but the
+   * assistant owns the voice and the line is never delivered, with no event
+   * reporting the omission. Use `chat_on_enter` to announce an assistant-backed bot.
    */
   speak_on_enter?: string;
 
@@ -602,10 +628,10 @@ export interface MeetingSessionCreateParams {
 
 export namespace MeetingSessionCreateParams {
   /**
-   * Request options for attaching a voice assistant to the session. Routing fields
-   * (`call_control_connection_id`, `from`, and `loopback_sip_uri`) are used only to
-   * establish the assistant call leg and are omitted from response objects.
-   * `audio_gate` is returned with `id` in the assistant response object.
+   * Attach a Telnyx AI Assistant to the session. Supply the Assistant's ID; the
+   * Meeting service connects it to the meeting directly. The Call Control
+   * connection, caller ID and loopback SIP URI previously required here have been
+   * removed and are now rejected as unknown fields.
    */
   export interface Assistant {
     /**
@@ -614,24 +640,37 @@ export namespace MeetingSessionCreateParams {
     id: string;
 
     /**
-     * Call control connection used to bridge the assistant into the meeting audio.
-     */
-    call_control_connection_id: string;
-
-    /**
-     * E.164 calling number used as the originating party for the assistant call leg.
+     * Audio gating strategy for the assistant call leg. `half_duplex` (default) sends
+     * the assistant a single mixed meeting stream and mutes it while the assistant
+     * speaks, so the assistant cannot hear itself and cannot be interrupted.
+     * `full_duplex` sends a separate stream per participant, which allows barge-in and
+     * removes self-hearing, and COSTS SIGNIFICANTLY MORE: per-participant streams
+     * multiply the per-minute cost by the number of participants.
      */
-    from: string;
+    audio_gate?: 'half_duplex' | 'full_duplex';
 
     /**
-     * SIP URI to which the assistant media loopback is established.
+     * Per-conversation values for the
+     * [dynamic variables](/docs/inference/ai-assistants/dynamic-variables) used in the
+     * Assistant's instructions, greeting, or tools. Delivered before the Assistant's
+     * first utterance, so they resolve for the opening line as well as the rest of the
+     * conversation. At most 63 entries; keys 1-128 characters; values must be strings.
+     * The map is budgeted in aggregate at 1,047,552 bytes (1023 KiB) rather than
+     * capped per value. `streaming_audio`, `ai_assistant_streaming_audio` and
+     * `meeting_session_id` are reserved and rejected with `400 invalid_request` --
+     * they toggle provider infrastructure or are set by the service rather than fill a
+     * prompt template.
      */
-    loopback_sip_uri: string;
+    dynamic_variables?: { [key: string]: string };
 
     /**
-     * Audio gating strategy for the assistant call leg.
+     * Leave the meeting when the Assistant's conversation reaches a terminal state --
+     * `ended` **or** `failed`. Off by default, which leaves the bot in the meeting
+     * after the Assistant stops. Fires once: a second terminal transition does not
+     * leave twice, and a leave the provider refuses is logged without changing how the
+     * session settles.
      */
-    audio_gate?: 'none' | 'half_duplex';
+    leave_on_end?: boolean;
   }
 
   /**

package/src/resources/messages/messages.ts

@@ -2,7 +2,6 @@
 
 import { APIResource } from '../../core/resource';
 import * as MessagesAPI from './messages';
-import * as Shared from '../shared';
 import * as RcsAPI from './rcs';
 import {
   RcGenerateDeeplinkParams,
@@ -258,8 +257,15 @@ export interface MessagingInboundMessagePayload {
   id?: string;
 
   /**
-   * WhatsApp message body. For message edits and revocations, inspect `type` and the
-   * corresponding `edit` or `revoke` object.
+   * Automatic response type triggered by an inbound opt-in, opt-out, or help
+   * keyword. Examples include START, STOP, and HELP.
+   */
+  autoresponse_type?: string;
+
+  /**
+   * Message body for RCS and WhatsApp. RCS messages contain text, user_file,
+   * location, or suggestion_response. For WhatsApp edits and revocations, inspect
+   * type and the corresponding edit or revoke object.
    */
   body?: MessagingInboundMessagePayload.Body;
 
@@ -366,15 +372,16 @@ export interface MessagingInboundMessagePayload {
   text?: string;
 
   /**
-   * Receiving address. SMS and MMS webhooks use an array of recipients. WhatsApp
-   * webhooks use one E.164 phone number.
+   * Receiving address. SMS, MMS and RCS webhooks use an array of recipients. RCS
+   * recipients are identified by agent_id and agent_name. WhatsApp webhooks use one
+   * E.164 phone number.
    */
   to?: Array<MessagingInboundMessagePayload.UnionMember0> | string;
 
   /**
    * The messaging channel used for the message.
    */
-  type?: 'SMS' | 'MMS' | 'WHATSAPP';
+  type?: 'SMS' | 'MMS' | 'WHATSAPP' | 'RCS';
 
   /**
    * Not used for inbound messages.
@@ -395,8 +402,9 @@ export interface MessagingInboundMessagePayload {
 
 export namespace MessagingInboundMessagePayload {
   /**
-   * WhatsApp message body. For message edits and revocations, inspect `type` and the
-   * corresponding `edit` or `revoke` object.
+   * Message body for RCS and WhatsApp. RCS messages contain text, user_file,
+   * location, or suggestion_response. For WhatsApp edits and revocations, inspect
+   * type and the corresponding edit or revoke object.
    */
   export interface Body {
     /**
@@ -419,11 +427,26 @@ export namespace MessagingInboundMessagePayload {
      */
     from?: string;
 
+    /**
+     * Location shared in an RCS message.
+     */
+    location?: Body.Location;
+
     /**
      * Details for a revoked WhatsApp message.
      */
     revoke?: Body.Revoke;
 
+    /**
+     * Selected RCS suggestion.
+     */
+    suggestion_response?: Body.SuggestionResponse;
+
+    /**
+     * RCS text string or WhatsApp text object.
+     */
+    text?: string | Body.Body;
+
     /**
      * Unix timestamp supplied by Meta.
      */
@@ -435,6 +458,11 @@ export namespace MessagingInboundMessagePayload {
      */
     type?: string;
 
+    /**
+     * RCS file attachment and optional thumbnail.
+     */
+    user_file?: Body.UserFile;
+
     [k: string]: unknown;
   }
 
@@ -455,6 +483,15 @@ export namespace MessagingInboundMessagePayload {
       original_message_id: string;
     }
 
+    /**
+     * Location shared in an RCS message.
+     */
+    export interface Location {
+      latitude?: number;
+
+      longitude?: number;
+    }
+
     /**
      * Details for a revoked WhatsApp message.
      */
@@ -465,6 +502,52 @@ export namespace MessagingInboundMessagePayload {
        */
       original_message_id: string;
     }
+
+    /**
+     * Selected RCS suggestion.
+     */
+    export interface SuggestionResponse {
+      postback_data?: string;
+
+      text?: string;
+    }
+
+    export interface Body {
+      body?: string;
+
+      [k: string]: unknown;
+    }
+
+    /**
+     * RCS file attachment and optional thumbnail.
+     */
+    export interface UserFile {
+      payload?: UserFile.Payload;
+
+      thumbnail?: UserFile.Thumbnail;
+    }
+
+    export namespace UserFile {
+      export interface Payload {
+        file_name?: string;
+
+        file_size_bytes?: number;
+
+        file_uri?: string;
+
+        mime_type?: string;
+      }
+
+      export interface Thumbnail {
+        file_name?: string;
+
+        file_size_bytes?: number;
+
+        file_uri?: string;
+
+        mime_type?: string;
+      }
+    }
   }
 
   export interface Cc {
@@ -549,7 +632,7 @@ export namespace MessagingInboundMessagePayload {
     /**
      * The line-type of the sender.
      */
-    line_type?: 'Wireline' | 'Wireless' | 'VoWiFi' | 'VoIP' | 'Pre-Paid Wireless' | '';
+    line_type?: 'Wireline' | 'Wireless' | 'VoWiFi' | 'VoIP' | 'Pre-Paid Wireless' | '' | 'long_code';
 
     /**
      * Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short
@@ -557,7 +640,7 @@ export namespace MessagingInboundMessagePayload {
      */
     phone_number?: string;
 
-    status?: 'received' | 'delivered';
+    status?: 'received' | 'delivered' | 'webhook_delivered';
   }
 
   export interface Media {
@@ -583,6 +666,16 @@ export namespace MessagingInboundMessagePayload {
   }
 
   export interface UnionMember0 {
+    /**
+     * RCS agent identifier.
+     */
+    agent_id?: string;
+
+    /**
+     * RCS agent name.
+     */
+    agent_name?: string;
+
     /**
      * The carrier of the receiver.
      */
@@ -616,6 +709,11 @@ export interface MessagingOutboundMessagePayload {
    */
   id?: string;
 
+  /**
+   * RCS webhook message body. Text messages use the text property.
+   */
+  body?: MessagingOutboundMessagePayload.Body;
+
   cc?: Array<MessagingOutboundMessagePayload.Cc>;
 
   /**
@@ -731,7 +829,7 @@ export interface MessagingOutboundMessagePayload {
   /**
    * The type of message.
    */
-  type?: 'SMS' | 'MMS';
+  type?: 'SMS' | 'MMS' | 'RCS';
 
   /**
    * Message must be out of the queue by this time or else it will be discarded and
@@ -760,6 +858,16 @@ export interface MessagingOutboundMessagePayload {
 }
 
 export namespace MessagingOutboundMessagePayload {
+  /**
+   * RCS webhook message body. Text messages use the text property.
+   */
+  export interface Body {
+    /**
+     * RCS text message.
+     */
+    text?: string;
+  }
+
   export interface Cc {
     /**
      * The carrier of the receiver.
@@ -834,6 +942,16 @@ export namespace MessagingOutboundMessagePayload {
   }
 
   export interface From {
+    /**
+     * RCS agent identifier.
+     */
+    agent_id?: string;
+
+    /**
+     * RCS agent name.
+     */
+    agent_name?: string;
+
     /**
      * The carrier of the receiver.
      */
@@ -900,7 +1018,8 @@ export namespace MessagingOutboundMessagePayload {
       | 'sending_failed'
       | 'delivery_unconfirmed'
       | 'delivered'
-      | 'delivery_failed';
+      | 'delivery_failed'
+      | 'read';
   }
 }
 
@@ -910,6 +1029,11 @@ export interface OutboundMessagePayload {
    */
   id?: string;
 
+  /**
+   * RCS webhook message body. Text messages use the text property.
+   */
+  body?: OutboundMessagePayload.Body;
+
   cc?: Array<OutboundMessagePayload.Cc>;
 
   /**
@@ -939,7 +1063,7 @@ export interface OutboundMessagePayload {
    * These errors may point at addressees when referring to unsuccessful/unconfirmed
    * delivery statuses.
    */
-  errors?: Array<Shared.MessagingError>;
+  errors?: Array<MessagingError0b38e7044b>;
 
   from?: OutboundMessagePayload.From;
 
@@ -1025,7 +1149,7 @@ export interface OutboundMessagePayload {
   /**
    * The type of message.
    */
-  type?: 'SMS' | 'MMS';
+  type?: 'SMS' | 'MMS' | 'RCS';
 
   /**
    * Message must be out of the queue by this time or else it will be discarded and
@@ -1054,6 +1178,16 @@ export interface OutboundMessagePayload {
 }
 
 export namespace OutboundMessagePayload {
+  /**
+   * RCS webhook message body. Text messages use the text property.
+   */
+  export interface Body {
+    /**
+     * RCS text message.
+     */
+    text?: string;
+  }
+
   export interface Cc {
     /**
      * The carrier of the receiver.
@@ -1128,6 +1262,16 @@ export namespace OutboundMessagePayload {
   }
 
   export interface From {
+    /**
+     * RCS agent identifier.
+     */
+    agent_id?: string;
+
+    /**
+     * RCS agent name.
+     */
+    agent_name?: string;
+
     /**
      * The carrier of the receiver.
      */
@@ -1194,7 +1338,8 @@ export namespace OutboundMessagePayload {
       | 'sending_failed'
       | 'delivery_unconfirmed'
       | 'delivered'
-      | 'delivery_failed';
+      | 'delivery_failed'
+      | 'read';
   }
 }
 
@@ -1917,7 +2062,7 @@ export interface WhatsappReaction {
 }
 
 export interface MessageRetrieveResponse {
-  data?: MessagingOutboundMessagePayload | MessagingInboundMessagePayload;
+  data?: OutboundMessagePayload | MessagingInboundMessagePayload;
 }
 
 export interface MessageCancelScheduledResponse {
@@ -2216,31 +2361,31 @@ export namespace MessageCancelScheduledResponse {
 }
 
 export interface MessageRetrieveGroupMessagesResponse {
-  data?: Array<MessagingOutboundMessagePayload>;
+  data?: Array<OutboundMessagePayload>;
 }
 
 export interface MessageScheduleResponse {
-  data?: MessagingOutboundMessagePayload;
+  data?: OutboundMessagePayload;
 }
 
 export interface MessageSendResponse {
-  data?: MessagingOutboundMessagePayload;
+  data?: OutboundMessagePayload;
 }
 
 export interface MessageSendGroupMmsResponse {
-  data?: MessagingOutboundMessagePayload;
+  data?: OutboundMessagePayload;
 }
 
 export interface MessageSendLongCodeResponse {
-  data?: MessagingOutboundMessagePayload;
+  data?: OutboundMessagePayload;
 }
 
 export interface MessageSendNumberPoolResponse {
-  data?: MessagingOutboundMessagePayload;
+  data?: OutboundMessagePayload;
 }
 
 export interface MessageSendShortCodeResponse {
-  data?: MessagingOutboundMessagePayload;
+  data?: OutboundMessagePayload;
 }
 
 export interface MessageSendWithAlphanumericSenderResponse {

package/src/resources/noise-suppression-engines.ts

@@ -0,0 +1,51 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Noise suppression engines that can be selected when configuring noise suppression on voice connections.
+ */
+export class NoiseSuppressionEngines extends APIResource {
+  /**
+   * Returns all noise suppression engines available to the authenticated user.
+   * Engines gated behind a feature flag are included only when the flag is enabled
+   * for the user's account. Results are not paginated; the number of engines is
+   * expected to remain small.
+   */
+  list(options?: RequestOptions): APIPromise<NoiseSuppressionEngineListResponse> {
+    return this._client.get('/noise_suppression_engines', options);
+  }
+}
+
+export interface NoiseSuppressionEngineListResponse {
+  data: Array<NoiseSuppressionEngineListResponse.Data>;
+}
+
+export namespace NoiseSuppressionEngineListResponse {
+  /**
+   * A noise suppression engine available to the authenticated user.
+   */
+  export interface Data {
+    /**
+     * Default attenuation level of the engine (0-100, in multiples of ten).
+     */
+    default_attenuation_level: number;
+
+    /**
+     * Human-readable name of the engine.
+     */
+    label: string;
+
+    /**
+     * Machine-readable identifier of the engine, used when configuring noise
+     * suppression.
+     */
+    value: string;
+  }
+}
+
+export declare namespace NoiseSuppressionEngines {
+  export { type NoiseSuppressionEngineListResponse as NoiseSuppressionEngineListResponse };
+}

package/src/resources/phone-numbers/phone-numbers.ts

@@ -353,12 +353,23 @@ export interface NumbersPhoneNumberDetailed {
   inbound_call_screening?: 'disabled' | 'reject_calls' | 'flag_calls';
 
   /**
-   * Identifies the messaging profile associated with the phone number.
+   * Identifies the messaging campaign associated with the phone number's messaging
+   * profile. If the messaging profile details could not be retrieved, this value is
+   * the string `UNAVAILABLE`.
+   */
+  messaging_campaign_id?: string | null;
+
+  /**
+   * Identifies the messaging profile associated with the phone number. If the
+   * messaging profile details could not be retrieved, this value is the string
+   * `UNAVAILABLE`.
    */
   messaging_profile_id?: string | null;
 
   /**
-   * The name of the messaging profile associated with the phone number.
+   * The name of the messaging profile associated with the phone number. If the
+   * messaging profile details could not be retrieved, this value is the string
+   * `UNAVAILABLE`.
    */
   messaging_profile_name?: string | null;