GET
/
sms

Authorizations

x-api-key
string
headerrequired

Query Parameters

phoneNumber
string
required

Target phone number in E.164 format (e.g., +1234567890)

retrieveIfDoesNotExists
boolean
required

When true, creates a new SMS contact if one doesn't exist

sentId
string | null

Optional Sent platform identifier for existing contacts

Response

200 - application/json

Detailed SMS contact information including validation and formatting details

id
string

Unique identifier for the phone number record

sentId
string

Sent platform identifier

phoneNumber
string

Phone number in E.164 format

countryCode
string

ISO country code for the phone number

validNumber
boolean

Indicates if the phone number is valid for SMS delivery

nationalFormat
string

Locally formatted version of the phone number

payload
string

Additional payload information in JSON format