Start Composite Recording - API

This API lets you start composite recording of multiple participant

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.

participants

OPTIONAL

Array of object which contains list of participants to be recorded along with the kind of media to be recorded.

This is an optional parameter, if provided it will record scpeific participant else it will record at most 3 participants.

• kind is optional, if can have following values: audio, video, screen_audio, screen_video

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",
		"participants" : [{"participantId":"abcd","kind":"video"}]
	}),
};
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

{
  "message": "Composite recording started successfully",
  "recordingId": "68bec210ec765e266517c8f4"
}