Skip to main content
POST
json

Body

application/json
NumberType
enum<string>
required

Number classification: 'mvno' (supports both a2p and p2p), 'iot' (p2p only - cannot be provisioned as a2p; use mvno NumberType for a2p MessageType)

Available options:
mvno,
iot
Example:

"iot"

MessageType
enum<string>
required

Message type: a2p (Application-to-Person) or p2p (Person-to-Person)

Available options:
a2p,
p2p
Example:

"p2p"

MessageEnabled
boolean
required

Enable SMS/MMS capabilities

Example:

true

VoiceEnabled
boolean
required

Enable voice call capabilities

Example:

false

ProductType
enum<string>
required

Product type for the provisioned number. Options: Sms-Only, Data-Only, Sms+Data, Sms+Data+Voice

Available options:
Sms-Only,
Data-Only,
Sms+Data,
Sms+Data+Voice
Example:

"Sms+Data"

DataEnabled
boolean

Enable data capabilities (for IoT numbers)

Example:

true

MessageRouteId
string

MRID for message routing configuration

Example:

"MRID-81dr9t90-....-....-....-.........."

VoiceRouteId
string

CRID for voice routing configuration

Example:

"CRID-5nov0yuy-....-....-....-........."

AreaCode
string

Preferred 3-digit area code. Lookup searches AreaCode first before ZipCode. If both AreaCode and ZipCode are left blank or null, a randomized set of results will be returned

Example:

"201"

ZipCode
string

5-digit zip code. Used as fallback if AreaCode is unavailable. You may provide both AreaCode and ZipCode, or just one; AreaCode takes priority if included. Please note that zip codes must be valid and within the United States.

Example:

"84043"

ICCID
string

Integrated Circuit Card Identifier. Optional field, but required when provisioning a physical SIM (pSIM)

Example:

"8901240397190195850"

AssignedSubscriberId
string

Optional subscriber-id to be assigned to the new number

Example:

"TSUID-1234567999"

AccountId
string

Account ID (AID) to provision the number under. Required when a distributor account has more than one sub-account.

Example:

"AID-ab12345-2725-45a1-bd5e-526ed19799xx"

Response

Success — returns the order ID, assigned phone number, and provisioning status

The response is of type object.