Delete Chatroom Custom Attributes (KV)

Delete a custom attribute KV pair in the specified chatroom. This API requires the user ID to which the KV pair belongs.

Request Method

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

Rate Limit: Up to 100 KV pairs per second, shared with the batch deletion API /chatroom/entry/batch/remove.json. If only the single attribute deletion API is used, it can be called 100 times per second.

Signature Rule: All server API requests require signature validation. For details, refer to API Request Signature.

Request 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.
userId	String	Yes	The user ID of the operator. Non-chatroom users can set this via the Server API.
key	String	Yes	The chatroom attribute name. The key supports a combination of uppercase and lowercase letters, numbers, and special characters + = - _. It is case-sensitive with a maximum length of 128 characters.
objectName	String	No	The message type for chatroom attribute change notifications, usually the built-in message type RC:chrmKVNotiMsg, but can also be a custom message type. If this field is provided, a message will be sent when the chatroom attribute changes. Note: Starting from client SDK versions 4.0.2 (Android / iOS) and 3.0.6 (Web), the SDK synchronizes chatroom attribute changes from the server by default and no longer relies on this notification message. Clients can set a chatroom attribute change listener to get real-time attribute changes.
content	String	No	The message content for chatroom attribute change notifications. JSON structure. When objectName is RC:chrmKVNotiMsg, the content must include the type, key, and value attributes. For detailed information on the RC:chrmKVNotiMsg message structure, refer to Chatroom Attribute Notification Message.

Request Example

POST /chatroom/entry/remove.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&userId=jrT1igbKr

Response

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

Return Value	Type	Description
code	Number	Return code, 200 for success.

Response Example

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

{"code":200}