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
5Api-Key: [API 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 "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": "03813615-da15-4e3b-8e0a-3ea64b2585de",
7 "type": "voice_out_trunks",
8 "attributes": {
9 "name": "Outbound trunk Name",
10 "allowed_rtp_ips": [
11 "0.0.0.0/0"
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": "string",
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 "default_dst_action": "allow_all",
32 "dst_prefixes": [],
33 "emergency_enable_all": false,
34 "force_symmetric_rtp": false,
35 "rtp_ping": false,
36 "rtp_timeout": 30,
37 "callback_url": null,
38 "created_at": "2025-04-02T10:00:00.000Z",
39 "external_reference_id": null
40 },
41 "relationships": {
42 "dids": {
43 "links": {
44 "self": "https://api.didww.com/v3/voice_out_trunks/03813615-da15-4e3b-8e0a-3ea64b2585de/relationships/dids",
45 "related": "https://api.didww.com/v3/voice_out_trunks/03813615-da15-4e3b-8e0a-3ea64b2585de/dids"
46 }
47 },
48 "emergency_dids": {
49 "links": {
50 "self": "https://api.didww.com/v3/voice_out_trunks/03813615-da15-4e3b-8e0a-3ea64b2585de/relationships/emergency_dids",
51 "related": "https://api.didww.com/v3/voice_out_trunks/03813615-da15-4e3b-8e0a-3ea64b2585de/emergency_dids"
52 }
53 }
54 }
55 },
56 "meta": {
57 "api_version": "2026-04-16"
58 }
59}
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
5Api-Key: [API 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 "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": "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 "default_dst_action": "allow_all",
30 "dst_prefixes": [],
31 "emergency_enable_all": true,
32 "force_symmetric_rtp": false,
33 "rtp_ping": false,
34 "rtp_timeout": 30,
35 "callback_url": null,
36 "created_at": "2025-04-02T10:00:00.000Z",
37 "external_reference_id": null
38 },
39 "relationships": {
40 "dids": {
41 "links": {
42 "self": "https://api.didww.com/v3/voice_out_trunks/cf2e6377-fcaa-4416-8c8e-acd5f31a427f/relationships/dids",
43 "related": "https://api.didww.com/v3/voice_out_trunks/cf2e6377-fcaa-4416-8c8e-acd5f31a427f/dids"
44 }
45 },
46 "emergency_dids": {
47 "links": {
48 "self": "https://api.didww.com/v3/voice_out_trunks/cf2e6377-fcaa-4416-8c8e-acd5f31a427f/relationships/emergency_dids",
49 "related": "https://api.didww.com/v3/voice_out_trunks/cf2e6377-fcaa-4416-8c8e-acd5f31a427f/emergency_dids"
50 }
51 }
52 }
53 },
54 "meta": {
55 "api_version": "2026-04-16"
56 }
57}
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
5Api-Key: [API 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 "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": "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 "default_dst_action": "allow_all",
25 "dst_prefixes": [],
26 "emergency_enable_all": false,
27 "force_symmetric_rtp": false,
28 "rtp_ping": false,
29 "rtp_timeout": 30,
30 "callback_url": null,
31 "created_at": "2025-04-02T10:00:00.000Z",
32 "external_reference_id": null
33 },
34 "relationships": {
35 "dids": {
36 "links": {
37 "self": "https://api.didww.com/v3/voice_out_trunks/14a0b7fb-845a-44d9-a7dc-ac1620f21e42/relationships/dids",
38 "related": "https://api.didww.com/v3/voice_out_trunks/14a0b7fb-845a-44d9-a7dc-ac1620f21e42/dids"
39 }
40 },
41 "emergency_dids": {
42 "links": {
43 "self": "https://api.didww.com/v3/voice_out_trunks/14a0b7fb-845a-44d9-a7dc-ac1620f21e42/relationships/emergency_dids",
44 "related": "https://api.didww.com/v3/voice_out_trunks/14a0b7fb-845a-44d9-a7dc-ac1620f21e42/emergency_dids"
45 }
46 }
47 }
48 },
49 "meta": {
50 "api_version": "2026-04-16"
51 }
52}
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
5Api-Key: [API 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 "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": "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 "default_dst_action": "allow_all",
32 "dst_prefixes": [],
33 "emergency_enable_all": false,
34 "force_symmetric_rtp": false,
35 "rtp_ping": false,
36 "rtp_timeout": 30,
37 "callback_url": null,
38 "created_at": "2025-04-02T10:00:00.000Z",
39 "external_reference_id": null
40 },
41 "relationships": {
42 "dids": {
43 "links": {
44 "self": "https://api.didww.com/v3/voice_out_trunks/91f7bcb4-3278-433b-9de1-5e6f4131fd4d/relationships/dids",
45 "related": "https://api.didww.com/v3/voice_out_trunks/91f7bcb4-3278-433b-9de1-5e6f4131fd4d/dids"
46 }
47 },
48 "emergency_dids": {
49 "data": [
50 {
51 "type": "dids",
52 "id": "0b5d4ca6-7002-4f19-a678-f5be95538e9b"
53 }
54 ]
55 }
56 }
57 },
58 "included": [
59 {
60 "id": "0b5d4ca6-7002-4f19-a678-f5be95538e9b",
61 "type": "dids",
62 "attributes": {
63 "number": "12125550124",
64 "emergency_enabled": true
65 }
66 }
67 ],
68 "meta": {
69 "api_version": "2026-04-16"
70 }
71}
Other Responses#
Code |
Success |
Description |
|---|---|---|
404 |
No |
|
401 |
No |