Get Inbound Trunks#

Returns the collection of inbound Trunks.

Request#

HTTP Method: GET

URI Path: /v3/voice_in_trunks

Note

For all returned data attributes, see Inbound Trunk Object.

URI Query Parameters#

Name

Type

Is Required?

Description

include

string

No

Inclusion

filter[<filter_name>]

string, DateTime

No

Filtering

fields[voice_in_trunks]

string

No

Sparse fieldsets

sort

string

No

Sorting

page[number]

integer

No

Page number.

page[size]

integer

No

Page size. Pagination defaults to 50 records per page. The maximum is 100.

Filters#

Filter Name

Type

Allow Blank

Allow Array

Filters by:

id

string

No

Yes

Trunk id field.

name

string

Yes

Yes

Trunk name field.

external_reference_id

string

No

No

The external_reference_id field.

configuration.type

string

Yes

Yes

The type of configuration: sip_configurations, pstn_configurations.

Sorting#

Value

Sorts by:

name

The name field.

priority

The priority field.

capacity_limit

The capacity_limit field.

weight

The weight field.

cli_format

The cli_format field.

cli_prefix

The cli_prefix field.

description

The description field.

ringing_timeout

The ringing_timeout field.

created_at

The created_at field.

external_reference_id

The external_reference_id field.

Includes#

Name

Description

voice_in_trunk_group

Trunk Group Object

Object Relationships#

Value

Description

voice_in_trunk_group

Trunk Group Object

Example#

http

1GET /v3/voice_in_trunks 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_in_trunks -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    {
  7      "id": "2d7f943f-07c4-4b27-8792-e85806368218",
  8      "type": "voice_in_trunks",
  9      "attributes": {
 10        "priority": 1,
 11        "capacity_limit": 10,
 12        "weight": 2,
 13        "name": "Office",
 14        "cli_format": "e164",
 15        "cli_prefix": "+",
 16        "description": null,
 17        "ringing_timeout": 30,
 18        "pop": null,
 19        "created_at": "2017-06-25T08:21:41.795Z",
 20        "external_reference_id": null,
 21        "configuration": {
 22          "type": "sip_configurations",
 23          "attributes": {
 24            "username": "username",
 25            "host": "example.com",
 26            "port": null,
 27            "codecs": [
 28              "pcmu",
 29              "g723"
 30            ],
 31            "rx_dtmf_format_id": 1,
 32            "tx_dtmf_format_id": 1,
 33            "resolve_ruri": true,
 34            "auth_enabled": true,
 35            "auth_user": "username",
 36            "auth_password": "password",
 37            "auth_from_user": "Office",
 38            "auth_from_domain": "example.com",
 39            "sst_enabled": false,
 40            "sst_min_timer": 600,
 41            "sst_max_timer": 900,
 42            "sst_accept_501": true,
 43            "sip_timer_b": 8000,
 44            "dns_srv_failover_timer": 2000,
 45            "rtp_ping": false,
 46            "rtp_timeout": 30,
 47            "force_symmetric_rtp": false,
 48            "symmetric_rtp_ignore_rtcp": false,
 49            "rerouting_disconnect_code_ids": [
 50              58,
 51              59,
 52              1505
 53            ],
 54            "sst_session_expires": null,
 55            "sst_refresh_method_id": 1,
 56            "transport_protocol_id": 1,
 57            "max_transfers": 5,
 58            "max_30x_redirects": 7,
 59            "media_encryption_mode": "disabled",
 60            "ice_mode": "disabled",
 61            "rtcp_mux_mode": "disabled",
 62            "rtcp_feedback_mode": "disabled",
 63            "stir_shaken_mode": "disabled",
 64            "allowed_rtp_ips": null,
 65            "network_protocol_priority": "any",
 66            "enabled_sip_registration": false,
 67            "use_did_in_ruri": false,
 68            "incoming_auth_username": null,
 69            "incoming_auth_password": null,
 70            "diversion_relay_policy": "as_is",
 71            "diversion_inject_mode": "did_number",
 72            "cnam_lookup": true
 73          }
 74        }
 75      },
 76      "relationships": {
 77        "voice_in_trunk_group": {
 78          "links": {
 79            "self": "https://api.didww.com/v3/voice_in_trunks/2d7f943f-07c4-4b27-8792-e85806368218/relationships/voice_in_trunk_group",
 80            "related": "https://api.didww.com/v3/voice_in_trunks/2d7f943f-07c4-4b27-8792-e85806368218/voice_in_trunk_group"
 81          }
 82        }
 83      }
 84    },
 85    {
 86      "id": "34b95e8c-9b78-4e64-aea8-9e5764d8f16f",
 87      "type": "voice_in_trunks",
 88      "attributes": {
 89        "priority": 1,
 90        "capacity_limit": 5,
 91        "weight": 65535,
 92        "name": "Office Mobile",
 93        "cli_format": "e164",
 94        "cli_prefix": null,
 95        "description": null,
 96        "ringing_timeout": null,
 97        "pop": null,
 98        "created_at": "2017-06-25T08:21:41.795Z",
 99        "external_reference_id": null,
100        "configuration": {
101          "type": "pstn_configurations",
102          "attributes": {
103            "dst": "1xxxxxxxxx"
104          }
105        }
106      },
107      "relationships": {
108        "voice_in_trunk_group": {
109          "links": {
110            "self": "https://api.didww.com/v3/voice_in_trunks/34b95e8c-9b78-4e64-aea8-9e5764d8f16f/relationships/voice_in_trunk_group",
111            "related": "https://api.didww.com/v3/voice_in_trunks/34b95e8c-9b78-4e64-aea8-9e5764d8f16f/voice_in_trunk_group"
112          }
113        }
114      }
115    }
116  ],
117  "meta": {
118    "total_records": 2,
119    "api_version": "2026-11-19"
120  },
121  "links": {
122    "first": "https://api.didww.com/v3/voice_in_trunks?page%5Bnumber%5D=1&page%5Bsize%5D=50",
123    "last": "https://api.didww.com/v3/voice_in_trunks?page%5Bnumber%5D=1&page%5Bsize%5D=50"
124  }
125}

Other Responses#

Code

Success

Description

400

No

Bad Request. Malformed request: unknown filter, bad pagination or bad sort field.

401

No

Unauthorized

429

No

The request budget of the account for the current window is spent (too_many_requests). Retry-After gives the number of seconds to wait.