Get Outbound Trunks#
Returns the collection of outbound trunks.
Request#
HTTP Method: GET
URI Path: /v3/voice_out_trunks
Note
For all returned data attributes, see Outbound Trunk Object.
URI Query Parameters#
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
include |
|
No |
|
filter[<filter_name>] |
|
No |
|
fields[voice_out_trunks] |
|
No |
|
sort |
|
No |
|
page[number] |
|
No |
|
page[size] |
|
No |
Page size. Pagination defaults to |
Filters#
Filter Name |
Type |
Allow Blank |
Allow Array |
Filters by: |
|---|---|---|---|---|
id |
|
No |
Yes |
The trunk |
name |
|
Yes |
No |
The trunk |
name_contains |
|
Yes |
No |
The |
external_reference_id |
|
No |
No |
The |
on_cli_mismatch_action |
|
Yes |
No |
The |
allow_any_did_as_cli |
|
No |
No |
The |
status |
|
No |
No |
The |
threshold_reached |
|
No |
No |
The |
default_dst_action |
|
No |
No |
The |
media_encryption_mode |
|
No |
No |
The |
authentication_method.type |
|
No |
Yes |
The |
default_did.id |
|
No |
No |
Trunks whose default caller ID is this DID. A DID the account does not own is rejected rather than matching nothing. |
Sorting#
Value |
Sorts by: |
|---|---|
name |
The |
created_at |
The |
external_reference_id |
The |
allow_any_did_as_cli |
The |
threshold_reached |
The |
Includes#
Value |
Description |
|---|---|
dids |
|
emergency_dids |
Emergency DID relationship data. |
Object Relationships#
Value |
Description |
|---|---|
dids |
|
emergency_dids |
Emergency DID relationship data. |
Example#
http
1GET /v3/voice_out_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_out_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": "03813615-da15-4e3b-8e0a-3ea64b2585de",
8 "type": "voice_out_trunks",
9 "attributes": {
10 "name": "Outbound trunk Name",
11 "allowed_rtp_ips": [
12 "203.0.113.0/24"
13 ],
14 "authentication_method": {
15 "type": "credentials_and_ip",
16 "attributes": {
17 "allowed_sip_ips": [
18 "0.0.0.0/0"
19 ],
20 "tech_prefix": null,
21 "username": "554******",
22 "password": "fqe******"
23 }
24 },
25 "allow_any_did_as_cli": true,
26 "status": "active",
27 "on_cli_mismatch_action": "send_original_cli",
28 "capacity_limit": 100,
29 "threshold_reached": false,
30 "threshold_amount": "10000.0",
31 "media_encryption_mode": "disabled",
32 "ice_mode": "accept",
33 "rtcp_mux_mode": "accept",
34 "rtcp_feedback_mode": "accept",
35 "codecs": [
36 "pcma",
37 "pcmu",
38 "g729",
39 "g723",
40 "gsm",
41 "telephone_event"
42 ],
43 "default_dst_action": "allow_all",
44 "dst_prefixes": [],
45 "emergency_enable_all": false,
46 "force_symmetric_rtp": false,
47 "rtp_ping": false,
48 "rtp_timeout": 30,
49 "callback_url": null,
50 "created_at": "2025-04-02T10:00:00.000Z",
51 "external_reference_id": null
52 },
53 "relationships": {
54 "dids": {
55 "links": {
56 "self": "https://api.didww.com/v3/voice_out_trunks/03813615-da15-4e3b-8e0a-3ea64b2585de/relationships/dids",
57 "related": "https://api.didww.com/v3/voice_out_trunks/03813615-da15-4e3b-8e0a-3ea64b2585de/dids"
58 }
59 },
60 "emergency_dids": {
61 "links": {
62 "self": "https://api.didww.com/v3/voice_out_trunks/03813615-da15-4e3b-8e0a-3ea64b2585de/relationships/emergency_dids",
63 "related": "https://api.didww.com/v3/voice_out_trunks/03813615-da15-4e3b-8e0a-3ea64b2585de/emergency_dids"
64 }
65 }
66 },
67 "meta": {
68 "spent_amount": "12.34"
69 }
70 },
71 {
72 "id": "cf2e6377-fcaa-4416-8c8e-acd5f31a427f",
73 "type": "voice_out_trunks",
74 "attributes": {
75 "name": "Outbound trunk Name",
76 "allowed_rtp_ips": [
77 "198.51.100.1/32"
78 ],
79 "authentication_method": {
80 "type": "ip_only",
81 "attributes": {
82 "allowed_sip_ips": [
83 "198.51.100.1/32"
84 ],
85 "tech_prefix": null
86 }
87 },
88 "allow_any_did_as_cli": true,
89 "status": "active",
90 "on_cli_mismatch_action": "send_original_cli",
91 "capacity_limit": 100,
92 "threshold_reached": false,
93 "threshold_amount": "10000.0",
94 "media_encryption_mode": "disabled",
95 "ice_mode": "accept",
96 "rtcp_mux_mode": "accept",
97 "rtcp_feedback_mode": "accept",
98 "codecs": [
99 "pcma",
100 "pcmu",
101 "g729",
102 "g723",
103 "gsm",
104 "telephone_event"
105 ],
106 "default_dst_action": "allow_all",
107 "dst_prefixes": [],
108 "emergency_enable_all": true,
109 "force_symmetric_rtp": false,
110 "rtp_ping": false,
111 "rtp_timeout": 30,
112 "callback_url": null,
113 "created_at": "2025-04-02T10:00:00.000Z",
114 "external_reference_id": null
115 },
116 "relationships": {
117 "dids": {
118 "links": {
119 "self": "https://api.didww.com/v3/voice_out_trunks/cf2e6377-fcaa-4416-8c8e-acd5f31a427f/relationships/dids",
120 "related": "https://api.didww.com/v3/voice_out_trunks/cf2e6377-fcaa-4416-8c8e-acd5f31a427f/dids"
121 }
122 },
123 "emergency_dids": {
124 "links": {
125 "self": "https://api.didww.com/v3/voice_out_trunks/cf2e6377-fcaa-4416-8c8e-acd5f31a427f/relationships/emergency_dids",
126 "related": "https://api.didww.com/v3/voice_out_trunks/cf2e6377-fcaa-4416-8c8e-acd5f31a427f/emergency_dids"
127 }
128 }
129 },
130 "meta": {
131 "spent_amount": "12.34"
132 }
133 },
134 {
135 "id": "14a0b7fb-845a-44d9-a7dc-ac1620f21e42",
136 "type": "voice_out_trunks",
137 "attributes": {
138 "name": "Outbound trunk Name",
139 "allowed_rtp_ips": null,
140 "authentication_method": {
141 "type": "twilio",
142 "attributes": {
143 "twilio_account_sid": "AC39347AF064AF97E1682C3B7332DAAEE6"
144 }
145 },
146 "allow_any_did_as_cli": true,
147 "status": "active",
148 "on_cli_mismatch_action": "send_original_cli",
149 "capacity_limit": 100,
150 "threshold_reached": false,
151 "threshold_amount": "10000.0",
152 "media_encryption_mode": "disabled",
153 "ice_mode": "accept",
154 "rtcp_mux_mode": "accept",
155 "rtcp_feedback_mode": "accept",
156 "codecs": [
157 "pcma",
158 "pcmu",
159 "g729",
160 "g723",
161 "gsm",
162 "telephone_event"
163 ],
164 "default_dst_action": "allow_all",
165 "dst_prefixes": [],
166 "emergency_enable_all": false,
167 "force_symmetric_rtp": false,
168 "rtp_ping": false,
169 "rtp_timeout": 30,
170 "callback_url": null,
171 "created_at": "2025-04-02T10:00:00.000Z",
172 "external_reference_id": null
173 },
174 "relationships": {
175 "dids": {
176 "links": {
177 "self": "https://api.didww.com/v3/voice_out_trunks/14a0b7fb-845a-44d9-a7dc-ac1620f21e42/relationships/dids",
178 "related": "https://api.didww.com/v3/voice_out_trunks/14a0b7fb-845a-44d9-a7dc-ac1620f21e42/dids"
179 }
180 },
181 "emergency_dids": {
182 "links": {
183 "self": "https://api.didww.com/v3/voice_out_trunks/14a0b7fb-845a-44d9-a7dc-ac1620f21e42/relationships/emergency_dids",
184 "related": "https://api.didww.com/v3/voice_out_trunks/14a0b7fb-845a-44d9-a7dc-ac1620f21e42/emergency_dids"
185 }
186 }
187 },
188 "meta": {
189 "spent_amount": "12.34"
190 }
191 }
192 ],
193 "meta": {
194 "total_records": 3,
195 "api_version": "2026-11-19"
196 },
197 "links": {
198 "first": "https://api.didww.com/v3/voice_out_trunks?page%5Bnumber%5D=1&page%5Bsize%5D=50",
199 "last": "https://api.didww.com/v3/voice_out_trunks?page%5Bnumber%5D=1&page%5Bsize%5D=50"
200 }
201}
http
1GET /v3/voice_out_trunks?include=emergency_dids 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_out_trunks?include=emergency_dids' -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": "91f7bcb4-3278-433b-9de1-5e6f4131fd4d",
8 "type": "voice_out_trunks",
9 "attributes": {
10 "name": "Outbound trunk with emergency DID",
11 "allowed_rtp_ips": [
12 "198.51.100.0/24"
13 ],
14 "authentication_method": {
15 "type": "credentials_and_ip",
16 "attributes": {
17 "allowed_sip_ips": [
18 "198.51.100.0/24"
19 ],
20 "tech_prefix": null,
21 "username": "9q2******",
22 "password": "6zm******"
23 }
24 },
25 "allow_any_did_as_cli": true,
26 "status": "active",
27 "on_cli_mismatch_action": "send_original_cli",
28 "capacity_limit": 75,
29 "threshold_reached": false,
30 "threshold_amount": "3000.0",
31 "media_encryption_mode": "disabled",
32 "ice_mode": "accept",
33 "rtcp_mux_mode": "accept",
34 "rtcp_feedback_mode": "accept",
35 "codecs": [
36 "pcma",
37 "pcmu",
38 "g729",
39 "g723",
40 "gsm",
41 "telephone_event"
42 ],
43 "default_dst_action": "allow_all",
44 "dst_prefixes": [],
45 "emergency_enable_all": false,
46 "force_symmetric_rtp": false,
47 "rtp_ping": false,
48 "rtp_timeout": 30,
49 "callback_url": null,
50 "created_at": "2025-04-02T10:00:00.000Z",
51 "external_reference_id": null
52 },
53 "relationships": {
54 "dids": {
55 "links": {
56 "self": "https://api.didww.com/v3/voice_out_trunks/91f7bcb4-3278-433b-9de1-5e6f4131fd4d/relationships/dids",
57 "related": "https://api.didww.com/v3/voice_out_trunks/91f7bcb4-3278-433b-9de1-5e6f4131fd4d/dids"
58 }
59 },
60 "emergency_dids": {
61 "links": {
62 "self": "https://api.didww.com/v3/voice_out_trunks/91f7bcb4-3278-433b-9de1-5e6f4131fd4d/relationships/emergency_dids",
63 "related": "https://api.didww.com/v3/voice_out_trunks/91f7bcb4-3278-433b-9de1-5e6f4131fd4d/emergency_dids"
64 },
65 "data": [
66 {
67 "type": "dids",
68 "id": "0b5d4ca6-7002-4f19-a678-f5be95538e9b"
69 }
70 ]
71 }
72 },
73 "meta": {
74 "spent_amount": "12.34"
75 }
76 }
77 ],
78 "included": [
79 {
80 "id": "0b5d4ca6-7002-4f19-a678-f5be95538e9b",
81 "type": "dids",
82 "attributes": {
83 "number": "12125550123",
84 "description": null,
85 "blocked": false,
86 "awaiting_registration": false,
87 "terminated": false,
88 "emergency_enabled": true,
89 "capacity_limit": null,
90 "channels_included_count": 0,
91 "dedicated_channels_count": 0,
92 "billing_cycles_count": null,
93 "created_at": "2025-04-02T10:00:00.000Z",
94 "expires_at": "2026-05-02T10:00:00.000Z"
95 },
96 "relationships": {
97 "did_group": {
98 "links": {
99 "self": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/relationships/did_group",
100 "related": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/did_group"
101 }
102 },
103 "order": {
104 "links": {
105 "self": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/relationships/order",
106 "related": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/order"
107 }
108 },
109 "capacity_pool": {
110 "links": {
111 "self": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/relationships/capacity_pool",
112 "related": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/capacity_pool"
113 }
114 },
115 "shared_capacity_group": {
116 "links": {
117 "self": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/relationships/shared_capacity_group",
118 "related": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/shared_capacity_group"
119 }
120 },
121 "address_verification": {
122 "links": {
123 "self": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/relationships/address_verification",
124 "related": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/address_verification"
125 }
126 },
127 "voice_in_trunk": {
128 "links": {
129 "self": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/relationships/voice_in_trunk",
130 "related": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/voice_in_trunk"
131 }
132 },
133 "voice_in_trunk_group": {
134 "links": {
135 "self": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/relationships/voice_in_trunk_group",
136 "related": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/voice_in_trunk_group"
137 }
138 },
139 "sms_trunk": {
140 "links": {
141 "self": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/relationships/sms_trunk",
142 "related": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/sms_trunk"
143 }
144 },
145 "sms_trunk_group": {
146 "links": {
147 "self": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/relationships/sms_trunk_group",
148 "related": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/sms_trunk_group"
149 }
150 },
151 "emergency_calling_service": {
152 "links": {
153 "self": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/relationships/emergency_calling_service",
154 "related": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/emergency_calling_service"
155 }
156 },
157 "emergency_verification": {
158 "links": {
159 "self": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/relationships/emergency_verification",
160 "related": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/emergency_verification"
161 }
162 },
163 "identity": {
164 "links": {
165 "self": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/relationships/identity",
166 "related": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/identity"
167 }
168 }
169 }
170 }
171 ],
172 "meta": {
173 "total_records": 1,
174 "api_version": "2026-11-19"
175 },
176 "links": {
177 "first": "https://api.didww.com/v3/voice_out_trunks?include=emergency_dids&page%5Bnumber%5D=1&page%5Bsize%5D=50",
178 "last": "https://api.didww.com/v3/voice_out_trunks?include=emergency_dids&page%5Bnumber%5D=1&page%5Bsize%5D=50"
179 }
180}
Other Responses#
Code |
Success |
Description |
|---|---|---|
400 |
No |
Bad Request. Malformed request: unknown filter, bad pagination or bad sort field. |
401 |
No |
|
403 |
No |
The Outbound API is not enabled for the account. |
429 |
No |
The request budget of the account for the current window is spent ( |