You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /企业直播/API 参考/评论设置/Version：2020-06-01/获取直播间置顶评论
获取直播间置顶评论
最近更新时间：2024.06.19 11:33:29首次发布时间：2022.03.29 22:10:12
我的收藏

您可通过此接口获取指定直播间的置顶评论。

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是GetTopChatAPI接口名称。当前 API 的名称为 GetTopChatAPI。
VersionString是2020-06-01接口版本。当前 API 的版本为 2020-06-01。
ActivityIdLong是1732412312直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
AudienceGroupIdLong否1798530530571分组 ID。默认取值为 -2 ，表示全部直播分组。您可以通过 GetAudienceGroupConfig 接口查询 ID。

返回参数

参数类型示例值描述
DataArray of Data-置顶评论信息列表。

Data

参数类型示例值描述
ChatIdInteger31823336评论 ID。
CreateTimeLong1591860377评论的发送时间。Unix 时间戳，单位为秒。
TextContentString我们评论内容。
UserArray of User-发送评论的观众信息。

IsDelete

Boolean

false

评论是否已被删除。支持以下取值：

  • true：已被删除（已废弃）
  • false：未被删除
LikeCountInteger3评论点赞数。

IsPresenter

Boolean

false

是否是主持人发送的评论。支持以下取值：

  • true：主持人发送评论
  • false：普通评论

reviewStatus

Integer

0

评论审核状态。支持以下取值：

  • 0：不需要审核
  • 1：待审核（已废弃）
  • 2：审核通过

IsTipOff

Integer

0

评论举报状态。支持以下取值：

  • 0：未被举报
  • 1：已被举报
AudienceGroupIdLong1798530530571评论所属直播分组的 ID。

User

参数类型示例值描述
UserIdLong1669024344048647用户 ID。
NicknameString111用户昵称。

请求示例

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

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202201201826170101501312091D1C09D2",
    "Action": "GetTopChatAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1656067132
  },
  "Result": {
    "Data": [
      {
        "ChatId": 31823336,
        "CreateTime": 1591860377,
        "TextContent": "我们",
        "User": {
          "Nickname": "111",
          "UserId": 1669024344048647
        },
        "IsDelete": false,
        "LikeCount": 3,
        "IsPresenter": false,
        "reviewStatus": 0,
        "IsTipOff": 0,
        "AudienceGroupId": 1798530530571
      }
    ]
  }
}

错误码

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