GetTopChatAPI - 获取直播间置顶评论--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

GetTopChatAPI - 获取直播间置顶评论

最近更新时间：2025.03.24 17:08:24首次发布时间：2022.03.29 22:10:12

调用 GetTopChatAPI 接口，获取指定直播间的置顶评论。

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。
前提条件：确保您拥有火山引擎主账号或具备直播间的直播控制 > 仅查看或可编辑权限的子账号。有关如何添加子账号，详见子账号管理。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetTopChatAPI`	接口名称。当前 API 的名称为 `GetTopChatAPI`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。
ActivityId	Long	是	`1770****83012`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
AudienceGroupId	Long	否	`-2`	直播分组 ID。默认值为 `-2`，即获取所有直播分组中的评论。您可通过调用 GetAudienceGroupConfig 接口获取 ID。说明该参数仅在开启直播分组功能后生效。更多有关直播分组的内容，详见直播分组。

返回参数

参数	类型	示例值	描述
Data	Array of Data	`-`	置顶评论信息。

Data

参数	类型	示例值	描述
ChatId	Integer	`31****36`	评论 ID。
CreateTime	Long	`1591860377`	评论的发送时间。Unix 时间戳，单位为秒。
TextContent	String	`大家好`	评论内容。
User	Object of User	`-`	发送评论的用户信息。
IsDelete	Boolean	`false`	评论是否已被删除。取值如下： `true`：已被删除（已废弃） `false`：未被删除
LikeCount	Integer	`3`	评论点赞数。
IsPresenter	Boolean	`false`	是否是主持人发送的评论。取值如下： `true`：主持人发送的评论 `false`：非主持人发送的评论
reviewStatus	Integer	`0`	评论审核状态。取值如下： `0`：不需要审核 `1`：待审核（已废弃） `2`：审核通过说明当 `IsPresenter` 取值为 `true` 时，该参数取值固定为 `2`。
IsTipOff	Integer	`0`	评论举报状态。取值如下： `0`：未被举报 `1`：已被举报
AudienceGroupId	Long	`0`	评论所属直播分组的 ID。说明该参数仅在开启直播分组功能后生效。更多有关直播分组的内容，详见直播分组。
LLMAnalyzeResult	String	`商品咨询`	聊天 AI 分析的结果。说明仅在开启聊天 AI 分析功能且观众在观看页发送聊天内容后，会产生聊天 AI 分析结果。您可以调用 UpdateActivityCommentConfig 接口，将 `IsCommentLLMAnalyzeEnable` 参数的取值设置为 `1`，开启聊天 AI 分析功能。更多有关聊天 AI 分析的内容，详见聊天 AI 分析。

User

参数	类型	示例值	描述
Nickname	String	`观众 A`	用户昵称。
UserId	Long	`166902****048647`	用户 ID。说明当 `IsPresenter` 取值为 `true` 时，该参数取值固定为 `0`。
Extra	String	`运营部`	额外信息，业务方扩展参数。
ExternalId	String	`abc`	关联用户 ID，即观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份，以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间，关联用户 ID 的取值如下所示。微信：观众在企业直播微信服务号的 OpenID。企业微信：绑定企业直播的企业内部成员 OpenID。自定义：自定义登录时通过 `UserId` 传入的值。详见自定义登录。 OAuth 2.0：您自有账号系统中用户 ID 对应的字段。飞书：绑定企业直播的飞书企业成员 Open ID。手机号：观众通过手机号注册企业直播后生成的 passport_id。白名单：观众输入的白名单校验信息。说明如果您集成了观播 SDK，且 SDK 的鉴权模式为自定义模式，关联用户 ID 的取值为调用 GetSDKTokenAPI 接口时传入的 `UserIdStr`（观众 ID）。仅在 `IsPresenter` 取值为 `false` 且观众通过以上方式登录直播间时，该参数有值。

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetTopChatAPI&Version=2020-06-01&ActivityId=1770****83012&AudienceGroupId=-2

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetTopChatAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "Data": [
            {
                "ChatId": 31****36,
                "CreateTime": 1591860377,
                "TextContent": "大家好",
                "User": {
                    "Nickname": "观众 A",
                    "Extra": "运营部",
                    "ExternalId": "abc",
                    "UserId": 166902****048647
                },
                "IsDelete": false,
                "LikeCount": 3,
                "IsPresenter": false,
                "reviewStatus": 0,
                "IsTipOff": 0,
                "AudienceGroupId": 0,
                "LLMAnalyzeResult": "商品咨询"
            }
        ]
    }
}

错误码

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