Join Room

Join an existing classroom session. This endpoint generates a token for a participant to join a room that has already been created.

Endpoint: POST https://api.verriflo.com/v1/room/:roomId/join

Headers

Header	Type	Required	Description
VF-ORG-ID	string	Yes	Your Organization ID
Content-Type	string	Yes	application/json

Request Body

{
  "participant": {
    "uid": "student-456",
    "name": "Jane Doe",
    "role": "STUDENT"
  },
  "customization": {
    "showLobby": false,
    "theme": "light"
  }
}

Parameters

Field	Type	Required	Description
participant	object	Yes	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	Override UI customization options (see Customization Object).

Response

{
  "success": true,
  "data": {
    "token": "eyJhbGciOiJIUz...",
    "iframeUrl": "https://live.verriflo.com/iframe/live?token=eyJ...",
    "expiresAt": "2023-12-31T23:59:59.000Z"
  }
}

Error Codes

Status	Message	Description
404	Room not found	The room ID provided does not exist or has ended.
401	Unauthorized	Invalid organization ID.
400	Validation error	Missing required fields.