GetSilenceUserListAPI - 获取禁言用户列表--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

GetSilenceUserListAPI - 获取禁言用户列表

最近更新时间：2025.03.24 17:08:25首次发布时间：2022.03.29 22:10:12

获取禁言用户列表。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetSilenceUserListAPI`	接口名称。当前 API 的名称为 `GetSilenceUserListAPI`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。
ActivityId	Long	是	`732412312`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。

返回参数

参数	类型	示例值	描述
UserList	Array of UserList	`-`	禁言用户列表

UserList

参数	类型	示例值	描述
UserId	Long	`1670265947464959`	用户 ID
Nickname	String	`用户A`	用户昵称

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetSilenceUserListAPI&Version=2020-06-01&ActivityId=732412312

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetSilenceUserListAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "UserList": [
            {
                "UserId": 1670265947464959,
                "Nickname": "用户A"
            }
        ]
    }
}

错误码

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