Start recording for room
Use this to start a recording job for a room.
The recoding will be in starting
state to begin with, and turn into running
shortly.
POSThttps://api.100ms.live/v2/recordings/room/<room_id>/start
curl --location --request POST 'https://api.100ms.live/v2/recordings/room/<room_id>/start' \ --header 'Authorization: Bearer <management_token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "meeting_url" : "<meeting_url>", "resolution" : {"width": 1280, "height": 720} }'
RESPONSE
Status: 200 OK
{ "id": "<recording-id>", "room_id": "<room-id>", "session_id": "<session-id>", "status": "starting", "created_at": "2023-03-30T05:14:04.007990308Z", "started_at": null, "updated_at": "2023-03-30T05:14:04.007990308Z", "stopped_at": null, "meeting_url": "<meeting-url>", "started_by": "", "stopped_by": "", "asset_types": [ "room-composite", "chat" ], "recording_assets": null }
Parameters
Name | Type | Description | Required |
---|---|---|---|
meeting_url | string | Single click meeting URL for the stream | Yes |
resolution | object | Video resolution for stream | No |
audio_only | boolean | Pass true to get an audio-only recording asset | No |
meeting_url
This is a URL which lands into the room directly. You can use 100ms room links that look like:
https://<domain>.app.100ms.live/preview/<room_id>/<role>?skip_preview=true
Other supported query parameters:
skip_preview=true
: skips the preview page and directly joins the meeting with header and controls disabledskip_preview_headful=true
: skips the preview page and directly joins the meeting with header and controls enabledauth_token=token1234
: Use this to pass an auth token to authenticate the room join actionui_mode=activespeaker
: Render active speaker mode by defaultname=johndoe
: Use this to add a name for the peer
Have a suggestion? Recommend changes ->