Get Inbound Trunk Groups#
Returns a collection of Trunk Groups.
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 |
|---|---|---|---|
include |
|
No |
|
filter[<filter_name>] |
|
No |
|
fields[voice_in_trunk_groups] |
|
No |
|
sort |
|
No |
|
page[number] |
|
No |
|
page[size] |
|
No |
Page size. Pagination defaults to |
Includes#
Value |
Description |
|---|---|
voice_in_trunks |
Filters#
Filter Name |
Type |
Allow Blank |
Allow Array |
Filters by: |
|---|---|---|---|---|
id |
|
No |
Yes |
The trunk group |
external_reference_id |
|
No |
No |
The |
Sorting#
Value |
Sorts by: |
|---|---|
name |
The |
created_at |
The |
external_reference_id |
The |
capacity_limit |
The |
Examples#
http
1GET /v3/voice_in_trunk_groups HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Authorization: Bearer [access token]
curl
1curl -i -X GET https://api.didww.com/v3/voice_in_trunk_groups -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]"
response
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4{
5 "data": [
6 {
7 "id": "65b401cb-42f5-4911-877d-dc317a46b478",
8 "type": "voice_in_trunk_groups",
9 "attributes": {
10 "created_at": "2017-06-25T14:56:31.513Z",
11 "external_reference_id": null,
12 "name": "Common Group",
13 "capacity_limit": 69
14 },
15 "relationships": {
16 "voice_in_trunks": {
17 "links": {
18 "self": "https://api.didww.com/v3/voice_in_trunk_groups/65b401cb-42f5-4911-877d-dc317a46b478/relationships/voice_in_trunks",
19 "related": "https://api.didww.com/v3/voice_in_trunk_groups/65b401cb-42f5-4911-877d-dc317a46b478/voice_in_trunks"
20 }
21 }
22 },
23 "meta": {
24 "trunks_count": 1
25 }
26 },
27 {
28 "id": "72a60b4a-affb-46c7-8a8a-7e042c7611e8",
29 "type": "voice_in_trunk_groups",
30 "attributes": {
31 "created_at": "2017-06-25T14:56:31.513Z",
32 "external_reference_id": null,
33 "name": "Custom Group",
34 "capacity_limit": 50
35 },
36 "relationships": {
37 "voice_in_trunks": {
38 "links": {
39 "self": "https://api.didww.com/v3/voice_in_trunk_groups/72a60b4a-affb-46c7-8a8a-7e042c7611e8/relationships/voice_in_trunks",
40 "related": "https://api.didww.com/v3/voice_in_trunk_groups/72a60b4a-affb-46c7-8a8a-7e042c7611e8/voice_in_trunks"
41 }
42 }
43 },
44 "meta": {
45 "trunks_count": 0
46 }
47 }
48 ],
49 "meta": {
50 "total_records": 2,
51 "api_version": "2026-11-19"
52 },
53 "links": {
54 "first": "https://api.didww.com/v3/voice_in_trunk_groups?page%5Bnumber%5D=1&page%5Bsize%5D=50",
55 "last": "https://api.didww.com/v3/voice_in_trunk_groups?page%5Bnumber%5D=1&page%5Bsize%5D=50"
56 }
57}
http
1GET /v3/voice_in_trunk_groups?include=voice_in_trunks HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Authorization: Bearer [access token]
curl
1curl -i -X GET 'https://api.didww.com/v3/voice_in_trunk_groups?include=voice_in_trunks' -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]"
response
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4{
5 "data": [
6 {
7 "id": "a8176983-61c4-4768-b699-10d5f3245d90",
8 "type": "voice_in_trunk_groups",
9 "attributes": {
10 "created_at": "2017-06-25T14:56:31.513Z",
11 "external_reference_id": null,
12 "name": "Common Group",
13 "capacity_limit": 69
14 },
15 "relationships": {
16 "voice_in_trunks": {
17 "links": {
18 "self": "https://api.didww.com/v3/voice_in_trunk_groups/a8176983-61c4-4768-b699-10d5f3245d90/relationships/voice_in_trunks",
19 "related": "https://api.didww.com/v3/voice_in_trunk_groups/a8176983-61c4-4768-b699-10d5f3245d90/voice_in_trunks"
20 },
21 "data": [
22 {
23 "type": "voice_in_trunks",
24 "id": "5aa0b0ea-2bda-4424-a93c-104829d72c06"
25 }
26 ]
27 }
28 },
29 "meta": {
30 "trunks_count": 1
31 }
32 },
33 {
34 "id": "def3b7b1-ce76-420d-9684-8dbdb69e17c1",
35 "type": "voice_in_trunk_groups",
36 "attributes": {
37 "created_at": "2017-06-25T14:56:31.513Z",
38 "external_reference_id": null,
39 "name": "Custom Group",
40 "capacity_limit": 50
41 },
42 "relationships": {
43 "voice_in_trunks": {
44 "links": {
45 "self": "https://api.didww.com/v3/voice_in_trunk_groups/def3b7b1-ce76-420d-9684-8dbdb69e17c1/relationships/voice_in_trunks",
46 "related": "https://api.didww.com/v3/voice_in_trunk_groups/def3b7b1-ce76-420d-9684-8dbdb69e17c1/voice_in_trunks"
47 },
48 "data": []
49 }
50 },
51 "meta": {
52 "trunks_count": 0
53 }
54 }
55 ],
56 "included": [
57 {
58 "id": "5aa0b0ea-2bda-4424-a93c-104829d72c06",
59 "type": "voice_in_trunks",
60 "attributes": {
61 "priority": 1,
62 "capacity_limit": 5,
63 "weight": 65535,
64 "name": "Office Mobile",
65 "cli_format": "e164",
66 "cli_prefix": null,
67 "description": null,
68 "ringing_timeout": null,
69 "pop": null,
70 "created_at": "2017-06-25T08:21:41.795Z",
71 "external_reference_id": null,
72 "configuration": {
73 "type": "pstn_configurations",
74 "attributes": {
75 "dst": "1xxxxxxxxx"
76 }
77 }
78 },
79 "relationships": {
80 "voice_in_trunk_group": {
81 "links": {
82 "self": "https://api.didww.com/v3/voice_in_trunks/5aa0b0ea-2bda-4424-a93c-104829d72c06/relationships/voice_in_trunk_group",
83 "related": "https://api.didww.com/v3/voice_in_trunks/5aa0b0ea-2bda-4424-a93c-104829d72c06/voice_in_trunk_group"
84 }
85 }
86 }
87 }
88 ],
89 "meta": {
90 "total_records": 2,
91 "api_version": "2026-11-19"
92 },
93 "links": {
94 "first": "https://api.didww.com/v3/voice_in_trunk_groups?include=voice_in_trunks&page%5Bnumber%5D=1&page%5Bsize%5D=50",
95 "last": "https://api.didww.com/v3/voice_in_trunk_groups?include=voice_in_trunks&page%5Bnumber%5D=1&page%5Bsize%5D=50"
96 }
97}
Other Responses#
Code |
Success |
Description |
|---|---|---|
400 |
No |
Bad Request. Malformed request: unknown filter, bad pagination or bad sort field. |
401 |
No |
|
429 |
No |
The request budget of the account for the current window is spent ( |