Get Available DID#
Returns a single Available DID from DIDWW inventory.
Note
Available DID request is not enabled by default. To enable this feature, please contact our Customer Service or Sales Departments.
Request#
HTTP Method: GET
URI Path: /v3/available_dids/
URI Query Parameters#
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
id |
|
Yes |
Unique ID number of the Available DID. |
include |
|
No |
Includes#
Value |
Description |
|---|---|
did_group |
|
did_group.stock_keeping_units |
|
nanpa_prefix |
Examples#
http
1GET /v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144 HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Api-Key: [API token]
curl
1curl -i -X GET https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144 -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"
response
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4 {
5 "data": {
6 "id": "75a21935-acfd-4160-8485-9fb7d049f144",
7 "type": "available_dids",
8 "attributes": {
9 "number": "12124727604"
10 },
11 "relationships": {
12 "did_group": {
13 "links": {
14 "self": "https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144/relationships/did_group",
15 "related": "https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144/did_group"
16 }
17 },
18 "nanpa_prefix": {
19 "links": {
20 "self": "https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144/relationships/nanpa_prefix",
21 "related": "https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144/nanpa_prefix"
22 }
23 }
24 }
25 },
26 "meta": {
27 "api_version": "2022-05-10"
28 }
29 }
http
1GET /v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144?include=did_group HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Api-Key: [API token]
curl
1curl -i -X GET 'https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144?include=did_group' -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"
response
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "75a21935-acfd-4160-8485-9fb7d049f144",
7 "type": "available_dids",
8 "attributes": {
9 "number": "12124727604"
10 },
11 "relationships": {
12 "did_group": {
13 "links": {
14 "self": "https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144/relationships/did_group",
15 "related": "https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144/did_group"
16 },
17 "data": {
18 "type": "did_groups",
19 "id": "916c8f4d-2108-4d79-853b-7c545ee83f8c"
20 }
21 },
22 "nanpa_prefix": {
23 "links": {
24 "self": "https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144/relationships/nanpa_prefix",
25 "related": "https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144/nanpa_prefix"
26 }
27 }
28 }
29 },
30 "included": [
31 {
32 "id": "916c8f4d-2108-4d79-853b-7c545ee83f8c",
33 "type": "did_groups",
34 "attributes": {
35 "prefix": "212",
36 "features": [
37 "voice_in",
38 "t38"
39 ],
40 "is_metered": false,
41 "area_name": "New York",
42 "allow_additional_channels": true
43 },
44 "relationships": {
45 "country": {
46 "links": {
47 "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/country",
48 "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/country"
49 }
50 },
51 "city": {
52 "links": {
53 "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/city",
54 "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/city"
55 }
56 },
57 "did_group_type": {
58 "links": {
59 "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/did_group_type",
60 "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/did_group_type"
61 }
62 },
63 "region": {
64 "links": {
65 "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/region",
66 "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/region"
67 }
68 },
69 "stock_keeping_units": {
70 "links": {
71 "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/stock_keeping_units",
72 "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/stock_keeping_units"
73 }
74 },
75 "requirement": {
76 "links": {
77 "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/requirement",
78 "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/requirement"
79 }
80 }
81 },
82 "meta": {
83 "available_dids_enabled": true,
84 "needs_registration": false,
85 "is_available": true,
86 "total_count": 8
87 }
88 }
89 ],
90 "meta": {
91 "api_version": "2022-05-10"
92 }
93}
http
1GET /v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144?include=did_group.stock_keeping_units HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Api-Key: [API token]
curl
1curl -i -X GET 'https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144?include=did_group.stock_keeping_units' -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"
response
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "75a21935-acfd-4160-8485-9fb7d049f144",
7 "type": "available_dids",
8 "attributes": {
9 "number": "12124727604"
10 },
11 "relationships": {
12 "did_group": {
13 "links": {
14 "self": "https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144/relationships/did_group",
15 "related": "https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144/did_group"
16 },
17 "data": {
18 "type": "did_groups",
19 "id": "916c8f4d-2108-4d79-853b-7c545ee83f8c"
20 }
21 },
22 "nanpa_prefix": {
23 "links": {
24 "self": "https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144/relationships/nanpa_prefix",
25 "related": "https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144/nanpa_prefix"
26 }
27 }
28 }
29 },
30 "included": [
31 {
32 "id": "916c8f4d-2108-4d79-853b-7c545ee83f8c",
33 "type": "did_groups",
34 "attributes": {
35 "prefix": "212",
36 "features": [
37 "voice_in",
38 "t38"
39 ],
40 "is_metered": false,
41 "area_name": "New York",
42 "allow_additional_channels": true
43 },
44 "relationships": {
45 "country": {
46 "links": {
47 "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/country",
48 "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/country"
49 }
50 },
51 "city": {
52 "links": {
53 "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/city",
54 "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/city"
55 }
56 },
57 "did_group_type": {
58 "links": {
59 "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/did_group_type",
60 "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/did_group_type"
61 }
62 },
63 "region": {
64 "links": {
65 "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/region",
66 "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/region"
67 }
68 },
69 "stock_keeping_units": {
70 "links": {
71 "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/stock_keeping_units",
72 "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/stock_keeping_units"
73 },
74 "data": [
75 {
76 "type": "stock_keeping_units",
77 "id": "af589936-3e8d-498c-b127-8054ef026dfa"
78 },
79 {
80 "type": "stock_keeping_units",
81 "id": "5dec9d3e-f25a-4ac3-a9b0-efcdd9ec744b"
82 },
83 {
84 "type": "stock_keeping_units",
85 "id": "e48e981f-ab6d-48a6-aaf6-e75539fc1011"
86 }
87 ]
88 },
89 "requirement": {
90 "links": {
91 "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/requirement",
92 "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/requirement"
93 }
94 }
95 },
96 "meta": {
97 "available_dids_enabled": true,
98 "needs_registration": false,
99 "is_available": true,
100 "total_count": 8
101 }
102 },
103 {
104 "id": "af589936-3e8d-498c-b127-8054ef026dfa",
105 "type": "stock_keeping_units",
106 "attributes": {
107 "setup_price": "0.0",
108 "monthly_price": "0.09",
109 "channels_included_count": 0
110 }
111 },
112 {
113 "id": "5dec9d3e-f25a-4ac3-a9b0-efcdd9ec744b",
114 "type": "stock_keeping_units",
115 "attributes": {
116 "setup_price": "0.0",
117 "monthly_price": "0.19",
118 "channels_included_count": 2
119 }
120 },
121 {
122 "id": "e48e981f-ab6d-48a6-aaf6-e75539fc1011",
123 "type": "stock_keeping_units",
124 "attributes": {
125 "setup_price": "4.42",
126 "monthly_price": "4.42",
127 "channels_included_count": 5
128 }
129 }
130 ],
131 "meta": {
132 "api_version": "2022-05-10"
133 }
134}
Other Responses#
Code |
Success |
Description |
|---|---|---|
404 |
No |
|
401 |
No |