Query Chatroom Attributes (KV)

Query the custom attributes (KV) of a specified chatroom.

Request Method

POST: https://data center domain/chatroom/entry/query.json

Rate Limit: 100 requests per second

Signature Rule: All server API requests require signature verification. For details, see API Request Signature.

Body Parameters

The HTTP request body is in application/x-www-form-urlencoded format and supports the following HTTP form parameters:

Parameter	Type	Required	Description
chatroomId	String	Yes	The chatroom ID.
keys	String	No	Batch retrieval of specific keys in the chatroom, up to 100 keys. If not provided, all keys will be retrieved.

Request Example

POST /chatroom/entry/query.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

chatroomId=kvchatroom2&keys=Lnq9MJsPY&keys=Lnq88JsPY

Response

The HTTP response body contains a JSON object with the following structure:

Return Value	Return Type	Description
code	Number	Return code, 200 indicates success.
keys	Array	Array of attributes.
keys[i].key	String	The attribute name.
keys[i].value	String	The content of the attribute.
keys[i].userId	String	The user ID of the last user who set this key.
keys[i].autoDelete	String	Whether to delete this key after the user leaves the chatroom, 0 for no deletion, 1 for deletion.
keys[i].lastSetTime	String	The last time the key was set.

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
	"code":200,
	"keys":
	[{"key":"key1","value":"value1","userId":"2121","autoDelete":"0","lastSetTime":"2121"},
	{"key":"key2","value":"value2","userId":"4343","autoDelete":"1","lastSetTime":"2121"}]
}