Inbound Trunk Groups#

Use the Inbound Trunk Groups resource to create, retrieve, update, and delete groups of Inbound Trunks used for incoming call routing.

An Inbound Trunk Group organizes multiple Inbound Trunks into one routing destination that can be assigned to DID phone numbers. The priority and weight configured on each member trunk determine how call-delivery attempts are distributed within the group.

Each group has a unique name and can define a simultaneous-call limit and an external reference ID. Group records also provide their creation time, member-trunk relationship, and the number of trunks in the group.

Endpoints#

Action

Method

Endpoint

Retrieve all Inbound Trunk Groups

GET

/v3/voice_in_trunk_groups

Retrieve Inbound Trunk Group

GET

/v3/voice_in_trunk_groups/{id}

Create Inbound Trunk Group

POST

/v3/voice_in_trunk_groups

Update Inbound Trunk Group

PATCH

/v3/voice_in_trunk_groups/{id}

Delete Inbound Trunk Group

DELETE

/v3/voice_in_trunk_groups/{id}

Retrieve all Inbound Trunk Groups#

Retrieves all Inbound Trunk Groups configured for the account.

Use this endpoint to filter groups by external reference ID and sort results by name, creation time, or simultaneous-call limit. Member Inbound Trunks can be included in the response.

See Retrieve All Inbound Trunk Groups.

GET /v3/voice_in_trunk_groups

Retrieve Inbound Trunk Group#

Retrieves a specific Inbound Trunk Group by its unique ID.

Use this endpoint to inspect the group settings, member-trunk count, and related Inbound Trunks.

See Retrieve Inbound Trunk Group.

GET /v3/voice_in_trunk_groups/{id}

Create Inbound Trunk Group#

Creates an Inbound Trunk Group.

Provide a unique group name and optionally set an external reference ID, a simultaneous-call limit, and the Inbound Trunks that should belong to the group.

See Create Inbound Trunk Group.

POST /v3/voice_in_trunk_groups

Update Inbound Trunk Group#

Updates a specific Inbound Trunk Group.

Use this endpoint to change the group name, external reference ID, simultaneous-call limit, or member Inbound Trunks.

See Update Inbound Trunk Group.

PATCH /v3/voice_in_trunk_groups/{id}

Delete Inbound Trunk Group#

Deletes a specific Inbound Trunk Group from the account.

See Delete Inbound Trunk Group.

DELETE /v3/voice_in_trunk_groups/{id}

Data reference#

See Inbound Trunk Group Object for the complete group attribute, relationship, and metadata definitions.

Common Inbound Trunk Group use cases#

Use case

Description

Group routing destinations

Organize multiple Inbound Trunks into one destination that can be assigned to DIDs.

Configure routing and failover

Combine trunks with different priority and weight values to control call-delivery attempts.

Limit simultaneous calls

Set capacity_limit to control the maximum number of concurrent calls delivered through the group.

Manage group membership

Assign or remove Inbound Trunks when creating or updating the group.

Inspect member trunks

Include the voice_in_trunks relationship and review the returned trunks_count metadata.

Synchronize external systems

Store an external_reference_id for the corresponding record in another system.