Add Number

post

{protocol}://{server}{basePath}/accounts/{accountId}/phone-numbers

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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

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.

phoneNumber

string

length between 5 and 15

^\+[1-9]\d{3,13}$

The phone number in the E.164 format

displayName

string

length ≤ 255

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

countryCode

string

length between 2 and 2

^[A-Z]{2}$

ISO Country code for number.

isCallingPartyNumber

boolean

Indicates whether the number is caller Id.

preferredMediaLocation

string

length between 1 and 7

Preferred media location set by tenant instead of default coming from CPaaS.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

202Accepted

400Constraint Violation

401Unauthorized

403Forbidden

404Not Found

409Conflict

500All other application errors