SSoftLinkSMSDocs
SMS

Retrieve a single SMS message

GET
/api/v1/sms/{id}

Returns the delivery status and details of a single SMS message owned by the authenticated user.

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.

Path Parameters

id*string

A UUID string identifying this Message.

Formatuuid

Response Body

Message retrieved successfully.

application/json
  1. response
id*string
Formatuuid
body*string

The text to send. message is accepted as an alias.

traffic_class?string

promotional (default, shared sender ID) or transactional (OTPs, receipts, alerts; needs approval, sent from your own sender ID). See GET /sending-profile.

  • promotional - Promotional
  • transactional - Transactional
Default"promotional"
Value in"promotional""transactional"
sender_id*string
price*string
currency*|

The currency of the message

batch_id*|

The send this message was part of

Formatuuid
message_id*|

The id of the message

recipient*string
response_code*|

The response code from the delivery

response_description*|

The response description from the delivery

status*string

Dispatch status of the message

  • pending - Pending
  • sent - Sent
  • delivered - Delivered
  • bounced - Bounced
  • failed - Failed
  • retrying - Retrying
Value in"pending""sent""delivered""bounced""failed""retrying"
duration_ms*|

Measured time, in milliseconds, the provider took to respond to this message's send request. Null until a result comes back (or forever, for messages that ran out of retries without ever getting one).

created_at*string
Formatdate-time
updated_at*string
Formatdate-time
Example Request
curl -X GET 'https://api.softlinksms.co.ke/api/v1/sms/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "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"}