Create a Chatroom

Create a single chatroom with configurable destruction type, mute all settings, mute exceptions, and custom attributes. To set the destruction type, ensure you understand the Chatroom Destruction Mechanism.

This API replaces the deprecated interface Create Chatroom (Deprecated).

Request Method

POST: https://Data Center Domain/chatroom/create_new.json

Rate Limit: 100 requests per second

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

Body Parameters

The HTTP request body data format is application/x-www-form-urlencoded, supporting the following HTTP form parameters:

Parameter	Type	Required	Description
chatroomId	String	Yes	The chatroom ID.
destroyType	int	No	Specifies the chatroom destruction type. 0: Default value, indicating destroy when inactive. By default, all chatrooms are set to destroy when inactive, and will be destroyed after 60 minutes of inactivity. This duration can be extended using destroyTime. 1: Fixed time destruction. When set to this type, the chatroom will be automatically destroyed 60 minutes after creation. This duration can be extended using destroyTime. You can also set this after the chatroom is successfully created. For details, see Set Chatroom Destruction Type.
destroyTime	int	No	Sets the chatroom destruction time. When destroyType=0, it indicates the duration of inactivity after which the chatroom will be destroyed. When destroyType=1, it indicates the survival time after creation before the chatroom is destroyed. The unit is minutes, with a minimum of 60 minutes and a maximum of 10080 minutes (7 days). If not set, the default is 60 minutes.
isBan	boolean	No	Whether to mute all members in the chatroom. Default is false. You can also set this after the chatroom is successfully created. For details, see Mute All Chatroom Members.
whiteUserIds	array	No	The list of user IDs exempt from muting. Supports batch setting, with a maximum of 20 users. You can also set this after the chatroom is successfully created. For details, see Add Users to Chatroom Mute Exceptions.
entryOwnerId	String	No	The user ID associated with the chatroom custom attributes. This field is only available after enabling the chatroom custom attributes service and must be used together with the entryInfo field. If the service is not enabled or if this field is set without entryInfo, the API will return a failure. Only one user ID is supported. You can also set this after the chatroom is successfully created. For details, see Chatroom Attribute Overview.
entryInfo	String	No	The chatroom custom attribute key-value pairs in JSON format. This field is only available after enabling the chatroom custom attributes service and must be used together with the entryOwnerId field. Supports batch setting of key-value pairs, with a maximum of 20 pairs per request. The key is the attribute name, supporting uppercase and lowercase English 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. You can also set this after the chatroom is successfully created. For details, see Chatroom Attribute Overview.

Request Example

POST /chatroom/create_new.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
X-Request-ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXX (Max length 36)

chatroomId=gid1&destroyType=1&destroyTime=120

Response

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

Return Value	Return 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}