WAwavix
SMS and MMS

Export messages

Changed on

Streams matching SMS and MMS messages as newline-delimited JSON (NDJSON), one message per line, for bulk export.

get/v3/messages/all

Request

  • Base URL
    https://api.wavix.com
  • URL
    https://api.wavix.com/v3/messages/all
  • Auth
    HTTP bearer

Query parameters

sent_afterstring
Example:2023-04-10T00:00:00

Returns messages sent on or after this timestamp, in YYYY-MM-DDTHH:MM:SS format.

sent_beforestring
Example:2023-04-13T23:59:59

Returns messages sent on or before this timestamp, in YYYY-MM-DDTHH:MM:SS format.

typestring required
Example:outbound

Filters messages by direction. One of inbound (messages received by the account) or outbound (messages sent by the account).

fromstring
Example:15072429497

Filters by message sender. For outbound messages, the Sender ID used to send the message; for inbound messages, the originating phone number.

tostring
Example:16419252149

Filters by message recipient. For outbound messages, the destination phone number; for inbound messages, the SMS-enabled number that received the message.

status'accepted' | 'pending' | 'sent' | 'delivered' | 'undelivered' | 'expired' | 'rejected' | 'dlr_expired'

Current delivery status of the message. One of:

  • accepted — the message was accepted by the platform for sending.
  • pending — the message is queued and awaiting a carrier response.
  • sent — the message was handed to the carrier.
  • delivered — the carrier confirmed delivery to the handset.
  • undelivered — the carrier reported that delivery failed.
  • expired — the validity period elapsed before the message was sent.
  • rejected — the message was rejected before sending.
  • dlr_expired — no delivery receipt arrived from the carrier within the expected window.

Filters messages by delivery status. Accepts a MessageDeliveryStatus value.

tagstring
Example:campaignX

Filters messages by tag. Supported for outbound messages only.

message_type'sms' | 'mms'
Example:sms

Filters messages by type. One of sms (text message) or mms (multimedia message).

Response

Returns an NDJSON stream of messages, one per line.

Changes

  • 6a89c962481cRevision changes
    • breaking

      the query request parameter status was restricted to a list of enum values

    • info

      added the new enum value accepted to the query request parameter status

    • info

      added the new enum value delivered to the query request parameter status

    • info

      added the new enum value dlr_expired to the query request parameter status

    • info

      added the new enum value expired to the query request parameter status

    • info

      added the new enum value pending to the query request parameter status

    • info

      added the new enum value rejected to the query request parameter status

    • info

      added the new enum value sent to the query request parameter status

    • info

      added the new enum value undelivered to the query request parameter status

    • info

      for the query request parameter status, the type was generalized from no type to string

    • info

      added the non-success response with the status

  • 33be77905120Revision changes
    • info

      the endpoint scheme security bearerAuth was added to the API