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.

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}
}'

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

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 disabled
• skip_preview_headful=true: skips the preview page and directly joins the meeting with header and controls enabled
• auth_token=token1234: Use this to pass an auth token to authenticate the room join action
• ui_mode=activespeaker: Render active speaker mode by default
• name=johndoe: Use this to add a name for the peer