Agora Meeting Business Service

其他语言版本：简体中文

Overview

Agora Meeting Business Service manages the status of a video meeting, plus the status of its host and the participants. Agora Meeting Business Service provides the following functions:

• Create a conference room.
• Generate and update Agora RTC SDK, Agora RTM SDK and whiteboard tokens.
• Manage the list of host and participants.
• Enable/Disable the host and participants' audio and video.
• Control meeting status, including whether to mute all.
• Share the screen.
• Draw on the whiteboard.
• Pass host controls.
• Report on when a user enters or leaves the room and the total number of participants.
• Send instant messages.
• End the meeting.

You can use Agora Meeting Business Service, together with the Agora RTC SDK, the Agora RTM SDK, and the third-party Netless Whiteboard SDK to quickly implement online interactive meeting scenarios.

Get started

Enter a room

Call entry room to enter a room:

Method: POST /conf/v1/apps/{appId}/room/entry

Use the following parameters as required:

Request parameters	Description
appId	The App ID issued by Agora for developers.
roomName	The displayed name of a room.
roomUuid	The unique identifier of a room in your meeting management system. Users passing in the same roomUuid are assigned to the same room.
userName	The displayed name of a user.
userUuid	The unique identifier of a user in your user management system. Users passing in the same userUuid are considered as one user.
password	The password of the room. This parameter is optional.
enableVideo	Whether to enable the video. The default value is 0, which enables the video.
enableAudio	Whether to enable the audio. The default value is 0, which enables the audio.

Response parameters	Description
roomId	The unique identifier of a room.
userToken	The unique identifier of a user in the room. You need to pass in userToken for all user operations in the room.

Initialize a room

Call get room info to get room information (room name, room type, whiteboard ID, whiteboard token, the status of the meeting, plus the number of users and co-hosts in the room), and user information (user name, user role, RTC token, RTM token, and whether the user can send text messages, audio or video).

You can initialize a room on the client side by using the previously-mentioned information.

Method: GET /conf/v1/apps/{appId}/room/{roomId}

Use the following parameters as required:

Request parameter	Description
appId	The App ID issued by Agora for developers.
roomId	The unique identifier of a room. Returned in the response of entry room.
token	The token identifying a user. Returned in the userToken parameter in the response of entry room.

Response parameter	Description
room	The information of the current room, including:Room nameRoom typeMeeting statusNumber of users in the roomThe parameter also contains roomId which you can use in your own meeting system for customization.
user	The information of the current user, including the user name, user role, RTC token, RTC Token, and user privileges. The parameter also contains userUuid which you can use in your own user system for customization.

During the meeting

During the meeting, the host can call change room info and change user info to update the room information (the meeting status, whether to mute all, whether to lock the whiteboard) and the user information (whether the user can send text messages, audio and video, and draw on the whiteboard). The participants can call change user info to update their own user information.

After changing room or user information, the service sends an RTM channel message to update it with all the users in the classroom.

change room info

Method: POST /conf/v1/apps/{appId}/room/{roomId}

You need to pass in appId, roomId, and token when calling the method.

change user info

Method: POST /conf/v1/apps/{appId}/room/{roomId}/user/{userId}

You need to pass in appId, roomId, token, and userId when calling the method.