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

string

No

Inclusion

filter[<filter_name>]

string, boolean

No

Filtering

fields[voice_out_trunks]

string

No

Sparse fieldsets

sort

string

No

Sorting

pagination

string

No

Pagination

Filters#

Filter Name

Type

Allow Blank

Allow Array

Filters by:

name

string

Yes

Yes

The trunk name field.

name_contains

string

Yes

Yes

The name_contains field.

external_reference_id

string

No

No

The external_reference_id field.

on_cli_mismatch_action

string

Yes

Yes

The on_cli_mismatch_action field. Possible values: reject_call, replace_cli, send_original_cli.

allow_any_did_as_cli

boolean

No

No

The allow_any_did_as_cli field.

status

string

No

No

The status field. Possible values: active, blocked.

threshold_reached

boolean

No

No

The threshold_reached field.

default_dst_action

string

No

No

The default_dst_action field. Possible values: allow_all, reject_all.

media_encryption_mode

string

No

No

The media_encryption_mode field. Possible values: disabled, srtp_sdes, srtp_dtls, zrtp.

authentication_method.type

string

No

No

The authentication_method.type field. Possible values: credentials_and_ip, ip_only, twilio.

emergency_enable_all

boolean

No

No

The emergency_enable_all field.

Sorting#

Value

Sorts by:

name

The name field.

created_at

The created_at field.

allow_any_did_as_cli

The allow_any_did_as_cli field.

threshold_reached

The threshold_reached field.

Includes#

Value

Description

dids

DID Object

emergency_dids

Emergency DID relationship data.

Object Relationships#

Value

Description

dids

DID Object

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
5Api-Key: [API token]

curl

1curl -i -X GET https://api.didww.com/v3/voice_out_trunks -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    {
  7      "id": "03813615-da15-4e3b-8e0a-3ea64b2585de",
  8      "type": "voice_out_trunks",
  9      "attributes": {
 10        "name": "Outbound trunk Name",
 11        "allowed_rtp_ips": [
 12          "0.0.0.0/0"
 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        "default_dst_action": "allow_all",
 33        "dst_prefixes": [],
 34        "emergency_enable_all": false,
 35        "force_symmetric_rtp": false,
 36        "rtp_ping": false,
 37        "rtp_timeout": 30,
 38        "callback_url": null,
 39        "created_at": "2025-04-02T10:00:00.000Z",
 40        "external_reference_id": null
 41      },
 42      "relationships": {
 43        "dids": {
 44          "links": {
 45            "self": "https://api.didww.com/v3/voice_out_trunks/03813615-da15-4e3b-8e0a-3ea64b2585de/relationships/dids",
 46            "related": "https://api.didww.com/v3/voice_out_trunks/03813615-da15-4e3b-8e0a-3ea64b2585de/dids"
 47          }
 48        },
 49        "emergency_dids": {
 50          "links": {
 51            "self": "https://api.didww.com/v3/voice_out_trunks/03813615-da15-4e3b-8e0a-3ea64b2585de/relationships/emergency_dids",
 52            "related": "https://api.didww.com/v3/voice_out_trunks/03813615-da15-4e3b-8e0a-3ea64b2585de/emergency_dids"
 53          }
 54        }
 55      }
 56    },
 57    {
 58      "id": "cf2e6377-fcaa-4416-8c8e-acd5f31a427f",
 59      "type": "voice_out_trunks",
 60      "attributes": {
 61        "name": "Outbound trunk Name",
 62        "allowed_rtp_ips": [
 63          "198.51.100.1/32"
 64        ],
 65        "authentication_method": {
 66          "type": "ip_only",
 67          "attributes": {
 68            "allowed_sip_ips": [
 69              "198.51.100.1/32"
 70            ],
 71            "tech_prefix": null
 72          }
 73        },
 74        "allow_any_did_as_cli": true,
 75        "status": "active",
 76        "on_cli_mismatch_action": "send_original_cli",
 77        "capacity_limit": 100,
 78        "threshold_reached": false,
 79        "threshold_amount": "10000.0",
 80        "media_encryption_mode": "disabled",
 81        "default_dst_action": "allow_all",
 82        "dst_prefixes": [],
 83        "emergency_enable_all": true,
 84        "force_symmetric_rtp": false,
 85        "rtp_ping": false,
 86        "rtp_timeout": 30,
 87        "callback_url": null,
 88        "created_at": "2025-04-02T10:00:00.000Z",
 89        "external_reference_id": null
 90      },
 91      "relationships": {
 92        "dids": {
 93          "links": {
 94            "self": "https://api.didww.com/v3/voice_out_trunks/cf2e6377-fcaa-4416-8c8e-acd5f31a427f/relationships/dids",
 95            "related": "https://api.didww.com/v3/voice_out_trunks/cf2e6377-fcaa-4416-8c8e-acd5f31a427f/dids"
 96          }
 97        },
 98        "emergency_dids": {
 99          "links": {
100            "self": "https://api.didww.com/v3/voice_out_trunks/cf2e6377-fcaa-4416-8c8e-acd5f31a427f/relationships/emergency_dids",
101            "related": "https://api.didww.com/v3/voice_out_trunks/cf2e6377-fcaa-4416-8c8e-acd5f31a427f/emergency_dids"
102          }
103        }
104      }
105    },
106    {
107      "id": "14a0b7fb-845a-44d9-a7dc-ac1620f21e42",
108      "type": "voice_out_trunks",
109      "attributes": {
110        "name": "Outbound trunk Name",
111        "allowed_rtp_ips": null,
112        "authentication_method": {
113          "type": "twilio",
114          "attributes": {
115            "twilio_account_sid": "AC39347AF064AF97E1682C3B7332DAAEE6"
116          }
117        },
118        "allow_any_did_as_cli": true,
119        "status": "active",
120        "on_cli_mismatch_action": "send_original_cli",
121        "capacity_limit": 100,
122        "threshold_reached": false,
123        "threshold_amount": "10000.0",
124        "media_encryption_mode": "disabled",
125        "default_dst_action": "allow_all",
126        "dst_prefixes": [],
127        "emergency_enable_all": false,
128        "force_symmetric_rtp": false,
129        "rtp_ping": false,
130        "rtp_timeout": 30,
131        "callback_url": null,
132        "created_at": "2025-04-02T10:00:00.000Z",
133        "external_reference_id": null
134      },
135      "relationships": {
136        "dids": {
137          "links": {
138            "self": "https://api.didww.com/v3/voice_out_trunks/14a0b7fb-845a-44d9-a7dc-ac1620f21e42/relationships/dids",
139            "related": "https://api.didww.com/v3/voice_out_trunks/14a0b7fb-845a-44d9-a7dc-ac1620f21e42/dids"
140          }
141        },
142        "emergency_dids": {
143          "links": {
144            "self": "https://api.didww.com/v3/voice_out_trunks/14a0b7fb-845a-44d9-a7dc-ac1620f21e42/relationships/emergency_dids",
145            "related": "https://api.didww.com/v3/voice_out_trunks/14a0b7fb-845a-44d9-a7dc-ac1620f21e42/emergency_dids"
146          }
147        }
148      }
149    }
150  ],
151  "meta": {
152    "total_records": 3,
153    "api_version": "2026-04-16"
154  },
155  "links": {
156    "first": "https://api.didww.com/v3/voice_out_trunks?page%5Bnumber%5D=1&page%5Bsize%5D=50",
157    "last": "https://api.didww.com/v3/voice_out_trunks?page%5Bnumber%5D=1&page%5Bsize%5D=50"
158  }
159}