SilenceUserAPI - 用户禁言--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

SilenceUserAPI - 用户禁言

最近更新时间：2025.07.03 17:27:09首次发布时间：2022.03.29 22:10:12

调用 SilenceUserAPI 接口，对直播间指定用户进行禁言。

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。
前提条件：确保您拥有火山引擎主账号或具备直播间的直播控制 > 可编辑权限的子账号。有关如何添加子账号，详见子账号管理。

请求说明

请求方式：POST
请求地址：https://livesaas.volcengineapi.com/?Action=SilenceUserAPI&Version=2020-06-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`SilenceUserAPI`	接口名称。当前 API 的名称为 `SilenceUserAPI`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。

Body

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`732412312`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
UserId	Long	是	`1245231`	用户 ID。您可以通过 PollingChatAPI 接口查询 ID。
Status	Boolean	是	`true`	禁言操作。支持以下两种取值。 true：禁言； false：取消禁言。

ActivityId

Long

是

732412312

直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

说明

使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。

UserId Long 是 1245231 用户 ID。您可以通过 PollingChatAPI 接口查询 ID。

Status

Boolean

是

true

禁言操作。支持以下两种取值。

true：禁言；
false：取消禁言。

返回参数

参数类型示例值描述

参数	类型	示例值	描述
status	Boolean	`true`	是否成功禁言。取值如下： `true`：成功 `false`：失败

status

Boolean

true

是否成功禁言。取值如下：

true：成功
false：失败

请求示例

POST https://livesaas.volcengineapi.com/?Action=SilenceUserAPI&Version=2020-06-01
{
    "ActivityId": 732412312,
    "UserId": 1245231,
    "Status": true
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "SilenceUserAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "status": true
    }
}

错误码

访问公共错误码和错误码获取详细信息。