Get DID
Description
Returns a single DID owned by your account.
Request
HTTP Method: GET
URI Path: /v3/dids/
URI Query Parameters:
Name |
Type |
Is Required? |
Description |
---|---|---|---|
id |
|
Yes |
Unique ID identifier of the Order. |
include |
|
No |
Includes:
Object Relationships:
Value |
Description |
---|---|
order |
|
voice_in_trunk |
|
voice_in_trunk.voice_in_trunk_group |
|
voice_in_trunk.pop |
|
voice_in_trunk_group |
|
capacity_pool |
|
shared_capacity_group |
|
did_group |
|
did_group.country |
|
did_group.city |
|
did_group.region |
|
did_group.did_group_type |
|
did_group.stock_keeping_units |
Examples
GET /v3/dids/44957076-778a-4802-b60c-d22db0cda284 HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]
curl -i -X GET https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284 -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"id": "9c55ccc7-8b8e-4684-beaa-9f81462dcfdb",
"type": "dids",
"attributes": {
"blocked": false,
"capacity_limit": 1,
"description": "description",
"terminated": false,
"awaiting_registration": false,
"created_at": "2020-09-14T07:35:07.198Z",
"billing_cycles_count": null,
"number": "35314403952",
"expires_at": "2021-05-14T07:36:06.443Z",
"channels_included_count": 0,
"dedicated_channels_count": 0
},
"relationships": {
"did_group": {
"links": {
"self": "https://api.didww.com/v3/dids/9c55ccc7-8b8e-4684-beaa-9f81462dcfdb/relationships/did_group",
"related": "https://api.didww.com/v3/dids/9c55ccc7-8b8e-4684-beaa-9f81462dcfdb/did_group"
}
},
"order": {
"links": {
"self": "https://api.didww.com/v3/dids/9c55ccc7-8b8e-4684-beaa-9f81462dcfdb/relationships/order",
"related": "https://api.didww.com/v3/dids/9c55ccc7-8b8e-4684-beaa-9f81462dcfdb/order"
}
},
"voice_in_trunk": {
"links": {
"self": "https://api.didww.com/v3/dids/9c55ccc7-8b8e-4684-beaa-9f81462dcfdb/relationships/voice_in_trunk",
"related": "https://api.didww.com/v3/dids/9c55ccc7-8b8e-4684-beaa-9f81462dcfdb/voice_in_trunk"
}
},
"voice_in_trunk_group": {
"links": {
"self": "https://api.didww.com/v3/dids/9c55ccc7-8b8e-4684-beaa-9f81462dcfdb/relationships/voice_in_trunk_group",
"related": "https://api.didww.com/v3/dids/9c55ccc7-8b8e-4684-beaa-9f81462dcfdb/voice_in_trunk_group"
}
},
"capacity_pool": {
"links": {
"self": "https://api.didww.com/v3/dids/9c55ccc7-8b8e-4684-beaa-9f81462dcfdb/relationships/capacity_pool",
"related": "https://api.didww.com/v3/dids/9c55ccc7-8b8e-4684-beaa-9f81462dcfdb/capacity_pool"
}
},
"shared_capacity_group": {
"links": {
"self": "https://api.didww.com/v3/dids/9c55ccc7-8b8e-4684-beaa-9f81462dcfdb/relationships/shared_capacity_group",
"related": "https://api.didww.com/v3/dids/9c55ccc7-8b8e-4684-beaa-9f81462dcfdb/shared_capacity_group"
}
},
"address_verification": {
"links": {
"self": "https://api.didww.com/v3/dids/9c55ccc7-8b8e-4684-beaa-9f81462dcfdb/relationships/address_verification",
"related": "https://api.didww.com/v3/dids/9c55ccc7-8b8e-4684-beaa-9f81462dcfdb/address_verification"
}
}
}
},
"meta": {
"api_version": "2022-05-10"
}
}
GET /v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d?include=did_group HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]
{
"data": {
"id": "2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d",
"type": "dids",
"attributes": {
"blocked": false,
"capacity_limit": 1,
"description": "string",
"terminated": false,
"awaiting_registration": false,
"number": "437xxxxxxxxx",
"expires_at": "2017-06-25T08:21:41.795Z",
"channels_included_count": 2,
"created_at": "2017-06-25T08:21:41.795Z",
"dedicated_channels_count": 0
},
"relationships": {
"did_group": {
"links": {
"self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/did_group",
"related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/did_group"
},
"data": {
"type": "did_groups",
"id": "d04b6466-3d98-4be1-aac5-93ee241f57ca"
}
},
"order": {
"links": {
"self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/order",
"related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/order"
}
},
"voice_in_trunk": {
"links": {
"self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/voice_in_trunk",
"related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/voice_in_trunk"
}
},
"voice_in_trunk_group": {
"links": {
"self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/voice_in_trunk_group",
"related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/voice_in_trunk_group"
}
},
"capacity_pool": {
"links": {
"self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/capacity_pool",
"related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/capacity_pool"
}
},
"shared_capacity_group": {
"links": {
"self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/shared_capacity_group",
"related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/shared_capacity_group"
}
}
}
},
"included": [
{
"id": "d04b6466-3d98-4be1-aac5-93ee241f57ca",
"type": "did_groups",
"links": {
"self": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca"
},
"attributes": {
"prefix": "721",
"local_prefix": "",
"features": [
"voice"
],
"is_metered": false,
"area_name": "National",
"allow_additional_channels": true
},
"relationships": {
"country": {
"links": {
"self": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/relationships/country",
"related": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/country"
}
},
"city": {
"links": {
"self": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/relationships/city",
"related": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/city"
}
},
"did_group_type": {
"links": {
"self": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/relationships/did_group_type",
"related": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/did_group_type"
}
},
"region": {
"links": {
"self": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/relationships/region",
"related": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/region"
}
},
"stock_keeping_units": {
"links": {
"self": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/relationships/stock_keeping_units",
"related": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/stock_keeping_units"
}
}
}
}
]
}
curl -i -X GET 'https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d?include=did_group' -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json" --data-raw '{"data": {"attributes": {"awaiting_registration": false, "blocked": false, "capacity_limit": 1, "channels_included_count": 2, "created_at": "2017-06-25T08:21:41.795Z", "dedicated_channels_count": 0, "description": "string", "expires_at": "2017-06-25T08:21:41.795Z", "number": "437xxxxxxxxx", "terminated": false}, "id": "2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d", "relationships": {"capacity_pool": {"links": {"related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/capacity_pool", "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/capacity_pool"}}, "did_group": {"data": {"id": "d04b6466-3d98-4be1-aac5-93ee241f57ca", "type": "did_groups"}, "links": {"related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/did_group", "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/did_group"}}, "order": {"links": {"related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/order", "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/order"}}, "shared_capacity_group": {"links": {"related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/shared_capacity_group", "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/shared_capacity_group"}}, "voice_in_trunk": {"links": {"related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/voice_in_trunk", "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/voice_in_trunk"}}, "voice_in_trunk_group": {"links": {"related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/voice_in_trunk_group", "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/voice_in_trunk_group"}}}, "type": "dids"}, "included": [{"id": "d04b6466-3d98-4be1-aac5-93ee241f57ca", "type": "did_groups", "links": {"self": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca"}, "attributes": {"prefix": "721", "local_prefix": "", "features": ["voice"], "is_metered": false, "area_name": "National", "allow_additional_channels": true}, "relationships": {"country": {"links": {"self": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/relationships/country", "related": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/country"}}, "city": {"links": {"self": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/relationships/city", "related": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/city"}}, "did_group_type": {"links": {"self": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/relationships/did_group_type", "related": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/did_group_type"}}, "region": {"links": {"self": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/relationships/region", "related": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/region"}}, "stock_keeping_units": {"links": {"self": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/relationships/stock_keeping_units", "related": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/stock_keeping_units"}}}}]}'
Other Responses
Code |
Success |
Description |
---|---|---|
404 |
No |
|
401 |
No |