Skip to main content
POST
sms.registration-toll-free.status

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by sms.registration-toll-free.submit or a row of sms.registration-toll-free.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$

Response

The result

phoneNumber
string
required

Your toll-free sending number.

Pattern: ^\+[1-9]\d{6,14}$
state
enum<string>
required

Current filing review state.

Available options:
pending,
in_review,
approved,
rejected
canSend
boolean
required

Whether this number has approved verification; delivery is not guaranteed.

editable
boolean
required

Whether the filing can still be edited.

editExpiresAt
string

Editing deadline, in UTC.