Skip to main content
GET
/
v1
/
external
/
sms
/
logs
/
{sequenceNo}
curl --request GET \
  --url https://api.kairosafrika.com/v1/external/sms/logs/01K4195MWQY2V4V0A7JZFC183S \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-api-secret: YOUR_API_SECRET' \
  --header 'x-api-version: 2025-08-01'

{
  "statusCode": "200",
  "statusMessage": "Delivery receipt details successfully retrieved",
  "transactionId": "01K4195MWQY2V4V0A7JZFC183S",
  "sequenceNo": "01K4195MWQY2V4V0A7JZFC183S",
  "data": {
    "_id": "68b4e204caf5c1616d5efe1a",
    "clientCorrelatorId": "db4f4068-cc2b-46f6-9f8c-8a09983c5cc7",
    "consumerId": "1",
    "createdAt": "2025-09-01T00:00:04.014Z",
    "deliveryStatus": "EXPIRED",
    "gatewayId": "99696059172",
    "gatewayMessageId": 99696059172,
    "ipAddress": "41.189.160.10",
    "message": "Hello ASTCCU, your customer access report is ready for download.",
    "messageId": "99696059172",
    "receiverAddress": [
      "233003003000"
    ],
    "requestDeliveryReceipt": true,
    "senderAddress": "KAIROS",
    "sequenceNo": "01K4195MWQY2V4V0A7JZFC183S",
    "transactionId": "db4f4068-cc2b-46f6-9f8c-8a09983c5cc7"
  },
  "timestamp": "2025-10-03T14:41:00.014Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.kairosafrika.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Get SMS Delivery Receipt

This endpoint allows you to retrieve the delivery receipt and status details of a previously sent SMS message using the sequence number. Endpoint: GET /v1/external/sms/logs/{sequenceNo} 
curl --request GET \
  --url https://api.kairosafrika.com/v1/external/sms/logs/01K4195MWQY2V4V0A7JZFC183S \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-api-secret: YOUR_API_SECRET' \
  --header 'x-api-version: 2025-08-01'

​
Path Parameter

  • sequenceNo (string, required): The sequence number of the SMS message (returned when sending SMS).

​
Responses

  • 200 OK: Returns SMS delivery receipt and status details.
  • 404 Not Found: Message not found.

​
Response Example

{
  "statusCode": "200",
  "statusMessage": "Delivery receipt details successfully retrieved",
  "transactionId": "01K4195MWQY2V4V0A7JZFC183S",
  "sequenceNo": "01K4195MWQY2V4V0A7JZFC183S",
  "data": {
    "_id": "68b4e204caf5c1616d5efe1a",
    "clientCorrelatorId": "db4f4068-cc2b-46f6-9f8c-8a09983c5cc7",
    "consumerId": "1",
    "createdAt": "2025-09-01T00:00:04.014Z",
    "deliveryStatus": "EXPIRED",
    "gatewayId": "99696059172",
    "gatewayMessageId": 99696059172,
    "ipAddress": "41.189.160.10",
    "message": "Hello ASTCCU, your customer access report is ready for download.",
    "messageId": "99696059172",
    "receiverAddress": ["233003003000"],
    "requestDeliveryReceipt": true,
    "senderAddress": "KAIROS",
    "sequenceNo": "01K4195MWQY2V4V0A7JZFC183S",
    "transactionId": "db4f4068-cc2b-46f6-9f8c-8a09983c5cc7"
  },
  "timestamp": "2025-10-03T14:41:00.014Z"
}

​
Response Fields

  • statusCode (string): HTTP status code.
  • statusMessage (string): Status message description.
  • transactionId (string): Unique transaction identifier.
  • sequenceNo (string): Sequence number for the request.
  • data (object): Delivery receipt details.
    • _id (string): MongoDB document ID.
    • deliveryStatus (string): Delivery status (DELIVERED, UNDELIVERED, REJECTED, EXPIRED, ACCEPTED).
    • message (string): The SMS message content.
    • receiverAddress (array): Array of receiver phone numbers.
    • senderAddress (string): Sender address/ID.
    • createdAt (string): Timestamp when the SMS was created.
    • gatewayMessageId (integer): Gateway message ID.
  • timestamp (string): ISO 8601 timestamp of the response.

Authorizations

​
x-api-key
string
header
required

API Key for authentication

​
x-api-secret
string
header
required

API Secret for authentication

Headers

​
x-api-version
enum<string>
required

API version header (required for full JSON response)

Available options:
2025-08-01

Path Parameters

​
sequenceNo
string
required

The sequence number of the SMS message

Response

SMS delivery receipt retrieved successfully

​
statusCode
string

HTTP status code

Example:

"200"

​
statusMessage
string

Status message

Example:

"Delivery receipt details successfully retrieved"

​
transactionId
string

Unique transaction identifier

Example:

"01K4195MWQY2V4V0A7JZFC183S"

​
sequenceNo
string

Sequence number

Example:

"01K4195MWQY2V4V0A7JZFC183S"

​
data
object
​
timestamp
string<date-time>

ISO 8601 timestamp

Example:

"2025-10-03T14:41:00.014Z"