GET
/
sms
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "sentId": "123e4567-e89b-12d3-a456-426614174111",
  "phoneNumber": "+14155552671",
  "countryCode": "US",
  "validNumber": true,
  "nationalFormat": "(415) 555-2671",
  "payload": "{\"carrier\":\"Verizon\",\"type\":\"mobile\"}",
  "createdAt": "2023-01-01T12:00:00Z",
  "updatedAt": "2023-01-01T12:00:00Z"
}

Authorizations

​
x-api-key
string
header
required

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
Successfully retrieved SMS contact information

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

Example:

"US"

​
validNumber
boolean

Indicates if the phone number is valid for SMS delivery

Example:

true

​
nationalFormat
string

Locally formatted version of the phone number

Example:

"(415) 555-2671"

​
payload
string

Additional payload information in JSON format

Example:

"{\"carrier\":\"Verizon\",\"type\":\"mobile\"}"

Was this page helpful?