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#
http
1GET /v3/trunk_groups/418fe352-04b8-4e03-a7ce-cb57efd8c664 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/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"
response
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "418fe352-04b8-4e03-a7ce-cb57efd8c664",
7 "type": "trunk_groups",
8 "links": {
9 "self": "https://api.didww.com/v3/trunk_groups/418fe352-04b8-4e03-a7ce-cb57efd8c664"
10 },
11 "attributes": {
12 "created_at": "2017-06-25T14:56:31.513Z",
13 "name": "Common Group",
14 "capacity_limit": 69
15 },
16 "relationships": {
17 "trunks": {
18 "links": {
19 "self": "https://api.didww.com/v3/trunk_groups/418fe352-04b8-4e03-a7ce-cb57efd8c664/relationships/trunks",
20 "related": "https://api.didww.com/v3/trunk_groups/418fe352-04b8-4e03-a7ce-cb57efd8c664/trunks"
21 }
22 }
23 },
24 "meta": {
25 "trunks_count": 1
26 }
27 },
28 "meta": {
29 "api_version": "2017-09-18"
30 }
31}
http
1GET /v3/trunk_groups/465b059a-b4a2-4c8e-ab3b-33dc60e096ae?include=trunks 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/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"
response
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "465b059a-b4a2-4c8e-ab3b-33dc60e096ae",
7 "type": "trunk_groups",
8 "links": {
9 "self": "https://api.didww.com/v3/trunk_groups/465b059a-b4a2-4c8e-ab3b-33dc60e096ae"
10 },
11 "attributes": {
12 "created_at": "2017-06-25T14:56:31.513Z",
13 "name": "Common Group",
14 "capacity_limit": 69
15 },
16 "relationships": {
17 "trunks": {
18 "links": {
19 "self": "https://api.didww.com/v3/trunk_groups/465b059a-b4a2-4c8e-ab3b-33dc60e096ae/relationships/trunks",
20 "related": "https://api.didww.com/v3/trunk_groups/465b059a-b4a2-4c8e-ab3b-33dc60e096ae/trunks"
21 },
22 "data": [{
23 "type": "trunks",
24 "id": "87133f4d-4a88-436b-b74b-b63e79318426"
25 }]
26 }
27 },
28 "meta": {
29 "trunks_count": 1
30 }
31 },
32 "included": [{
33 "id": "87133f4d-4a88-436b-b74b-b63e79318426",
34 "type": "trunks",
35 "attributes": {
36 "priority": 1,
37 "capacity_limit": 5,
38 "weight": 65535,
39 "name": "Office Mobile",
40 "cli_format": "e164",
41 "cli_prefix": null,
42 "description": null,
43 "ringing_timeout": null,
44 "configuration": {
45 "type": "pstn_configurations",
46 "attributes": {
47 "dst": "1xxxxxxxxx"
48 }
49 }
50 },
51 "relationships": {
52 "trunk_group": {
53 "links": {
54 "self": "https://api.didww.com/v3/trunks/87133f4d-4a88-436b-b74b-b63e79318426/relationships/trunk_group",
55 "related": "https://api.didww.com/v3/trunks/87133f4d-4a88-436b-b74b-b63e79318426/trunk_group"
56 }
57 }
58 }
59 }],
60 "meta": {
61 "api_version": "2017-09-18"
62 }
63}
Other Responses#
Code |
Success |
Description |
|---|---|---|
404 |
No |
|
401 |
No |