You need to enable JavaScript to run this app.
导航

用户禁言

最近更新时间2023.11.08 09:30:19

首次发布时间2022.03.29 22:10:12

对直播间指定用户进行禁言。

注意事项

请求频率:单用户请求频率限制为 120 次/分钟

请求说明

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

请求参数

以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共请求参数

Query

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

Body

参数类型是否必选示例值描述
ActivityIdLong732412312直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
UserIdLong1245231用户 ID。您可以通过 PollingChatAPI 接口查询 ID。

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": "201806041104200100100232280022D30",
    "Action": "SilenceUserAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1656067132
  },
  "Result": {
    "Status": true
  }
}

错误码

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