telnyx 7.26.0 → 7.28.0

package/resources/messages/messages.d.mts

@@ -21,7 +21,7 @@ export declare class Messages extends APIResource {
      * });
      * ```
      */
-    send(body: MessageSendParams, options?: RequestOptions): APIPromise<MessageSendResponse>;
+    send(params: MessageSendParams, options?: RequestOptions): APIPromise<MessageSendResponse>;
     /**
      * Queues an outbound SMS or MMS using a long-code sender. Delivery progress and
      * final disposition are reported asynchronously through messaging webhooks.
@@ -34,7 +34,7 @@ export declare class Messages extends APIResource {
      * });
      * ```
      */
-    sendLongCode(body: MessageSendLongCodeParams, options?: RequestOptions): APIPromise<MessageSendLongCodeResponse>;
+    sendLongCode(params: MessageSendLongCodeParams, options?: RequestOptions): APIPromise<MessageSendLongCodeResponse>;
     /**
      * Queues an outbound message using a number pool. Telnyx selects an eligible
      * sender from the pool according to its messaging profile configuration.
@@ -48,7 +48,7 @@ export declare class Messages extends APIResource {
      * });
      * ```
      */
-    sendNumberPool(body: MessageSendNumberPoolParams, options?: RequestOptions): APIPromise<MessageSendNumberPoolResponse>;
+    sendNumberPool(params: MessageSendNumberPoolParams, options?: RequestOptions): APIPromise<MessageSendNumberPoolResponse>;
     /**
      * Queues an outbound SMS or MMS using a short-code sender. Delivery progress and
      * final disposition are reported asynchronously through messaging webhooks.
@@ -61,7 +61,7 @@ export declare class Messages extends APIResource {
      * });
      * ```
      */
-    sendShortCode(body: MessageSendShortCodeParams, options?: RequestOptions): APIPromise<MessageSendShortCodeResponse>;
+    sendShortCode(params: MessageSendShortCodeParams, options?: RequestOptions): APIPromise<MessageSendShortCodeResponse>;
     /**
      * Queues an MMS addressed to multiple recipients as a group conversation. Delivery
      * events are reported asynchronously through messaging webhooks.
@@ -74,7 +74,7 @@ export declare class Messages extends APIResource {
      * });
      * ```
      */
-    sendGroupMms(body: MessageSendGroupMmsParams, options?: RequestOptions): APIPromise<MessageSendGroupMmsResponse>;
+    sendGroupMms(params: MessageSendGroupMmsParams, options?: RequestOptions): APIPromise<MessageSendGroupMmsResponse>;
     /**
      * Schedule a message with a Phone Number, Alphanumeric Sender ID, Short Code or
      * Number Pool.
@@ -132,7 +132,7 @@ export declare class Messages extends APIResource {
      *   });
      * ```
      */
-    sendWithAlphanumericSender(body: MessageSendWithAlphanumericSenderParams, options?: RequestOptions): APIPromise<MessageSendWithAlphanumericSenderResponse>;
+    sendWithAlphanumericSender(params: MessageSendWithAlphanumericSenderParams, options?: RequestOptions): APIPromise<MessageSendWithAlphanumericSenderResponse>;
     /**
      * Retrieve all messages in a group MMS conversation by the group message ID.
      *
@@ -160,7 +160,7 @@ export declare class Messages extends APIResource {
      * });
      * ```
      */
