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

文档中心

立即注册

导航

企业直播

获取禁言用户列表

最近更新时间：2023.11.08 09:30:19首次发布时间：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": "202201201826170101501312091D1C09D2",
    "Action": "GetSilenceUserListAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1656067132
  },
  "Result": {
    "UserList": [
      {
        "Nickname": "用户A",
        "UserId": 1670265947464959
      }
    ]
  }
}

错误码

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