QueryRoomAttribute

POST

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

Query all room attributes for the specified room ID.

QPS Limit

20 times/s

Request

Query Parameters

Action stringrequired

Possible values: [QueryRoomAttribute]

API prototype parameter

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

AppId uint32required

💡Public parameter. Application ID, assigned by ZEGOCLOUD. Get it from the ZEGOCLOUD Admin Console.

SignatureNonce stringrequired

💡Public parameter. A 16-character hexadecimal random string (hex encoding of 8-byte random number). Refer to Signature example for how to generate.

Timestamp int64required

💡Public parameter. Current Unix timestamp, in seconds. Refer to Signature example for how to generate, with a maximum error of 10 minutes.

SignatureVersion stringrequired

Possible values: [2.0]

Default value: 2.0

💡Public parameter. Signature version number.

Signature stringrequired

💡Public parameter. Signature, used to verify the legitimacy of the request. Refer to Signing the requests for how to generate an API request signature.

application/json

Body

required

FromUserId stringrequired

Possible values: <= 32 characters

Operator, must be in registered status. This user will not automatically join the room. Only supports numbers, English characters, and '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', ' ', ',', '{'

RoomId stringrequired

Possible values: <= 32 characters

Room ID. Only supports numbers, English characters, and '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', ' ', ',', '{'

Responses

application/json

Schema
Example (from schema)
Example

Schema

Code number

Return status code (0 indicates success).

The following only lists the return codes related to the API business logic. For the complete return codes, please refer to Return codes.

Return code	Description	Solution
660000002	Parameter error.	Please check the parameters.
660300005	Frequency limit.	Please try again later.

Message string

Return status information.

RequestId string

Unique request identifier.

AttributeSeq number

Records the total number of changes to all attributes (create, modify, delete) in the room, used to calibrate attributes and calculate the order of attribute changes. The AttributeSeq value increases by 1 each time an attribute changes.

Note: When multiple attributes change at once, the AttributeSeq value will increase multiple times. For example, if 3 attributes are modified at once, the AttributeSeq value will increase by 3.

Attributes object[]

List of room attributes.

Array[

Key string

Room attribute key value.

Value string

Room attribute value.

Seq int32

Sequence number of the room attribute Key, used to calibrate attributes and calculate the order of attribute changes. When each attribute is successfully created or modified, the Seq value equals the current AttributeSeq.

AutoDelete number

Whether to automatically delete.

]

{
  "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
    }
  ]
}