Messages
List messages
Lists your messages, newest first. Filter by status, recipient, sender ID, reference, batch or date.
GET
Lists your messages, newest first. Filter by status, recipient, sender ID, reference, batch or date.
bearerheader
AuthorizationBearer <JWT>Your secret API key: sk_live_… for live traffic or sk_test_… for testing.
page?numberPage number, starting at 1.
Range
1 <= value <= 2147483647limit?numberItems per page, 1 to 100. Defaults to 10.
Range
1 <= value <= 100status?stringOnly messages with this status.
Value in
"queued""sent""delivered""undelivered""failed""expired"to?stringOnly messages to this number.
Length
length <= 32from?stringOnly messages from this sender ID.
Length
length <= 11reference?stringOnly messages with this reference.
Length
length <= 100batchId?stringOnly messages in this batch.
Length
length <= 40createdFrom?stringOnly messages created at or after this time (ISO 8601).
Format
date-timecreatedTo?stringOnly messages created before this time (ISO 8601).
Format
date-timeA page of messages.
application/jsoncurl -X GET 'https://api.appstractone.com/v1/messages'Example Response
{
"docs": [
{
"id": "msg_01M6MJSBW6TNFXDJ48HMRQXBPM",
"to": "+233201234567",
"from": "MYSHOP",
"text": "Hi Ama, your order is ready.",
"status": "delivered",
"encoding": "GSM-7",
"segments": 1,
"cost": {
"amount": "0.04",
"currency": "GHS"
},
"reference": null,
"batchId": "bat_01M6MJSBW6TNFXDJ48HMRQXBPJ",
"test": true,
"errorCode": null,
"createdAt": "2026-11-05T00:47:20.459Z",
"sentAt": null,
"deliveredAt": "2026-11-05T00:47:20.454Z"
}
],
"totalDocs": 4,
"limit": 2,
"totalPages": 2,
"page": 1,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": true,
"prevPage": null,
"nextPage": 2
}