获取直播间热门评论--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取直播间热门评论

最近更新时间：2024.06.19 11:33:29首次发布时间：2022.03.29 22:10:12

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

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetHotChatAPI`	接口名称。当前 API 的名称为 `GetHotChatAPI`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。
ActivityId	Long	是	`1770637083012`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
AudienceGroupId	Long	否	`0`	分组 ID。默认取值为 `-2`，表示全部直播分组。您可以通过 GetAudienceGroupConfig 接口查询 ID。

返回参数

参数	类型	示例值	描述
Data	Array of Data	`-`	热门评论信息列表。

Data

参数	类型	示例值	描述
ChatId	Integer	`31823336`	评论 ID。
CreateTime	Long	`1591860377`	评论的发送时间。Unix 时间戳，单位为秒。
TextContent	String	`我们`	评论内容。
User	Array of User	`-`	发送评论的观众信息。
IsDelete	Boolean	`false`	评论是否已被删除。支持以下取值： `true`：已被删除（已废弃） `false`：未被删除
LikeCount	Integer	`3`	评论点赞数。
IsPresenter	Boolean	`false`	是否是主持人发送的评论。支持以下取值： `true`：主持人发送评论 `false`：普通评论
reviewStatus	Integer	`0`	评论审核状态。支持以下取值： `0`：不需要审核 `1`：待审核（已废弃） `2`：审核通过
IsTipOff	Integer	`0`	评论举报状态。支持以下取值： `0`：未被举报 `1`：已被举报
AudienceGroupId	Long	`0`	评论所属直播分组的 ID。

User

参数	类型	示例值	描述
UserId	Long	`1669024344048647`	用户 ID。
Nickname	String	`111`	用户昵称。

请求示例

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

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202201201826170101501312091D1C09D2",
    "Action": "GetHotChatAPI",
    "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": 0
      }
    ]
  }
}

错误码

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