Skip to main content
POST
Phone numbers support inbound SMS and MMS. Outbound SMS is not currently available.

Request body

string
required
Handle of the agent identity that will own the number. A leading @ is optional.
string
default:"US"
Country code. Supported values are US and CA.
string
default:"local"
Number type: local or toll_free.
string
Two-letter US state or Canadian province code, such as CA or ON.
string
Three-digit area code. Do not provide this together with region.
The number becomes SMS-ready asynchronously. Check sms_status or subscribe to the number.sms_ready webhook before relying on inbound delivery.