List Phone Numbers

post

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

This API requires the Account Administrator role.

It will accept list of phone number Ids and return list of phone number objects which is not DISABLED.

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.

Query Params

orderBy

string

length ≤ 255

Defaults to displayName

It Specifies how response data should be sorted.
Supported fields for orderBy - displayName, phoneNumber.
Field Names are case-senstive (should be written as it is in description).
To specify descending order, a suffix " desc" should be added. For example, "displayName asc" for ascending or "displayName desc" for descending".
The default sorting order is displayName ascending when no orderBy param will be passed.

Body Params

List of Phone number Ids

PhoneNumberListRequest

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

200OK

400Constraint Violation

401Unauthorized

403Forbidden

404Not Found

500All other application errors