Batch Set Chatroom Attributes (KV)
Batch set custom attribute KV pairs in a specified chatroom, with a maximum of 20 KV pairs per request. If the attribute already exists, this API will forcefully overwrite the existing KV pair's owner ID and value.
Once the chatroom is destroyed, all custom attributes within the chatroom will also be destroyed.
Enable the Service
Before using the Chatroom Attributes (KV) feature, ensure that the service has been enabled for the current App Key. For more details, refer to Chatroom Attributes Overview.
If the service is not enabled, the Server API will return error code 1009. Note that if continuous requests exceed the API rate limit when the service is not enabled, the Server API will return an HTTP 429 Too Many Requests error (error code 1008).
Request Method
POST: https://Data Center Domain/chatroom/entry/batch/set.json
Rate Limit: Up to 100 KV pairs per second, shared with /chatroom/entry/set.json. For example, setting 1 attribute allows 100 calls per second, while setting 20 attributes allows 5 calls per second.
Signature Rule: All server API requests must be validated according to the API Request Signature rules.
Request Parameters
The HTTP request body should be in application/x-www-form-urlencoded format and supports the following HTTP form parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| chatroomId | String | Yes | Chatroom ID |
| autoDelete | Int | No | Whether to delete the Key and its corresponding Value when the user (entryOwnerId) exits the chatroom. Set to 1 to delete, 0 to retain. Default is 0. |
| entryOwnerId | String | Yes | The owner ID of the chatroom's custom attribute |
| entryInfo | String | Yes | Chatroom custom attribute KV pairs in JSON format, with a maximum of 20 KV pairs per request. The Key is the attribute name, supporting uppercase and lowercase letters, numbers, and special characters + = - _. Case-sensitive. Maximum length is 128 characters. The Value is the attribute value, with a maximum length of 4096 characters. |
Request Example
POST /chatroom/entry/batch/set.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded
X-Request-ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXX(最大长度36)
chatroomId=gid1&autoDelete=true&entryOwnerId=test&entryInfo={"key1":"value1","key2":"value2"}
Response
The HTTP response body contains a JSON object with the following structure:
| Return Value | Type | Description |
|---|---|---|
| code | Int | Return code. 200 indicates success |
Response Example
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Request-ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXX
{"code":200}