Sign in

v50

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-06-16122182589.7 KB
SIP trunks

Retrieve a SIP trunk

Returns the SIP trunk identified by id.

get/v1/trunks/{id}

Path parameters

idinteger required
Example:3107

The unique ID of the SIP trunk.

Response

Returns the SIP trunk.

idinteger required

Unique identifier of the SIP trunk on the platform

namestring required

System-generated login name of the SIP trunk

calleridstring nullable required

Caller ID configured on the SIP trunk. Contains null if no Caller ID is set, or an empty string if multiple Caller IDs are allowed.

labelstring required

User-defined name of the SIP trunk

ip_restrictboolean

Indicates whether IP restriction must be enabled on the SIP trunk

channels_restrictboolean

Indicates if the max number of concurrent outbound calls limit is activated for the SIP trunk.

max_channelsinteger nullable

A maximum number of concurrent outbound calls placed via the SIP trunk. Cannot be higher than the outbound channel capacity configured on the account.

cost_limitboolean

Indicates if the max cost limit for an outbound call limit is activated for the SIP trunk.

max_call_coststring nullable

A maximum cost of an outbound call, in USD.

call_restrictboolean nullable

Indicates if maximum call duration limit is activated for the SIP trunk.

call_limitinteger nullable

A maximum call duration for the SIP trunk, in seconds. Cannot be higher than the max call duration set for the account.

didinfo_enabledboolean

Indicates if inbound calls carry dialed number information in the 'To' header of SIP Invites

rewrite_enabledboolean

Indicates if a custom dial plan is activated for the SIP trunk.

rewrite_prefixstring

Leading digits to be added before the dialed phone numbers.

rewrite_condstring

Leading digits to be deleted from the dialed phone numbers.

call_recording_enabledboolean

Indicates if outbound call recording is enabled on the SIP trunk. Available for Flex Pro customers only.

machine_detection_enabledboolean

Indicates if automatic voicemail detection is enabled on the SIP trunk. Available for Flex Pro customers only.

transcription_enabledboolean

Indicates if automatic call transcription is enabled on the SIP trunk. Available for Flex Pro customers only.

transcription_thresholdinteger

Transcriptions will be generated for calls that meet or exceed the specified minimal call duration threshold, in seconds

created_atstring date-time required

Date and time the SIP trunk was created

hoststring

Registration host for the SIP trunk. dynamic for credential-based registration, or a public static IP address for IP authentication.

multiple_numbersboolean

Indicates whether any active or verified phone number on the account can be used as the Caller ID for the SIP trunk.

encrypted_mediaboolean

Indicates whether SRTP media encryption is enabled for the SIP trunk.

passthroughboolean

Indicates whether Caller ID passthrough is enabled.

access_tokenstring nullable

Static authentication token for the SIP trunk.

Example response

{
  "id": 293,
  "name": "67758",
  "callerid": "12345678900",
  "label": "My trunk",
  "allowed_ips": [
    {
      "id": 6712,
      "ip": "127.0.0.1"
    }
  ],
  "max_channels": 2,
  "cost_limit": true,
  "max_call_cost": "0.18",
  "call_limit": 3600,
  "didinfo_enabled": true,
  "rewrite_enabled": true,
  "rewrite_prefix": "1",
  "call_recording_enabled": true,
  "machine_detection_enabled": true,
  "transcription_threshold": 10,
  "created_at": "2023-05-16T17:13:25.000Z",
  "host": "dynamic",
  "multiple_numbers": true,
  "encrypted_media": true,
  "passthrough": true,
  "access_token": "123easwqe321132"
}