telnyx 7.20.0 → 7.22.0

package/src/resources/messages/messages.ts

@@ -257,6 +257,12 @@ export interface MessagingInboundMessagePayload {
    */
   id?: string;
 
+  /**
+   * WhatsApp message body. For message edits and revocations, inspect `type` and the
+   * corresponding `edit` or `revoke` object.
+   */
+  body?: MessagingInboundMessagePayload.Body;
+
   cc?: Array<MessagingInboundMessagePayload.Cc>;
 
   /**
@@ -359,12 +365,16 @@ export interface MessagingInboundMessagePayload {
    */
   text?: string;
 
-  to?: Array<MessagingInboundMessagePayload.To>;
+  /**
+   * Receiving address. SMS and MMS webhooks use an array of recipients. WhatsApp
+   * webhooks use one E.164 phone number.
+   */
+  to?: Array<MessagingInboundMessagePayload.UnionMember0> | string;
 
   /**
-   * The type of message. This value can be either 'sms' or 'mms'.
+   * The messaging channel used for the message.
    */
-  type?: 'SMS' | 'MMS';
+  type?: 'SMS' | 'MMS' | 'WHATSAPP';
 
   /**
    * Not used for inbound messages.
@@ -384,6 +394,79 @@ export interface MessagingInboundMessagePayload {
 }
 
 export namespace MessagingInboundMessagePayload {
+  /**
+   * WhatsApp message body. For message edits and revocations, inspect `type` and the
+   * corresponding `edit` or `revoke` object.
+   */
+  export interface Body {
+    /**
+     * Telnyx identifier for this webhook message.
+     */
+    id?: string;
+
+    /**
+     * Details for an edited WhatsApp message.
+     */
+    edit?: Body.Edit;
+
+    /**
+     * Meta WhatsApp message identifier for this webhook event.
+     */
+    foreign_id?: string;
+
+    /**
+     * WhatsApp sender in E.164 format.
+     */
+    from?: string;
+
+    /**
+     * Details for a revoked WhatsApp message.
+     */
+    revoke?: Body.Revoke;
+
+    /**
+     * Unix timestamp supplied by Meta.
+     */
+    timestamp?: string;
+
+    /**
+     * WhatsApp message body type. Edit and revoke events use `edit` and `revoke`,
+     * respectively.
+     */
+    type?: string;
+
+    [k: string]: unknown;
+  }
+
+  export namespace Body {
+    /**
+     * Details for an edited WhatsApp message.
+     */
+    export interface Edit {
+      /**
+       * Replacement WhatsApp message content. Its shape depends on the message type.
+       */
+      message: { [key: string]: unknown };
+
+      /**
+       * Telnyx message ID when a mapping exists, otherwise the original Meta WhatsApp
+       * message ID. Treat this value as opaque.
+       */
+      original_message_id: string;
+    }
+
+    /**
+     * Details for a revoked WhatsApp message.
+     */
+    export interface Revoke {
+      /**
+       * Telnyx message ID when a mapping exists, otherwise the original Meta WhatsApp
+       * message ID. Treat this value as opaque.
+       */
+      original_message_id: string;
+    }
+  }
+
   export interface Cc {
     /**
      * The carrier of the receiver.
@@ -414,12 +497,12 @@ export namespace MessagingInboundMessagePayload {
     /**
      * The amount deducted from your account.
      */
-    amount?: string;
+    amount?: string | null;
 
     /**
      * The ISO 4217 currency identifier.
      */
-    currency?: string;
+    currency?: string | null;
   }
 
   /**
@@ -499,7 +582,7 @@ export namespace MessagingInboundMessagePayload {
     url?: string;
   }
 
-  export interface To {
+  export interface UnionMember0 {
     /**
      * The carrier of the receiver.
      */

package/src/resources/messaging-profiles/actions.ts

@@ -24,7 +24,7 @@ export class Actions extends APIResource {
 }
 
 export interface ActionRegenerateSecretResponse {
-  data?: MessagingProfilesAPI.MessagingProfile;
+  data?: MessagingProfilesAPI.MessagingMessagingProfile;
 }
 
 export declare namespace Actions {

package/src/resources/messaging-profiles/index.ts

@@ -16,7 +16,9 @@ export {
 } from './autoresp-configs';
 export {
   MessagingProfiles,
+  type MessagingMessagingProfile,
   type MessagingProfile,
+  type MessagingProfileFeatures,
   type NumberPoolSettings,
   type URLShortenerSettings,
   type MessagingProfileCreateResponse,
@@ -31,5 +33,5 @@ export {
   type MessagingProfileListShortCodesParams,
   type MessagingProfileListAlphanumericSenderIDsParams,
   type MessagingProfileRetrieveMetricsParams,
-  type MessagingProfilesDefaultFlatPagination,
+  type MessagingMessagingProfilesDefaultFlatPagination,
 } from './messaging-profiles';

package/src/resources/messaging-profiles/messaging-profiles.ts

@@ -41,7 +41,7 @@ export class MessagingProfiles extends APIResource {
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const messagingProfile of client.messagingProfiles.list()) {
+   * for await (const messagingMessagingProfile of client.messagingProfiles.list()) {
    *   // ...
    * }
    * ```
@@ -49,8 +49,8 @@ export class MessagingProfiles extends APIResource {
   list(
     query: MessagingProfileListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<MessagingProfilesDefaultFlatPagination, MessagingProfile> {
-    return this._client.getAPIList('/messaging_profiles', DefaultFlatPagination<MessagingProfile>, {
+  ): PagePromise<MessagingMessagingProfilesDefaultFlatPagination, MessagingMessagingProfile> {
+    return this._client.getAPIList('/messaging_profiles', DefaultFlatPagination<MessagingMessagingProfile>, {
       query,
       ...options,
     });
@@ -232,7 +232,172 @@ export class MessagingProfiles extends APIResource {
   }
 }
 
-export type MessagingProfilesDefaultFlatPagination = DefaultFlatPagination<MessagingProfile>;
+export type MessagingMessagingProfilesDefaultFlatPagination =
+  DefaultFlatPagination<MessagingMessagingProfile>;
+
+export interface MessagingMessagingProfile {
+  /**
+   * Identifies the type of resource.
+   */
+  id?: string;
+
+  /**
+   * The AI assistant ID associated with this messaging profile.
+   */
+  ai_assistant_id?: string | null;
+
+  /**
+   * The alphanumeric sender ID to use when sending to destinations that require an
+   * alphanumeric sender ID.
+   */
+  alpha_sender?: string | null;
+
+  /**
+   * ISO 8601 formatted date indicating when the resource was created.
+   */
+  created_at?: string;
+
+  /**
+   * The maximum amount of money (in USD) that can be spent by this profile before
+   * midnight UTC.
+   */
+  daily_spend_limit?: string;
+
+  /**
+   * Whether to enforce the value configured by `daily_spend_limit`.
+   */
+  daily_spend_limit_enabled?: boolean;
+
+  /**
+   * Specifies whether the messaging profile is enabled or not.
+   */
+  enabled?: boolean;
+
+  /**
+   * Telnyx product features the messaging customer can enable on the messaging
+   * profile. Keys map to individual feature flags; unknown keys are accepted and
+   * preserved for forward compatibility with rolling deployments.
+   */
+  features?: MessagingProfileFeatures | null;
+
+  /**
+   * DEPRECATED: health check url service checking
+   */
+  health_webhook_url?: string | null;
+
+  /**
+   * enables SMS fallback for MMS messages.
+   */
+  mms_fall_back_to_sms?: boolean;
+
+  /**
+   * enables automated resizing of MMS media.
+   */
+  mms_transcoding?: boolean;
+
+  /**
+   * Send messages only to mobile phone numbers.
+   */
+  mobile_only?: boolean;
+
+  /**
+   * A user friendly name for the messaging profile.
+   */
+  name?: string;
+
+  /**
+   * Number Pool allows you to send messages from a pool of numbers of different
+   * types, assigning weights to each type. The pool consists of all the long code
+   * and toll free numbers assigned to the messaging profile.
+   *
+   * To disable this feature, set the object field to `null`.
+   */
+  number_pool_settings?: NumberPoolSettings | null;
+
+  /**
+   * The organization that owns this messaging profile.
+   */
+  organization_id?: string;
+
+  /**
+   * Identifies the type of the resource.
+   */
+  record_type?: 'messaging_profile';
+
+  /**
+   * Indicates whether message content redaction is enabled for this profile. When
+   * enabled, message text, MMS media, and the counterparty phone number are redacted
+   * in message records and reporting. Requires organization activation — contact
+   * support to enable. The field is only present in responses for organizations with
+   * redaction access.
+   */
+  redaction_enabled?: boolean;
+
+  /**
+   * Determines how much information is redacted for privacy or compliance purposes.
+   * Level 1: message records and reporting are redacted, but inbound webhook
+   * payloads are not. Level 2 (default): message records, reporting, and inbound
+   * webhook payloads are all redacted.
+   */
+  redaction_level?: number;
+
+  /**
+   * The resource group ID associated with this messaging profile.
+   */
+  resource_group_id?: string | null;
+
+  /**
+   * Enables automatic character encoding optimization for SMS messages. When
+   * enabled, the system automatically selects the most efficient encoding (GSM-7 or
+   * UCS-2) based on message content to maximize character limits and minimize costs.
+   */
+  smart_encoding?: boolean;
+
+  /**
+   * ISO 8601 formatted date indicating when the resource was updated.
+   */
+  updated_at?: string;
+
+  /**
+   * The URL shortener feature allows automatic replacement of URLs that were
+   * generated using a public URL shortener service. Some examples include bit.do,
+   * bit.ly, goo.gl, ht.ly, is.gd, ow.ly, rebrand.ly, t.co, tiny.cc, and tinyurl.com.
+   * Such URLs are replaced with with links generated by Telnyx. The use of custom
+   * links can improve branding and message deliverability.
+   *
+   * To disable this feature, set the object field to `null`.
+   */
+  url_shortener_settings?: URLShortenerSettings | null;
+
+  /**
+   * Secret used to authenticate with v1 endpoints.
+   */
+  v1_secret?: string;
+
+  /**
+   * Determines which webhook format will be used, Telnyx API v1, v2, or a legacy
+   * 2010-04-01 format.
+   */
+  webhook_api_version?: '1' | '2' | '2010-04-01';
+
+  /**
+   * The failover URL where webhooks related to this messaging profile will be sent
+   * if sending to the primary URL fails.
+   */
+  webhook_failover_url?: string | null;
+
+  /**
+   * The URL where webhooks related to this messaging profile will be sent.
+   */
+  webhook_url?: string | null;
+
+  /**
+   * Destinations to which the messaging profile is allowed to send. The elements in
+   * the list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
+   * destinations will be allowed.
+   */
+  whitelisted_destinations?: Array<string>;
+}
 
 export interface MessagingProfile {
   /**
@@ -385,6 +550,23 @@ export interface MessagingProfile {
   whitelisted_destinations?: Array<string>;
 }
 
+/**
+ * Telnyx product features the messaging customer can enable on the messaging
+ * profile. Keys map to individual feature flags; unknown keys are accepted and
+ * preserved for forward compatibility with rolling deployments.
+ */
+export interface MessagingProfileFeatures {
+  /**
+   * Enables AI detection of inbound opt-out messages that do not follow the standard
+   * STOP/UNSTOP/HELP opt-out keyword pattern. When enabled, the messaging platform
+   * applies an AI model to identify non-standard opt-out requests (e.g.
+   * natural-language phrases) and treats them as opt-outs.
+   */
+  ai_opt_out_detection_enabled?: boolean;
+
+  [k: string]: unknown;
+}
+
 /**
  * Number Pool allows you to send messages from a pool of numbers of different
  * types, assigning weights to each type. The pool consists of all the long code
@@ -471,19 +653,19 @@ export interface URLShortenerSettings {
 }
 
 export interface MessagingProfileCreateResponse {
-  data?: MessagingProfile;
+  data?: MessagingMessagingProfile;
 }
 
 export interface MessagingProfileRetrieveResponse {
-  data?: MessagingProfile;
+  data?: MessagingMessagingProfile;
 }
 
 export interface MessagingProfileUpdateResponse {
-  data?: MessagingProfile;
+  data?: MessagingMessagingProfile;
 }
 
 export interface MessagingProfileDeleteResponse {
-  data?: MessagingProfile;
+  data?: MessagingMessagingProfile;
 }
 
 export interface MessagingProfileRetrieveMetricsResponse {
@@ -562,6 +744,13 @@ export interface MessagingProfileCreateParams {
    */
   enabled?: boolean;
 
+  /**
+   * Telnyx product features the messaging customer can enable on the messaging
+   * profile. Keys map to individual feature flags; unknown keys are accepted and
+   * preserved for forward compatibility with rolling deployments.
+   */
+  features?: MessagingProfileFeatures | null;
+
   /**
    * A URL to receive health check webhooks for numbers in this profile.
    */
@@ -660,6 +849,13 @@ export interface MessagingProfileUpdateParams {
    */
   enabled?: boolean;
 
+  /**
+   * Telnyx product features the messaging customer can enable on the messaging
+   * profile. Keys map to individual feature flags; unknown keys are accepted and
+   * preserved for forward compatibility with rolling deployments.
+   */
+  features?: MessagingProfileFeatures | null;
+
   /**
    * enables SMS fallback for MMS messages.
    */
@@ -689,6 +885,21 @@ export interface MessagingProfileUpdateParams {
    */
   number_pool_settings?: NumberPoolSettings | null;
 
+  /**
+   * Set to true to enable message content redaction on this profile, or false to
+   * disable it. Ignored if the organization is not on the redaction allowlist. See
+   * the [Message Redaction guide](/docs/messaging/messages/message-redaction) for
+   * what is redacted.
+   */
+  redaction_enabled?: boolean;
+
+  /**
+   * The redaction level to apply when redaction is enabled. 1: redact message
+   * records and reporting only. 2 (default): also redact inbound webhook payloads.
+   * See the [Message Redaction guide](/docs/messaging/messages/message-redaction).
+   */
+  redaction_level?: number;
+
   /**
    * Enables automatic character encoding optimization for SMS messages. When
    * enabled, the system automatically selects the most efficient encoding (GSM-7 or
@@ -757,7 +968,9 @@ MessagingProfiles.Actions = Actions;
 
 export declare namespace MessagingProfiles {
   export {
+    type MessagingMessagingProfile as MessagingMessagingProfile,
     type MessagingProfile as MessagingProfile,
+    type MessagingProfileFeatures as MessagingProfileFeatures,
     type NumberPoolSettings as NumberPoolSettings,
     type URLShortenerSettings as URLShortenerSettings,
     type MessagingProfileCreateResponse as MessagingProfileCreateResponse,
@@ -765,7 +978,7 @@ export declare namespace MessagingProfiles {
     type MessagingProfileUpdateResponse as MessagingProfileUpdateResponse,
     type MessagingProfileDeleteResponse as MessagingProfileDeleteResponse,
     type MessagingProfileRetrieveMetricsResponse as MessagingProfileRetrieveMetricsResponse,
-    type MessagingProfilesDefaultFlatPagination as MessagingProfilesDefaultFlatPagination,
+    type MessagingMessagingProfilesDefaultFlatPagination as MessagingMessagingProfilesDefaultFlatPagination,
     type MessagingProfileListParams as MessagingProfileListParams,
     type MessagingProfileCreateParams as MessagingProfileCreateParams,
     type MessagingProfileUpdateParams as MessagingProfileUpdateParams,

package/src/resources/uac-connections/uac-connections.ts

@@ -247,7 +247,10 @@ export interface UacConnection {
 
   /**
    * The password to be used as part of the credentials. Must be 8 to 128 characters
-   * long.
+   * long. For primary accounts created on or after September 8, 2026, this password
+   * is returned as `********`. The password is returned in full on create, and on
+   * update only when that update changed the password. Accounts created before
+   * September 8, 2026 are unaffected.
    */
   password?: string;
 
@@ -348,7 +351,11 @@ export interface UacExternalSettings {
   outbound_proxy?: string | null;
 
   /**
-   * The SIP password used for digest authentication with the external SIP peer.
+   * The SIP password used for digest authentication with the external SIP peer. For
+   * primary accounts created on or after September 8, 2026, this password is
+   * returned as `********`. The password is returned in full on create, and on
+   * update only when that update changed the password. Accounts created before
+   * September 8, 2026 are unaffected.
    */
   password?: string;
 

package/src/resources/webhooks.ts

@@ -4500,6 +4500,175 @@ export namespace Transcription {
   }
 }
 
+export interface WhatsappAccountUpdate {
+  data: WhatsappAccountUpdate.Data;
+}
+
+export namespace WhatsappAccountUpdate {
+  export interface Data {
+    id: string;
+
+    event_type: 'whatsapp.account.update';
+
+    occurred_at: string;
+
+    payload: Data.Payload;
+
+    record_type: 'event';
+  }
+
+  export namespace Data {
+    export interface Payload {
+      /**
+       * Account event reported by Meta. Coexistence lifecycle values include
+       * `ACCOUNT_OFFBOARDED`, `ACCOUNT_RECONNECTED`, and `PARTNER_REMOVED`. Preserve
+       * unknown values for forward compatibility.
+       */
+      event: string;
+
+      record_type: 'whatsapp_account';
+
+      /**
+       * Meta WhatsApp Business Account identifier.
+       */
+      waba_id: string;
+    }
+  }
+}
+
+export interface WhatsappMessageEcho {
+  data: WhatsappMessageEcho.Data;
+}
+
+export namespace WhatsappMessageEcho {
+  export interface Data {
+    id: string;
+
+    event_type: 'message.echo';
+
+    occurred_at: string;
+
+    payload: Data.Payload;
+
+    record_type: 'event';
+  }
+
+  export namespace Data {
+    export interface Payload {
+      /**
+       * Telnyx identifier for the mirrored message.
+       */
+      id: string;
+
+      /**
+       * Mirrored WhatsApp message content. The content property matches the value of
+       * `type`.
+       */
+      body: Payload.Body;
+
+      /**
+       * No charge is created for a Business app message echo.
+       */
+      cost: Payload.Cost;
+
+      /**
+       * Indicates that the business sent the message to the WhatsApp user.
+       */
+      direction: 'outbound';
+
+      errors: Array<MessagesAPI.MessagingError0b38e7044b>;
+
+      from: Payload.From;
+
+      messaging_profile_id: string;
+
+      organization_id: string;
+
+      /**
+       * Identifies the WhatsApp Business app as the source of the message.
+       */
+      origin: 'whatsapp_business_app';
+
+      record_type: 'message';
+
+      /**
+       * WhatsApp user who received the Business app message.
+       */
+      to: string;
+
+      type: 'WHATSAPP';
+
+      received_at?: string;
+
+      tags?: Array<string>;
+
+      webhook_failover_url?: string | null;
+
+      webhook_url?: string | null;
+    }
+
+    export namespace Payload {
+      /**
+       * Mirrored WhatsApp message content. The content property matches the value of
+       * `type`.
+       */
+      export interface Body {
+        /**
+         * Telnyx identifier for the mirrored message.
+         */
+        id: string;
+
+        /**
+         * Meta WhatsApp message identifier, also known as a wamid.
+         */
+        foreign_id: string;
+
+        /**
+         * Unix timestamp supplied by Meta.
+         */
+        timestamp: string;
+
+        /**
+         * WhatsApp message content type.
+         */
+        type: string;
+
+        /**
+         * WhatsApp user who received the message.
+         */
+        from?: string;
+
+        /**
+         * Opaque recipient identifier when Meta does not supply a phone number.
+         */
+        from_user_id?: string;
+
+        [k: string]: unknown;
+      }
+
+      /**
+       * No charge is created for a Business app message echo.
+       */
+      export interface Cost {
+        amount?: string | null;
+
+        currency?: string | null;
+      }
+
+      export interface From {
+        /**
+         * Coexistence-enabled business phone number in E.164 format.
+         */
+        phone_number: string;
+
+        carrier?: string;
+
+        line_type?: string;
+      }
+    }
+  }
+}
+
 export interface CallAIGatherEndedWebhookEvent {
   data?: CallAIGatherEnded;
 }
@@ -7751,7 +7920,9 @@ export type UnsafeUnwrapWebhookEvent =
   | ReplacedLinkClickWebhookEvent
   | SessionStatusChangedWebhookEvent
   | TranscriptCompletedWebhookEvent
-  | TranscriptionWebhookEvent;
+  | TranscriptionWebhookEvent
+  | WhatsappAccountUpdate
+  | WhatsappMessageEcho;
 
 export type UnwrapWebhookEvent =
   | CallAIGatherEndedWebhookEvent
@@ -7826,7 +7997,9 @@ export type UnwrapWebhookEvent =
   | ReplacedLinkClickWebhookEvent
   | SessionStatusChangedWebhookEvent
   | TranscriptCompletedWebhookEvent
-  | TranscriptionWebhookEvent;
+  | TranscriptionWebhookEvent
+  | WhatsappAccountUpdate
+  | WhatsappMessageEcho;
 
 export declare namespace Webhooks {
   export {
@@ -7891,6 +8064,8 @@ export declare namespace Webhooks {
     type OutboundMessage as OutboundMessage,
     type ReplacedLinkClick as ReplacedLinkClick,
     type Transcription as Transcription,
+    type WhatsappAccountUpdate as WhatsappAccountUpdate,
+    type WhatsappMessageEcho as WhatsappMessageEcho,
     type CallAIGatherEndedWebhookEvent as CallAIGatherEndedWebhookEvent,
     type CallAIGatherMessageHistoryUpdatedWebhookEvent as CallAIGatherMessageHistoryUpdatedWebhookEvent,
     type CallAIGatherPartialResultsWebhookEvent as CallAIGatherPartialResultsWebhookEvent,