API Endpoints
Room Management
| Description | Endpoint | Method | Documentation |
|---|---|---|---|
| start meeting | /rooms | POST | Link |
| get meeting detail | /rooms/ACCESS_KEY | GET | Link |
| end meeting | /rooms/ACCESS_KEY | DELETE | Link |
| force stop meeting | /rooms/ROOM_ID | DELETE | Link |
| get list of running meetings | /rooms | GET | Link |
| lock meeting | /rooms/ACCESS_KEY/lock | POST | Link |
| send message | /rooms/ACCESS_KEY/messages | POST | Link |
| start playback | /rooms/ACCESS_KEY/playbacks | POST | Link |
| stop playback | /rooms/ACCESS_KEY/playbacks/PLAY_ID | DELETE | Link |
User Management
| Description | Endpoint | Method | Documentation |
|---|---|---|---|
| fetch user details | /rooms/ACCESS_KEY/users/CLIENT_ID | GET | Link |
| register user | /rooms | POST | Link |
| register guest user | /guests/GUEST_TOKEN | POST | Link |
| kick user | /rooms/ACCESS_KEY/users/USER_ID | DELETE | Link |
| create permalink | /permalink | POST | Link |
| get list of permalinks | /permalink | GET | Link |
| get permalink by id | /permalink/PERMALINK_ID | GET | Link |
| update permalink | /permalink/PERMALINK_ID | PUT | Link |
| delete permalink | /permalink/PERMALINK_ID | DELETE | Link |
| register host user | /permalink/PERMALINK_ID/users | POST | Link |
| remove host user | /permalink/PERMALINK_ID/users/USER_TOKEN | DELETE | Link |
| get meeting info | /permalink/USER_TOKEN | GUEST_TOKEN | GET | Link |
| start meeting | /permalink/USER_TOKEN | POST | Link |
| register guest user to permalink | /guests/GUEST_TOKEN | POST | Link |
Stream Forwarding Management - AI adapter
| Description | Endpoint | Method | Documentation |
|---|---|---|---|
| forward source | /rooms/ROOM_ID/forward/source | POST | Link |
| forward mcu | /rooms/ROOM_ID/forward/mcu | POST | Link |
| forward playback | /rooms/ROOM_ID/forward/playback | POST | Link |
| end forward | /rooms/ROOM_ID/forward/FORWARD_ID | DELETE | Link |
Layout and Layer Management
| Description | Endpoint | Method | Documentation |
|---|---|---|---|
| add content to layer | /rooms/ACCESS_KEY/layers | POST | Link |
| delete layer content | /rooms/ACCESS_KEY/layers/LAYER_INDEX | DELETE | Link |
| set layout | /rooms/ACCESS_KEY/layout | POST | Link |
Recording and Snapshot Management
| Description | Endpoint | Method | Documentation |
|---|---|---|---|
| start recording | /rooms/ACCESS_KEY/recording | POST | Link |
| stop recording | /rooms/ACCESS_KEY/recording | DELETE | Link |
| get recording | /recordings/RECORDING_ID | GET | Link |
| get list of recordings | /rooms/ROOM_ID/recordings | GET | Link |
| delete recording | /recordings/RECORDING_ID | DELETE | Link |
| create snapshot | /rooms/ACCESS_KEY/snapshot | POST | Link |
| get snapshot | /rooms/ACCESS_KEY/snapshots/SNAPSHOT_ID | GET | Link |
| get snapshot | /snapshots/SNAPSHOT_ID | GET | Link |
| get list of snapshots | /rooms/ROOM_ID/snapshots | GET | Link |
| delete snapshot | /snapshots/SNAPSHOT_ID | DELETE | Link |
Broadcast Management
| Description | Endpoint | Method | Documentation |
|---|---|---|---|
| start broadcast | /rooms/ACCESS_KEY/broadcasts | POST | Link |
| update player_url | /rooms/ACCESS_KEY/broadcasts | PUT | Link |
| stop broadcast | /rooms/ACCESS_KEY/broadcasts | DELETE | Link |
Webhook Management
| Description | Endpoint | Method | Documentation |
|---|---|---|---|
| register webhook | /webhooks | POST | Link |
| get webhooks | /webhooks | GET | Link |
| remove webhook | /webhooks/WEBHOOK_ID | DELETE | Link |
tip
Make sure to get acquainted with all parameters at endpoints.