Bridge Request

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/telnyx/main/json-schema/telnyx-bridge-request-schema.json",
  "title": "Bridge Request",
  "x-generated": "2026-10-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-call-commands-api-openapi.yml#/components/schemas/BridgeRequest",
  "properties": {
    "call_control_id": {
      "description": "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.",
      "type": "string"
    },
    "client_state": {
      "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.",
      "type": "string"
    },
    "command_id": {
      "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.",
      "type": "string"
    },
    "hold_after_unbridge": {
      "description": "Specifies behavior after the bridge ends. If set to `true`, the current leg will be put on hold after unbridge instead of being hung up.",
      "type": "boolean"
    },
    "mute_dtmf": {
      "default": "none",
      "description": "When enabled, DTMF tones are not passed to the call participant. The webhooks containing the DTMF information will be sent.",
      "enum": [
        "none",
        "both",
        "self",
        "opposite"
      ],
      "type": "string"
    },
    "park_after_unbridge": {
      "description": "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.",
      "type": "string"
    },
    "play_ringtone": {
      "default": false,
      "description": "Specifies whether to play a ringtone if the call you want to bridge with has not yet been answered.",
      "type": "boolean"
    },
    "prevent_double_bridge": {
      "default": false,
      "description": "When set to `true`, it prevents bridging if the target call is already bridged to another call. Disabled by default.",
      "type": "boolean"
    },
    "queue": {
      "description": "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.",
      "type": "string"
    },
    "record": {
      "description": "Start recording automatically after an event. Disabled by default.",
      "enum": [
        "record-from-answer"
      ],
      "type": "string"
    },
    "record_channels": {
      "default": "dual",
      "description": "Defines which channel should be recorded ('single' or 'dual') when `record` is specified.",
      "enum": [
        "single",
        "dual"
      ],
      "type": "string"
    },
    "record_custom_file_name": {
      "description": "The custom recording file name to be used instead of the default `call_leg_id`. Telnyx will still add a Unix timestamp suffix.",
      "maxLength": 40,
      "minLength": 1,
      "type": "string"
    },
    "record_format": {
      "default": "mp3",
      "description": "Defines the format of the recording ('wav' or 'mp3') when `record` is specified.",
      "enum": [
        "wav",
        "mp3"
      ],
      "type": "string"
    },
    "record_max_length": {
      "default": 0,
      "description": "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).",
      "format": "int32",
      "type": "integer"
    },
    "record_timeout_secs": {
      "default": 0,
      "description": "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).",
      "format": "int32",
      "type": "integer"
    },
    "record_track": {
      "default": "both",
      "description": "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).",
      "enum": [
        "both",
        "inbound",
        "outbound"
      ],
      "type": "string"
    },
    "record_trim": {
      "description": "When set to `trim-silence`, silence will be removed from the beginning and end of the recording.",
      "enum": [
        "trim-silence"
      ],
      "type": "string"
    },
    "ringtone": {
      "default": "us",
      "description": "Specifies which country ringtone to play when `play_ringtone` is set to `true`. If not set, the US ringtone will be played.",
      "enum": [
        "at",
        "au",
        "be",
        "bg",
        "br",
        "ch",
        "cl",
        "cn",
        "cz",
        "de",
        "dk",
        "ee",
        "es",
        "fi",
        "fr",
        "gr",
        "hu",
        "il",
        "in",
        "it",
        "jp",
        "lt",
        "mx",
        "my",
        "nl",
        "no",
        "nz",
        "ph",
        "pl",
        "pt",
        "ru",
        "se",
        "sg",
        "th",
        "tw",
        "uk",
        "us-old",
        "us",
        "ve",
        "za"
      ],
      "type": "string"
    },
    "video_room_context": {
      "description": "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.",
      "type": "string"
    },
    "video_room_id": {
      "description": "The ID of the video room you want to bridge with, can't be used together with call_control_id parameter or queue parameter.",
      "format": "uuid",
      "type": "string"
    }
  },
  "required": [
    "call_control_id"
  ],
  "type": "object"
}