Get Inbound Trunk Group#
Returns a single inbound trunk group.
Request#
HTTP Method: GET
URI Path: /v3/voice_in_trunk_groups/
Note
For all returned data attributes, see Trunk Group Object.
URI Query Parameters#
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
id |
|
Yes |
Unique ID identifier of the Trunk Group. |
include |
|
No |
Includes#
Value |
Description |
|---|---|
voice_in_trunks |
Examples#
http
1GET /v3/voice_in_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/voice_in_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": "voice_in_trunk_groups",
8 "links": {
9 "self": "https://api.didww.com/v3/voice_in_trunk_groups/418fe352-04b8-4e03-a7ce-cb57efd8c664"
10 },
11 "attributes": {
12 "created_at": "2017-06-25T14:56:31.513Z",
13 "external_reference_id": null,
14 "name": "Common Group",
15 "capacity_limit": 69
16 },
17 "relationships": {
18 "voice_in_trunks": {
19 "links": {
20 "self": "https://api.didww.com/v3/voice_in_trunk_groups/418fe352-04b8-4e03-a7ce-cb57efd8c664/relationships/voice_in_trunks",
21 "related": "https://api.didww.com/v3/voice_in_trunk_groups/418fe352-04b8-4e03-a7ce-cb57efd8c664/voice_in_trunks"
22 }
23 }
24 },
25 "meta": {
26 "trunks_count": 1
27 }
28 }
29}
http
1GET /v3/voice_in_trunk_groups/465b059a-b4a2-4c8e-ab3b-33dc60e096ae?include=voice_in_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/voice_in_trunk_groups/465b059a-b4a2-4c8e-ab3b-33dc60e096ae?include=voice_in_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": "voice_in_trunk_groups",
8 "links": {
9 "self": "https://api.didww.com/v3/voice_in_trunk_groups/465b059a-b4a2-4c8e-ab3b-33dc60e096ae"
10 },
11 "attributes": {
12 "created_at": "2017-06-25T14:56:31.513Z",
13 "external_reference_id": null,
14 "name": "Common Group",
15 "capacity_limit": 69
16 },
17 "relationships": {
18 "voice_in_trunks": {
19 "links": {
20 "self": "https://api.didww.com/v3/voice_in_trunk_groups/465b059a-b4a2-4c8e-ab3b-33dc60e096ae/relationships/voice_in_trunks",
21 "related": "https://api.didww.com/v3/voice_in_trunk_groups/465b059a-b4a2-4c8e-ab3b-33dc60e096ae/voice_in_trunks"
22 },
23 "data": [
24 {
25 "type": "voice_in_trunks",
26 "id": "87133f4d-4a88-436b-b74b-b63e79318426"
27 }
28 ]
29 }
30 },
31 "meta": {
32 "trunks_count": 1
33 }
34 },
35 "included": [
36 {
37 "id": "87133f4d-4a88-436b-b74b-b63e79318426",
38 "type": "voice_in_trunks",
39 "attributes": {
40 "priority": 1,
41 "capacity_limit": 5,
42 "weight": 65535,
43 "name": "Office Mobile",
44 "cli_format": "e164",
45 "cli_prefix": null,
46 "description": null,
47 "ringing_timeout": null,
48 "configuration": {
49 "type": "pstn_configurations",
50 "attributes": {
51 "dst": "1xxxxxxxxx"
52 }
53 }
54 },
55 "relationships": {
56 "voice_in_trunk_group": {
57 "links": {
58 "self": "https://api.didww.com/v3/voice_in_trunks/87133f4d-4a88-436b-b74b-b63e79318426/relationships/voice_in_trunk_group",
59 "related": "https://api.didww.com/v3/voice_in_trunks/87133f4d-4a88-436b-b74b-b63e79318426/voice_in_trunk_group"
60 }
61 }
62 }
63 }
64 ]
65}
Other Responses#
Code |
Success |
Description |
|---|---|---|
404 |
No |
|
401 |
No |