Set group member roles

Overview

You can call this operation to set roles for group members within the group.

The ZIM SDK supports setting users as group owners, administrators, and regular members by default. In a group, the group owner has all client permissions and can perform all group functions. Administrators have most client permissions, while regular members have the fewest client permissions. The specific client permissions for each role are shown in the table below:

In addition, you can also customize the group role, but the client permissions of this role are the same as those of ordinary members.

After the setting is successful, the group members will receive notifications through the following ZIM callbacks:

Operation prototype

• Request method: GET
• Request URL: https://zim-api.zego.im/?Action=SetGroupMemberRole
• Protocol: HTTPS
• QPS limit: 20 times/second.

Request parameters

The following table describes only the operation-specific request parameters and some common request parameters. For the complete list of common request parameters, see the Public request parameters section of the Accessing Server APIs topic.

Sample response

https://zim-api.zego.im/?Action=SetGroupMemberRole
&<Common request parameters>
&FromUserId=zego
&GroupId=group
&ToUserId=zego2
&Role=3

Response parameters

Sample response

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782"
 }

Return codes

The following table describes only the return codes related to the business logic of the operation. For the complete list of return codes, see Return codes.