调用 ListInteractionScriptComments
接口,获取指定互动脚本的评论列表,包括评论 ID、发送评论的用户身份和时间等。
请求频率:单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListInteractionScriptComments | 接口名称。当前 API 的名称为 ListInteractionScriptComments 。 |
Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01 。 |
InteractionScriptId | Long | 是 | 1 | 互动脚本 ID。您可通过调用 ListActivityMediaAPI 接口获取绑定视频库或直播暂存视频的互动脚本 ID,或调用 ListLoopVideos 接口获取绑定伪直播视频的互动脚本 ID。 |
PageNumber | Integer | 否 |
| 定位到的评论所在的页码。默认值为 说明 传入的参数不同,返回结果中定位的页码也存在差异。规则如下所示:
|
PageSize | Integer | 否 | 10 | 每页包含的评论数量。默认值为 10 。取值范围为 [1, 1000]。 |
SendTime | Integer | 否 |
| 评论的发送时间。单位为秒。例如参数取值为 说明 传入的参数不同,返回结果中定位的页码也存在差异。规则如下所示:
|
CommentId | Integer | 否 |
| 评论 ID。您可以调用 AddInteractionScriptComments 接口,通过返回参数 说明 传入的参数不同,返回结果中定位的页码也存在差异。规则如下所示:
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
PageNumber | Integer | 1 | 定位到的评论所在的页码。 |
PageSize | Integer | 10 | 每页包含的评论数量。 |
TotalAmount | Integer | 1 | 互动脚本评论总数。 |
Comments | Array of Comments | - | 评论配置信息。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Id | Long | 1 | 评论 ID。 |
SendTime | Integer | 10 | 评论的发送时间。单位为秒。例如参数值为 10 ,则该条评论会在视频开始播放 10 秒后发送。 |
Role | Integer |
| 发送评论的用户身份。取值如下:
|
Nickname | String | 观众 A | 用户昵称。 |
Content | String | 你好 | 评论内容。 |
GET https://livesaas.volcengineapi.com/?Action=ListInteractionScriptComments&Version=2023-08-01&InteractionScriptId=1&PageNumber=1&PageSize=10&SendTime=10&CommentId=1
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "ListInteractionScriptComments", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697446406 }, "Result": { "PageNumber": 1, "PageSize": 10, "TotalAmount": 1, "Comments": [ { "Id": 1, "SendTime": 10, "Role": 1, "Nickname": "观众 A", "Content": "你好" } ] } }