Recording start

POST /calls/:call_control_id/actions/record_start

Start recording the call. Recording will stop on call hang-up, or can be initiated via the Stop Recording command.

Expected Webhooks: There are no webhooks associated with this Command.

Request

call_control_id stringrequired

Unique identifier and token for controlling the call

required

format stringrequired

Possible values: [wav, mp3]

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

channels stringrequired

Possible values: [single, dual]

When 'dual', final audio file will be stereo recorded with the first leg on channel A, and the rest on channel B.

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".

play_beep boolean

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

200: Successful response

Schema

result stringrequired

{
  "result": "ok"
}

422: Error response

Schema

code stringrequired

title stringrequired

detail stringrequired

{
  "code": "90015",
  "title": "Invalid Call Control ID",
  "detail": "The call_control_id provided was not valid."
}