Query Chatroom Information
Retrieve basic information about a chatroom, including the chatroom ID, creation time, member count, auto-destruction type, and whether all members are muted.
This interface replaces the deprecated interface Get Chatroom Basic Information (Deprecated).
Request Method
POST: https://Data Center Domain/chatroom/get.json
Rate Limit: 100 requests per second
Signature Rule: All server-side API requests must be validated according to the signature rules. For details, see API Request Signature.
Body Parameters
The HTTP request body data format is application/x-www-form-urlencoded, and it supports the following HTTP form parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| chatroomId | String | Yes | Chatroom ID |
Request Example
POST /chatroom/get.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
Response
The HTTP response body contains a JSON object with the following structure:
| Return Value | Return Type | Description |
|---|---|---|
| code | Int | Return code. 200: Success. 23410: Chatroom does not exist |
| chatroomId | String | Chatroom ID |
| createTime | long | Chatroom creation time |
| memberCount | int | Current member count in the chatroom |
| destroyType | int | Specifies the chatroom's destruction method. 0: Default value, indicates destroy when inactive. By default, all chatrooms are set to be destroyed when inactive, and will be destroyed after 60 minutes of inactivity. This time can be extended using destroyTime. 1: Fixed time destruction, when set to this type, the chatroom will be automatically destroyed 60 minutes after creation, and the survival time can be extended using destroyTime. |
| destroyTime | int | Sets the chatroom destruction wait time. When destroyType=0, it indicates the chatroom should be automatically destroyed after being inactive for this duration. When destroyType=1, it indicates the chatroom should be automatically destroyed after surviving for this duration since creation. The unit is minutes, with a minimum of 60 minutes and a maximum of 10080 minutes (7 days). |
| ban | boolean | Whether the chatroom is in a state of muting all members, default is false. |
Response Example
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Request-ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXX
{"code":200,"chatroomId":"chatroom001","createTime":1694777649942,"memberCount":0,"destroyType":1,"destroyTime":120,"ban":true}