このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。
ドキュメント概要/
Feedback

Mute Room Members

Feature Description

App administrators can use this API to mute participants in a conference room. While muted, members are unable to speak for the specified duration.

API Call Instructions

Request URL Example

https://console.tim.qq.com/v4/room_engine_http_srv/mute_room_member?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/mute_room_member
Request API
sdkappid
SDKAppID assigned by the Instant Messaging (IM) console when creating the 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
Enter a random 32-bit unsigned integer in the range: 0 - 4294967295
contenttype
Request format, fixed value: json

Maximum Call Frequency

Up to 200 requests per second.

Request Packet Example

Basic Format
 {
     "RoomId": "room-test",
     "MemberList_Account": [123456789, 987654321],
     "MuteTime": 3600
 }

Request Packet Field Description

Field
Type
Attribute
Description
RoomId
String
Required
Room ID.
MemberList_Account
Array
Required
Array of TinyIds for members to be muted; maximum 20 per request.
MuteTime
Integer
Required
Mute duration in seconds; set to 0 to unmute.

Response Packet Example

Basic Format
 {
   "ErrorCode": 0,
   "ErrorInfo": "",
   "ActionStatus": "OK",
   "RequestId": "Id-d4e0a71869c84352ac3a730fda71cdb0-O-Seq-47158"
 }

Response Packet Field Description

Field
Type
Description
ActionStatus
String
Result of request: OK indicates success, FAIL indicates failure.
ErrorCode
Integer
Error code: 0 indicates success, non-zero indicates failure.
ErrorInfo
String
Error message.
RequestId
String
Unique request ID, returned with every request; provide this ID for troubleshooting.

Error Code Description

Unless a network error occurs (such as a 502 error), this API always returns HTTP status code 200. Actual errors and messages are provided in the response packet 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, check the error description and ensure the request is correct.
100004
Room does not exist, or it has been dissolved.