DID List or Search

Direct Inward Dialing (DID) Management

Manage your DID numbers.  

 
List or Search 

Use DID_Management  to enumerate and search your DID inventory of numbers. 

 

Note: When more records are available on the next page, the API returns pageSize + 1 records.

 
Endpoint and methods
  • GET: /_rest/v3/my/did
 
Parameters

Header

  • Accept: application/json
  • Authorization: xxxxxxxxxxxxxxxxx

Field

Type

Description

Accept

 

String

application/json

Authorization

String

Authorization token (see Authenticate)

Path

 

Field

Type

Description

countryCode optional


Numeric[]

The country code of the desired number(s).

hasE911 optional

Boolean

The E911 status of the desired number(s).

 

  • Must be scalar.

 

Like optional

String

An alpha-numeric string to search for.

 

  • Alphabetic characters will be translated to numbers as follows: 2 = ABC, 3 = DEF, 4 = GHI, 5 = JKL, 6 = MNO, 7 = PQRS, 8 = TUV, 9 = WXYZ
  • Must be scalar.

 

Label optional

String[]

The label of the desired number(s).

 

Npa optional

Numeric[]

The NPA (area code) of the desired number(s).

 

Nxx optional

Numeric[]

The NXX (local prefix) of the desired number(s).

 

packageID optional

Integer[]

The package ID of the desired number(s).

 

Page optional

Integer

Which page of results to retrieve.

 

Note: When more records are available on the next page, this API will return pageSize + 1 records.

 

Default value: 1

 

pageSize optional

Integer

The maximum number of results to return per page. Max: 100

 

Note: When more records are available on the next page, this API will return pageSize + 1 records.

 

Default value: 100

 

rateCenter optional
String[] The rate center of the desired number(s).

 

State optional

String[]

The state of the desired number(s) (see ISO 3166-2:US)

 

 

E911 Search

GET /_rest/v3/my/did?hasE911=true

 

Search Multiple NPAs

GET /_rest/v3/my/did?npa[]=303&npa[]=303

 

NPA-Nxx Search

GET /_rest/v3/my/did?npa=303&nxx=729

 

Response example and schema

 

Success 200

 

Field 

Type

Description

countryCode

 

Numeric

The number’s country code.

countryID

 

Integer

The number’s internal country ID.

 

countryName

String

The number’s country name.

 

e164

Numeric

The e.164 representation of the number.

 

e911Address optional

Object

If the number has E911 service, the address registered for E911 service.

 

address1


string

The first line of the registered E911 address.

address2

string

The second line of the registered E911 address.

 

city

string

The city of the registered E911 address.

 

name

string

The name/label of the registered E911 address.

 

state

string

The state of the registered E911 address.

 

hasE911

Boolean

The number’s E911 status.

 

label

String

The number’s label.

 

npa

Numeric

The number’s NPA (area code).

 

nxx

Numeric

The number’s NXX (local prefix).

 

number

Numeric

The number.

 

packageID

Integer

The number’s package ID.

 

rateCenter

String

The number’s rate center.

 

state

String

The number’s state (see ISO 3166-2:US).

 

HTTP/1.1 200 OK

[

    {

        "countryCode": "1",

        "countryID": 255,

        "countryName": "United States",

        "e164": "+13037293863",

        "hasE911": false,

        "e911Address": null,

        "label": "no E911",

        "npa": "303",

        "number": "3037293863",

        "nxx": "729",

        "packageID": 12345,

        "rateCenter": "DENVER",

        "state": "CO"

    },

    {

        "countryCode": "1",

        "countryID": 255,

        "countryName": "United States",

        "e164": "+13037293864",

        "hasE911": false,

        "e911Address": {

            "name": "Home Office",

            "address1": "5975 S QUEBEC ST",

            "address2": "",

            "city": "CENTENNIAL",

            "state": "CO",

            "zip": "80111"

        }

        "label": "",

        "npa": "303",

        "number": "3037293864",

        "nxx": "729",

        "packageID": 12345,

        "rateCenter": "DENVER",

        "state": "CO"

    }

]
Error

Name

Type Description
code

Integer

Error code

error
String

Error description

HTTP/1.1 401 Unauthorized

{

    "code": 401,

    "error": "Unauthorized"

}




HTTP/1.1 401 Unauthorized

{

    "code": 401,

    "error": "Session Expired"

}
HTTP/1.1 406 Not Acceptable

{

    "code": 406,

    "error": "Not Acceptable"

}




HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

    "error": "The '%s' parameter must be scalar."

}




HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

    "error": "The '%s' parameter must be formatted as a(n) boolean."

}




HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

    "error": "The '%s' parameter must be formatted as a(n) integer."

}




HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

    "error": "The '%s' parameter must be formatted as a(n) numeric."

}




HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

    "error": "The '%s' parameter must be formatted as a non-empty string."

}