List messages
Returns a paginated list of SMS and MMS messages for the authenticated account, filtered by direction, date, and other criteria.
Query parameters
Returns messages sent on or after this date, in YYYY-MM-DD format.
Returns messages sent on or before this date, in YYYY-MM-DD format.
Filters messages by direction. One of inbound (messages received by the account) or outbound (messages sent by the account).
Filters by message sender. For outbound messages, the Sender ID used to send the message; for inbound messages, the originating phone number.
Filters by message recipient. For outbound messages, the destination phone number; for inbound messages, an SMS-enabled number on the Wavix platform.
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.
Filters messages by tag. Supported for outbound messages only.
Filters messages by type. One of sms (text message) or mms (multimedia message).
Page number to retrieve. Default 1.
Number of records to return per page. Default 25.
Response
Returns a paginated list of messages.
Example response
{
"items": [
{
"charge": "0.0475",
"delivered_at": "2023-08-29T12:32:45.000Z",
"direction": "outbound",
"error_message": null,
"from": "Sender ID.",
"mcc": "234",
"message_body": {
"text": "Please call me back",
"media": null
},
"message_id": "3a525ca2-6909-4c72-9399-905adf7f3a74",
"message_type": "sms",
"mnc": "024",
"segments": 1,
"sent_at": "2023-08-29T12:32:44.000Z",
"status": "delivered",
"submitted_at": "2023-08-29T12:32:44.000Z",
"carrier_fees": "0.0",
"tag": null,
"to": "447537151866"
}
],
"pagination": {
"current_page": 1,
"per_page": 10,
"total": 1,
"total_pages": 1
}
}