These docs are for v0.0.1. Click to read the latest docs for v1.0.63.

Add Number

This API requires the Account Administrator role.

Assign phone number which is available.
The following field must be unique otherwise a HTTP 409 Conflcit will be returned:

  • phoneNumber

Will trigger asynchronous updates, the status of which should be monitored via /phone-numbers/{phoneNumberId}.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 6 and 6
^[a-zA-Z]{6}$

The unique 6 character internal id that represents the customer account

Body Params

PhoneNumber of an Account.

string
length between 5 and 15
^\+[1-9]\d{3,13}$

The phone number in the E.164 format

string
length ≤ 255

Domestic format version of the phone number or any suitable name that will identify the number easily.

string
length between 2 and 2
^[A-Z]{2}$

ISO Country code for number.

boolean

Indicates whether the number is caller Id.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json