文档中心
即时通讯
服务端 API
群组相关
设置群成员昵称

设置群成员昵称

更新时间：2024-03-18 15:33

描述

通过该接口批量修改群内成员在该群中的昵称。默认单次最多可修改 20 名用户的昵称，如需调整，请联系 ZEGO 技术支持。

昵称设置成功后，群内成员通过以下 ZIM SDK 的回调接口，收到相关通知：

iOS	Android	macOS	Windows	Web
groupMemberInfoUpdated	onGroupMemberInfoUpdated	groupMemberInfoUpdated	onGroupMemberInfoUpdated	groupMemberInfoUpdated
小程序	Flutter	Unity3D	uni-app	React Native
groupMemberInfoUpdated	onGroupMemberInfoUpdated	OnGroupMemberInfoUpdated	groupMemberInfoUpdated	groupMemberInfoUpdated

接口原型

请求方法：POST
请求地址： https://zim-api.zego.im/?Action=SetGroupMembersNickname
传输协议：HTTPS
调用频率限制：1 次/秒，群级别限制。如需调整，请联系 ZEGO 技术支持。

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考调用方式 - 公共请求参数。

参数	类型	是否必选	描述
FromUserId	String	是	操作者用户 ID。用户需已注册 ZIM 服务。
GroupId	String	是	群组 ID。
UserIds	Array of Object	是	需要被设置昵称的用户列表。
UserId	String	是	用户 ID。
Nickname	String	是	用户在群组的昵称。

FromUserId、GroupId、UserIds 和 Nickname 仅支持数字，英文字符和 '!'，'#'，'$'，'%'，'&'，'('，')'，'+'，''，':'，';'，'<'，'='，'.'，'>'，'?'，'@'，'['，']'，'^'，'_'，'{'，'}'，'|'，'~'。

请求示例

请求地址 URL：

https://zim-api.zego.im/?Action=SetGroupMembersNickname
&<公共请求参数>

请求消息体

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

响应参数

参数	类型	描述
Code	Number	返回码。
Message	String	操作结果描述。
RequestId	String	请求 ID。
ErrorUsers	Array of Object	昵称设置失败用户信息。 Code 为 0： ErrorUsers 为空，全部指定用户群昵称设置成功。 ErrorUsers 不为空，表示部分指定用户群昵称设置失败，请参考 SubCode 处理。 Code 不为 0： ErrorUsers 为空，表示参数错误、接口频率限制、系统错误。 ErrorUsers 不为空，表示全部指定用户群昵称设置失败。
UserId	String	失败用户 ID。
SubCode	Number	昵称设置失败的具体返回码。

响应示例

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

返回码

以下仅列出了接口业务逻辑相关的返回码，完整返回码请参考全局返回码。

返回码	说明	处理建议
660000002	输入参数错误。	请检查输入参数。
660000011	用户个数超过限制。	请检查输入的用户列表。
660300006	频率限制	请稍后再试，或了解相关频率限制。
660500002	操作者用户未注册。	请让操作者先注册 ZIM 服务。
660600001	群组不存在。	请确认输入的 GroupID 是否正确。

云通讯产品

AIGC

扩展服务

低代码互动产品

标准 AI 产品

AIGC

社交娱乐

电商直播

在线教育

医疗健康

互动游戏

协同办公

物联网