Start recording a conference
This API lets you start recording an ongoing conference after the conference is initiated. Alternatively, you can record a conference by using the recording capabilities of the Conference XML element.
API Endpoint
The member_id attribute that’s passed in the URL can be a member_id, a comma-separated list of member IDs on which this operation will be performed, or the string all. In the latter case, the play audio action is performed on all members of the conference.
Attributes
Attributes | Description |
---|---|
file_format | The file format for the recording. Allowed values: mp3 , wav .Defaults to mp3 . |
transcription_type | auto : Transcription is automated; the turnaround time is under 5 minutes and increases linearly with call duration. Transcription charges and details are available on our pricing page. |
Note | Transcription service is available only in English, and limited to calls with a duration greater than 500 milliseconds and less than 4 hours, with a recording file size smaller than 2GB. |
transcription_url [Callback-retry configurable] | The URL to which the transcription should be posted. |
Note | The transcription information will be sent to this URL via an HTTP POST callback. |
callback_url [Callback-retry configurable] | The URL invoked when the recording ends. The parameters to be posted to the URL are documented in the table below. |
callback_method | The HTTP verb used to invoke the callback_url . Defaults to POST . |
List of parameters sent to the callback URL
These details are posted when the callback URL is invoked after the recording ends.
api_id | The API ID that was returned by the conference record API. |
record_url | The URL where the recorded file can be accessed. |
recording_id | The recording ID associated with the recording file. |
conference_name | The name of the conference recorded. |
recording_duration | The recording duration in seconds. |
recording_duration_ms | The recording duration in milliseconds. |
recording_start_ms | The start time of the recording since epoch in milliseconds. |
recording_end_ms | The end time of the recording since epoch in milliseconds. |
List of parameters sent to the transcription URL
transcription_charge | The credit deducted for the transcription. |
transcription | The transcribed text of the recording. |
duration | The duration in seconds of the recording. |
call_uuid | The call UUID of the call that was transcribed. |
transcription_rate | The rate of the transcription per minute. |
recording_id | Recording ID of the transcribed recording. |
error | May be Recording duration too long for transcription or Recording file size too large for transcription . Empty if transcription is successful. |
.mp3 files are smaller in size than .wav files. Consider changing the recording file format to .mp3 if you see this error.
Returns
If successful, returns an acknowledgement that conference recording has started along with a URL to access the recording.