Set nicknames of group members

Overview

You can call this operation to batch change the nicknames of up to 20 group members at a time. If you need a higher limit, contact ZEGOCLOUD technical support.

After nicknames are changed, group members receive the notification in the following ZIM SDK callbacks.

iOS	Android	macOS	Windows
groupMemberInfoUpdated	onGroupMemberInfoUpdated	groupMemberInfoUpdated	onGroupMemberInfoUpdated
Web	Flutter	Unity3D	React Native
groupMemberInfoUpdated	onGroupMemberInfoUpdated	OnGroupMemberInfoUpdated	groupMemberInfoUpdated

Request method and endpoint

Request method: POST
Request URL: https://zim-api.zego.im/?Action=SetGroupMembersNickname
Protocol: HTTPS
QPS limit: 1 call per second, applicable to group chats only. If you need a higher limit, contact ZEGOCLOUD technical support.

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 Common request parameters section of the Accessing Server APIs topic.

Parameter	Type	Required	Description
FromUserId	String	Yes	The ID of the operator. The operator must be registered.
GroupId	String	Yes	The group chat ID.
UserIds	Array of Object	Yes	The list of IDs of users whose nicknames are to be changed.
└UserId	String	Yes	The user ID.
└Nickname	String	Yes	The nickname of the user in the group.

Note

The `FromUserId`, `GroupId`, `UserIds`, and `Nickname` parameters can contain only digits, letters, and the following characters: '!', '#', '$', '%', '&', '(', ')', '+', '', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', ', ', '|', '~'.

Sample request

Request URL:

https://zim-api.zego.im/?Action=SetGroupMembersNickname
&<Common request parameters>

https://zim-api.zego.im/?Action=SetGroupMembersNickname
&<Common request parameters>

Request body

{
    "FromUserId": "zego_user",
    "GroupId": "groupA",
    "UserIds": [
        {
            "UserId": "usera",
            "Nickname": "nicknamea"
        },
        {
            "UserId": "userb",
            "Nickname": "nicknameb"
        }
    ]
}

{
    "FromUserId": "zego_user",
    "GroupId": "groupA",
    "UserIds": [
        {
            "UserId": "usera",
            "Nickname": "nicknamea"
        },
        {
            "UserId": "userb",
            "Nickname": "nicknameb"
        }
    ]
}

Response parameters

Parameter	Type	Description
Code	Number	The return code.
Message	String	The description of the operation result.
RequestId	String	The request ID.
ErrorUsers	Array of Object	The list of failed results. If `Code` is `0`: If `ErrorUsers` is empty, the nicknames of all specified users are successfully changed. If `ErrorUsers` is not empty, the nicknames of some specified users fail to be changed. In this case, see `SubCode`. If `Code` is not `0`: If `ErrorUsers` is empty, one or more parameters are invalid, the QPS limit is exceeded, or a system error occurs. If `ErrorUsers` is not empty, the nicknames of all specified users fail to be changed.
└UserId	String	The ID of the user whose nickname fails to be changed.
└SubCode	Number	The code returned when the request fails.

Sample response

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

{
    "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.

Return Code	Description	Solution
660000002	Invalid parameter.	Check the input parameter.
660000011	Too many users are included in the list.	Check the number of users.
660300006	The QPS limit is exceeded.	Please try again later, or check the QPS limit.
660500002	The operator is not registered.	Register the operator.
660600001	The group chat does not exist.	Check whether the value of the `GroupID` parameter is valid.