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=TopChatAPI&Version=2020-06-01

请求参数

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

Query

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

Body

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

TopStatus

Integer

2

置顶操作。支持以下两种取值。

  • 1:置顶;
  • 2:取消置顶。

返回参数

参数类型示例值描述

Status

Boolean

true

置顶操作状态。支持以下两种取值。

  • true:操作成功;
  • false:操作失败。

示例

请求示例

POST https://livesaas.volcengineapi.com/?Action=TopChatAPI&Version=2020-06-01
{
  "ActivityId": 732412312,
  "ChatId": 1245231,
  "TopStatus": 2
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "TopChatAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1656067132
  },
  "Result": {
    "Status": true
  }
}

错误码

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