logo
即时通讯
机器人
ZIM Audio
当前页

设置群成员昵称

POST

https://zim-api.zego.im/

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

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

iOSAndroidmacOSWindows
groupMemberInfoUpdatedonGroupMemberInfoUpdatedgroupMemberInfoUpdatedonGroupMemberInfoUpdated
Web小程序FlutterReact Native
groupMemberInfoUpdatedgroupMemberInfoUpdatedonGroupMemberInfoUpdatedgroupMemberInfoUpdated
Unity3Duni-app | uni-app xHarmonyOS
OnGroupMemberInfoUpdatedgroupMemberInfoUpdatedgroupMemberInfoUpdated
说明
参数 FromUserIdUserId 对应的用户已在客户端调用 login 方法登录 ZIM 服务,或已调用 服务端 API 完成注册。
说明

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

说明
1 次/秒,群级别限制。如需调整,请联系 ZEGO 技术支持。

Request

Query Parameters

    Action string必填

    可选值: [SetGroupMembersNickname]

    接口原型参数

    https://zim-api.zego.im/?Action=SetGroupMembersNickname

    AppId uint32必填

    💡公共参数。应用 Id,由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台 获取。

    SignatureNonce string必填

    💡公共参数。16 位 16 进制随机字符串(8 字节随机数的 hex 编码)。生成算法可参考 签名示例

    Timestamp int64必填

    💡公共参数。当前 Unix 时间戳,单位为秒。生成算法可参考 签名示例,最多允许 10 分钟的误差。

    SignatureVersion string必填

    可选值: [2.0]

    默认值: 2.0

    💡公共参数。签名版本号。

    Signature string必填

    💡公共参数。签名,用于验证请求的合法性。请参考签名机制生成。

Body

required
    FromUserId string必填

    可选值: <= 32 characters

    操作者用户 ID。用户需已注册 ZIM 服务。

    GroupId string必填

    可选值: <= 32 characters

    群组 ID。

    UserIds object[]required
    需要被设置昵称的用户列表。
  • Array[
  • UserId string必填

    可选值: <= 32 characters

    用户 ID。

    Nickname string必填

    可选值: <= 256 characters

    用户在群组的昵称。

  • ]

Responses

OK
Schema
    Code number

    返回码。

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

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

    操作结果描述。

    RequestId string

    请求 ID。

    ErrorUsers object[]
    昵称设置失败用户信息。
    • Code 为 0:
    • ErrorUsers 为空,全部指定用户昵称设置成功。
    • ErrorUsers 不为空,表示部分指定用户昵称设置失败,请参考 SubCode 处理。
    • Code 不为 0:
    • ErrorUsers 为空,表示参数错误、接口频率限制、系统错误。
    • ErrorUsers 不为空,表示全部指定用户昵称设置失败。
  • Array[
  • UserId string

    失败用户 ID。

    SubCode number

    昵称设置失败的具体返回码。完整返回码请参考 Code 说明或者 全局返回码

  • ]

Previous

添加群成员

Next

设置群成员角色

当前页

返回到顶部