Get Available DIDs
GET https://{{host}}/v3/available_dids
Returns a list of Available DIDs. Pagination and Sorting are disabled.
Note
Available DIDs request is not enabled by default. To enable this feature, please contact our Customer Service or Sales Departments.Note
Sorting order in which results are returned is random.Note
Previous requests are not saved/cached and new request may return same values as in the previous request, having in mind mind filters used.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
include | null | Comma-separated values of include parameter. | |
The response will include a top-level object relationships with associated data under the appropriate resource key. | |||
| Details in Inclusion of Related Resources Article. |
Allowed values:
did_group - DID Group Object
did_group.stock_keeping_units - Stock Keeping Unit Object
*** |
| filter[id] | null | | string - Filters by available DID id field.
-
Allow blank - No.
-
Allow array - Yes. | |
filter[number_contains]| null | |string- Filters by the number field. -
Allow blank - No.
-
Allow array - No. | |
filter[did_group.id]| null | |string- Filters by DID group id field. -
Allow blank - No.
-
Allow array - Yes. | |
filter[did_group_type.id]| null | |string- Filters by DID group type id field. -
Allow blank - No.
-
Allow array - Yes. | |
filter[did_group.needs_registration]| null | |boolean- Filters by DID group needs_registration field. -
Allow blank - No.
-
Allow array - No. | |
filter[did_group.features]| null | |string- Filters by the did_group.features field.
Can be one/several/all of voice_in, voice_out, t38, sms_in, sms_out (example: “voice_in,sms_in”). -
Allow blank - No.
-
Allow array - Yes. | |
filter[country.id]| null | |string- Filters by DID group country id field. -
Allow blank - No.
-
Allow array - Yes. | |
filter[region.id]| null | |string- Filters by DID group region id field. -
Allow blank - No.
-
Allow array - Yes. | |
filter[city.id]| null | |string- Filters by DID group city id field. -
Allow blank - No.
-
Allow array - Yes. | |
filter[nanpa_prefix.id]| null | |string- Filters by nanpa_prefix id field. -
Allow blank - No.
-
Allow array - No. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string | ||
Content-Type | string | ||
Api-Key | string |
RESPONSES
status: OK
{"data":[{"id":"240af4b1-d7c7-4674-8203-35684f0abab7","type":"available_dids","attributes":{"number":"12172109332"},"relationships":{"did_group":{"links":{"self":"https://api.didww.com/v3/available_dids/240af4b1-d7c7-4674-8203-35684f0abab7/relationships/did_group","related":"https://api.didww.com/v3/available_dids/240af4b1-d7c7-4674-8203-35684f0abab7/did_group"},"data":{"type":"did_groups","id":"2678ca58-347e-4ed6-9116-8f6f6b66d552"}}}},{"id":"fb21709a-d480-4fb8-98a4-57eb2c18c0b0","type":"available_dids","attributes":{"number":"12172109374"},"relationships":{"did_group":{"links":{"self":"https://api.didww.com/v3/available_dids/fb21709a-d480-4fb8-98a4-57eb2c18c0b0/relationships/did_group","related":"https://api.didww.com/v3/available_dids/fb21709a-d480-4fb8-98a4-57eb2c18c0b0/did_group"},"data":{"type":"did_groups","id":"2678ca58-347e-4ed6-9116-8f6f6b66d552"}}}},{"id":"5add4ae0-4577-45f0-86d8-e91a870684ac","type":"available_dids","attributes":{"number":"12172109352"},"relationships":{"did_group":{"links":{"self":"https://api.didww.com/v3/available_dids/5add4ae0-4577-45f0-86d8-e91a870684ac/relationships/did_group","related":"https://api.didww.com/v3/available_dids/5add4ae0-4577-45f0-86d8-e91a870684ac/did_group"},"data":{"type":"did_groups","id":"2678ca58-347e-4ed6-9116-8f6f6b66d552"}}}},{"id":"27b219e3-c462-40bb-896b-9f6f30f920d8","type":"available_dids","attributes":{"number":"12172109372"},"relationships":{"did_group":{"links":{"self":"https://api.didww.com/v3/available_dids/27b219e3-c462-40bb-896b-9f6f30f920d8/relationships/did_group","related":"https://api.didww.com/v3/available_dids/27b219e3-c462-40bb-896b-9f6f30f920d8/did_group"},"data":{"type":"did_groups","id":"2678ca58-347e-4ed6-9116-8f6f6b66d552"}}}},{"id":"abcbf58c-b07d-4fb6-93ea-67b5b1e520b7","type":"available_dids","attributes":{"number":"12172109362"},"relationships":{"did_group":{"links":{"self":"https://api.didww.com/v3/available_dids/abcbf58c-b07d-4fb6-93ea-67b5b1e520b7/relationships/did_group","related":"https://api.didww.com/v3/available_dids/abcbf58c-b07d-4fb6-93ea-67b5b1e520b7/did_group"},"data":{"type":"did_groups","id":"2678ca58-347e-4ed6-9116-8f6f6b66d552"}}}},{"id":"2ee4ccb6-5941-4cff-aa3c-69cbc324fc58","type":"available_dids","attributes":{"number":"12172109335"},"relationships":{"did_group":{"links":{"self":"https://api.didww.com/v3/available_dids/2ee4ccb6-5941-4cff-aa3c-69cbc324fc58/relationships/did_group","related":"https://api.didww.com/v3/available_dids/2ee4ccb6-5941-4cff-aa3c-69cbc324fc58/did_group"},"data":{"type":"did_groups","id":"2678ca58-347e-4ed6-9116-8f6f6b66d552"}}}},{"id":"092f1fb2-4cbe-4505-a229-4a4961c641db","type":"available_dids","attributes":{"number":"12172109365"},"relationships":{"did_group":{"links":{"self":"https://api.didww.com/v3/available_dids/092f1fb2-4cbe-4505-a229-4a4961c641db/relationships/did_group","related":"https://api.didww.com/v3/available_dids/092f1fb2-4cbe-4505-a229-4a4961c641db/did_group"},"data":{"type":"did_groups","id":"2678ca58-347e-4ed6-9116-8f6f6b66d552"}}}},{"id":"be913aeb-bf4c-4bb7-b807-d114fcd47c71","type":"available_dids","attributes":{"number":"12172109360"},"relationships":{"did_group":{"links":{"self":"https://api.didww.com/v3/available_dids/be913aeb-bf4c-4bb7-b807-d114fcd47c71/relationships/did_group","related":"https://api.didww.com/v3/available_dids/be913aeb-bf4c-4bb7-b807-d114fcd47c71/did_group"},"data":{"type":"did_groups","id":"2678ca58-347e-4ed6-9116-8f6f6b66d552"}}}},{"id":"7bd39d55-0a31-4c06-962a-88286495d430","type":"available_dids","attributes":{"number":"12172109354"},"relationships":{"did_group":{"links":{"self":"https://api.didww.com/v3/available_dids/7bd39d55-0a31-4c06-962a-88286495d430/relationships/did_group","related":"https://api.didww.com/v3/available_dids/7bd39d55-0a31-4c06-962a-88286495d430/did_group"},"data":{"type":"did_groups","id":"2678ca58-347e-4ed6-9116-8f6f6b66d552"}}}},{"id":"f144dfbf-05eb-4177-8b2c-a7047e5359e0","type":"available_dids","attributes":{"number":"12172109336"},"relationships":{"did_group":{"links":{"self":"https://api.didww.com/v3/available_dids/f144dfbf-05eb-4177-8b2c-a7047e5359e0/relationships/did_group","related":"https://api.didww.com/v3/available_dids/f144dfbf-05eb-4177-8b2c-a7047e5359e0/did_group"},"data":{"type":"did_groups","id":"2678ca58-347e-4ed6-9116-8f6f6b66d552"}}}}],"included":[{"id":"2678ca58-347e-4ed6-9116-8f6f6b66d552","type":"did_groups","attributes":{"prefix":"217","local_prefix":"","features":["voice_in","voice_out","sms_in","sms_out","t38"],"is_metered":false,"area_name":"Springfield","allow_additional_channels":true},"relationships":{"country":{"links":{"self":"https://api.didww.com/v3/did_groups/2678ca58-347e-4ed6-9116-8f6f6b66d552/relationships/country","related":"https://api.didww.com/v3/did_groups/2678ca58-347e-4ed6-9116-8f6f6b66d552/country"}},"city":{"links":{"self":"https://api.didww.com/v3/did_groups/2678ca58-347e-4ed6-9116-8f6f6b66d552/relationships/city","related":"https://api.didww.com/v3/did_groups/2678ca58-347e-4ed6-9116-8f6f6b66d552/city"}},"did_group_type":{"links":{"self":"https://api.didww.com/v3/did_groups/2678ca58-347e-4ed6-9116-8f6f6b66d552/relationships/did_group_type","related":"https://api.didww.com/v3/did_groups/2678ca58-347e-4ed6-9116-8f6f6b66d552/did_group_type"}},"region":{"links":{"self":"https://api.didww.com/v3/did_groups/2678ca58-347e-4ed6-9116-8f6f6b66d552/relationships/region","related":"https://api.didww.com/v3/did_groups/2678ca58-347e-4ed6-9116-8f6f6b66d552/region"}},"stock_keeping_units":{"links":{"self":"https://api.didww.com/v3/did_groups/2678ca58-347e-4ed6-9116-8f6f6b66d552/relationships/stock_keeping_units","related":"https://api.didww.com/v3/did_groups/2678ca58-347e-4ed6-9116-8f6f6b66d552/stock_keeping_units"},"data":[{"type":"stock_keeping_units","id":"c4621609-5a98-40bd-910f-d98d2e92ddba"},{"type":"stock_keeping_units","id":"b57cf11c-d73c-4f21-a590-4d8568a7529d"}]}},"meta":{"available_dids_enabled":true,"needs_registration":false,"is_available":true,"total_count":41,"restrictions":null}},{"id":"c4621609-5a98-40bd-910f-d98d2e92ddba","type":"stock_keeping_units","attributes":{"setup_price":"0.0","monthly_price":"0.15","channels_included_count":0}},{"id":"b57cf11c-d73c-4f21-a590-4d8568a7529d","type":"stock_keeping_units","attributes":{"setup_price":"0.0","monthly_price":"0.4","channels_included_count":2}}],"meta":{"total_count":40,"api_version":"2022-05-10"}}