Create Outbound Trunk#
Creates an outbound trunk.
In version 2026-11-19, customers with the Outbound API enabled can create outbound trunks even if the Outbound feature is not enabled on the account. Without the Outbound API, the request returns 403 Forbidden.
Request#
HTTP Method: POST
URI Path: /v3/voice_out_trunks
Body Parameters#
Name |
Type |
Nullable |
Is Required? |
Description |
|---|---|---|---|---|
type |
|
No |
Yes |
Must be |
attributes |
|
No |
Yes |
Outbound trunk attributes object. |
Data Attributes#
Name |
Type |
Nullable |
Is Required? |
Description |
|---|---|---|---|---|
name |
|
No |
Yes |
The outbound trunk name. |
external_reference_id |
|
Yes |
No |
Optional identifier for the outbound trunk in the customer’s external system. Maximum length is 100 characters. |
allowed_rtp_ips |
Array of |
Yes |
No |
Allowed RTP IP addresses for media traffic. Null means no restriction. An empty list is rejected. |
authentication_method |
|
No |
Yes |
Authentication method object. Supported POST types: |
on_cli_mismatch_action |
|
No |
Yes |
Possible values: |
capacity_limit |
|
Yes |
No |
The capacity limit of the outbound trunk. Allowed values from 1 to 32767. |
allow_any_did_as_cli |
|
No |
No |
When set to |
status |
|
No |
No |
Possible values: |
threshold_amount |
|
No |
No |
The outbound trunk 24-hour threshold limit. The accepted range depends on the account. |
default_dst_action |
|
No |
No |
Possible values: |
dst_prefixes |
Array of |
No |
No |
The destination prefixes allowed or rejected based on |
emergency_enable_all |
|
No |
No |
Allows all eligible DIDs to be used for emergency calling on the trunk. Default value is |
media_encryption_mode |
|
No |
No |
Media encryption mode. Possible values: |
ice_mode |
|
No |
No |
ICE (Interactive Connectivity Establishment) for calls from the trunk: not used, accepted when the trunk offers it, or initiated by DIDWW. Possible values: |
rtcp_mux_mode |
|
No |
No |
RTP and RTCP multiplexed on one port: not used, accepted when the trunk offers it, or initiated by DIDWW. Possible values: |
rtcp_feedback_mode |
|
No |
No |
RTCP feedback (AVPF): not used, accepted when the trunk offers it, or initiated by DIDWW. Possible values: |
codecs |
Array of |
No |
No |
Codecs offered on calls from the trunk, in priority order: the first has the highest priority. Send at least one value, without repeats. Possible values: |
callback_url |
|
Yes |
No |
Can be |
force_symmetric_rtp |
|
No |
No |
Enables symmetric RTP / COMEDIA mode. |
rtp_ping |
|
No |
No |
Enables RTP ping after the call is connected. |
rtp_timeout |
|
No |
No |
Disconnects the call if RTP packets do not arrive within the specified time. Supported values are from 30 to 600 seconds. |
See Outbound Trunk callback details for
information about callback_url and the JSON callback payload.
Request Body Object Relationships#
Title |
Type |
Description |
|---|---|---|
default_did |
The DID used as the caller ID. Required while |
|
dids |
The DID numbers explicitly allowed as CLI when |
|
emergency_dids |
The DID numbers explicitly enabled for emergency calling when |
Authentication Method#
The outbound trunk authentication is configured through the authentication_method attribute.
Supported authentication method types:
credentials_and_ip- uses SIP credentials together with allowed IP addresses.twilio- uses a Twilio Account SID for authentication.ip_onlyis returned byGETendpoints but is not supported inPOSTrequests.
Authentication Method Attributes by Type#
Name |
Type |
Nullable |
Is Required? |
Description |
|---|---|---|---|---|
allowed_sip_ips |
Array of |
No |
Yes |
The allowed originating SIP IPs. |
tech_prefix |
|
Yes |
No |
Prefix stripped from the dialled number before routing. The maximum length is 8 characters and only digits and |
Name |
Type |
Nullable |
Is Required? |
Description |
|---|---|---|---|---|
twilio_account_sid |
|
No |
Yes |
The Twilio Account SID. It is a 34-character identifier of the Twilio account. |
Examples#
http
1POST /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]
6
7{
8 "data": {
9 "type": "voice_out_trunks",
10 "attributes": {
11 "name": "Outbound trunk Name",
12 "callback_url": null,
13 "allowed_rtp_ips": [
14 "203.0.113.0/24"
15 ],
16 "authentication_method": {
17 "type": "credentials_and_ip",
18 "attributes": {
19 "allowed_sip_ips": [
20 "0.0.0.0/0"
21 ],
22 "tech_prefix": null
23 }
24 },
25 "on_cli_mismatch_action": "send_original_cli",
26 "capacity_limit": 100,
27 "allow_any_did_as_cli": true,
28 "status": "active",
29 "threshold_amount": "10000.0",
30 "default_dst_action": "allow_all",
31 "dst_prefixes": [],
32 "emergency_enable_all": false,
33 "media_encryption_mode": "disabled",
34 "ice_mode": "accept",
35 "rtcp_mux_mode": "accept",
36 "rtcp_feedback_mode": "accept",
37 "codecs": [
38 "pcma",
39 "pcmu",
40 "g729",
41 "g723",
42 "gsm",
43 "telephone_event"
44 ],
45 "force_symmetric_rtp": false,
46 "rtp_ping": false,
47 "rtp_timeout": 30
48 }
49 }
50}
curl
1curl -i -X POST 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]" --data-raw '{"data": {"attributes": {"allow_any_did_as_cli": true, "allowed_rtp_ips": ["203.0.113.0/24"], "authentication_method": {"attributes": {"allowed_sip_ips": ["0.0.0.0/0"], "tech_prefix": null}, "type": "credentials_and_ip"}, "callback_url": null, "capacity_limit": 100, "codecs": ["pcma", "pcmu", "g729", "g723", "gsm", "telephone_event"], "default_dst_action": "allow_all", "dst_prefixes": [], "emergency_enable_all": false, "force_symmetric_rtp": false, "ice_mode": "accept", "media_encryption_mode": "disabled", "name": "Outbound trunk Name", "on_cli_mismatch_action": "send_original_cli", "rtcp_feedback_mode": "accept", "rtcp_mux_mode": "accept", "rtp_ping": false, "rtp_timeout": 30, "status": "active", "threshold_amount": "10000.0"}, "type": "voice_out_trunks"}}'
response
1HTTP/1.1 201 Created
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 "callback_url": null,
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 "on_cli_mismatch_action": "send_original_cli",
26 "capacity_limit": 100,
27 "allow_any_did_as_cli": true,
28 "status": "active",
29 "threshold_reached": false,
30 "threshold_amount": "10000.0",
31 "default_dst_action": "allow_all",
32 "dst_prefixes": [],
33 "emergency_enable_all": false,
34 "media_encryption_mode": "disabled",
35 "ice_mode": "accept",
36 "rtcp_mux_mode": "accept",
37 "rtcp_feedback_mode": "accept",
38 "codecs": [
39 "pcma",
40 "pcmu",
41 "g729",
42 "g723",
43 "gsm",
44 "telephone_event"
45 ],
46 "force_symmetric_rtp": false,
47 "rtp_ping": false,
48 "rtp_timeout": 30,
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": "0.0"
68 }
69 },
70 "meta": {
71 "api_version": "2026-11-19"
72 }
73}
http
1POST /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]
6
7{
8 "data": {
9 "type": "voice_out_trunks",
10 "attributes": {
11 "name": "Outbound trunk Name",
12 "callback_url": null,
13 "allowed_rtp_ips": null,
14 "authentication_method": {
15 "type": "twilio",
16 "attributes": {
17 "twilio_account_sid": "AC39347AF064AF97E1682C3B7332DAAEE6"
18 }
19 },
20 "on_cli_mismatch_action": "send_original_cli",
21 "capacity_limit": 100,
22 "allow_any_did_as_cli": true,
23 "status": "active",
24 "threshold_amount": "10000.0",
25 "default_dst_action": "allow_all",
26 "dst_prefixes": [],
27 "emergency_enable_all": false,
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 "force_symmetric_rtp": false,
41 "rtp_ping": false,
42 "rtp_timeout": 30
43 }
44 }
45}
curl
1curl -i -X POST 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]" --data-raw '{"data": {"attributes": {"allow_any_did_as_cli": true, "allowed_rtp_ips": null, "authentication_method": {"attributes": {"twilio_account_sid": "AC39347AF064AF97E1682C3B7332DAAEE6"}, "type": "twilio"}, "callback_url": null, "capacity_limit": 100, "codecs": ["pcma", "pcmu", "g729", "g723", "gsm", "telephone_event"], "default_dst_action": "allow_all", "dst_prefixes": [], "emergency_enable_all": false, "force_symmetric_rtp": false, "ice_mode": "accept", "media_encryption_mode": "disabled", "name": "Outbound trunk Name", "on_cli_mismatch_action": "send_original_cli", "rtcp_feedback_mode": "accept", "rtcp_mux_mode": "accept", "rtp_ping": false, "rtp_timeout": 30, "status": "active", "threshold_amount": "10000.0"}, "type": "voice_out_trunks"}}'
response
1HTTP/1.1 201 Created
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 "callback_url": null,
11 "allowed_rtp_ips": null,
12 "authentication_method": {
13 "type": "twilio",
14 "attributes": {
15 "twilio_account_sid": "AC39347AF064AF97E1682C3B7332DAAEE6"
16 }
17 },
18 "on_cli_mismatch_action": "send_original_cli",
19 "capacity_limit": 100,
20 "allow_any_did_as_cli": true,
21 "status": "active",
22 "threshold_reached": false,
23 "threshold_amount": "10000.0",
24 "default_dst_action": "allow_all",
25 "dst_prefixes": [],
26 "emergency_enable_all": false,
27 "media_encryption_mode": "disabled",
28 "ice_mode": "accept",
29 "rtcp_mux_mode": "accept",
30 "rtcp_feedback_mode": "accept",
31 "codecs": [
32 "pcma",
33 "pcmu",
34 "g729",
35 "g723",
36 "gsm",
37 "telephone_event"
38 ],
39 "force_symmetric_rtp": false,
40 "rtp_ping": false,
41 "rtp_timeout": 30,
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": "0.0"
61 }
62 },
63 "meta": {
64 "api_version": "2026-11-19"
65 }
66}
http
1POST /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]
6
7{
8 "data": {
9 "type": "voice_out_trunks",
10 "attributes": {
11 "name": "Outbound trunk for selected emergency DIDs",
12 "authentication_method": {
13 "type": "credentials_and_ip",
14 "attributes": {
15 "allowed_sip_ips": [
16 "0.0.0.0/0"
17 ]
18 }
19 },
20 "on_cli_mismatch_action": "send_original_cli",
21 "emergency_enable_all": false,
22 "codecs": [
23 "pcma",
24 "pcmu",
25 "g729",
26 "g723",
27 "gsm",
28 "telephone_event"
29 ]
30 },
31 "relationships": {
32 "emergency_dids": {
33 "data": [
34 {
35 "id": "7158ac26-392f-47d1-89ab-c8b3f5ec05d9",
36 "type": "dids"
37 },
38 {
39 "id": "67a90c09-1bff-4bc3-a35e-116fda2b0d22",
40 "type": "dids"
41 }
42 ]
43 }
44 }
45 }
46}
curl
1curl -i -X POST 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]" --data-raw '{"data": {"attributes": {"authentication_method": {"attributes": {"allowed_sip_ips": ["0.0.0.0/0"]}, "type": "credentials_and_ip"}, "codecs": ["pcma", "pcmu", "g729", "g723", "gsm", "telephone_event"], "emergency_enable_all": false, "name": "Outbound trunk for selected emergency DIDs", "on_cli_mismatch_action": "send_original_cli"}, "relationships": {"emergency_dids": {"data": [{"id": "7158ac26-392f-47d1-89ab-c8b3f5ec05d9", "type": "dids"}, {"id": "67a90c09-1bff-4bc3-a35e-116fda2b0d22", "type": "dids"}]}}, "type": "voice_out_trunks"}}'
response
1HTTP/1.1 201 Created
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "9c91f03e-8796-4e6a-8c12-00e4f334f9b2",
7 "type": "voice_out_trunks",
8 "attributes": {
9 "name": "Outbound trunk for selected emergency DIDs",
10 "callback_url": null,
11 "allowed_rtp_ips": null,
12 "authentication_method": {
13 "type": "credentials_and_ip",
14 "attributes": {
15 "allowed_sip_ips": [
16 "0.0.0.0/0"
17 ],
18 "tech_prefix": null,
19 "username": "554******",
20 "password": "fqe******"
21 }
22 },
23 "on_cli_mismatch_action": "send_original_cli",
24 "capacity_limit": null,
25 "allow_any_did_as_cli": false,
26 "status": "active",
27 "threshold_reached": false,
28 "threshold_amount": "3000.0",
29 "default_dst_action": "allow_all",
30 "dst_prefixes": [],
31 "emergency_enable_all": false,
32 "media_encryption_mode": "disabled",
33 "ice_mode": "accept",
34 "rtcp_mux_mode": "accept",
35 "rtcp_feedback_mode": "accept",
36 "codecs": [
37 "pcma",
38 "pcmu",
39 "g729",
40 "g723",
41 "gsm",
42 "telephone_event"
43 ],
44 "force_symmetric_rtp": false,
45 "rtp_ping": false,
46 "rtp_timeout": 30,
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/9c91f03e-8796-4e6a-8c12-00e4f334f9b2/relationships/dids",
54 "related": "https://api.didww.com/v3/voice_out_trunks/9c91f03e-8796-4e6a-8c12-00e4f334f9b2/dids"
55 }
56 },
57 "emergency_dids": {
58 "links": {
59 "self": "https://api.didww.com/v3/voice_out_trunks/9c91f03e-8796-4e6a-8c12-00e4f334f9b2/relationships/emergency_dids",
60 "related": "https://api.didww.com/v3/voice_out_trunks/9c91f03e-8796-4e6a-8c12-00e4f334f9b2/emergency_dids"
61 }
62 }
63 },
64 "meta": {
65 "spent_amount": "0.0"
66 }
67 },
68 "meta": {
69 "api_version": "2026-11-19"
70 }
71}
http
1POST /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]
6
7{
8 "data": {
9 "type": "voice_out_trunks",
10 "attributes": {
11 "name": "Office outbound",
12 "authentication_method": {
13 "type": "credentials_and_ip",
14 "attributes": {
15 "allowed_sip_ips": [
16 "203.0.113.10/32"
17 ]
18 }
19 },
20 "on_cli_mismatch_action": "reject_call",
21 "codecs": [
22 "pcma",
23 "pcmu",
24 "g729",
25 "g723",
26 "gsm",
27 "telephone_event"
28 ]
29 },
30 "relationships": {
31 "dids": {
32 "data": [
33 {
34 "type": "dids",
35 "id": "7a1c1c55-5f4e-4c9b-9a8e-2d8f0c3b6e41"
36 }
37 ]
38 }
39 }
40 }
41}
curl
1curl -i -X POST 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]" --data-raw '{"data": {"attributes": {"authentication_method": {"attributes": {"allowed_sip_ips": ["203.0.113.10/32"]}, "type": "credentials_and_ip"}, "codecs": ["pcma", "pcmu", "g729", "g723", "gsm", "telephone_event"], "name": "Office outbound", "on_cli_mismatch_action": "reject_call"}, "relationships": {"dids": {"data": [{"type": "dids", "id": "7a1c1c55-5f4e-4c9b-9a8e-2d8f0c3b6e41"}]}}, "type": "voice_out_trunks"}}'
response
1HTTP/1.1 422 Unprocessable Entity
2Content-Type: application/vnd.api+json
3
4{
5 "errors": [
6 {
7 "title": "cannot be assigned as an allowed CLI because it is awaiting registration",
8 "detail": "dids/7a1c1c55-5f4e-4c9b-9a8e-2d8f0c3b6e41 - cannot be assigned as an allowed CLI because it is awaiting registration",
9 "code": "100",
10 "source": {
11 "pointer": "/data/relationships/dids/7a1c1c55-5f4e-4c9b-9a8e-2d8f0c3b6e41"
12 },
13 "status": "422"
14 }
15 ]
16}
Other Responses#
Code |
Success |
Description |
|---|---|---|
422 |
No |
|
400 |
No |
Bad Request. Also returned with the title |
401 |
No |
|
403 |
No |
The Outbound API is not enabled for the account. Also returned when the access token carries the |
429 |
No |
The request budget of the account for the current window is spent ( |