Get Muted Member List
Feature Description
App admins can use this API to mute and unmute members.
API Calling Description
Request URL sample:
https://xxxxxx/v4/live_engine_http_srv/get_muted_member_list?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Request parameters
The table below only lists the parameters modified when this interface is called. For more details on other parameters, please refer to REST API.
Parameters | Description |
xxxxxx | Domain name corresponding to the country/region where your SDKAppID is located: China: console.tim.qq.com Singapore: adminapisgp.im.qcloud.com United States: adminapiusa.im.qcloud.com |
v4/live_engine_http_srv/get_muted_member_list | Request API |
sdkappid | SDKAppID assigned by the Chat console when an app is created |
identifier | |
usersig | Signature generated by the App administrator account, for specific steps please refer to Generate UserSig |
random | A random 32-bit unsigned integer ranging from 0 to 4294967295 |
contenttype | Request format fixed value: `json` |
Maximum calling frequency
200 queries/sec.
Sample request packets
Basic Form
{"RoomId": "test"}
Request packet fields
Field | Type | Attribute | Description |
RoomId | String | Required | Room ID |
Sample response packets
Basic Form
{"ErrorCode": 0,"ErrorInfo": "","ActionStatus": "OK","RequestId": "Id-9a9fe01d96164827b49dacb6b3cdadba-O-Seq-126318","Response": {"MutedAccountList": [{"Member_Account": "user1","MutedUntil": 1719293107},{"Member_Account": "brennanli","MutedUntil": 1719293107}]}}
Response Packet Field Description
Field | Type | Description |
ActionStatus | String | The result of the request process: OK indicates success; FAIL indicates failure |
ErrorCode | Integer | Error code. 0: success; other values: failure |
ErrorInfo | String | Error message |
RequestId | String | Unique Request ID is returned with each request and required to provide this RequestId when locating issues |
MutedAccountList | Array | List of mute users |
Member_Account | String | Mute user Id |
MutedUntil | Integer | Mute Expiration Time |
Error codes
Unless a network error occurs (such as a 502 error), the HTTP return code for this interface is always 200. The actual error code and error message are in the response body ErrorCode and ErrorInfo representation.
The private error codes for this API are as follows
Error Code | Description |
100001 | System error, retry |
100002 | Invalid parameter, please check the request for correctness based on the error description |
100004 | The room does not exist, possibly because it was never created or has already been dissolved |