telnyx 7.21.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/index.ts

@@ -18,6 +18,7 @@ export {
   MessagingProfiles,
   type MessagingMessagingProfile,
   type MessagingProfile,
+  type MessagingProfileFeatures,
   type NumberPoolSettings,
   type URLShortenerSettings,
   type MessagingProfileCreateResponse,

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

@@ -273,6 +273,13 @@ export interface MessagingMessagingProfile {
    */
   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
    */
@@ -543,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
@@ -720,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.
    */
@@ -818,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.
    */
@@ -932,6 +970,7 @@ 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,

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,

package/src/resources/whatsapp/business-accounts/phone-numbers.ts

@@ -72,12 +72,34 @@ export type PhoneNumberListResponsesDefaultFlatPagination = DefaultFlatPaginatio
 export interface PhoneNumberListResponse {
   calling_enabled?: boolean;
 
+  /**
+   * Current lifecycle state for a coexistence number. This is null for a standard
+   * Cloud API number.
+   */
+  coexistence_state?:
+    | 'pending_onboarding'
+    | 'sync_pending'
+    | 'syncing'
+    | 'sync_complete'
+    | 'active'
+    | 'history_declined'
+    | 'sync_deadline_expired'
+    | 'offboarded'
+    | 'disconnected'
+    | null;
+
   created_at?: string;
 
   display_name?: string;
 
   enabled?: boolean;
 
+  /**
+   * Indicates whether the number is connected to both the WhatsApp Business app and
+   * Cloud API through WhatsApp Coexistence.
+   */
+  is_on_biz_app?: boolean;
+
   /**
    * Phone number in E164 format
    */
@@ -97,6 +119,18 @@ export interface PhoneNumberListResponse {
 
   status?: string;
 
+  /**
+   * Deadline for initiating the current coexistence synchronization cycle. This is
+   * null when no deadline applies.
+   */
+  sync_deadline?: string | null;
+
+  /**
+   * Synchronization progress. This object is returned only while a coexistence
+   * number is synchronizing.
+   */
+  sync_progress?: PhoneNumberListResponse.SyncProgress | null;
+
   /**
    * User ID
    */
@@ -108,6 +142,24 @@ export interface PhoneNumberListResponse {
   waba_id?: string;
 }
 
+export namespace PhoneNumberListResponse {
+  /**
+   * Synchronization progress. This object is returned only while a coexistence
+   * number is synchronizing.
+   */
+  export interface SyncProgress {
+    contacts_status?: string;
+
+    history_chunk_order?: number | null;
+
+    history_phase?: number | null;
+
+    history_progress?: number | null;
+
+    history_status?: string;
+  }
+}
+
 export interface PhoneNumberListParams extends DefaultFlatPaginationParams {}
 
 export interface PhoneNumberInitializeVerificationParams {

package/src/resources/whatsapp/index.ts

@@ -12,6 +12,7 @@ export {
   type PhoneNumberListResponse,
   type PhoneNumberGetResponse,
   type PhoneNumberRetrieveConversationWindowResponse,
+  type PhoneNumberRetrievePhoneNumberResponse,
   type PhoneNumberListParams,
   type PhoneNumberResendVerificationParams,
   type PhoneNumberVerifyParams,

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

@@ -19,6 +19,7 @@ export {
   type PhoneNumberListResponse,
   type PhoneNumberGetResponse,
   type PhoneNumberRetrieveConversationWindowResponse,
+  type PhoneNumberRetrievePhoneNumberResponse,
   type PhoneNumberListParams,
   type PhoneNumberResendVerificationParams,
   type PhoneNumberVerifyParams,