-    whatsapp(body: MessageWhatsappParams, options?: RequestOptions): APIPromise<MessageWhatsappResponse>;
+    whatsapp(params: MessageWhatsappParams, options?: RequestOptions): APIPromise<MessageWhatsappResponse>;
 }
 export interface MessagingError0b38e7044b {
     code: string;
@@ -323,9 +323,16 @@ export declare namespace MessagingInboundMessagePayload {
          */
         foreign_id?: string;
         /**
-         * WhatsApp sender in E.164 format.
+         * WhatsApp sender in E.164 format. Empty when the user hides their phone number;
+         * `from_user_id` then identifies the sender.
          */
         from?: string;
+        /**
+         * Business-scoped user ID (BSUID) of the WhatsApp sender when Meta provides one,
+         * for example `US.13491208655302741918`. When `from` is empty, pass this value as
+         * `to` to reply.
+         */
+        from_user_id?: string;
         /**
          * Location shared in an RCS message.
          */
@@ -542,7 +549,8 @@ export interface MessagingOutboundMessagePayload {
      */
     id?: string;
     /**
-     * RCS webhook message body. Text messages use the text property.
+     * Message body for RCS and WhatsApp. RCS text messages use the text property.
+     * WhatsApp messages contain the `whatsapp_message` object from the send request.
      */
     body?: MessagingOutboundMessagePayload.Body;
     cc?: Array<MessagingOutboundMessagePayload.Cc>;
@@ -626,6 +634,15 @@ export interface MessagingOutboundMessagePayload {
      * The registration status of the TCR campaign.
      */
     tcr_campaign_registered?: string | null;
+    /**
+     * Telnyx ID of the WhatsApp template used by the message, when known.
+     */
+    template_id?: string;
+    /**
+     * Name of the WhatsApp template used by the message. Present for WhatsApp template
+     * messages.
+     */
+    template_name?: string;
     /**
      * Message body (i.e., content) as a non-empty string.
      *
@@ -636,7 +653,7 @@ export interface MessagingOutboundMessagePayload {
     /**
      * The type of message.
      */
-    type?: 'SMS' | 'MMS' | 'RCS';
+    type?: 'SMS' | 'MMS' | 'RCS' | 'WHATSAPP';
     /**
      * Message must be out of the queue by this time or else it will be discarded and
      * marked as 'sending_failed'. Once the message moves out of the queue, this field
@@ -661,13 +678,15 @@ export interface MessagingOutboundMessagePayload {
 }
 export declare namespace MessagingOutboundMessagePayload {
     /**
-     * RCS webhook message body. Text messages use the text property.
+     * Message body for RCS and WhatsApp. RCS text messages use the text property.
+     * WhatsApp messages contain the `whatsapp_message` object from the send request.
      */
     interface Body {
         /**
          * RCS text message.
          */
         text?: string;
+        [k: string]: unknown;
     }
     interface Cc {
         /**
@@ -789,7 +808,8 @@ export interface OutboundMessagePayload {
      */
     id?: string;
     /**
-     * RCS webhook message body. Text messages use the text property.
+     * Message body for RCS and WhatsApp. RCS text messages use the text property.
+     * WhatsApp messages contain the `whatsapp_message` object from the send request.
      */
     body?: OutboundMessagePayload.Body;
     cc?: Array<OutboundMessagePayload.Cc>;
@@ -873,6 +893,15 @@ export interface OutboundMessagePayload {
      * The registration status of the TCR campaign.
      */
     tcr_campaign_registered?: string | null;
+    /**
+     * Telnyx ID of the WhatsApp template used by the message, when known.
+     */
+    template_id?: string;
+    /**
+     * Name of the WhatsApp template used by the message. Present for WhatsApp template
+     * messages.
+     */
+    template_name?: string;
     /**
      * Message body (i.e., content) as a non-empty string.
      *
@@ -883,7 +912,7 @@ export interface OutboundMessagePayload {
     /**
      * The type of message.
      */
-    type?: 'SMS' | 'MMS' | 'RCS';
+    type?: 'SMS' | 'MMS' | 'RCS' | 'WHATSAPP';
     /**
      * Message must be out of the queue by this time or else it will be discarded and
      * marked as 'sending_failed'. Once the message moves out of the queue, this field
@@ -908,13 +937,15 @@ export interface OutboundMessagePayload {
 }
 export declare namespace OutboundMessagePayload {
     /**
-     * RCS webhook message body. Text messages use the text property.
+     * Message body for RCS and WhatsApp. RCS text messages use the text property.
+     * WhatsApp messages contain the `whatsapp_message` object from the send request.
      */
     interface Body {
         /**
          * RCS text message.
          */
         text?: string;
+        [k: string]: unknown;
     }
     interface Cc {
         /**
@@ -1875,287 +1906,342 @@ export declare namespace MessageWhatsappResponse {
 }
 export interface MessageSendParams {
     /**
-     * Receiving address (+E.164 formatted phone number or short code).
+     * Body param: Receiving address (+E.164 formatted phone number or short code).
      */
     to: string;
     /**
-     * Automatically detect if an SMS message is unusually long and exceeds a
-     * recommended limit of message parts.
+     * Body param: Automatically detect if an SMS message is unusually long and exceeds
+     * a recommended limit of message parts.
      */
     auto_detect?: boolean;
     /**
-     * Encoding to use for the message. `auto` (default) uses smart encoding to
-     * automatically select the most efficient encoding. `gsm7` forces GSM-7 encoding
-     * (returns 400 if message contains characters that cannot be encoded). `ucs2`
-     * forces UCS-2 encoding and disables smart encoding. When set, this overrides the
-     * messaging profile's `smart_encoding` setting.
+     * Body param: Encoding to use for the message. `auto` (default) uses smart
+     * encoding to automatically select the most efficient encoding. `gsm7` forces
+     * GSM-7 encoding (returns 400 if message contains characters that cannot be
+     * encoded). `ucs2` forces UCS-2 encoding and disables smart encoding. When set,
+     * this overrides the messaging profile's `smart_encoding` setting.
      */
     encoding?: 'auto' | 'gsm7' | 'ucs2';
     /**
-     * Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short
-     * code).
+     * Body param: Sending address (+E.164 formatted phone number, alphanumeric sender
+     * ID, or short code).
      *
      * **Required if sending with a phone number, short code, or alphanumeric sender
      * ID.**
      */
     from?: string;
     /**
-     * A list of media URLs. The total media size must be less than 1 MB.
+     * Body param: A list of media URLs. The total media size must be less than 1 MB.
      *
      * **Required for MMS**
      */
     media_urls?: Array<string>;
     /**
-     * Unique identifier for a messaging profile.
+     * Body param: Unique identifier for a messaging profile.
      *
      * **Required if sending via number pool or with an alphanumeric sender ID.**
      */
     messaging_profile_id?: string;
     /**
-     * ISO 8601 formatted date indicating when to send the message - accurate up till a
-     * minute.
+     * Body param: ISO 8601 formatted date indicating when to send the message -
+     * accurate up till a minute.
      */
     send_at?: string | null;
     /**
-     * Subject of multimedia message
+     * Body param: Subject of multimedia message
      */
     subject?: string;
     /**
-     * Message body (i.e., content) as a non-empty string.
+     * Body param: Message body (i.e., content) as a non-empty string.
      *
      * **Required for SMS**
      */
     text?: string;
     /**
-     * The protocol for sending the message, either SMS or MMS.
+     * Body param: The protocol for sending the message, either SMS or MMS.
      */
     type?: 'SMS' | 'MMS';
     /**
-     * If the profile this number is associated with has webhooks, use them for
-     * delivery notifications. If webhooks are also specified on the message itself,
-     * they will be attempted first, then those on the profile.
+     * Body param: If the profile this number is associated with has webhooks, use them
+     * for delivery notifications. If webhooks are also specified on the message
+     * itself, they will be attempted first, then those on the profile.
      */
     use_profile_webhooks?: boolean;
     /**
-     * The failover URL where webhooks related to this message will be sent if sending
-     * to the primary URL fails.
+     * Body param: The failover URL where webhooks related to this message will be sent
+     * if sending to the primary URL fails.
      */
     webhook_failover_url?: string;
     /**
-     * The URL where webhooks related to this message will be sent.
+     * Body param: The URL where webhooks related to this message will be sent.
      */
     webhook_url?: string;
+    /**
+     * Header param: Optional opaque, unquoted key for safely retrying the same logical
+     * request. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores.
+     * Generate a unique UUID v4 for each operation and reuse it only when retrying
+     * that operation with the same request. Invalid headers—including duplicate,
+     * empty, malformed, or overlong values—return 400 with error code 10015. A request
+     * already in progress with the same key returns 409; reusing the key with a
+     * different request returns 422. Only successful responses are replayed, for up to
+     * 24 hours. Do not include sensitive data in the key.
+     */
+    'Idempotency-Key'?: string;
 }
 export interface MessageSendLongCodeParams {
     /**
-     * Phone number, in +E.164 format, used to send the message.
+     * Body param: Phone number, in +E.164 format, used to send the message.
      */
     from: string;
     /**
-     * Receiving address (+E.164 formatted phone number or short code).
+     * Body param: Receiving address (+E.164 formatted phone number or short code).
      */
     to: string;
     /**
-     * Automatically detect if an SMS message is unusually long and exceeds a
-     * recommended limit of message parts.
+     * Body param: Automatically detect if an SMS message is unusually long and exceeds
+     * a recommended limit of message parts.
      */
     auto_detect?: boolean;
     /**
-     * Encoding to use for the message. `auto` (default) uses smart encoding to
-     * automatically select the most efficient encoding. `gsm7` forces GSM-7 encoding
-     * (returns 400 if message contains characters that cannot be encoded). `ucs2`
-     * forces UCS-2 encoding and disables smart encoding. When set, this overrides the
-     * messaging profile's `smart_encoding` setting.
+     * Body param: Encoding to use for the message. `auto` (default) uses smart
+     * encoding to automatically select the most efficient encoding. `gsm7` forces
+     * GSM-7 encoding (returns 400 if message contains characters that cannot be
+     * encoded). `ucs2` forces UCS-2 encoding and disables smart encoding. When set,
+     * this overrides the messaging profile's `smart_encoding` setting.
      */
     encoding?: 'auto' | 'gsm7' | 'ucs2';
     /**
-     * A list of media URLs. The total media size must be less than 1 MB.
+     * Body param: A list of media URLs. The total media size must be less than 1 MB.
      *
      * **Required for MMS**
      */
     media_urls?: Array<string>;
     /**
-     * Subject of multimedia message
+     * Body param: Subject of multimedia message
      */
     subject?: string;
     /**
-     * Message body (i.e., content) as a non-empty string.
+     * Body param: Message body (i.e., content) as a non-empty string.
      *
      * **Required for SMS**
      */
     text?: string;
     /**
-     * The protocol for sending the message, either SMS or MMS.
+     * Body param: The protocol for sending the message, either SMS or MMS.
      */
     type?: 'SMS' | 'MMS';
     /**
-     * If the profile this number is associated with has webhooks, use them for
-     * delivery notifications. If webhooks are also specified on the message itself,
-     * they will be attempted first, then those on the profile.
+     * Body param: If the profile this number is associated with has webhooks, use them
+     * for delivery notifications. If webhooks are also specified on the message
+     * itself, they will be attempted first, then those on the profile.
      */
     use_profile_webhooks?: boolean;
     /**
-     * The failover URL where webhooks related to this message will be sent if sending
-     * to the primary URL fails.
+     * Body param: The failover URL where webhooks related to this message will be sent
+     * if sending to the primary URL fails.
      */
     webhook_failover_url?: string;
     /**
-     * The URL where webhooks related to this message will be sent.
+     * Body param: The URL where webhooks related to this message will be sent.
      */
     webhook_url?: string;
+    /**
+     * Header param: Optional opaque, unquoted key for safely retrying the same logical
+     * request. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores.
+     * Generate a unique UUID v4 for each operation and reuse it only when retrying
+     * that operation with the same request. Invalid headers—including duplicate,
+     * empty, malformed, or overlong values—return 400 with error code 10015. A request
+     * already in progress with the same key returns 409; reusing the key with a
+     * different request returns 422. Only successful responses are replayed, for up to
+     * 24 hours. Do not include sensitive data in the key.
+     */
+    'Idempotency-Key'?: string;
 }
 export interface MessageSendNumberPoolParams {
     /**
-     * Unique identifier for a messaging profile.
+     * Body param: Unique identifier for a messaging profile.
      */
     messaging_profile_id: string;
     /**
-     * Receiving address (+E.164 formatted phone number or short code).
+     * Body param: Receiving address (+E.164 formatted phone number or short code).
      */
     to: string;
     /**
-     * Automatically detect if an SMS message is unusually long and exceeds a
-     * recommended limit of message parts.
+     * Body param: Automatically detect if an SMS message is unusually long and exceeds
+     * a recommended limit of message parts.
      */
     auto_detect?: boolean;
     /**
-     * Encoding to use for the message. `auto` (default) uses smart encoding to
-     * automatically select the most efficient encoding. `gsm7` forces GSM-7 encoding
-     * (returns 400 if message contains characters that cannot be encoded). `ucs2`
-     * forces UCS-2 encoding and disables smart encoding. When set, this overrides the
-     * messaging profile's `smart_encoding` setting.
+     * Body param: Encoding to use for the message. `auto` (default) uses smart
+     * encoding to automatically select the most efficient encoding. `gsm7` forces
+     * GSM-7 encoding (returns 400 if message contains characters that cannot be
+     * encoded). `ucs2` forces UCS-2 encoding and disables smart encoding. When set,
+     * this overrides the messaging profile's `smart_encoding` setting.
      */
     encoding?: 'auto' | 'gsm7' | 'ucs2';
     /**
-     * A list of media URLs. The total media size must be less than 1 MB.
+     * Body param: A list of media URLs. The total media size must be less than 1 MB.
      *
      * **Required for MMS**
      */
     media_urls?: Array<string>;
     /**
-     * Subject of multimedia message
+     * Body param: Subject of multimedia message
      */
     subject?: string;
     /**
-     * Message body (i.e., content) as a non-empty string.
+     * Body param: Message body (i.e., content) as a non-empty string.
      *
      * **Required for SMS**
      */
     text?: string;
     /**
-     * The protocol for sending the message, either SMS or MMS.
+     * Body param: The protocol for sending the message, either SMS or MMS.
      */
     type?: 'SMS' | 'MMS';
     /**
-     * If the profile this number is associated with has webhooks, use them for
-     * delivery notifications. If webhooks are also specified on the message itself,
-     * they will be attempted first, then those on the profile.
+     * Body param: If the profile this number is associated with has webhooks, use them
+     * for delivery notifications. If webhooks are also specified on the message
+     * itself, they will be attempted first, then those on the profile.
      */
     use_profile_webhooks?: boolean;
     /**
-     * The failover URL where webhooks related to this message will be sent if sending
-     * to the primary URL fails.
+     * Body param: The failover URL where webhooks related to this message will be sent
+     * if sending to the primary URL fails.
      */
     webhook_failover_url?: string;
     /**
-     * The URL where webhooks related to this message will be sent.
+     * Body param: The URL where webhooks related to this message will be sent.
      */
     webhook_url?: string;
+    /**
+     * Header param: Optional opaque, unquoted key for safely retrying the same logical
+     * request. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores.
+     * Generate a unique UUID v4 for each operation and reuse it only when retrying
+     * that operation with the same request. Invalid headers—including duplicate,
+     * empty, malformed, or overlong values—return 400 with error code 10015. A request
+     * already in progress with the same key returns 409; reusing the key with a
+     * different request returns 422. Only successful responses are replayed, for up to
+     * 24 hours. Do not include sensitive data in the key.
+     */
+    'Idempotency-Key'?: string;
 }
 export interface MessageSendShortCodeParams {
     /**
-     * Phone number, in +E.164 format, used to send the message.
+     * Body param: Phone number, in +E.164 format, used to send the message.
      */
     from: string;
     /**
-     * Receiving address (+E.164 formatted phone number or short code).
+     * Body param: Receiving address (+E.164 formatted phone number or short code).
      */
     to: string;
     /**
-     * Automatically detect if an SMS message is unusually long and exceeds a
-     * recommended limit of message parts.
+     * Body param: Automatically detect if an SMS message is unusually long and exceeds
+     * a recommended limit of message parts.
      */
     auto_detect?: boolean;
     /**
-     * Encoding to use for the message. `auto` (default) uses smart encoding to
-     * automatically select the most efficient encoding. `gsm7` forces GSM-7 encoding
-     * (returns 400 if message contains characters that cannot be encoded). `ucs2`
-     * forces UCS-2 encoding and disables smart encoding. When set, this overrides the
-     * messaging profile's `smart_encoding` setting.
+     * Body param: Encoding to use for the message. `auto` (default) uses smart
+     * encoding to automatically select the most efficient encoding. `gsm7` forces
+     * GSM-7 encoding (returns 400 if message contains characters that cannot be
+     * encoded). `ucs2` forces UCS-2 encoding and disables smart encoding. When set,
+     * this overrides the messaging profile's `smart_encoding` setting.
      */
     encoding?: 'auto' | 'gsm7' | 'ucs2';
     /**
-     * A list of media URLs. The total media size must be less than 1 MB.
+     * Body param: A list of media URLs. The total media size must be less than 1 MB.
      *
      * **Required for MMS**
      */
     media_urls?: Array<string>;
     /**
-     * Subject of multimedia message
+     * Body param: Subject of multimedia message
      */
     subject?: string;
     /**
-     * Message body (i.e., content) as a non-empty string.
+     * Body param: Message body (i.e., content) as a non-empty string.
      *
      * **Required for SMS**
      */
     text?: string;
     /**
-     * The protocol for sending the message, either SMS or MMS.
+     * Body param: The protocol for sending the message, either SMS or MMS.
      */
     type?: 'SMS' | 'MMS';
     /**
-     * If the profile this number is associated with has webhooks, use them for
-     * delivery notifications. If webhooks are also specified on the message itself,
-     * they will be attempted first, then those on the profile.
+     * Body param: If the profile this number is associated with has webhooks, use them
+     * for delivery notifications. If webhooks are also specified on the message
+     * itself, they will be attempted first, then those on the profile.
      */
     use_profile_webhooks?: boolean;
     /**
-     * The failover URL where webhooks related to this message will be sent if sending
-     * to the primary URL fails.
+     * Body param: The failover URL where webhooks related to this message will be sent
+     * if sending to the primary URL fails.
      */
     webhook_failover_url?: string;
     /**
-     * The URL where webhooks related to this message will be sent.
+     * Body param: The URL where webhooks related to this message will be sent.
      */
     webhook_url?: string;
+    /**
+     * Header param: Optional opaque, unquoted key for safely retrying the same logical
+     * request. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores.
+     * Generate a unique UUID v4 for each operation and reuse it only when retrying
+     * that operation with the same request. Invalid headers—including duplicate,
+     * empty, malformed, or overlong values—return 400 with error code 10015. A request
+     * already in progress with the same key returns 409; reusing the key with a
+     * different request returns 422. Only successful responses are replayed, for up to
+     * 24 hours. Do not include sensitive data in the key.
+     */
+    'Idempotency-Key'?: string;
 }
 export interface MessageSendGroupMmsParams {
     /**
-     * Phone number, in +E.164 format, used to send the message.
+     * Body param: Phone number, in +E.164 format, used to send the message.
      */
     from: string;
     /**
-     * A list of destinations. No more than 8 destinations are allowed.
+     * Body param: A list of destinations. No more than 8 destinations are allowed.
      */
     to: Array<string>;
     /**
-     * A list of media URLs. The total media size must be less than 1 MB.
+     * Body param: A list of media URLs. The total media size must be less than 1 MB.
      */
     media_urls?: Array<string>;
     /**
-     * Subject of multimedia message
+     * Body param: Subject of multimedia message
      */
     subject?: string;
     /**
-     * Message body (i.e., content) as a non-empty string.
+     * Body param: Message body (i.e., content) as a non-empty string.
      */
     text?: string;
     /**
-     * If the profile this number is associated with has webhooks, use them for
-     * delivery notifications. If webhooks are also specified on the message itself,
-     * they will be attempted first, then those on the profile.
+     * Body param: If the profile this number is associated with has webhooks, use them
+     * for delivery notifications. If webhooks are also specified on the message
+     * itself, they will be attempted first, then those on the profile.
      */
     use_profile_webhooks?: boolean;
     /**
-     * The failover URL where webhooks related to this message will be sent if sending
-     * to the primary URL fails.
+     * Body param: The failover URL where webhooks related to this message will be sent
+     * if sending to the primary URL fails.
      */
     webhook_failover_url?: string;
     /**
-     * The URL where webhooks related to this message will be sent.
+     * Body param: The URL where webhooks related to this message will be sent.
      */
     webhook_url?: string;
+    /**
+     * Header param: Optional opaque, unquoted key for safely retrying the same logical
+     * request. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores.
+     * Generate a unique UUID v4 for each operation and reuse it only when retrying
+     * that operation with the same request. Invalid headers—including duplicate,
+     * empty, malformed, or overlong values—return 400 with error code 10015. A request
+     * already in progress with the same key returns 409; reusing the key with a
+     * different request returns 422. Only successful responses are replayed, for up to
+     * 24 hours. Do not include sensitive data in the key.
+     */
+    'Idempotency-Key'?: string;
 }
 export interface MessageScheduleParams {
     /**
@@ -2224,56 +2310,433 @@ export interface MessageScheduleParams {
 }
 export interface MessageSendWithAlphanumericSenderParams {
     /**
-     * A valid alphanumeric sender ID on the user's account.
+     * Body param: A valid alphanumeric sender ID on the user's account.
      */
     from: string;
     /**
-     * The messaging profile ID to use.
+     * Body param: The messaging profile ID to use.
      */
     messaging_profile_id: string;
     /**
-     * The message body.
+     * Body param: The message body.
      */
     text: string;
     /**
-     * Receiving address (+E.164 formatted phone number).
+     * Body param: Receiving address (+E.164 formatted phone number).
      */
     to: string;
     /**
-     * If true, use the messaging profile's webhook settings.
+     * Body param: If true, use the messaging profile's webhook settings.
      */
     use_profile_webhooks?: boolean;
     /**
-     * Failover callback URL for delivery status updates.
+     * Body param: Failover callback URL for delivery status updates.
      */
     webhook_failover_url?: string | null;
     /**
-     * Callback URL for delivery status updates.
+     * Body param: Callback URL for delivery status updates.
      */
     webhook_url?: string | null;
+    /**
+     * Header param: Optional opaque, unquoted key for safely retrying the same logical
+     * request. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores.
+     * Generate a unique UUID v4 for each operation and reuse it only when retrying
+     * that operation with the same request. Invalid headers—including duplicate,
+     * empty, malformed, or overlong values—return 400 with error code 10015. A request
+     * already in progress with the same key returns 409; reusing the key with a
+     * different request returns 422. Only successful responses are replayed, for up to
+     * 24 hours. Do not include sensitive data in the key.
+     */
+    'Idempotency-Key'?: string;
 }
 export interface MessageWhatsappParams {
     /**
-     * Phone number in +E.164 format associated with Whatsapp account
+     * Body param: Phone number in +E.164 format associated with Whatsapp account
      */
     from: string;
     /**
-     * Phone number in +E.164 format
+     * Body param: Recipient phone number in +E.164 format, or the business-scoped user
+     * ID (BSUID) of a WhatsApp user who hides their phone number, for example
+     * `US.13491208655302741918`. Authentication templates cannot be sent to a BSUID.
      */
     to: string;
-    whatsapp_message: WhatsappMessageContent;
     /**
-     * Messaging profile ID - required if the 'from' number is not SMS-enabled
+     * Body param
+     */
+    whatsapp_message: MessageWhatsappParams.WhatsappMessage;
+    /**
+     * Body param: Messaging profile ID - required if the 'from' number is not
+     * SMS-enabled
      */
     messaging_profile_id?: string;
     /**
-     * Message type - must be set to "WHATSAPP"
+     * Body param: Message type - must be set to "WHATSAPP"
      */
     type?: 'WHATSAPP';
     /**
-     * The URL where webhooks related to this message will be sent.
+     * Body param: The URL where webhooks related to this message will be sent.
      */
     webhook_url?: string;
+    /**
+     * Header param: Optional opaque, unquoted key for safely retrying the same logical
+     * request. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores.
+     * Generate a unique UUID v4 for each operation and reuse it only when retrying
+     * that operation with the same request. Invalid headers—including duplicate,
+     * empty, malformed, or overlong values—return 400 with error code 10015. A request
+     * already in progress with the same key returns 409; reusing the key with a
+     * different request returns 422. Only successful responses are replayed, for up to
+     * 24 hours. Do not include sensitive data in the key.
+     */
+    'Idempotency-Key'?: string;
+}
+export declare namespace MessageWhatsappParams {
+    interface WhatsappMessage {
+        audio?: MessagesAPI.WhatsappMedia;
+        /**
+         * custom data to return with status update
+         */
+        biz_opaque_callback_data?: string;
+        contacts?: Array<WhatsappMessage.Contact>;
+        document?: MessagesAPI.WhatsappMedia;
+        image?: MessagesAPI.WhatsappMedia;
+        interactive?: WhatsappMessage.Interactive;
+        location?: MessagesAPI.WhatsappLocation;
+        reaction?: MessagesAPI.WhatsappReaction;
+        sticker?: MessagesAPI.WhatsappMedia;
+        /**
+         * Template message object. Provide either template_id or name + language to
+         * identify the template.
+         */
+        template?: WhatsappMessage.Template;
+        /**
+         * Text message content. Can only be sent within a 24-hour customer service window.
+         */
+        text?: WhatsappMessage.Text;
+        type?: 'audio' | 'document' | 'image' | 'sticker' | 'video' | 'interactive' | 'location' | 'template' | 'reaction' | 'contacts' | 'text';
+        video?: MessagesAPI.WhatsappMedia;
+    }
+    namespace WhatsappMessage {
+        interface Contact {
+            addresses?: Array<Contact.Address>;
+            birthday?: string;
+            emails?: Array<Contact.Email>;
+            name?: Contact.Name;
+            org?: Contact.Org;
+            phones?: Array<Contact.Phone>;
+            urls?: Array<Contact.URL>;
+        }
+        namespace Contact {
+            interface Address {
+                city?: string;
+                country?: string;
+                country_code?: string;
+                state?: string;
+                street?: string;
+                type?: string;
+                zip?: string;
+            }
+            interface Email {
+                email?: string;
+                type?: string;
+            }
+            interface Name {
+                /**
+                 * contact's full name as displayed in the message
+                 */
+                formatted_name: string;
+                first_name?: string;
+                last_name?: string;
+                middle_name?: string;
+                prefix?: string;
+                suffix?: string;
+            }
+            interface Org {
+                company?: string;
+                department?: string;
+                title?: string;
+            }
+            interface Phone {
+                phone?: string;
+                type?: string;
+                wa_id?: string;
+            }
+            interface URL {
+                type?: string;
+                url?: string;
+            }
+        }
+        interface Interactive {
+            action?: Interactive.Action;
+            body?: Interactive.Body;
+            footer?: Interactive.Footer;
+            header?: Interactive.Header;
+            type?: 'cta_url' | 'list' | 'carousel' | 'button' | 'location_request_message' | 'flow';
+        }
+        namespace Interactive {
+            interface Action {
+                button?: string;
+                buttons?: Array<Action.Button>;
+                cards?: Array<Action.Card>;
+                catalog_id?: string;
+                mode?: string;
+                name?: string;
+                parameters?: Action.Parameters;
+                product_retailer_id?: string;
+                sections?: Array<Action.Section>;
+            }
+            namespace Action {
+                interface Button {
+                    reply?: Button.Reply;
+                    type?: 'reply';
+                }
+                namespace Button {
+                    interface Reply {
+                        /**
+                         * unique identifier for each button, 256 character maximum
+                         */
+                        id?: string;
+                        /**
+                         * button label, 20 character maximum
+                         */
+                        title?: string;
+                    }
+                }
+                interface Card {
+                    action?: Card.Action;
+                    body?: Card.Body;
+                    /**
+                     * unique index for each card (0-9)
+                     */
+                    card_index?: number;
+                    header?: Card.Header;
+                    type?: 'cta_url';
+                }
+                namespace Card {
+                    interface Action {
+                        /**
+                         * the unique ID of the catalog
+                         */
+                        catalog_id?: string;
+                        /**
+                         * the unique retailer ID of the product
+                         */
+                        product_retailer_id?: string;
+                    }
+                    interface Body {
+                        /**
+                         * 160 character maximum, up to 2 line breaks
+                         */
+                        text?: string;
+                    }
+                    interface Header {
+                        image?: MessagesAPI.WhatsappMedia;
+                        type?: 'image' | 'video';
+                        video?: MessagesAPI.WhatsappMedia;
+                    }
+                }
+                interface Parameters {
+                    /**
+                     * button label text, 20 character maximum
+                     */
+                    display_text?: string;
+                    /**
+                     * how the flow starts. navigate opens the screen in flow_action_payload;
+                     * data_exchange requests the first screen from the business's flow endpoint.
+                     * Defaults to navigate
+                     */
+                    flow_action?: 'navigate' | 'data_exchange';
+                    /**
+                     * optional initial screen and data. When omitted, the flow opens on its first
+                     * entry screen. Must be omitted when flow_action is data_exchange
+                     */
+                    flow_action_payload?: Parameters.FlowActionPayload;
+                    /**
+                     * text of the button that opens the flow, 1-20 characters, no emoji. Required for
+                     * flow messages
+                     */
+                    flow_cta?: string;
+                    /**
+                     * ID of the flow to open. Provide exactly one of flow_id or flow_name
+                     */
+                    flow_id?: string;
+                    /**
+                     * flow message version, must be 3. Required for flow messages
+                     */
+                    flow_message_version?: string;
+                    /**
+                     * name of the flow to open. Provide exactly one of flow_id or flow_name
+                     */
+                    flow_name?: string;
+                    /**
+                     * business-generated identifier for the flow session. Returned in the flow
+                     * response for correlation
+                     */
+                    flow_token?: string;
+                    /**
+                     * use draft to test an unpublished flow. Defaults to published
+                     */
+                    mode?: 'draft' | 'published';
+                    /**
+                     * button URL to load when tapped by the user
+                     */
+                    url?: string;
+                }
+                namespace Parameters {
+                    /**
+                     * optional initial screen and data. When omitted, the flow opens on its first
+                     * entry screen. Must be omitted when flow_action is data_exchange
+                     */
+                    interface FlowActionPayload {
+                        /**
+                         * input data for the first screen. Must be a non-empty object when provided
+                         */
+                        data?: unknown;
+                        /**
+                         * ID of the first screen to show
+                         */
+                        screen?: string;
+                    }
+                }
+                interface Section {
+                    product_items?: Array<Section.ProductItem>;
+                    rows?: Array<Section.Row>;
+                    /**
+                     * section title, 24 character maximum
+                     */
+                    title?: string;
+                }
+                namespace Section {
+                    interface ProductItem {
+                        product_retailer_id?: string;
+                    }
+                    interface Row {
+                        /**
+                         * arbitrary string identifying the row, 200 character maximum
+                         */
+                        id?: string;
+                        /**
+                         * row description, 72 character maximum
+                         */
+                        description?: string;
+                        /**
+                         * row title, 24 character maximum
+                         */
+                        title?: string;
+                    }
+                }
+            }
+            interface Body {
+                /**
+                 * body text, 1024 character maximum
+                 */
+                text?: string;
+            }
+            interface Footer {
+                /**
+                 * footer text, 60 character maximum
+                 */
+                text?: string;
+            }
+            interface Header {
+                /**
+                 * header type. Required when a header is provided; the matching document, image,
+                 * text, or video field must be set
+                 */
+                type: 'document' | 'image' | 'text' | 'video';
+                document?: MessagesAPI.WhatsappMedia;
+                image?: MessagesAPI.WhatsappMedia;
+                sub_text?: string;
+                /**
+                 * header text, 60 character maximum
+                 */
+                text?: string;
+                video?: MessagesAPI.WhatsappMedia;
+            }
+        }
+        /**
+         * Template message object. Provide either template_id or name + language to
+         * identify the template.
+         */
+        interface Template {
+            /**
+             * Template parameter values for header, body, and button components.
+             */
+            components?: Array<Template.Component>;
+            /**
+             * Template language. Required unless template_id is provided.
+             */
+            language?: Template.Language;
+            /**
+             * Template name as registered with Meta. Required unless template_id is provided.
+             */
+            name?: string;
+            /**
+             * Telnyx template ID (the id field from template list/get responses). When
+             * provided, name and language are resolved automatically.
+             */
+            template_id?: string;
+        }
+        namespace Template {
+            interface Component {
+                /**
+                 * Button index (required for button components)
+                 */
+                index?: number;
+                parameters?: Array<Component.Parameter>;
+                sub_type?: 'quick_reply' | 'url' | 'flow';
+                type?: 'header' | 'body' | 'button';
+            }
+            namespace Component {
+                interface Parameter {
+                    /**
+                     * Flow button parameters. Used with type action on a flow button component
+                     */
+                    action?: Parameter.Action;
+                    text?: string;
+                    type?: 'text' | 'image' | 'video' | 'document' | 'currency' | 'date_time' | 'action';
+                }
+                namespace Parameter {
+                    /**
+                     * Flow button parameters. Used with type action on a flow button component
+                     */
+                    interface Action {
+                        /**
+                         * input data for the first screen of the flow
+                         */
+                        flow_action_data?: unknown;
+                        /**
+                         * business-generated identifier for the flow session. Returned in the flow
+                         * response for correlation
+                         */
+                        flow_token?: string;
+                    }
+                }
+            }
+            /**
+             * Template language. Required unless template_id is provided.
+             */
+            interface Language {
+                /**
+                 * Language code (e.g. en_US)
+                 */
+                code: string;
+                policy?: string;
+            }
+        }
+        /**
+         * Text message content. Can only be sent within a 24-hour customer service window.
+         */
+        interface Text {
+            /**
+             * The text message body.
+             */
+            body: string;
+            /**
+             * Whether to show a URL preview in the message.
+             */
+            preview_url?: boolean;
+        }
+    }
 }
 export declare namespace Messages {
     export { type MessagingError0b38e7044b as MessagingError0b38e7044b, type MessagingInboundMessagePayload as MessagingInboundMessagePayload, type MessagingOutboundMessagePayload as MessagingOutboundMessagePayload, type OutboundMessagePayload as OutboundMessagePayload, type RcsAgentMessage as RcsAgentMessage, type RcsCardContent as RcsCardContent, type RcsContentInfo as RcsContentInfo, type RcsSuggestion as RcsSuggestion, type RcsToItem as RcsToItem, type WhatsappContact as WhatsappContact, type WhatsappInteractive as WhatsappInteractive, type WhatsappLocation as WhatsappLocation, type WhatsappMedia as WhatsappMedia, type WhatsappMessageContent as WhatsappMessageContent, type WhatsappReaction as WhatsappReaction, type MessageRetrieveResponse as MessageRetrieveResponse, type MessageCancelScheduledResponse as MessageCancelScheduledResponse, type MessageRetrieveGroupMessagesResponse as MessageRetrieveGroupMessagesResponse, type MessageScheduleResponse as MessageScheduleResponse, type MessageSendResponse as MessageSendResponse, type MessageSendGroupMmsResponse as MessageSendGroupMmsResponse, type MessageSendLongCodeResponse as MessageSendLongCodeResponse, type MessageSendNumberPoolResponse as MessageSendNumberPoolResponse, type MessageSendShortCodeResponse as MessageSendShortCodeResponse, type MessageSendWithAlphanumericSenderResponse as MessageSendWithAlphanumericSenderResponse, type MessageWhatsappResponse as MessageWhatsappResponse, type MessageSendParams as MessageSendParams, type MessageSendLongCodeParams as MessageSendLongCodeParams, type MessageSendNumberPoolParams as MessageSendNumberPoolParams, type MessageSendShortCodeParams as MessageSendShortCodeParams, type MessageSendGroupMmsParams as MessageSendGroupMmsParams, type MessageScheduleParams as MessageScheduleParams, type MessageSendWithAlphanumericSenderParams as MessageSendWithAlphanumericSenderParams, type MessageWhatsappParams as MessageWhatsappParams, };