You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航
企业直播
  • 文档首页
    • /
  • 企业直播

评论置顶

最近更新时间：2022.09.29 17:29:31

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

我的收藏

配置是否将直播间指定评论置顶。

请求说明

  • 接口名称：TopChatAPI
  • 请求方式：POST
  • 接口地址：http://livesaas.volcengineapi.com/?Action=TopChatAPI&Version=2020-06-01
  • 请求频率：单用户请求频率限制为 120 次/分钟。

请求参数

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

Query

参数类型是否必选描述
ActionString是接口名称
VersionString是接口版本。直播当前 API 的版本为 2020-06-01

Body

参数类型是否必选描述
ActivityIdInt64是直播间 ID
ChatIdInt64是评论 ID

TopStatus

Int

是

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

  • 1：置顶；
  • 2：取消置顶。

返回参数

参数类型描述

Status

Bool

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

  • true：操作成功；
  • false：操作失败。

示例

请求示例

POST http://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
    }
}

异常返回示例

{
    "ResponseMetadata":{
        "RequestId":"201806041104200100100232280022D30",
        "Action":"TopChatAPI",
        "Version":"2020-06-01",
        "Service":"livesaas",
        "Region":"cn-north-1",
        "SystemTime":1656067132,
        "Error":{
            "Code":"200000",
            "Message":"参数异常" 
        }
    }
}

错误码

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