ListUserChatAPI - 获取直播间指定用户评论--企业直播-火山引擎

文档中心

立即注册

企业直播

直播间评论

ListUserChatAPI - 获取直播间指定用户评论

调用 ListUserChatAPI 接口，获取指定直播间内指定用户的评论。

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。
前提条件：确保您拥有火山引擎主账号或具备直播间的直播控制 > 仅查看或可编辑权限的子账号。有关如何添加子账号，详见子账号管理。
观众在发送评论时存在频率限制。超过限制时，评论可能发送失败，本接口将无法获取对应评论数据。

请求说明

请求方式：GET
请求地址：https://livesaas.volcengineapi.com/?Action=ListUserChatAPI&Version=2023-08-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListUserChatAPI`	接口名称。当前 API 的名称为 `ListUserChatAPI`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
ActivityId	Long	是	`1770637083012`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
UserId	Long	否	`173628****527134`	根据观众的用户 ID 进行筛选。说明 `UserId` 和 `ExternalUserId` 至少需要传一个，当同时传入时，`UserId` 的优先级最高，即仅根据观众的用户 ID 进行筛选。
ExternalUserId	String	否	`1efc****sds`	根据观众的关联用户 ID，即观众在第三方平台的唯一标识进行筛选。观众通过不同方式登录直播间，关联用户 ID 的取值如下所示。微信：观众在企业直播微信服务号的 OpenID。企业微信：绑定企业直播的企业内部成员 OpenID。自定义：自定义登录时通过 UserId 传入的值。详见自定义登录。 OAuth 2.0：您自有账号系统中用户 ID 对应的字段。飞书：绑定企业直播的飞书企业成员 Open ID。手机号：观众通过手机号注册企业直播后生成的 passport_id。白名单：观众输入的白名单校验信息。说明如果您集成了观播 SDK，且 SDK 的鉴权模式为自定义模式，关联用户 ID 的取值为调用 GetSDKTokenAPI 接口时、或调用 GetActivityLoginSecret 后生成 JWT 时，传入的 `UserIdStr`（观众 ID）。 `UserId` 和 `ExternalUserId` 至少需要传一个，当同时传入时，`UserId` 的优先级最高，即仅根据观众的用户 ID 进行筛选。
PollingOrder	Integer	否	`0`	评论排序方式。默认值为 `0`。取值如下： `0`：按评论 ID 正序排列（从旧到新） `1`：按评论 ID 倒序排列（从新到旧）
ChatId	Long	否	`0`	评论 ID。用于分页定位。默认值为 `0`。首次调用时，可不传 `chatId`（或传 `0`），接口将根据 `PollingOrder` 返回当前直播间的评论列表：当 `PollingOrder` 为 `0` （从旧到新）时，返回最早的一批评论；当 `PollingOrder` 为 `1` （从新到旧）时，返回最新的一批评论。后续调用时，可将参数值设置为上一次返回结果中的某个 `ChatId`，继续拉取评论：当 `PollingOrder` 为 `0` （从旧到新）时，返回该 `chatId` 之后的评论，即更新的数据；当 `PollingOrder` 为 `1` （从新到旧）时，获取该 `chatId` 之前的评论，即更早的数据。
Count	Integer	否	`200`	获取的评论数量。默认值为 `200`。取值范围为 [1,200]。
ReviewStatus	Integer	否	`-1`	评论审核状态，取值如下，不传此字段则不会筛选审核状态： `0`：无需审核 `1`：待审核 `2`：审核通过 `3`：审核不通过

返回参数

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

Data

参数	类型	示例值	描述
ChatId	Integer	`31****36`	评论 ID。
CreateTime	Integer	`1591860377`	评论的发送时间。Unix 时间戳，单位为秒。
TextContent	String	`大家好`	评论内容。
User	Object of User	`-`	发送评论的用户信息。
IsDelete	Boolean	`false`	评论是否已被删除。取值如下： `true`：已被删除 `false`：未被删除
ReviewStatus	Integer	`0`	评论审核状态。取值如下： 0：不需要审核 1：待审核 2：审核通过 3：审核不通过
IsTipOff	Integer	`0`	评论举报状态。取值如下： 0：未被举报 1：已被举报
AudienceGroupId	Integer	`0`	评论所属直播分组的 ID。说明该参数仅在开启直播分组功能后生效。更多有关直播分组的内容，详见直播分组。

User

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

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListUserChatAPI&Version=2023-08-01&ActivityId=1770637083012&UserId=173628****527134&ExternalUserId=1efc****sds&PollingOrder=0&ChatId=0&Count=200&ReviewStatus=-1

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListUserChatAPI",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "Data": [
            {
                "ChatId": 31****36,
                "CreateTime": 1591860377,
                "TextContent": "大家好",
                "User": {
                    "Nickname": "观众 A",
                    "Extra": "运营部",
                    "UserId": 1669024344048647,
                    "ExternalId": "abc"
                },
                "IsDelete": true,
                "ReviewStatus": 0,
                "IsTipOff": 0,
                "AudienceGroupId": 0
            }
        ]
    }
}

错误码

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

最近更新时间：2026.03.27 11:16:50

这个页面对您有帮助吗？

有用

无用

企业直播

注意事项 #

请求说明 #

调试 #

请求参数 #

Query #

返回参数 #

Data #

User #

请求示例 #

返回示例 #

错误码 #