Skip to main content
Version: /v2

Create a Room

This API lets you create unique meetingId.
Body Parameters
@discontinued

The region parameter has been discontinued; instead, the Video SDK's smart service will pick the best optimal servers for a conference, closest to your end-users' location. If you still need to hold your conferences in a specific region, i.e. Geo Fencing.

Contact Us

OPTIONAL

Customize Room id for better understanding.

OPTIONAL

values :

{
  'webhook': {
    'endPoint': 'your webhook endpoint',
    'events': ['webhook event type_1', 'webhook event type_2']
   }
}

You can subscribe from various events to get webhook.

  • participant-joined
  • participant-left
  • session-started
  • session-ended
  • recording-started
  • recording-stopped
  • livestream-started
  • livestream-stopped
  • hls-started
  • hls-stopped
    • Please refer this User webhooks for more information. All User webhooks endpoint must me a POST method in your api server / webhook server.
POST
|
https://api.videosdk.live/v2/rooms
import fetch from 'node-fetch';
const options = {
method: "POST",
headers: {
"Authorization": "$YOUR_TOKEN",
"Content-Type": "application/json",
},
body: JSON.stringify({"region" : "sg001","customRoomId" : "aaa-bbb-ccc","webhook" : "see example"}),
};
const url= `https://api.videosdk.live/v2/rooms`;
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
RESPONSE
{
"roomId": "abc-xyzw-lmno",
"customRoomId": "final-testing",
"userId": "5f7edbb14c938bcd42944527",
"disabled": false,
"createdAt": "2022-03-25T04:49:11.024Z",
"updatedAt": "2022-03-25T04:49:11.024Z",
"id": "623d49c760a18e699abcc8a4",
"links": {
"get_room": "https://api.videosdk.live/v2/rooms/abc-xyzw-lmno",
"get_session": "https://api.videosdk.live/v2/sessions/"
}
}