更新房间属性

POST

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

根据房间 ID 更新自定义的房间属性。一个房间最多可设置 20 个房间属性，如果需要增加房间属性数量上限，请联系 ZEGO 技术支持。

房间属性更新后，可以通过以下 ZIM SDK 的回调接口，接收房间属性更新的通知。

iOS	Android	macOS	Windows
roomAttributesUpdated	onRoomAttributesUpdated	roomAttributesUpdated	onRoomAttributesUpdated

Web	小程序	Flutter	React Native
roomAttributesUpdated	roomAttributesUpdated	onRoomAttributesUpdated	roomAttributesUpdated

Unity3D	uni-app \| uni-app x	HarmonyOS
OnRoomAttributesUpdated	roomAttributesUpdated	roomAttributesUpdated

说明

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

Request

Query Parameters

Action string必填

可选值: [ModifyRoomAttribute]

接口原型参数

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

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

操作者，需要是已注册状态，该用户不会自动加入房间。仅支持数字，英文字符和 '!'，'#'，'$'，'%'，'&'，'('，')'，'+'，'-'，':'，';'，'<'，'='，'.'，'>'，'?'，'@'，'['，']'，'^'，'_'，' '，'，'，'

RoomId string必填

可选值: <= 32 characters

房间 ID。仅支持数字，英文字符和 '!'，'#'，'$'，'%'，'&'，'('，')'，'+'，'-'，':'，';'，'<'，'='，'.'，'>'，'?'，'@'，'['，']'，'^'，'_'，'，'，'

Attributes object[]required

要更新的房间属性信息。

Array[

Action number必填

可选值: [0, 1]

删除还是设置，0 设置，1 删除。

Key string必填

房间属性 key。

说明

如果传递的 Key 已经存在，则会修改已有的属性信息。

Value string

房间属性 value。

AutoDelete number

可选值: [0, 1]

用户退出时，是否自动删除，0：不自动删除，1：自动删除。如果 FromUserId 不在房间内，则会在其先进入房间后，然后再退出时触发删除操作。

StopOnError integer

可选值: [0, 1]

是否开启快速失败，默认为关闭。

0: 关闭快速失败。执行遇到错误时，记录当前属性并继续执行后续的更新操作，执行结束后返回所有记录到的属性。
1: 开启快速失败。执行遇到错误时，停止更新操作并返回本次更新的属性，已执行成功的更新操作会保留。

]

Responses

application/json

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

Schema

Code integer

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

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

Code / SubCode	说明	解决方案
660000002	参数错误。	请检查参数。
660300005	频率限制。	请稍后再尝试。

Message string

返回状态信息。

RequestId string

请求唯一标识。

AttributeSeq int32

记录房间内所有属性（创建、修改、删除）的总变更次数，用于校准属性和计算属性变更顺序，每有一个属性发生变化时 AttributeSeq 值 + 1。

注意：当一次有多个属性变更时，AttributeSeq 值会增加多次。例如，一次修改了 3 个属性，则 AttributeSeq 值会增加 3。

SuccKeyList object[]

成功的 key 列表（仅成功时返回）

Array[

Key string

修改成功的 key。

Seq int32

房间属性 Key 的序列号，用于校准属性和计算属性变更顺序。每个属性在创建、修改成功时，Seq 值与当前的 AttributeSeq 相等。

]

ErrKeyList object[]

错误的 key 列表（仅失败时返回）。

Array[

SubCode number

具体返回码。完整返回码请参考 Code 说明或者全局返回码。

Key string

出现错误的 key 值。

]

{
  "Code": 0,
  "Message": "success",
  "RequestId": "req-123456789",
  "AttributeSeq": 3,
  "SuccKeyList": [
    {
      "Key": "key1",
      "Seq": 3
    }
  ],
  "ErrKeyList": [
    {
      "SubCode": 1,
      "Key": "attr1"
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "req-123456789",
  "AttributeSeq": 3,
  "SuccKeyList": [
    {
      "Key": "key1",
      "Seq": 3
    }
  ],
  "ErrKeyList": [
    {
      "SubCode": 1,
      "Key": "attr1"
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "req-123456789",
  "AttributeSeq": 3,
  "SuccKeyList": [
    {
      "Key": "key1",
      "Seq": 3
    },
    {
      "Key": "key2",
      "Seq": 2
    }
  ],
  "ErrKeyList": [
    {
      "SubCode": 1,
      "Key": "attr1"
    },
    {
      "SubCode": 2,
      "Key": "attr2"
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "req-123456789",
  "AttributeSeq": 3,
  "SuccKeyList": [
    {
      "Key": "key1",
      "Seq": 3
    },
    {
      "Key": "key2",
      "Seq": 2
    }
  ],
  "ErrKeyList": [
    {
      "SubCode": 1,
      "Key": "attr1"
    },
    {
      "SubCode": 2,
      "Key": "attr2"
    }
  ]
}

CURL

ZEGO 签名生成器

AppId

ServerSecret

RESPONSE清除

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

更新房间属性

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

Request

Query Parameters

Body

Responses​

Responses