Conference recording start

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

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.conferences.actions.recordStart('id', { format: 'wav' });

console.log(response.data);

200

Example

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

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Specifies the conference to record by id or name

Body

application/json

format · enum<string> · required

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

Available options: wav, mp3

Example:

"mp3"

command_id · string

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

Example:

"891510ac-f3e4-11e8-af5b-de00688a4901"

channels · enum<string> · default: single

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

Available options: single, dual

Example:

"dual"

play_beep · boolean

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

Example:

true

trim · enum<string>

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

Available options: trim-silence

Example:

"trim-silence"

custom_file_name · string

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

Required string length: 1 - 40

Example:

"my_recording_file_name"

region · enum<string>

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

Available options: Australia, Europe, Middle East, US

Example:

"US"

Response

200

application/json

Successful response upon making a conference command.

data · Conference Command Result · object

Show child attributes

Example:

{ "result": "ok" }