Skip to main content

Bridge calls

POST 
/calls/:call_control_id/actions/bridge

Bridge two call control calls.

Expected Webhooks:

  • Call bridged for Leg A
  • Call bridged for Leg B

Request ​

Path Parameters

    call_control_id stringrequired

    Unique identifier and token for controlling the call

Body

required

    call_control_id stringrequired

    The call control id of the call you want to bridge with.

    client_state string

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

    command_id string

    Use this field to avoid duplicate commands. Telnyx will ignore commands with the same "command_id".

    park_after_unbridge string

    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.

Responses ​

200: Successful response

Schema

    result stringrequired

422: Error response

Schema

    code stringrequired
    title stringrequired
    detail stringrequired

Request samples

curl -L 'https://api.telnyx.com/calls/:call_control_id/actions/bridge' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "call_control_id": "c8ac9611-25c3-494a-b8b4-2f036a18a6b2",
  "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
  "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901",
  "park_after_unbridge": "self"
}'

Response samples

{
  "result": "ok"
}