Start Conference Recording Request

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/telnyx/main/json-schema/telnyx-start-conference-recording-request-schema.json",
  "title": "Start Conference Recording Request",
  "x-generated": "2026-10-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-conference-commands-api-openapi.yml#/components/schemas/StartConferenceRecordingRequest",
  "properties": {
    "channels": {
      "default": "single",
      "description": "When `dual`, final audio file will be stereo recorded with the conference creator on the first channel, and the rest on the second channel.",
      "enum": [
        "single",
        "dual"
      ],
      "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 `conference_id`.",
      "type": "string"
    },
    "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"
    },
    "format": {
      "description": "The audio file format used when storing the conference recording. Can be either `mp3` or `wav`.",
      "enum": [
        "wav",
        "mp3"
      ],
      "type": "string"
    },
    "play_beep": {
      "description": "If enabled, a beep sound will be played at the start of a recording.",
      "type": "boolean"
    },
    "region": {
      "$ref": "#/$defs/ConferenceRegion"
    },
    "trim": {
      "description": "When set to `trim-silence`, silence will be removed from the beginning and end of the recording.",
      "enum": [
        "trim-silence"
      ],
      "type": "string"
    }
  },
  "required": [
    "format"
  ],
  "type": "object",
  "$defs": {
    "ConferenceRegion": {
      "description": "Region where the conference data is located. Defaults to the region defined in user's data locality settings (Europe or US).",
      "enum": [
        "Australia",
        "Europe",
        "Middle East",
        "US"
      ],
      "type": "string"
    }
  }
}