调用 TopChatAPI 接口，配置是否将直播间指定评论置顶。您可以最多对 3 条评论置顶。

注意事项 #

• 请求频率：单用户请求频率限制为 120 次/分钟。
• 前提条件：确保您拥有火山引擎主账号或具备直播间的直播控制 > 可编辑权限的子账号。有关如何添加子账号，详见子账号管理。
• 若直播间开启了直播分组能力，建议您在每个分组中单独管理置顶消息。请注意，对全部分组的评论进行操作会影响所有分组：
  • 在全部分组中置顶的评论，会同步置顶到所有分组。
  • 如果在任一分组中取消了这条全局置顶，那么所有分组都将同步取消该置顶。

请求说明 #

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

调试 #

请求参数 #

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

Query #

Body #

返回参数 #

请求示例 #

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

返回示例 #

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

错误码 #

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