修改群组属性

POST

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

通过该接口可以设置某个群的群属性。

说明

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

Request

Query Parameters

Action string必填

可选值: [ModifyGroupAttribute]

接口原型参数

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

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

Action number必填

本次请求的修改行为。

0（默认）：更新群组属性。
1：删除群组属性。

FromUserId string必填

操作者 id ，需要是已注册状态。

GroupId string必填

群组 id。

Attributes object[]required

更新的群组属性信息。

Array[

Key string必填

群组属性key。修改群组属性时，如果群组属性 key 已经存在，则更新群组属性；如果群组属性 key 不存在，则创建群组属性。

Value string

群组属性value。Action 为 0 时，需要此参数；Action 为 1 时，不需要此参数。

]

Responses

application/json

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

Schema

Code number

返回状态码（0表示成功）。

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

返回码	说明	处理建议
660000002	参数错误。	请检查并输入正确的参数。
660300006	调用接口的频率超出了群/房间限制。	请稍后再试。
660500002	FromUserId 未注册。	请先注册 FromUserId。
660600001	群组不存在。	请确认输入的 GroupId 是否正确，或创建群组。
660600009	获取群组相关信息失败。	请先确认 GroupID 是否正确。如果 GroupID 正确，请联系 ZEGO 技术支持。
660600028	修改群组资料失败。	请联系 ZEGO 技术支持。
660300019	已设置的群组属性的value总长度超出限制	请联系 ZEGO 技术支持。

Message string

返回状态信息。

RequestId string

请求唯一标识。

FailKeys object[]

更新或者删除失败的 key 列表。

Array[

Reason string

失败原因。

Key string

更新或者删除失败的 key 值。

]

Attributes object

更新或者删除成功的群组属性列表。

Attributes object[]

Array[

Key string

群组属性 key。

Value string

群组属性 value。

]

{
  "Code": 0,
  "Message": "success",
  "RequestId": "req-123456789",
  "FailKeys": [
    {
      "Reason": "key db-non-existent",
      "Key": "attr1"
    }
  ],
  "Attributes": {
    "Attributes": [
      {
        "Key": "attribute1",
        "Value": "value1"
      }
    ]
  }
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "req-123456789",
  "FailKeys": [
    {
      "Reason": "key db-non-existent",
      "Key": "attr1"
    }
  ],
  "Attributes": {
    "Attributes": [
      {
        "Key": "attribute1",
        "Value": "value1"
      }
    ]
  }
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "req-123456789",
  "FailKeys": [
    {
      "Reason": "key db-non-existent",
      "Key": "attr1"
    },
    {
      "Reason": "key db-non-existent",
      "Key": "attr2"
    }
  ],
  "Attributes": {
    "Attributes": [
      {
        "Key": "attribute1",
        "Value": "value1"
      },
      {
        "Key": "attribute2",
        "Value": "value2"
      }
    ]
  }
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "req-123456789",
  "FailKeys": [
    {
      "Reason": "key db-non-existent",
      "Key": "attr1"
    },
    {
      "Reason": "key db-non-existent",
      "Key": "attr2"
    }
  ],
  "Attributes": {
    "Attributes": [
      {
        "Key": "attribute1",
        "Value": "value1"
      },
      {
        "Key": "attribute2",
        "Value": "value2"
      }
    ]
  }
}

修改群组属性

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

Request

Query Parameters

Body

Responses​

Responses