Get Trunk Group
Description
Returns a single Trunk Group.
Request
HTTP Method: GET
URI Path: /v3/trunk_groups/
URI Query Parameters:
Name |
Type |
Is Required? |
Description |
---|---|---|---|
id |
|
Yes |
Unique ID identifier of the Trunk Group. |
include |
|
Optional |
Includes:
Value |
Description |
---|---|
trunks |
Examples
GET /v3/trunk_groups/418fe352-04b8-4e03-a7ce-cb57efd8c664 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/trunk_groups/418fe352-04b8-4e03-a7ce-cb57efd8c664 -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": "418fe352-04b8-4e03-a7ce-cb57efd8c664",
"type": "trunk_groups",
"links": {
"self": "https://api.didww.com/v3/trunk_groups/418fe352-04b8-4e03-a7ce-cb57efd8c664"
},
"attributes": {
"created_at": "2017-06-25T14:56:31.513Z",
"name": "Common Group",
"capacity_limit": 69
},
"relationships": {
"trunks": {
"links": {
"self": "https://api.didww.com/v3/trunk_groups/418fe352-04b8-4e03-a7ce-cb57efd8c664/relationships/trunks",
"related": "https://api.didww.com/v3/trunk_groups/418fe352-04b8-4e03-a7ce-cb57efd8c664/trunks"
}
}
},
"meta": {
"trunks_count": 1
}
},
"meta": {
"api_version": "2017-09-18"
}
}
GET /v3/trunk_groups/465b059a-b4a2-4c8e-ab3b-33dc60e096ae?include=trunks 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/trunk_groups/465b059a-b4a2-4c8e-ab3b-33dc60e096ae?include=trunks' -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": "465b059a-b4a2-4c8e-ab3b-33dc60e096ae",
"type": "trunk_groups",
"links": {
"self": "https://api.didww.com/v3/trunk_groups/465b059a-b4a2-4c8e-ab3b-33dc60e096ae"
},
"attributes": {
"created_at": "2017-06-25T14:56:31.513Z",
"name": "Common Group",
"capacity_limit": 69
},
"relationships": {
"trunks": {
"links": {
"self": "https://api.didww.com/v3/trunk_groups/465b059a-b4a2-4c8e-ab3b-33dc60e096ae/relationships/trunks",
"related": "https://api.didww.com/v3/trunk_groups/465b059a-b4a2-4c8e-ab3b-33dc60e096ae/trunks"
},
"data": [{
"type": "trunks",
"id": "87133f4d-4a88-436b-b74b-b63e79318426"
}]
}
},
"meta": {
"trunks_count": 1
}
},
"included": [{
"id": "87133f4d-4a88-436b-b74b-b63e79318426",
"type": "trunks",
"attributes": {
"priority": 1,
"capacity_limit": 5,
"weight": 65535,
"name": "Office Mobile",
"cli_format": "e164",
"cli_prefix": null,
"description": null,
"ringing_timeout": null,
"configuration": {
"type": "pstn_configurations",
"attributes": {
"dst": "1xxxxxxxxx"
}
}
},
"relationships": {
"trunk_group": {
"links": {
"self": "https://api.didww.com/v3/trunks/87133f4d-4a88-436b-b74b-b63e79318426/relationships/trunk_group",
"related": "https://api.didww.com/v3/trunks/87133f4d-4a88-436b-b74b-b63e79318426/trunk_group"
}
}
}
}],
"meta": {
"api_version": "2017-09-18"
}
}
Other Responses
Code |
Success |
Description |
---|---|---|
404 |
No |
|
401 |
No |