{"id":4708,"date":"2021-12-03T19:45:38","date_gmt":"2021-12-03T11:45:38","guid":{"rendered":"https:\/\/www.enablex.io\/developer\/?page_id=4708"},"modified":"2025-04-04T19:28:20","modified_gmt":"2025-04-04T11:28:20","slug":"create-meeting-room-using-rest-api","status":"publish","type":"page","link":"https:\/\/doc.smartflomeet.ttns.in\/developer\/video\/low-code-video-embed\/create-meeting-room-using-rest-api\/","title":{"rendered":"Create Meeting Room Using Rest API"},"content":{"rendered":"\n

Video Embed URL has embedded Room-ID for Virtual Sessions. Your Application’s business logic and workflow might need many rooms to meet your requirement. Know how you create more rooms of different kind and how to embed them into your EMBED URL to get connected to different Virtual Rooms.<\/p><\/blockquote>\n\n\n\n

A Video conferencing session takes place in the Meeting Room hosted on the Platform server. A Room<\/strong> is a virtual meeting space within the platform to host real-time communication sessions. It facilitates communication among participants through Audio, Video & Chat.<\/p>\n\n\n\n

The communication between your Application Server and the platform server is carried out via Rest API, which is also known as Video API. Access Credentials APP_ID<\/strong> and APP_KEY<\/strong>, which you get at the time of creating a Project, must be passed as Authorization Header for accessing the Video APIs.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

You can create a Meeting Room request by calling Video\/Rest API through Meeting Room URL (see Example 1). To establish the room connection, IFRAME Embed URL requires a Meeting Room ID. Once the connection gets established, the IFRAME Embed starts playing Participant\u2019s Videos on your platform.<\/p>\n\n\n\n

Example 1<\/strong>: Meeting URL Explanation<\/strong><\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n<\/a>\n\n\n\n
<\/div>\n\n\n\n

1. Create a Room to get Room ID<\/h3>\n\n\n\n

To create a Meeting Room URL, you first need to create a Room and fetch the Room ID. You can create a Room using a Video API<\/a> and the platform server responds with the JSON Payload containing the unique \u201croom-id\u201d. There are three different types of Meeting Rooms that can be created: Permanent, Scheduled, and Ad-hoc.<\/p>\n\n\n\n

<\/div>\n\n\n\n

1.1 Permanent Room<\/h4>\n\n\n\n

It is a meeting room that always remains available for use once created. You can start it anytime and schedule it for further use in the future. Use the following Settings in JSON Payload for API Call to create Permanent Room:<\/p>\n\n\n\n

{\"settings\": {\"scheduled\": false, \"adhoc\": false}}<\/code><\/p>\n\n\n\n

Example 2<\/strong>: API Call to create Permanent Room<\/strong><\/p>\n\n\n\n

POST https:\/\/api.smartflomeet.ttns.in\/video\/v1\/rooms\nContent-Type: application\/json\nAuthorization: Basic XXXXXXXX\n \n{\n  \"name\": \"My Permanent Room\",\n  \"owner_ref\": \"XOXO\",\n  \"settings\": {\n    \"description\": \"My Permanent Room\",\n    \"mode\": \"group\",\n    \"scheduled\": false,\n    \"adhoc\": false,\n    \"duration\": 30,\n    \"moderators\": \"1\",\n    \"participants\": \"3\",\n    \"quality\": \"SD\",\n    \"canvas\": false,\n    \"screen_share\": false,\n    \"abwd\": true,\n    \"max_active_talkers\": 4\n  } \n}<\/pre>\n\n\n\n
Platform server responds with JSON containing a unique room-id<\/code>.<\/p>\n\n\n\n
{\n  \"result\": 0,\n  \"room\": {\n    \"name\": \"My Permanent Room\",\n    \"owner_ref\": \"XOXO\",\n    \"settings\": {\n      \"scheduled\": false,\n      \"adhoc\": false\n    },\n    \"created\": \"2021-05-25T00:20:30.851Z\",\n    \"room_id\": \"xxxxxxxxxxxxxx\"\n  }\n}<\/pre>\n\n\n\n
<\/div>\n\n\n\n
1.2 Scheduled Room<\/h4>\n\n\n\n
This Room is only available for a particular duration\/period that needs to be specified with a scheduled time and duration. Use the following Settings in JSON Payload for API Call to create Scheduled Room:<\/p>\n\n\n\n
{\"settings\": {\"scheduled\": true, \"scheduled time\": \"YYYY-MM-DD HH:II:SS\", \"duration\": 30}}<\/code><\/p>\n\n\n\n
The scheduled time<\/code> here is in GMT.<\/p>\n\n\n\n
Example 3<\/strong>: API Call to create Scheduled Room<\/strong><\/p>\n\n\n\n
POST http:\/\/api.smartflomeet.ttns.in\/video\/v1\/rooms\nContent-Type: application\/json\nAuthorization: Basic XXXXXXXX\n \n{\n  \"name\": \"My Scheduled Room\",\n  \"owner_ref\": \"XOXO\",\n  \"settings\": {\n    \"description\": \"My Scheduled Room\",\n    \"mode\": \"group\",\n    \"scheduled\": true,\n    \"adhoc\": false,\n    \"scheduled_time\": \"2021-05-31 05:30:00\",\n    \"duration\": 30,\n    \"moderators\": \"1\",\n    \"participants\": \"3\",\n    \"quality\": \"SD\",\n    \"abwd\": true\n  }\n}<\/pre>\n\n\n\n
Platform server responds with JSON containing a unique room-id<\/code>.<\/p>\n\n\n\n
{\n  \"result\": 0,\n  \"room\": {\n    \"name\": \"My Scheduled Room\",\n    \"owner_ref\": \"XOXO\",\n    \"settings\": {\n      \"scheduled\": true,\n      \"scheduled_time\": \"2021-05-31 05:30:00\",\n      \"duration\": 30,\n      \"adhoc\": false\n    },\n    \"created\": \"2021-05-25T00:20:30.851Z\",\n    \"room_id\": \"xxxxxxxxxxxxxx\"\n  }\n}<\/pre>\n\n\n\n
<\/div>\n\n\n\n
1.3 Adhoc Room<\/h4>\n\n\n\n
It can be created instantly and is only available for a single call. Use the following Settings in JSON Payload for API Call to create Scheduled Room:<\/p>\n\n\n\n
{\"settings\": {\"scheduled\": false, \"adhoc\": true}}<\/code><\/p>\n\n\n\n
Example 4<\/strong>: API Call to create Adhoc Room<\/strong><\/p>\n\n\n\n
POST http:\/\/api.smartflomeet.ttns.in\/video\/v1\/rooms\nContent-Type: application\/json\nAuthorization: Basic XXXXXXXX\n \n{\n  \"name\": \"My Adhoc Room\",\n  \"owner_ref\": \"XOXO\",\n  \"settings\": {\n    \"description\": \"My Adhoc Room\",\n    \"mode\": \"group\",\n    \"scheduled\": false,\n    \"adhoc\": true,\n    \"duration\": 30,\n    \"moderators\": \"1\",\n    \"participants\": \"3\",\n    \"quality\": \"SD\",\n    \"canvas\": false,\n    \"screen_share\": false,\n    \"abwd\": true,\n    \"max_active_talkers\": 4\n  }\n}<\/pre>\n\n\n\n
Platform server responds with JSON containing a unique room-id<\/code>.<\/p>\n\n\n\n
{\n  \"result\": 0,\n  \"room\": {\n    \"name\": \"My Adhoc Room\",\n    \"owner_ref\": \"XOXO\",\n    \"settings\": {\n      \"scheduled\": false,\n      \"adhoc\": true\n    },\n    \"created\": \"2021-05-25T00:20:30.851Z\",\n    \"room_id\": \"xxxxxxxxxxxxxx\"\n  }\n}<\/pre>\n\n\n\n
To learn more about Video APIs, refer to the following sources:<\/p>\n\n\n\n