API Category
Last updated: 2025-10-30 21:46:36
Application Configuration APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| SetAppCustomContent | Sets the custom content of an application. | 20 |
| DeleteAppCustomContent | Deletes custom elements | 20 |
| ModifyApp | Modifies an application. | 20 |
| GetWatermark | Gets watermark settings | 20 |
| SetWatermark | Configures watermarks | 20 |
| CreateSupervisor | Creates a spectator. | 20 |
| DeleteSupervisor | Deletes spectators | 20 |
| DescribeSupervisors | Gets the spectators of a room | 20 |
User Login APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| LoginUser | Logs in. | 20 |
| LoginOriginId | Logs in with an origin account. | 20 |
Recording Management APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| DeleteRecord | Deletes the recording files of a specific room | 20 |
| BatchDeleteRecord | Deletes the recordings of multiple rooms | 20 |
Courseware Management APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CreateDocument | Creates a document. | 20 |
| DescribeDocument | Gets the information of a document | 20 |
| BindDocumentToRoom | Binds a document to a room. | 20 |
| BatchDescribeDocument | Gets courseware information | 20 |
| DescribeDocuments | Queries courseware information | 20 |
| UnbindDocumentFromRoom | Unbinds a document from a room. | 20 |
| DescribeDocumentsByRoom | Gets the documents of a specific room | 20 |
| DeleteDocument | Deletes a document | 20 |
Room Management APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CreateRoom | Creates a room. | 20 |
| BatchCreateRoom | Creates multiple rooms | 20 |
| DescribeCurrentMemberList | Gets the user list of a room | 20 |
| DescribeRoom | Gets room information. | 50 |
| DescribeRoomStatistics | Obtains the statistics of a room. | 20 |
| GetRoomEvent | Gets the events of a room | 20 |
| DescribeAnswerList | Gets the answers to a quiz question in a room | 20 |
| DescribeQuestionList | Gets the quiz details of a room | 20 |
| GetRoomMessage | Gets the message history of a room | 20 |
| GetRooms | Gets the room list | 20 |
| ModifyRoom | Modifies a room | 20 |
| DeleteRoom | Deletes a room. | 20 |
| EndRoom | Ends a room | 20 |
| StartRoom | Starts a room | 20 |
| KickUserFromRoom | Removes a user from the room | 20 |
User Management APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| RegisterUser | Registers a user. | 20 |
| BatchRegister | Registers multiple users | 20 |
| DescribeSdkAppIdUsers | Gets the user list of an application | 20 |
| DescribeUser | Obtains user profile. | 20 |
| ModifyUserProfile | Modifies a user profile | 20 |
Group Management APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| AddGroupMember | Adds users to a group | 20 |
| BatchAddGroupMember | Adds users to multiple groups | 20 |
| BatchCreateGroupWithMembers | Creates multiple groups | 20 |
| BatchDeleteGroupMember | Removes users from multiple groups | 20 |
| CreateGroupWithMembers | Creates a group | 20 |
| CreateGroupWithSubGroup | Merges groups | 20 |
| DeleteGroup | Deletes groups | 20 |
| DeleteGroupMember | Removes users from a group | 20 |
| DescribeGroup | Gets the details of a group | 20 |
| DescribeGroupList | Queries groups | 20 |
| DescribeGroupMemberList | Gets the members of a group | 20 |
| ModifyGroup | Modifies a group | 20 |
Developer APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| DescribeDeveloper | Gets developer information | 20 |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback