Start Participant Recording - API

This API lets you record a participant of your room by passing roomId and participantId as body parameters.

HTTP method and endpoint

POST

|

https://api.videosdk.live/v2/recordings/participant/start

Headers Parameters

Authorization

REQUIRED

values : YOUR_TOKEN_WITHOUT_ANY_PREFIX

This will be a JWT token generate using VideoSDK ApiKey and Secret.

Note that the token will not include any prefix such as "Basic " or "Bearer ". Just pass a token as value.

You can generate a new token by refering this Guide: Generate Auth token

Content-Type

REQUIRED

values : application/json

This is usefull for json body parameters, so that VideoSDK servers can understand that the incoming body parameter will be a JSON string.

Body Parameters

roomId

REQUIRED

The ID of the Room.

participantId

REQUIRED

The ID of the Participant.

fileFormat

OPTIONAL

• fileFormat:
  • values: "webm"
  • default: "webm"

webhookUrl

OPTIONAL

Webhook URL

bucketDirPath

OPTIONAL

Your Cloud Storage Bucket Path.

POST

|

https://api.videosdk.live/v2/recordings/participant/start

NodeJS

• cURL
• NodeJS
• PHP
• Python

import fetch from 'node-fetch';
const options = {
	method: "POST",
	headers: {
		"Authorization": "$YOUR_TOKEN",
		"Content-Type": "application/json",
	},
	body: JSON.stringify({
		"roomId" : "abcd-efgh-ijkl",
		"participantId" : "abcd",
		"fileFormat" : "webm",
		"webhookUrl" : "https://www.example.com/",
		"bucketDirPath" : "s3path"
	}),
};
const url= `https://api.videosdk.live/v2/recordings/participant/start`;
const response = await fetch(url, options);
const data = await response.json();
console.log(data);

RESPONSE

"participant recording started successfully."