Get Outbound Trunk#
Returns a single outbound trunk owned by the account.
Request#
HTTP Method: GET
URI Path: /v3/voice_out_trunks/{id}
Note
For all returned data attributes, see Outbound Trunk Object.
URI Query Parameters#
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
id |
|
Yes |
Unique identifier of the outbound trunk. |
include |
|
No |
Includes#
Value |
Description |
|---|---|
dids |
|
emergency_dids |
Emergency DID relationship data. |
Object Relationships#
Value |
Description |
|---|---|
dids |
|
emergency_dids |
Emergency DID relationship data. |
Examples#
http
1GET /v3/voice_out_trunks/03813615-da15-4e3b-8e0a-3ea64b2585de 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/03813615-da15-4e3b-8e0a-3ea64b2585de -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 "id": "03813615-da15-4e3b-8e0a-3ea64b2585de",
7 "type": "voice_out_trunks",
8 "attributes": {
9 "name": "Outbound trunk Name",
10 "allowed_rtp_ips": [
11 "203.0.113.0/24"
12 ],
13 "authentication_method": {
14 "type": "credentials_and_ip",
15 "attributes": {
16 "allowed_sip_ips": [
17 "0.0.0.0/0"
18 ],
19 "tech_prefix": null,
20 "username": "554******",
21 "password": "fqe******"
22 }
23 },
24 "allow_any_did_as_cli": true,
25 "status": "active",
26 "on_cli_mismatch_action": "send_original_cli",
27 "capacity_limit": 100,
28 "threshold_reached": false,
29 "threshold_amount": "10000.0",
30 "media_encryption_mode": "disabled",
31 "ice_mode": "accept",
32 "rtcp_mux_mode": "accept",
33 "rtcp_feedback_mode": "accept",
34 "codecs": [
35 "pcma",
36 "pcmu",
37 "g729",
38 "g723",
39 "gsm",
40 "telephone_event"
41 ],
42 "default_dst_action": "allow_all",
43 "dst_prefixes": [],
44 "emergency_enable_all": false,
45 "force_symmetric_rtp": false,
46 "rtp_ping": false,
47 "rtp_timeout": 30,
48 "callback_url": null,
49 "created_at": "2025-04-02T10:00:00.000Z",
50 "external_reference_id": null
51 },
52 "relationships": {
53 "dids": {
54 "links": {
55 "self": "https://api.didww.com/v3/voice_out_trunks/03813615-da15-4e3b-8e0a-3ea64b2585de/relationships/dids",
56 "related": "https://api.didww.com/v3/voice_out_trunks/03813615-da15-4e3b-8e0a-3ea64b2585de/dids"
57 }
58 },
59 "emergency_dids": {
60 "links": {
61 "self": "https://api.didww.com/v3/voice_out_trunks/03813615-da15-4e3b-8e0a-3ea64b2585de/relationships/emergency_dids",
62 "related": "https://api.didww.com/v3/voice_out_trunks/03813615-da15-4e3b-8e0a-3ea64b2585de/emergency_dids"
63 }
64 }
65 },
66 "meta": {
67 "spent_amount": "12.34"
68 }
69 },
70 "meta": {
71 "api_version": "2026-11-19"
72 }
73}
http
1GET /v3/voice_out_trunks/cf2e6377-fcaa-4416-8c8e-acd5f31a427f 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/cf2e6377-fcaa-4416-8c8e-acd5f31a427f -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 "id": "cf2e6377-fcaa-4416-8c8e-acd5f31a427f",
7 "type": "voice_out_trunks",
8 "attributes": {
9 "name": "Outbound trunk Name",
10 "allowed_rtp_ips": [
11 "198.51.100.1/32"
12 ],
13 "authentication_method": {
14 "type": "ip_only",
15 "attributes": {
16 "allowed_sip_ips": [
17 "198.51.100.1/32"
18 ],
19 "tech_prefix": null
20 }
21 },
22 "allow_any_did_as_cli": true,
23 "status": "active",
24 "on_cli_mismatch_action": "send_original_cli",
25 "capacity_limit": 100,
26 "threshold_reached": false,
27 "threshold_amount": "10000.0",
28 "media_encryption_mode": "disabled",
29 "ice_mode": "accept",
30 "rtcp_mux_mode": "accept",
31 "rtcp_feedback_mode": "accept",
32 "codecs": [
33 "pcma",
34 "pcmu",
35 "g729",
36 "g723",
37 "gsm",
38 "telephone_event"
39 ],
40 "default_dst_action": "allow_all",
41 "dst_prefixes": [],
42 "emergency_enable_all": true,
43 "force_symmetric_rtp": false,
44 "rtp_ping": false,
45 "rtp_timeout": 30,
46 "callback_url": null,
47 "created_at": "2025-04-02T10:00:00.000Z",
48 "external_reference_id": null
49 },
50 "relationships": {
51 "dids": {
52 "links": {
53 "self": "https://api.didww.com/v3/voice_out_trunks/cf2e6377-fcaa-4416-8c8e-acd5f31a427f/relationships/dids",
54 "related": "https://api.didww.com/v3/voice_out_trunks/cf2e6377-fcaa-4416-8c8e-acd5f31a427f/dids"
55 }
56 },
57 "emergency_dids": {
58 "links": {
59 "self": "https://api.didww.com/v3/voice_out_trunks/cf2e6377-fcaa-4416-8c8e-acd5f31a427f/relationships/emergency_dids",
60 "related": "https://api.didww.com/v3/voice_out_trunks/cf2e6377-fcaa-4416-8c8e-acd5f31a427f/emergency_dids"
61 }
62 }
63 },
64 "meta": {
65 "spent_amount": "12.34"
66 }
67 },
68 "meta": {
69 "api_version": "2026-11-19"
70 }
71}
http
1GET /v3/voice_out_trunks/14a0b7fb-845a-44d9-a7dc-ac1620f21e42 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/14a0b7fb-845a-44d9-a7dc-ac1620f21e42 -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 "id": "14a0b7fb-845a-44d9-a7dc-ac1620f21e42",
7 "type": "voice_out_trunks",
8 "attributes": {
9 "name": "Outbound trunk Name",
10 "allowed_rtp_ips": null,
11 "authentication_method": {
12 "type": "twilio",
13 "attributes": {
14 "twilio_account_sid": "AC39347AF064AF97E1682C3B7332DAAEE6"
15 }
16 },
17 "allow_any_did_as_cli": true,
18 "status": "active",
19 "on_cli_mismatch_action": "send_original_cli",
20 "capacity_limit": 100,
21 "threshold_reached": false,
22 "threshold_amount": "10000.0",
23 "media_encryption_mode": "disabled",
24 "ice_mode": "accept",
25 "rtcp_mux_mode": "accept",
26 "rtcp_feedback_mode": "accept",
27 "codecs": [
28 "pcma",
29 "pcmu",
30 "g729",
31 "g723",
32 "gsm",
33 "telephone_event"
34 ],
35 "default_dst_action": "allow_all",
36 "dst_prefixes": [],
37 "emergency_enable_all": false,
38 "force_symmetric_rtp": false,
39 "rtp_ping": false,
40 "rtp_timeout": 30,
41 "callback_url": null,
42 "created_at": "2025-04-02T10:00:00.000Z",
43 "external_reference_id": null
44 },
45 "relationships": {
46 "dids": {
47 "links": {
48 "self": "https://api.didww.com/v3/voice_out_trunks/14a0b7fb-845a-44d9-a7dc-ac1620f21e42/relationships/dids",
49 "related": "https://api.didww.com/v3/voice_out_trunks/14a0b7fb-845a-44d9-a7dc-ac1620f21e42/dids"
50 }
51 },
52 "emergency_dids": {
53 "links": {
54 "self": "https://api.didww.com/v3/voice_out_trunks/14a0b7fb-845a-44d9-a7dc-ac1620f21e42/relationships/emergency_dids",
55 "related": "https://api.didww.com/v3/voice_out_trunks/14a0b7fb-845a-44d9-a7dc-ac1620f21e42/emergency_dids"
56 }
57 }
58 },
59 "meta": {
60 "spent_amount": "12.34"
61 }
62 },
63 "meta": {
64 "api_version": "2026-11-19"
65 }
66}
http
1GET /v3/voice_out_trunks/91f7bcb4-3278-433b-9de1-5e6f4131fd4d?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/91f7bcb4-3278-433b-9de1-5e6f4131fd4d?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 "id": "91f7bcb4-3278-433b-9de1-5e6f4131fd4d",
7 "type": "voice_out_trunks",
8 "attributes": {
9 "name": "Outbound trunk with emergency DID",
10 "allowed_rtp_ips": [
11 "198.51.100.0/24"
12 ],
13 "authentication_method": {
14 "type": "credentials_and_ip",
15 "attributes": {
16 "allowed_sip_ips": [
17 "198.51.100.0/24"
18 ],
19 "tech_prefix": null,
20 "username": "9q2******",
21 "password": "6zm******"
22 }
23 },
24 "allow_any_did_as_cli": true,
25 "status": "active",
26 "on_cli_mismatch_action": "send_original_cli",
27 "capacity_limit": 75,
28 "threshold_reached": false,
29 "threshold_amount": "3000.0",
30 "media_encryption_mode": "disabled",
31 "ice_mode": "accept",
32 "rtcp_mux_mode": "accept",
33 "rtcp_feedback_mode": "accept",
34 "codecs": [
35 "pcma",
36 "pcmu",
37 "g729",
38 "g723",
39 "gsm",
40 "telephone_event"
41 ],
42 "default_dst_action": "allow_all",
43 "dst_prefixes": [],
44 "emergency_enable_all": false,
45 "force_symmetric_rtp": false,
46 "rtp_ping": false,
47 "rtp_timeout": 30,
48 "callback_url": null,
49 "created_at": "2025-04-02T10:00:00.000Z",
50 "external_reference_id": null
51 },
52 "relationships": {
53 "dids": {
54 "links": {
55 "self": "https://api.didww.com/v3/voice_out_trunks/91f7bcb4-3278-433b-9de1-5e6f4131fd4d/relationships/dids",
56 "related": "https://api.didww.com/v3/voice_out_trunks/91f7bcb4-3278-433b-9de1-5e6f4131fd4d/dids"
57 }
58 },
59 "emergency_dids": {
60 "links": {
61 "self": "https://api.didww.com/v3/voice_out_trunks/91f7bcb4-3278-433b-9de1-5e6f4131fd4d/relationships/emergency_dids",
62 "related": "https://api.didww.com/v3/voice_out_trunks/91f7bcb4-3278-433b-9de1-5e6f4131fd4d/emergency_dids"
63 },
64 "data": [
65 {
66 "type": "dids",
67 "id": "0b5d4ca6-7002-4f19-a678-f5be95538e9b"
68 }
69 ]
70 }
71 },
72 "meta": {
73 "spent_amount": "12.34"
74 }
75 },
76 "included": [
77 {
78 "id": "0b5d4ca6-7002-4f19-a678-f5be95538e9b",
79 "type": "dids",
80 "attributes": {
81 "number": "12125550124",
82 "description": null,
83 "blocked": false,
84 "awaiting_registration": false,
85 "terminated": false,
86 "emergency_enabled": true,
87 "capacity_limit": null,
88 "channels_included_count": 0,
89 "dedicated_channels_count": 0,
90 "billing_cycles_count": null,
91 "created_at": "2025-04-02T10:00:00.000Z",
92 "expires_at": "2026-05-02T10:00:00.000Z"
93 },
94 "relationships": {
95 "did_group": {
96 "links": {
97 "self": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/relationships/did_group",
98 "related": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/did_group"
99 }
100 },
101 "order": {
102 "links": {
103 "self": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/relationships/order",
104 "related": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/order"
105 }
106 },
107 "capacity_pool": {
108 "links": {
109 "self": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/relationships/capacity_pool",
110 "related": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/capacity_pool"
111 }
112 },
113 "shared_capacity_group": {
114 "links": {
115 "self": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/relationships/shared_capacity_group",
116 "related": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/shared_capacity_group"
117 }
118 },
119 "address_verification": {
120 "links": {
121 "self": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/relationships/address_verification",
122 "related": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/address_verification"
123 }
124 },
125 "voice_in_trunk": {
126 "links": {
127 "self": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/relationships/voice_in_trunk",
128 "related": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/voice_in_trunk"
129 }
130 },
131 "voice_in_trunk_group": {
132 "links": {
133 "self": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/relationships/voice_in_trunk_group",
134 "related": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/voice_in_trunk_group"
135 }
136 },
137 "sms_trunk": {
138 "links": {
139 "self": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/relationships/sms_trunk",
140 "related": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/sms_trunk"
141 }
142 },
143 "sms_trunk_group": {
144 "links": {
145 "self": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/relationships/sms_trunk_group",
146 "related": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/sms_trunk_group"
147 }
148 },
149 "emergency_calling_service": {
150 "links": {
151 "self": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/relationships/emergency_calling_service",
152 "related": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/emergency_calling_service"
153 }
154 },
155 "emergency_verification": {
156 "links": {
157 "self": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/relationships/emergency_verification",
158 "related": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/emergency_verification"
159 }
160 },
161 "identity": {
162 "links": {
163 "self": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/relationships/identity",
164 "related": "https://api.didww.com/v3/dids/0b5d4ca6-7002-4f19-a678-f5be95538e9b/identity"
165 }
166 }
167 }
168 }
169 ],
170 "meta": {
171 "api_version": "2026-11-19"
172 }
173}
Other Responses#
Code |
Success |
Description |
|---|---|---|
404 |
No |
|
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 ( |