查询房间属性

POST

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

查询指定房间 ID 的所有房间属性。

说明

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

Request

Query Parameters

Action string必填

可选值: [QueryRoomAttribute]

接口原型参数

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

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

Responses

application/json

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

Schema

Code number

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

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

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

Message string

返回状态信息。

RequestId string

请求唯一标识。

AttributeSeq number

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

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

Attributes object[]

房间属性列表。

Array[

Key string

房间属性 key 值。

Value string

房间属性 value 值。

Seq int32

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

AutoDelete number

是否自动删除。

]

{
  "Code": 0,
  "Message": "success",
  "RequestId": "req-123456789",
  "AttributeSeq": 10,
  "Attributes": [
    {
      "Key": "1",
      "Value": "attr1",
      "Seq": 1,
      "AutoDelete": 0
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "req-123456789",
  "AttributeSeq": 10,
  "Attributes": [
    {
      "Key": "1",
      "Value": "attr1",
      "Seq": 1,
      "AutoDelete": 0
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "req-123456789",
  "AttributeSeq": 10,
  "Attributes": [
    {
      "Key": "1",
      "Value": "attr1",
      "Seq": 9,
      "AutoDelete": 0
    },
    {
      "Key": "2",
      "Value": "attr1",
      "Seq": 10,
      "AutoDelete": 0
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "req-123456789",
  "AttributeSeq": 10,
  "Attributes": [
    {
      "Key": "1",
      "Value": "attr1",
      "Seq": 9,
      "AutoDelete": 0
    },
    {
      "Key": "2",
      "Value": "attr1",
      "Seq": 10,
      "AutoDelete": 0
    }
  ]
}

CURL

ZEGO 签名生成器

AppId

ServerSecret

RESPONSE清除

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