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

获取直播间评论

最近更新时间：2023.01.12 10:20:08

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

我的收藏

获取直播间评论。

请求说明

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

请求参数

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

Query

参数类型是否必选描述
ActionString是接口名称
VersionString是接口版本。直播当前 API 的版本为 2020-06-01
ActivityIdInt64是直播间 ID。您可通过 ListActivityAPI 接口查询 ID
ChatIdInt64是获取起始评论 ID，第一次传 0，之后传上次获取到的最后一个评论 ID
CountInt否评论拉取数量，默认取值为 0

PollingType

Int

否

评论拉取方式。支持以下两种取值

  • 0：查询 ChatId 之后的评论
  • 1：查询 ChatId 之前的评论

若 ChatId 取值为 0，则 PollingType 无论取值为 0 或 1 均表示查询 ChatId 之后的评论

返回参数

参数类型描述
DataArray of Chat评论内容

Chat

参数类型描述
ChatIdInt评论 ID
CreateTimeInt64发送评论时间
TextContentString评论内容
UserArray of UserInfo发送评论用户信息

IsDelete

Bool

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

  • true：被删除
  • false：未被删除
LikeCountInt评论点赞数

IsPresenter

Bool

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

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

reviewStatus

Int

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

  • 0：不需要审核
  • 1：待审核
  • 2：审核通过
  • 3：审核不通过

IsTipOff

Int

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

  • 0：未被举报
  • 1：已被举报

UserInfo

参数类型描述
UserIdInt用户 ID
NicknameString用户昵称

示例

请求示例

Get http://livesaas.volcengineapi.com/?Action=PollingChatAPI&Version=2020-06-01&ActivityId=1231231231&ChatId=0&Count=20&PollingType=0

正常返回示例

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

异常返回示例

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

错误码

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