¶ Main API
POST /room
| Field |
Type |
Description |
|
| token |
string |
{{token}} |
|
| Field |
Type |
Description |
|
| name |
string |
Whiteboard name |
|
| limit |
number |
Set to 0 is no limit, it is recommended to set it to 0: No room limit, limit from business. |
|
| mode |
string |
v2 version parameter; room type: persistent,historied |
|
The room has two modes: persistent room and replayable room. The room mode must be specified when it is created, and once determined, it cannot be modified. The different modes have the following characteristics:
| Mode |
Persistent |
Playback |
Description |
Persistent room (default)-persistent |
✓ |
✘ |
Even if the room will exist permanently, unless it is manually deleted by calling the API. |
Playback Room-historied |
✓ |
✓ |
Same as "Persistent Room". And all the contents of the room will be automatically recorded for playback. |
{
"name":"Whiteboard name",
"limit":0,
"mode": "persistent"
}
{
"code": 200,
"msg": {
"room": {
"id": 650,
"name": "console-room",
"limit": 0,
"teamId": 1,
"adminId": 1,
"mode": "persistent",
"template": "meeting",
"region": "cn",
"uuid": "This is the room uuid",
"updatedAt": "2019-01-15T09:12:05.974Z",
"createdAt": "2019-01-15T09:12:05.974Z"
},
"hare": "{\"uuid\":\"uuid\",\"teamId\":\"1\",\"mode\":\"persistent\",\"region\":\" cn\",\"isBan\":false,\"beginTimestamp\":1547543526200,\"endTimestamp\":1547543526200,\"endFrameId\":0,\"usersMaxCount\":100,\"survivalDuration\": 30000,\"chunkFramesCount\":700,\"snapshotIdInterval\":80}",
"roomToken": "This is the room roomToken",
"code": 201
}
}
GET /room/{{uuid}}/roomtoken
| Field |
Type |
Description |
|
| token |
string |
{{token}} |
|
| Field |
Type |
Description |
|
| uuid |
string |
Whiteboard unique identifier |
|
In the response of this request, in the msg field, the required roomToken field can be obtained.
Click to view: Get the roomtoken interface in the old version
`POST /room/join?uuid={{uuid}}`
| Field |
Type |
Description |
|
| token |
string |
{{token}} |
|
| Field |
Type |
Description |
|
| uuid |
string |
Whiteboard unique identifier |
|
In the response of this request, in the msg field, the required roomToken field can be obtained.
The old and new versions of the interface are valid and consistent at the same time, only the url is different
GET /room?offset={{offset}}&limit={{limit}}
| Field |
Type |
Description |
|
| token |
string |
{{token}} |
|
| Field |
Type |
Description |
|
| offset |
number |
Which whiteboard to start searching (counting from 1) |
|
| limit |
number |
The number of whiteboards obtained each time |
|
GET /room/id?uuid={{uuid}}
| Field |
Type |
Description |
|
| token |
string |
{{token}} |
|
| Field |
Type |
Description |
|
| uuid |
string |
Whiteboard unique identifier |
|
{
"code": 200,
"msg": {
"id": 11600,
"teamId": 1,
"adminId": 1,
"uuid": "Here is uuid",
"name": "Unnamed",
"limit": 0,
"current": 0,
"enable": true,
"playable": false,
"videoready": false,
"mode": null,
"region": "cn",
"template": null,
"createdAt": "2018-08-20T14:57:13.000Z",
"updatedAt": "2018-08-26T05:56:36.000Z"
}
}
GET /room/scenes/count?roomuuid={{uuid}}
| Field |
Type |
Description |
|
| token |
string |
{{token}} |
|
| Field |
Type |
Description |
|
| roomuuid |
string |
Whiteboard unique identifier |
|
¶ Disable and restore whiteboard
POST /banRoom
After using this API, all users will be kicked out of the room, and the room joining operation cannot be performed in the client sdk. The disabled whiteboard can be played back.
| Field |
Type |
Description |
|
| token |
string |
{{token}} |
|
| Field |
Type |
Description |
|
| ban |
boolean |
true to disable; false to restore |
|
| uuid |
string |
Whiteboard unique identifier |
|