tencent cloud

Mobile Live Video Broadcasting

문서Mobile Live Video BroadcastingServer APIs (TUILiveKit)REST APIUser-Related MattersMuting Members

Muting Members

PDF
포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-04-09 11:56:15

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/mute_member?
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 RESTful API.
Parameters
Description
xxxxxx
The reserved domain for the country/region where the SDKAppID is located:
Others in China: console.tim.qq.com
Singapore: adminapisgp.im.qcloud.com
Silicon Valley: adminapiusa.im.qcloud.com
Jakarta: adminapiidn.im.qcloud.com
v4/live_engine_http_srv/mute_member
Request API.
sdkappid
SDKAppID assigned by the Chat console when an app is created.
identifier
Must be an App administrator account. For more details, please refer to App Admin.
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", 
     "MemberList_Account": [
            "user1",
            "user2"
            ],
    "MuteTime": 3600  // In seconds, 0 means unmute
}

Request packet fields

Field
Type
Attribute
Description
RoomId
String
Required
Room ID.
MemberList_Account
Array
Required
List of muted members.
MuteTime
integer
Required
Mute duration, 0 means unmute.

Sample response packets

Basic Form
{
  "ActionStatus": "OK",
  "ErrorInfo": "",
  "ErrorCode": 0,
  "RequestId": "Id-8c9858f01e954611ae2d4c1b1ed7d583-O-Seq-52720",
}

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.

Error Code Description

Unless a network error occurs (e.g., 502 Error), the HTTP return code for this interface will always be 200. The actual error code and error information are indicated in the response payload by ErrorCode and ErrorInfo. Common Error Codes (60000 to 79999) can be found in the Error Code document. The private error codes for this API are as follows:
Error Code
Description
100001
Internal server error, please 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.

이전 주제: Resume Room Mixed Stream Task다음 주제: Get Muted Member List

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백