Query the List of Muted Users in a Chatroom
Retrieve the list of users who are muted in a specified chatroom.
Request Method
POST: https://data center domain/chatroom/user/gag/list.json
Rate Limit: 100 requests per second
Signature Rule: All server API requests must be validated according to the signature rules. For details, see API Request Signature.
Body Parameters
The HTTP request body is formatted as application/x-www-form-urlencoded and supports the following HTTP form parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| chatroomId | String | Yes | The chatroom ID. |
Request Example
POST /chatroom/user/gag/list.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=16
Response
The HTTP response body contains a JSON object with the following structure:
| Return Value | Return Type | Description |
|---|---|---|
| code | Number | The return code, where 200 indicates success. |
| users | String | An array of muted users. |
| time | String | The unmute time. Accurate to the second, formatted as YYYY-MM-DD HH:MM:SS, e.g., 2022-09-25 16:12:38. Note: The value of time depends on the data center associated with your app. If your app uses the China (Beijing) Data Center, time is in Beijing time. If your app uses the global data center, time is in UTC time. |
| userId | String | The ID of the muted user. |
Response Example
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"code":200,
"users":[{
"time":"2015-09-25 16:12:38",
"userId":"2582"
}]
}