SSoftLinkSMSDocs
SMS

List sent SMS messages

GET
/api/v1/sms

Returns a cursor-paginated list of SMS messages belonging to the authenticated user, ordered by most recent first. Supports free-text search over the recipient number, message body, and delivery response description via the search query parameter, plus exact filtering by status and mobile.

Authorization

apiKeyAuth
headerX-Api-Key<token>

Your API key, sent as X-Api-Key. Format bsk_<key_id>.<secret>. Create one in the dashboard under Settings → Developer tools.

Query Parameters

cursor?string

Opaque pagination cursor returned in next/previous links.

mobile?string

Filter by recipient number (partial match).

page_size?integer

Number of results to return per page.

search?string

Search term matched against to_number, message, and response_description.

status?string

Filter by simplified outcome category rather than the raw dispatch status: pending, sent (includes messages queued for retry), success (delivery confirmed), or error (failed or bounced).

Value in"error""pending""sent""success"

Response Body

application/json
  1. response
next?|
Formaturi
previous?|
Formaturi
results*array<>
Example Request
curl -X GET 'https://api.softlinksms.co.ke/api/v1/sms'
Example Response
{  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",  "results": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "body": "string",      "traffic_class": "promotional",      "sender_id": "string",      "price": "string",      "currency": "string",      "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",      "message_id": "string",      "recipient": "string",      "response_code": 0,      "response_description": "string",      "status": "pending",      "duration_ms": 0,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ]}