Get Available DID
GET https://{{host}}/v3/available_dids/:id
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 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 *** |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string | ||
Content-Type | string | ||
Api-Key | string |
RESPONSES
status: OK
{"data":{"id":"1b8a6517-a4f5-4851-b534-4e3fddb15c2b","type":"available_dids","attributes":{"number":"16362660758"},"relationships":{"did_group":{"links":{"self":"https://api.didww.com/v3/available_dids/1b8a6517-a4f5-4851-b534-4e3fddb15c2b/relationships/did_group","related":"https://api.didww.com/v3/available_dids/1b8a6517-a4f5-4851-b534-4e3fddb15c2b/did_group"},"data":{"type":"did_groups","id":"fe6cde1e-d68b-41e9-b1a0-8a617c65f3db"}}}},"included":[{"id":"fe6cde1e-d68b-41e9-b1a0-8a617c65f3db","type":"did_groups","attributes":{"prefix":"636","local_prefix":"","features":["voice"],"is_metered":false,"area_name":"Washington","allow_additional_channels":true},"relationships":{"country":{"links":{"self":"https://api.didww.com/v3/did_groups/fe6cde1e-d68b-41e9-b1a0-8a617c65f3db/relationships/country","related":"https://api.didww.com/v3/did_groups/fe6cde1e-d68b-41e9-b1a0-8a617c65f3db/country"}},"city":{"links":{"self":"https://api.didww.com/v3/did_groups/fe6cde1e-d68b-41e9-b1a0-8a617c65f3db/relationships/city","related":"https://api.didww.com/v3/did_groups/fe6cde1e-d68b-41e9-b1a0-8a617c65f3db/city"}},"did_group_type":{"links":{"self":"https://api.didww.com/v3/did_groups/fe6cde1e-d68b-41e9-b1a0-8a617c65f3db/relationships/did_group_type","related":"https://api.didww.com/v3/did_groups/fe6cde1e-d68b-41e9-b1a0-8a617c65f3db/did_group_type"}},"region":{"links":{"self":"https://api.didww.com/v3/did_groups/fe6cde1e-d68b-41e9-b1a0-8a617c65f3db/relationships/region","related":"https://api.didww.com/v3/did_groups/fe6cde1e-d68b-41e9-b1a0-8a617c65f3db/region"}},"stock_keeping_units":{"links":{"self":"https://api.didww.com/v3/did_groups/fe6cde1e-d68b-41e9-b1a0-8a617c65f3db/relationships/stock_keeping_units","related":"https://api.didww.com/v3/did_groups/fe6cde1e-d68b-41e9-b1a0-8a617c65f3db/stock_keeping_units"},"data":[{"type":"stock_keeping_units","id":"eab604a5-d276-4233-aca3-da790cd8ac1e"},{"type":"stock_keeping_units","id":"9da717e2-b235-43fd-ba12-9677fea6dea8"}]}},"meta":{"available_dids_enabled":true,"needs_registration":false,"is_available":true,"total_count":82,"restrictions":null}},{"id":"eab604a5-d276-4233-aca3-da790cd8ac1e","type":"stock_keeping_units","attributes":{"setup_price":"0.0","monthly_price":"0.09","channels_included_count":0}},{"id":"9da717e2-b235-43fd-ba12-9677fea6dea8","type":"stock_keeping_units","attributes":{"setup_price":"0.0","monthly_price":"0.19","channels_included_count":2}}],"meta":{"api_version":"2017-09-18"}}