Start recording

Start recording a conference.

Please log in to see full path URL. Learn why.

post

/calls/1/conferences/{conferenceId}/start-recording

Authorizations:

Scopes:

calls:manage

calls:traffic:record

Request rate limit:

100 requests / second (per account)

Learn more

path Parameters

conferenceId

required

string

Conference ID.

Request Body schema:

application/json

collapse all -

recordingType

required

string

Enum: "AUDIO" "AUDIO_AND_VIDEO"

Recording type.

conferenceComposition

object

enabled

boolean

Default: false

Indicates whether to create a single recording of all participants. If set to True, all participants are merged into a single audio or video file. Otherwise, all participants will have their own individual audio or video file.

customData

object

Custom data.

property name*

string

Custom data.

filePrefix

string

Custom name for the recording's zip file. Applicable only when SFTP server is enabled on Voice settings page. Using the same filePrefix will override the files on the SFTP server. For recording without composition, callId and fileId will be appended to the filePrefix value.