Bridge calls

POST

/calls/{call_control_id}/actions/bridge

Call Commands

Bridge two call control calls.

Expected Webhooks (see callback schema below):

call.bridged for Leg A

call.bridged for Leg B

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/calls//actions/bridge' \
--header 'Content-Type: application/json' \
--data-raw '{
    "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
    "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
    "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901",
    "park_after_unbridge": "self"
}'

Response Example

200 - Example 1

{
    "data": {
        "result": "ok"
    }
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

call_control_id

string

required

Unique identifier and token for controlling the call

Body Params application/json

call_control_id

string

required

The Call Control ID of the call you want to bridge with, can't be used together with queue parameter or video_room_id parameter.

Example:

v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg

client_state

string

optional

Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.

Example:

aGF2ZSBhIG5pY2UgZGF5ID1d

command_id

string

optional

Use this field to avoid duplicate commands. Telnyx will ignore any command with the same command_id for the same call_control_id.

Example:

891510ac-f3e4-11e8-af5b-de00688a4901

mute_dtmf

enum<string>

optional

When enabled, DTMF tones are not passed to the call participant. The webhooks containing the DTMF information will be sent.

Allowed values:

nonebothselfopposite

Default:

none

Example:

opposite

park_after_unbridge

string

optional

Specifies behavior after the bridge ends (i.e. the opposite leg either hangs up or is transferred). If supplied with the value self, the current leg will be parked after unbridge. If not set, the default behavior is to hang up the leg.

Example:

self

play_ringtone

boolean

optional

Specifies whether to play a ringtone if the call you want to bridge with has not yet been answered.

Default:

false

Example:

true

queue

string

optional

The name of the queue you want to bridge with, can't be used together with call_control_id parameter or video_room_id parameter. Bridging with a queue means bridging with the first call in the queue. The call will always be removed from the queue regardless of whether bridging succeeds. Returns an error when the queue is empty.

Example:

support

record

enum<string>

optional

Start recording automatically after an event. Disabled by default.

Allowed value:

record-from-answer

Example:

record-from-answer

record_channels

enum<string>

optional

Defines which channel should be recorded ('single' or 'dual') when record is specified.

Allowed values:

singledual

Default:

dual

Example:

single

record_custom_file_name

string

optional

The custom recording file name to be used instead of the default call_leg_id. Telnyx will still add a Unix timestamp suffix.

>= 1 characters<= 40 characters

Example:

my_recording_file_name

record_format

enum<string>

optional

Defines the format of the recording ('wav' or 'mp3') when record is specified.

Allowed values:

wavmp3

Default:

mp3

Example:

wav

record_max_length

integer <int32>

optional

Defines the maximum length for the recording in seconds when record is specified. The minimum value is 0. The maximum value is 43200. The default value is 0 (infinite).

Default:

Example:

1000

record_timeout_secs

integer <int32>

optional

The number of seconds that Telnyx will wait for the recording to be stopped if silence is detected when record is specified. The timer only starts when the speech is detected. Please note that call transcription is used to detect silence and the related charge will be applied. The minimum value is 0. The default value is 0 (infinite).

Default:

Example:

100

record_track

enum<string>

optional

The audio track to be recorded. Can be either both, inbound or outbound. If only single track is specified (inbound, outbound), channels configuration is ignored and it will be recorded as mono (single channel).

Allowed values:

bothinboundoutbound

Default:

both

Example:

outbound

record_trim

enum<string>

optional

When set to trim-silence, silence will be removed from the beginning and end of the recording.

Allowed value:

trim-silence

Example:

trim-silence

ringtone

enum<string>

optional

Specifies which country ringtone to play when play_ringtone is set to true. If not set, the US ringtone will be played.

Allowed values:

ataubebgbrchclcnczdedkeeesfifrgrhuilinitjpltmxmynlnonzphplptrusesgthtwukus-oldusveza

Default:

Example:

video_room_context

string

optional

The additional parameter that will be passed to the video conference. It is a text field and the user can decide how to use it. For example, you can set the participant name or pass JSON text. It can be used only with video_room_id parameter.

Example:

Alice

video_room_id

string <uuid>

optional

The ID of the video room you want to bridge with, can't be used together with call_control_id parameter or queue parameter.

Example:

0ccc7b54-4df3-4bca-a65a-3da1ecc777f0

Examples

Responses

🟢200OK

application/json

Successful response upon making a call control command.

Body

data

object (Call Control Command Result)

optional

Example:

{"result":"ok"}

result

string

optional

Example:

🔴500Server Error

Modified at 2025-06-16 19:14:41

Answer call

Update client state