Docs Overview/
Feedback

Get Muted Members

Feature Description

App administrators can use this API to retrieve the list of muted participants in a conference room.

API Call Instructions

Request URL Example

https://console.tim.qq.com/v4/room_engine_http_srv/get_muted_member_list?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request Parameter Description

The table below lists only the parameters relevant to this API call and their descriptions. For more details on other parameters, please refer to the REST API Overview.
Parameter
Description
v4/room_engine_http_srv/get_muted_member_list
API endpoint
sdkappid
SDKAppID assigned in the Instant Messaging (IM) Console when creating your application
identifier
Must be an App administrator account. For more details, see App Administrator
usersig
Signature generated by the App administrator account. For details, see Generate UserSig
random
A random 32-bit unsigned integer, value range 0 - 4294967295
contenttype
Request format, fixed value json

Maximum Call Frequency

Up to 200 requests per second.

Request Payload Example

Payload Format
 {
     "RoomId": "room-test"
 }

Request Payload Field Description

Field
Type
Required
Description
RoomId
String
Required
Conference room ID.

Response Payload Example

Payload Format
 {
   "ErrorCode": 0,
   "ErrorInfo": "",
   "ActionStatus": "OK",
   "RequestId": "Id-99d6df2213b54216a02bc18024a5c218-O-Seq-57681",
   "Response": {
       "MutedAccountList": [
           {
               "Member_Account": 123456789,
               "MutedUntil": 1703559417
           }
       ]
   }
 }

Response Payload Field Description

Field
Type
Description
ActionStatus
String
Request processing result: OK indicates success, FAIL indicates failure.
ErrorCode
Integer
Error code: 0 indicates success, non-zero indicates an error.
ErrorInfo
String
Error message.
RequestId
String
Unique request ID. Please provide this RequestId when troubleshooting issues.
MutedAccountList
Array
List of muted participant details.
MutedAccountList.Member_Account
Integer
TinyId of the muted participant.
MutedAccountList.MutedUntil
Integer
Mute expiration timestamp (Unix time, in seconds).

Error Code Description

Unless a network error occurs (such as a 502 error), the HTTP status code for this API is always 200. Actual error codes and error messages are provided in the response payload via ErrorCode and ErrorInfo.
Private error codes for this API are as follows:
Error Code
Description
100001
Internal server error. Please retry.
100002
Invalid request parameters. Please check the request according to the error description.
100004
Conference room does not exist, or was previously dismissed.