Skip to main content

API Endpoint Reference

This page provides detailed documentation for every endpoint in the EazyClassroom Academy API. Each endpoint requires authentication with a valid api_key (sent as POST parameter or query string).


1. Create Room

Creates a new persistent virtual room.

Endpoint: action=create_room
Method: POST
Scope required: create_room

Parameters

ParameterTypeRequiredDefaultDescription
api_keystringYesYour API key
room_namestringYesHuman‑readable name (e.g., "Math Class")
room_passwordstringNo(empty)Password required for moderators to start sessions
max_participantsintNo50Maximum number of attendees
max_durationintNo180Maximum session length in minutes
auto_start_recordingbooleanNotrueAutomatically start recording when session begins
start_mutedbooleanNofalseMute all participants on join
stop_recordingbooleanNofalseAllow moderators to stop recording
webcams_for_teachersbooleanNofalseOnly moderators can share webcams

Response (Success)

{
"success": true,
"message": "Room created successfully",
"data": {
"room_id": "math-class",
"room_name": "Math Class",
"moderator_password": "mp",
"attendee_password": "ap"
}
}