修改群组资料

POST

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

通过该接口可以实现修改群组资料信息，包括群组头像、群组名称、群组公告等。

修改群组资料成功后，群成员可通过以下 ZIM SDK 的回调接口接收群组资料修改通知：

iOS	Android	macOS	Windows
groupNameUpdated	onGroupNameUpdated	groupNameUpdated	onGroupNameUpdated

Web	小程序	Flutter	React Native
groupNameUpdated	groupNameUpdated	onGroupNameUpdated	groupNameUpdated

Unity3D	uni-app \| uni-app x	HarmonyOS
OnGroupNameUpdated	groupNameUpdated	groupNameUpdated

说明

由于参数 GroupAvatar、GroupName 和 GroupNotice 支持设置为空字符。因此，如果无需修改上述某个字段，JSON 字符串中不能包含该字段名称（不能传空），否则会被认为是空字符串，原有内容会被删除。

说明

调用频率限制：20 次/秒。

Request

Query Parameters

Action string必填

可选值: [UpdateGroupData]

接口原型参数

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

AppId uint32必填

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

SignatureNonce string必填

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

Timestamp int64必填

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

SignatureVersion string必填

可选值: [2.0]

默认值: 2.0

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

Signature string必填

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

application/json

Body

required

FromUserId string必填

可选值: <= 32 characters

修改群资料的操作者 ID（已注册）。

GroupId string必填

可选值: <= 32 characters

待修改资料的群组 ID。

GroupAvatar string

可选值: <= 500 characters

群组头像地址，长度限制 500 字符。

注意

群组头像、群组名称和群组公告至少有一个。

GroupName string

可选值: <= 50 characters

群组名称，长度限制 50 字符。

GroupNotice string

可选值: <= 300 characters

群组公告，长度限制 300 字符。

Responses

application/json

数据结构
按数据结构生成的示例

Schema

Code number

返回码。

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

返回码	描述	处理建议
660000002	参数错误。	请参考 Request 输入正确参数。
660300006	调用接口的频率超出了群/房间限制。	请稍后再试。
660500002	FromUserId 未注册。	请先注册 FromUserId。
660600001	群组不存在。	请确认 GroupId 是否正确。
660600009	获取群组相关信息失败。	请先确认 GroupID 是否正确。如正确，请联系技术支持。
660600028	修改群组资料失败。	请联系 ZEGO 技术支持。

Message string

操作结果描述。

RequestId string

请求 ID。

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

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

CURL

ZEGO 签名生成器

AppId

ServerSecret

RESPONSE清除

点击上方 “发送” 按钮，在此处查看响应。