Skip to Content
Transactional SMS

Search message dispatch history with filters

View Markdown (.md)
GET
/api/v1/public/sms/history/search

Search and paginate through dispatch logs by phone number, message text keyword, delivery status, or date range.

Authorization

headerX-Api-Key<token>

SMS Pro API Key (sk_live_... or sk_test_...)

Query Parameters

q?string

Search query matching recipient or text

status?string

Filter by message delivery status

Value in"DELIVERED""SUBMITTED""PENDING""FAILED""EXPIRED"
page?integer

Page index (0-based)

Default0
pageSize?integer

Number of records per page

Default20

Response Body

Paginated history search results

application/json
  1. response
status?string
data?
Example Request
curl -X GET 'https://api.smspro.com/api/v1/public/sms/history/search'
Example Response
{  "status": "string",  "data": {    "content": [      {        "id": "string",        "to": "string",        "message": "string",        "status": "string",        "deliveryStatus": "string",        "senderId": "string",        "segmentCount": 0,        "sentAt": "2019-08-24T14:15:22Z"      }    ],    "totalElements": 0,    "page": 0,    "pageSize": 0  }}