Create Room
Create a new classroom session. This endpoint initializes a room and returns a token for the initial participant (usually the host/teacher).
Endpoint: POST https://api.verriflo.com/v1/room/create
Headers​
| Header | Type | Required | Description |
|---|---|---|---|
VF-ORG-ID | string | Yes | Your Organization ID (e.g., llHUjznZtGuY6jXP) |
Content-Type | string | Yes | application/json |
Request Body​
{
"roomId": "math-101",
"title": "Calculus I - Morning Session",
"participant": {
"uid": "teacher-123",
"name": "Prof. Smith",
"role": "TEACHER"
},
"customization": {
"showLobby": true,
"theme": "dark"
},
"settings": {
"maxParticipants": 1000,
"emptyTimeout": 300
}
}
Parameters​
| Field | Type | Required | Description |
|---|---|---|---|
roomId | string | Yes | Unique identifier for the room. Must be unique per room and cannot be reused later even if the room is destroyed. |
title | string | Yes | Display title for the classroom. |
participant | object | Yes | Initial participant details. |
participant.uid | string | Yes | Unique ID for the participant. |
participant.name | string | Yes | Display name. |
participant.role | string | Yes | Role: TEACHER, STUDENT, MODERATOR, or ADMIN. |
customization | object | No | UI customization options (see Customization Guide). |
settings | object | No | Room configuration settings. |
settings.maxParticipants | number | No | Limits the number of users who can join the room. (Default: 1000, Max: 5000) |
settings.emptyTimeout | number | No | Duration (in seconds) the room stays active after the last participant leaves. (Default: 300 (5min), Max: 1800 (30min)) |
Response​
{
"success": true,
"data": {
"token": "eyJhbGciOiJIUz...",
"iframeUrl": "https://live.verriflo.com/iframe/live?token=eyJ...",
"expiresAt": "2023-12-31T23:59:59.000Z",
"room": {
"roomId": "math-101",
"sid": "RM_7482..."
}
}
}