Skip to main content
GET
Retrieve an SMS

Authorizations

Authorization
string
header
required

An API key from the dashboard. sk_live_… sends; sk_test_… validates and returns ids without sending.

Path Parameters

id
string
required
Example:

"sm_01j9x7k2r4m8q3v5n6b7c8d9e0"

Response

The SMS

id
string
required
channel
enum<string>
required
Available options:
sms
class
enum<string>
required
Available options:
transactional,
marketing
status
enum<string>
required
Available options:
queued,
sent,
delivered,
bounced,
complained,
failed,
expired,
rejected
to
string
required
from
string
required
segments
integer
required
credits
integer
required
tags
string[]
required
error
object | null
required
scheduledAt
string<date-time> | null
required
createdAt
string<date-time>
required
sentAt
string<date-time> | null
required
deliveredAt
string<date-time> | null
required
events
object[]
required