telnyx 7.13.0 → 7.14.0

package/resources/messages/messages.d.ts

@@ -5,9 +5,6 @@ import * as RcsAPI from "./rcs.js";
 import { RcGenerateDeeplinkParams, RcGenerateDeeplinkResponse, RcSendParams, RcSendResponse, Rcs } from "./rcs.js";
 import { APIPromise } from "../../core/api-promise.js";
 import { RequestOptions } from "../../internal/request-options.js";
-/**
- * Messages
- */
 export declare class Messages extends APIResource {
     rcs: RcsAPI.Rcs;
     /**
@@ -27,7 +24,8 @@ export declare class Messages extends APIResource {
      */
     send(body: MessageSendParams, options?: RequestOptions): APIPromise<MessageSendResponse>;
     /**
-     * Send a long code message
+     * Queues an outbound SMS or MMS using a long-code sender. Delivery progress and
+     * final disposition are reported asynchronously through messaging webhooks.
      *
      * @example
      * ```ts
@@ -39,7 +37,8 @@ export declare class Messages extends APIResource {
      */
     sendLongCode(body: MessageSendLongCodeParams, options?: RequestOptions): APIPromise<MessageSendLongCodeResponse>;
     /**
-     * Send a message using number pool
+     * Queues an outbound message using a number pool. Telnyx selects an eligible
+     * sender from the pool according to its messaging profile configuration.
      *
      * @example
      * ```ts
@@ -52,7 +51,8 @@ export declare class Messages extends APIResource {
      */
     sendNumberPool(body: MessageSendNumberPoolParams, options?: RequestOptions): APIPromise<MessageSendNumberPoolResponse>;
     /**
-     * Send a short code message
+     * Queues an outbound SMS or MMS using a short-code sender. Delivery progress and
+     * final disposition are reported asynchronously through messaging webhooks.
      *
      * @example
      * ```ts
@@ -64,7 +64,8 @@ export declare class Messages extends APIResource {
      */
     sendShortCode(body: MessageSendShortCodeParams, options?: RequestOptions): APIPromise<MessageSendShortCodeResponse>;
     /**
-     * Send a group MMS message
+     * Queues an MMS addressed to multiple recipients as a group conversation. Delivery
+     * events are reported asynchronously through messaging webhooks.
      *
      * @example
      * ```ts
@@ -145,6 +146,267 @@ export declare class Messages extends APIResource {
      * ```
      */
     retrieveGroupMessages(messageID: string, options?: RequestOptions): APIPromise<MessageRetrieveGroupMessagesResponse>;
+    /**
+     * Sends a WhatsApp message using a Telnyx WhatsApp-enabled number. The message
+     * body, interactive elements, media, location, and reaction content are specified
+     * in the `whatsapp_message` field. Delivery progress and final disposition are
+     * reported asynchronously through messaging webhooks.
+     *
+     * @example
+     * ```ts
+     * const response = await client.messages.whatsapp({
+     *   from: '+13125551234',
+     *   to: '+13125551234',
+     *   whatsapp_message: {},
+     * });
+     * ```
+     */
+    whatsapp(body: MessageWhatsappParams, options?: RequestOptions): APIPromise<MessageWhatsappResponse>;
+}
+export interface MessagingError0b38e7044b {
+    code: string;
+    title: string;
+    detail?: string;
+    meta?: unknown;
+    source?: MessagingError0b38e7044b.Source;
+}
+export declare namespace MessagingError0b38e7044b {
+    interface Source {
+        /**
+         * Indicates which query parameter caused the error.
+         */
+        parameter?: string;
+        /**
+         * JSON pointer (RFC6901) to the offending entity.
+         */
+        pointer?: string;
+    }
+}
+export interface MessagingOutboundMessagePayload {
+    /**
+     * Identifies the type of resource.
+     */
+    id?: string;
+    cc?: Array<MessagingOutboundMessagePayload.Cc>;
+    /**
+     * ISO 8601 formatted date indicating when the message was finalized.
+     */
+    completed_at?: string | null;
+    cost?: MessagingOutboundMessagePayload.Cost | null;
+    /**
+     * Detailed breakdown of the message cost components.
+     */
+    cost_breakdown?: MessagingOutboundMessagePayload.CostBreakdown | null;
+    /**
+     * The direction of the message. Inbound messages are sent to you whereas outbound
+     * messages are sent from you.
+     */
+    direction?: 'outbound';
+    /**
+     * Encoding scheme used for the message body.
+     */
+    encoding?: string;
+    /**
+     * These errors may point at addressees when referring to unsuccessful/unconfirmed
+     * delivery statuses.
+     */
+    errors?: Array<MessagingError0b38e7044b>;
+    from?: MessagingOutboundMessagePayload.From;
+    media?: Array<MessagingOutboundMessagePayload.Media>;
+    /**
+     * Unique identifier for a messaging profile.
+     */
+    messaging_profile_id?: string;
+    /**
+     * The number of characters in the message text
+     */
+    num_chars?: number;
+    /**
+     * The id of the organization the messaging profile belongs to.
+     */
+    organization_id?: string;
+    /**
+     * Number of parts into which the message's body must be split.
+     */
+    parts?: number;
+    /**
+     * ISO 8601 formatted date indicating when the message request was received.
+     */
+    received_at?: string;
+    /**
+     * Identifies the type of the resource.
+     */
+    record_type?: 'message';
+    /**
+     * ISO 8601 formatted date indicating when the message was sent.
+     */
+    sent_at?: string | null;
+    /**
+     * Indicates whether smart encoding was applied to this message. When `true`, one
+     * or more Unicode characters were automatically replaced with GSM-7 equivalents to
+     * reduce segment count and cost. The original message text is preserved in
+     * webhooks.
+     */
+    smart_encoding_applied?: boolean;
+    /**
+     * Subject of multimedia message
+     */
+    subject?: string | null;
+    /**
+     * Tags associated with the resource.
+     */
+    tags?: Array<string>;
+    /**
+     * Indicates whether the TCR campaign is billable.
+     */
+    tcr_campaign_billable?: boolean;
+    /**
+     * The Campaign Registry (TCR) campaign ID associated with the message.
+     */
+    tcr_campaign_id?: string | null;
+    /**
+     * The registration status of the TCR campaign.
+     */
+    tcr_campaign_registered?: string | null;
+    /**
+     * Message body (i.e., content) as a non-empty string.
+     *
+     * **Required for SMS**
+     */
+    text?: string;
+    to?: Array<MessagingOutboundMessagePayload.To>;
+    /**
+     * The type of message.
+     */
+    type?: 'SMS' | 'MMS';
+    /**
+     * 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
+     * will be nulled
+     */
+    valid_until?: string | null;
+    /**
+     * Seconds the message is queued due to rate limiting before being sent to the
+     * carrier. Represents the maximum wait across all applicable rate limits (account,
+     * carrier, campaign). 0.0 = no queuing delay.
+     */
+    wait_seconds?: number | null;
+    /**
+     * The failover URL where webhooks related to this message will be sent if sending
+     * to the primary URL fails.
+     */
+    webhook_failover_url?: string | null;
+    /**
+     * The URL where webhooks related to this message will be sent.
+     */
+    webhook_url?: string | null;
+}
+export declare namespace MessagingOutboundMessagePayload {
+    interface Cc {
+        /**
+         * The carrier of the receiver.
+         */
+        carrier?: string;
+        /**
+         * The line-type of the receiver.
+         */
+        line_type?: 'Wireline' | 'Wireless' | 'VoWiFi' | 'VoIP' | 'Pre-Paid Wireless' | '';
+        /**
+         * Receiving address (+E.164 formatted phone number or short code).
+         */
+        phone_number?: string;
+        status?: 'queued' | 'sending' | 'sent' | 'delivered' | 'sending_failed' | 'delivery_failed' | 'delivery_unconfirmed';
+    }
+    interface Cost {
+        /**
+         * The amount deducted from your account.
+         */
+        amount?: string;
+        /**
+         * The ISO 4217 currency identifier.
+         */
+        currency?: string;
+    }
+    /**
+     * Detailed breakdown of the message cost components.
+     */
+    interface CostBreakdown {
+        carrier_fee?: CostBreakdown.CarrierFee;
+        rate?: CostBreakdown.Rate;
+    }
+    namespace CostBreakdown {
+        interface CarrierFee {
+            /**
+             * The carrier fee amount.
+             */
+            amount?: string;
+            /**
+             * The ISO 4217 currency identifier.
+             */
+            currency?: string;
+        }
+        interface Rate {
+            /**
+             * The rate amount applied.
+             */
+            amount?: string;
+            /**
+             * The ISO 4217 currency identifier.
+             */
+            currency?: string;
+        }
+    }
+    interface From {
+        /**
+         * The carrier of the receiver.
+         */
+        carrier?: string;
+        /**
+         * The line-type of the receiver.
+         */
+        line_type?: 'Wireline' | 'Wireless' | 'VoWiFi' | 'VoIP' | 'Pre-Paid Wireless' | '';
+        /**
+         * Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short
+         * code).
+         */
+        phone_number?: string;
+    }
+    interface Media {
+        /**
+         * The MIME type of the requested media.
+         */
+        content_type?: string | null;
+        /**
+         * The SHA256 hash of the requested media.
+         */
+        sha256?: string | null;
+        /**
+         * The size of the requested media.
+         */
+        size?: number | null;
+        /**
+         * The url of the media requested to be sent.
+         */
+        url?: string;
+    }
+    interface To {
+        /**
+         * The carrier of the receiver.
+         */
+        carrier?: string;
+        /**
+         * The line-type of the receiver.
+         */
+        line_type?: 'Wireline' | 'Wireless' | 'VoWiFi' | 'VoIP' | 'Pre-Paid Wireless' | '';
+        /**
+         * Receiving address (+E.164 formatted phone number or short code).
+         */
+        phone_number?: string;
+        /**
+         * The delivery status of the message.
+         */
+        status?: 'queued' | 'sending' | 'sent' | 'expired' | 'sending_failed' | 'delivery_unconfirmed' | 'delivered' | 'delivery_failed';
+    }
 }
 export interface OutboundMessagePayload {
     /**
@@ -921,7 +1183,218 @@ export interface WhatsappReaction {
     message_id?: string;
 }
 export interface MessageRetrieveResponse {
-    data?: OutboundMessagePayload | Shared.InboundMessagePayload;
+    data?: MessagingOutboundMessagePayload | MessageRetrieveResponse.Inbound;
+}
+export declare namespace MessageRetrieveResponse {
+    interface Inbound {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        cc?: Array<Inbound.Cc>;
+        /**
+         * Not used for inbound messages.
+         */
+        completed_at?: string | null;
+        cost?: Inbound.Cost | null;
+        /**
+         * Detailed breakdown of the message cost components.
+         */
+        cost_breakdown?: Inbound.CostBreakdown | null;
+        /**
+         * The direction of the message. Inbound messages are sent to you whereas outbound
+         * messages are sent from you.
+         */
+        direction?: 'inbound';
+        /**
+         * Encoding scheme used for the message body.
+         */
+        encoding?: string;
+        /**
+         * These errors may point at addressees when referring to unsuccessful/unconfirmed
+         * delivery statuses.
+         */
+        errors?: Array<MessagesAPI.MessagingError0b38e7044b>;
+        from?: Inbound.From;
+        media?: Array<Inbound.Media>;
+        /**
+         * Unique identifier for a messaging profile.
+         */
+        messaging_profile_id?: string;
+        /**
+         * The number of characters in the message text
+         */
+        num_chars?: number;
+        /**
+         * Unique identifier for a messaging profile.
+         */
+        organization_id?: string;
+        /**
+         * Number of parts into which the message's body must be split.
+         */
+        parts?: number;
+        /**
+         * ISO 8601 formatted date indicating when the message request was received.
+         */
+        received_at?: string;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'message';
+        /**
+         * Not used for inbound messages.
+         */
+        sent_at?: string | null;
+        /**
+         * Message subject.
+         */
+        subject?: string | null;
+        /**
+         * Tags associated with the resource.
+         */
+        tags?: Array<string>;
+        /**
+         * Indicates whether the TCR campaign is billable.
+         */
+        tcr_campaign_billable?: boolean;
+        /**
+         * The Campaign Registry (TCR) campaign ID associated with the message.
+         */
+        tcr_campaign_id?: string | null;
+        /**
+         * The registration status of the TCR campaign.
+         */
+        tcr_campaign_registered?: string | null;
+        /**
+         * Message body (i.e., content) as a non-empty string.
+         *
+         * **Required for SMS**
+         */
+        text?: string;
+        to?: Array<Inbound.To>;
+        /**
+         * The type of message. This value can be either 'sms' or 'mms'.
+         */
+        type?: 'SMS' | 'MMS';
+        /**
+         * Not used for inbound messages.
+         */
+        valid_until?: string | null;
+        /**
+         * The failover URL where webhooks related to this message will be sent if sending
+         * to the primary URL fails.
+         */
+        webhook_failover_url?: string | null;
+        /**
+         * The URL where webhooks related to this message will be sent.
+         */
+        webhook_url?: string | null;
+    }
+    namespace Inbound {
+        interface Cc {
+            /**
+             * The carrier of the receiver.
+             */
+            carrier?: string;
+            /**
+             * The line-type of the receiver.
+             */
+            line_type?: 'Wireline' | 'Wireless' | 'VoWiFi' | 'VoIP' | 'Pre-Paid Wireless' | '';
+            /**
+             * Receiving address (+E.164 formatted phone number or short code).
+             */
+            phone_number?: string;
+            status?: 'queued' | 'sending' | 'sent' | 'delivered' | 'sending_failed' | 'delivery_failed' | 'delivery_unconfirmed';
+        }
+        interface Cost {
+            /**
+             * The amount deducted from your account.
+             */
+            amount?: string;
+            /**
+             * The ISO 4217 currency identifier.
+             */
+            currency?: string;
+        }
+        /**
+         * Detailed breakdown of the message cost components.
+         */
+        interface CostBreakdown {
+            carrier_fee?: CostBreakdown.CarrierFee;
+            rate?: CostBreakdown.Rate;
+        }
+        namespace CostBreakdown {
+            interface CarrierFee {
+                /**
+                 * The carrier fee amount.
+                 */
+                amount?: string;
+                /**
+                 * The ISO 4217 currency identifier.
+                 */
+                currency?: string;
+            }
+            interface Rate {
+                /**
+                 * The rate amount applied.
+                 */
+                amount?: string;
+                /**
+                 * The ISO 4217 currency identifier.
+                 */
+                currency?: string;
+            }
+        }
+        interface From {
+            /**
+             * The carrier of the sender.
+             */
+            carrier?: string;
+            /**
+             * The line-type of the sender.
+             */
+            line_type?: 'Wireline' | 'Wireless' | 'VoWiFi' | 'VoIP' | 'Pre-Paid Wireless' | '';
+            /**
+             * Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short
+             * code).
+             */
+            phone_number?: string;
+            status?: 'received' | 'delivered';
+        }
+        interface Media {
+            /**
+             * The MIME type of the requested media.
+             */
+            content_type?: string;
+            /**
+             * The SHA256 hash of the requested media.
+             */
+            hash_sha256?: string;
+            /**
+             * The size of the requested media.
+             */
+            size?: number;
+            /**
+             * The url of the media requested to be sent.
+             */
+            url?: string;
+        }
+        interface To {
+            /**
+             * The carrier of the receiver.
+             */
+            carrier?: string;
+            /**
+             * The line-type of the receiver.
+             */
+            line_type?: 'Wireline' | 'Wireless' | 'VoWiFi' | 'VoIP' | 'Pre-Paid Wireless' | '';
+            /**
+             * Receiving address (+E.164 formatted phone number or short code).
+             */
+            phone_number?: string;
+            status?: 'queued' | 'sending' | 'sent' | 'delivered' | 'sending_failed' | 'delivery_failed' | 'delivery_unconfirmed' | 'webhook_delivered';
+        }
+    }
 }
 export interface MessageCancelScheduledResponse {
     /**
@@ -951,7 +1424,7 @@ export interface MessageCancelScheduledResponse {
      * These errors may point at addressees when referring to unsuccessful/unconfirmed
      * delivery statuses.
      */
-    errors?: Array<Shared.MessagingError>;
+    errors?: Array<MessagingError0b38e7044b>;
     from?: MessageCancelScheduledResponse.From;
     media?: Array<MessageCancelScheduledResponse.Media>;
     /**
@@ -1147,29 +1620,74 @@ export declare namespace MessageCancelScheduledResponse {
     }
 }
 export interface MessageRetrieveGroupMessagesResponse {
-    data?: Array<OutboundMessagePayload>;
+    data?: Array<MessagingOutboundMessagePayload>;
 }
 export interface MessageScheduleResponse {
-    data?: OutboundMessagePayload;
+    data?: MessagingOutboundMessagePayload;
 }
 export interface MessageSendResponse {
-    data?: OutboundMessagePayload;
+    data?: MessagingOutboundMessagePayload;
 }
 export interface MessageSendGroupMmsResponse {
-    data?: OutboundMessagePayload;
+    data?: MessagingOutboundMessagePayload;
 }
 export interface MessageSendLongCodeResponse {
-    data?: OutboundMessagePayload;
+    data?: MessagingOutboundMessagePayload;
 }
 export interface MessageSendNumberPoolResponse {
-    data?: OutboundMessagePayload;
+    data?: MessagingOutboundMessagePayload;
 }
 export interface MessageSendShortCodeResponse {
-    data?: OutboundMessagePayload;
+    data?: MessagingOutboundMessagePayload;
 }
 export interface MessageSendWithAlphanumericSenderResponse {
     data?: OutboundMessagePayload;
 }
+export interface MessageWhatsappResponse {
+    data?: MessageWhatsappResponse.Data;
+}
+export declare namespace MessageWhatsappResponse {
+    interface Data {
+        /**
+         * message ID
+         */
+        id?: string;
+        body?: MessagesAPI.WhatsappMessageContent;
+        direction?: string;
+        encoding?: string;
+        from?: Data.From;
+        messaging_profile_id?: string;
+        organization_id?: string;
+        received_at?: string;
+        record_type?: string;
+        to?: Array<MessagesAPI.RcsToItem>;
+        type?: string;
+        /**
+         * Seconds the message is queued due to rate limiting before being sent to the
+         * carrier. Represents the maximum wait across all applicable rate limits (account,
+         * carrier, campaign). 0.0 = no queuing delay.
+         */
+        wait_seconds?: number | null;
+    }
+    namespace Data {
+        interface From {
+            /**
+             * The carrier of the sender.
+             */
+            carrier?: string;
+            /**
+             * The line-type of the sender.
+             */
+            line_type?: 'Wireline' | 'Wireless' | 'VoWiFi' | 'VoIP' | 'Pre-Paid Wireless' | '';
+            /**
+             * Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short
+             * code).
+             */
+            phone_number?: string;
+            status?: 'received' | 'delivered';
+        }
+    }
+}
 export interface MessageSendParams {
     /**
      * Receiving address (+E.164 formatted phone number or short code).
@@ -1549,8 +2067,31 @@ export interface MessageSendWithAlphanumericSenderParams {
      */
     webhook_url?: string | null;
 }
+export interface MessageWhatsappParams {
+    /**
+     * Phone number in +E.164 format associated with Whatsapp account
+     */
+    from: string;
+    /**
+     * Phone number in +E.164 format
+     */
+    to: string;
+    whatsapp_message: WhatsappMessageContent;
+    /**
+     * Messaging profile ID - required if the 'from' number is not SMS-enabled
+     */
+    messaging_profile_id?: string;
+    /**
+     * Message type - must be set to "WHATSAPP"
+     */
+    type?: 'WHATSAPP';
+    /**
+     * The URL where webhooks related to this message will be sent.
+     */
+    webhook_url?: string;
+}
 export declare namespace Messages {
-    export { 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 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, };
+    export { type MessagingError0b38e7044b as MessagingError0b38e7044b, 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, };
     export { Rcs as Rcs, type RcGenerateDeeplinkResponse as RcGenerateDeeplinkResponse, type RcSendResponse as RcSendResponse, type RcGenerateDeeplinkParams as RcGenerateDeeplinkParams, type RcSendParams as RcSendParams, };
 }
 //# sourceMappingURL=messages.d.ts.map