DID List or Search

Use DID_Management to enumerate and search your Direct Inward Dialing (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 (for more information, see Atmosphere® API Authentication)

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 are 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 returns 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 returns 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) (for more information, 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.
e911Adress (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 (for more information, see ISO 3166-2:US).

Success Response

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
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

Code 401 Response

Copy

1
2
3
4
5
6
7
8
9
HTTP/1.1 401 Unauthorized

{

    "code": 401,

    "error": "Unauthorized"

}

Copy

1
2
3
4
5
6
7
8
9
HTTP/1.1 401 Unauthorized

{

    "code": 401,

    "error": "Session Expired"

}

Code 406 Response

Copy

1
2
3
4
5
6
7
8
9
HTTP/1.1 406 Not Acceptable

{

    "code": 406,

    "error": "Not Acceptable"

}

Copy

1
2
3
4
5
6
7
8
9
HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

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

}

Copy

1
2
3
4
5
6
7
8
9
HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

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

}

Copy

1
2
3
4
5
6
7
8
9
HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

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

}

Copy

1
2
3
4
5
6
7
8
9
HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

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

}

Copy

1
2
3
4
5
6
7
8
9
HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

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

}