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

GET /v3/voice_out_trunks HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

curl

curl -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

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": [
    {
      "id": "03813615-da15-4e3b-8e0a-3ea64b2585de",
      "type": "voice_out_trunks",
      "attributes": {
        "name": "Outbound trunk Name",
        "allowed_rtp_ips": [
          "0.0.0.0/0"
        ],
        "authentication_method": {
          "type": "credentials_and_ip",
          "attributes": {
            "allowed_sip_ips": [
              "0.0.0.0/0"
            ],
            "tech_prefix": null,
            "username": "554******",
            "password": "fqe******"
          }
        },
        "allow_any_did_as_cli": true,
        "status": "active",
        "on_cli_mismatch_action": "send_original_cli",
        "capacity_limit": 100,
        "threshold_reached": false,
        "threshold_amount": "10000.0",
        "media_encryption_mode": "disabled",
        "default_dst_action": "allow_all",
        "dst_prefixes": [],
        "emergency_enable_all": false,
        "force_symmetric_rtp": false,
        "rtp_ping": false,
        "rtp_timeout": 30,
        "callback_url": null,
        "created_at": "2025-04-02T10:00:00.000Z",
        "external_reference_id": null
      },
      "relationships": {
        "dids": {
          "links": {
            "self": "https://api.didww.com/v3/voice_out_trunks/03813615-da15-4e3b-8e0a-3ea64b2585de/relationships/dids",
            "related": "https://api.didww.com/v3/voice_out_trunks/03813615-da15-4e3b-8e0a-3ea64b2585de/dids"
          }
        },
        "emergency_dids": {
          "links": {
            "self": "https://api.didww.com/v3/voice_out_trunks/03813615-da15-4e3b-8e0a-3ea64b2585de/relationships/emergency_dids",
            "related": "https://api.didww.com/v3/voice_out_trunks/03813615-da15-4e3b-8e0a-3ea64b2585de/emergency_dids"
          }
        }
      }
    },
    {
      "id": "cf2e6377-fcaa-4416-8c8e-acd5f31a427f",
      "type": "voice_out_trunks",
      "attributes": {
        "name": "Outbound trunk Name",
        "allowed_rtp_ips": [
          "11.0.0.0/32"
        ],
        "authentication_method": {
          "type": "ip_only",
          "attributes": {
            "allowed_sip_ips": [
              "11.0.0.0/32"
            ],
            "tech_prefix": null
          }
        },
        "allow_any_did_as_cli": true,
        "status": "active",
        "on_cli_mismatch_action": "send_original_cli",
        "capacity_limit": 100,
        "threshold_reached": false,
        "threshold_amount": "10000.0",
        "media_encryption_mode": "disabled",
        "default_dst_action": "allow_all",
        "dst_prefixes": [],
        "emergency_enable_all": true,
        "force_symmetric_rtp": false,
        "rtp_ping": false,
        "rtp_timeout": 30,
        "callback_url": null,
        "created_at": "2025-04-02T10:00:00.000Z",
        "external_reference_id": null
      },
      "relationships": {
        "dids": {
          "links": {
            "self": "https://api.didww.com/v3/voice_out_trunks/cf2e6377-fcaa-4416-8c8e-acd5f31a427f/relationships/dids",
            "related": "https://api.didww.com/v3/voice_out_trunks/cf2e6377-fcaa-4416-8c8e-acd5f31a427f/dids"
          }
        },
        "emergency_dids": {
          "links": {
            "self": "https://api.didww.com/v3/voice_out_trunks/cf2e6377-fcaa-4416-8c8e-acd5f31a427f/relationships/emergency_dids",
            "related": "https://api.didww.com/v3/voice_out_trunks/cf2e6377-fcaa-4416-8c8e-acd5f31a427f/emergency_dids"
          }
        }
      }
    },
    {
      "id": "14a0b7fb-845a-44d9-a7dc-ac1620f21e42",
      "type": "voice_out_trunks",
      "attributes": {
        "name": "Outbound trunk Name",
        "allowed_rtp_ips": null,
        "authentication_method": {
          "type": "twilio",
          "attributes": {
            "twilio_account_sid": "AC39347AF064AF97E1682C3B7332DAAEE6"
          }
        },
        "allow_any_did_as_cli": true,
        "status": "active",
        "on_cli_mismatch_action": "send_original_cli",
        "capacity_limit": 100,
        "threshold_reached": false,
        "threshold_amount": "10000.0",
        "media_encryption_mode": "disabled",
        "default_dst_action": "allow_all",
        "dst_prefixes": [],
        "emergency_enable_all": false,
        "force_symmetric_rtp": false,
        "rtp_ping": false,
        "rtp_timeout": 30,
        "callback_url": null,
        "created_at": "2025-04-02T10:00:00.000Z",
        "external_reference_id": null
      },
      "relationships": {
        "dids": {
          "links": {
            "self": "https://api.didww.com/v3/voice_out_trunks/14a0b7fb-845a-44d9-a7dc-ac1620f21e42/relationships/dids",
            "related": "https://api.didww.com/v3/voice_out_trunks/14a0b7fb-845a-44d9-a7dc-ac1620f21e42/dids"
          }
        },
        "emergency_dids": {
          "links": {
            "self": "https://api.didww.com/v3/voice_out_trunks/14a0b7fb-845a-44d9-a7dc-ac1620f21e42/relationships/emergency_dids",
            "related": "https://api.didww.com/v3/voice_out_trunks/14a0b7fb-845a-44d9-a7dc-ac1620f21e42/emergency_dids"
          }
        }
      }
    }
  ],
  "meta": {
    "total_records": 3,
    "api_version": "2026-04-16"
  },
  "links": {
    "first": "https://api.didww.com/v3/voice_out_trunks?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "https://api.didww.com/v3/voice_out_trunks?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}