Skip to main content
GET
Track SMS

Authorizations

Authorization
string
header
required

Project API key (sk_live… or sk_dev…). Send it as Authorization: Bearer <api_key>.

Path Parameters

smsId
string
required

The SMS ID to track

Pattern: ^sms-[a-f0-9]{24}$
Example:

"sms-1234567890abcdef123456"

Response

SMS status retrieved successfully. Response body includes SMSTrackingResponse with fields: smsId, phoneNumber, status, cost, isFinalStatus, lastChannel, channelFlow[].

smsId
string
required

Unique identifier for the SMS message

Pattern: ^sms-[a-f0-9]{24}$
Example:

"sms-1234567890abcdef123456"

phoneNumber
string
required

Phone number the SMS was sent to

Example:

"964750123456"

status
enum<string>
required

Current status of the SMS message

Available options:
pending,
sent,
delivered,
read,
failed
Example:

"sent"

cost
number
required

Cost of the SMS in IQD

Required range: x >= 0
Example:

200

isFinalStatus
boolean
required

Whether the SMS has reached a final state (no further attempts will be made)

Example:

false

lastChannel
string
required

The last channel attempted or used for sending. One of 'sms', 'whatsapp', 'telegram'.

channelFlow
object[]
required

Sequence of channels and their attempt statuses