Conference Commands

Conference recording start

Changed on

Start recording the conference. Recording will stop on conference end, or via the Stop Recording command.

Expected Webhooks:

  • conference.recording.saved
post/conferences/{id}/actions/record_start

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/conferences/{id}/actions/record_start
  • Auth: HTTP bearer

Path parameters

idstring required

Specifies the conference to record by id or name

Request body

format'wav' | 'mp3' required

The audio file format used when storing the conference recording. Can be either mp3 or wav.

command_idstring

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

channels'single' | 'dual'

When dual, final audio file will be stereo recorded with the conference creator on the first channel, and the rest on the second channel.

play_beepboolean

If enabled, a beep sound will be played at the start of a recording.

trim'trim-silence'

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

custom_file_namestring

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

region'Australia' | 'Europe' | 'Middle East' | 'US'

Region where the conference data is located. Defaults to the region defined in user's data locality settings (Europe or US).

Example request

{
  "format": "wav",
  "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901",
  "play_beep": true
}

Response

Successful response upon making a conference command.

Example response

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

Changes