Create Phone Numbers

Create Phone Numbers

The following are reasons a number might have been rejected:

ReasonDescriptionResponse Code
INVALID_NUMBERInvalid Phone Number201
ALLOCATED_NUMBER_BUSINESSPhone Number exists within under a different business within same reseller201
ALLOCATED_NUMBER_GRANT_CONFLICTPhone Number exists within another reseller (with Service Grant Conflict)201
DUPLICATE_NUMBERPhone Number is duplicated in the request201
RELATIONSHIP_NOT_FOUNDPhone Number is created with an invalid relationship (BU/Program not found)201
INVALID_RELATIONSHIPPhone Number is created with an invalid relationship (assigned to invalid BU-Program-Group-delivery channel Relationship)201
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Note! Assigning a Phone Number to a Program for Branding or Sentry requires the ID of the Business, the Business Unit and the Program (three IDs).

  • If a Phone Number is being assigned to a new Program under a different Business Unit, that different Business Units ID will be required in the request.
  • If a Phone Number is being assigned to a new Program under the same Business Unit, that same Business Unit ID will be required in the request.
Path Params
string
required

System generated unique identifier for the business

Body Params
string
required

The most common purpose why the phone number is making calls. Must be one of GET /exchange/v1/reference-data/call-purposes

boolean
Defaults to false

Is the phone number used to make Verified calls

relationships
object

Association of the phone number with Business, Business Units, Programs, etc.

string
required
7 to 15
^\+[1-9]\d{1,14}$

Phone number in E.164 format.

Headers
string
required

Access Token

Responses

401

Unauthorized

403

Forbidden

Language
URL
LoadingLoading…
Response
Choose an example:
application/json