You need to enable JavaScript to run this app.
导航
获取互动脚本评论列表
最近更新时间:2025.01.22 10:45:53首次发布时间:2025.01.22 10:45:53

调用 ListInteractionScriptComments 接口,获取指定互动脚本的评论列表,包括评论 ID、发送评论的用户身份和时间等。

注意事项

请求频率:单用户请求频率限制为 10 次/秒

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringListInteractionScriptComments接口名称。当前 API 的名称为 ListInteractionScriptComments
VersionString2023-08-01接口版本。当前 API 的版本为 2023-08-01
InteractionScriptIdLong1互动脚本 ID。您可通过调用 ListActivityMediaAPI 接口获取绑定视频库或直播暂存视频的互动脚本 ID,或调用 ListLoopVideos 接口获取绑定伪直播视频的互动脚本 ID。

PageNumber

Integer

1

定位到的评论所在的页码。默认值为 1。取值大于等于 1。

说明

传入的参数不同,返回结果中定位的页码也存在差异。规则如下所示:

  1. 当传入 CommentId 且该 CommentId 存在时,则根据 CommentId 进行定位。
  2. 当未传入 CommentId 或传入的 CommentId 不存在时,则根据 SendTime 进行定位。
  3. 当未传入 SendTime 时,则根据 PageNumber 进行定位。
PageSizeInteger10每页包含的评论数量。默认值为 10。取值范围为 [1, 1000]。

SendTime

Integer

10

评论的发送时间。单位为秒。例如参数取值为 10,则会定位到视频播放开始后第 10 秒及之后发送的第一条评论所在的页码,并相应地改变返回的 PageNumber 参数值。

说明

传入的参数不同,返回结果中定位的页码也存在差异。规则如下所示:

  1. 当传入 CommentId 且该 CommentId 存在时,则根据 CommentId 进行定位。
  2. 当未传入 CommentId 或传入的 CommentId 不存在时,则根据 SendTime 进行定位。
  3. 当未传入 SendTime 时,则根据 PageNumber 进行定位。

CommentId

Integer

1

评论 ID。您可以调用 AddInteractionScriptComments 接口,通过返回参数 LatestCommentId 获取评论 ID。
如传入该参数,则会定位到与 ID 对应的评论所在的页码,并相应地改变返回的 PageNumber 参数值。

说明

传入的参数不同,返回结果中定位的页码也存在差异。规则如下所示:

  1. 当传入 CommentId 且该 CommentId 存在时,则根据 CommentId 进行定位。
  2. 当未传入 CommentId 或传入的 CommentId 不存在时,则根据 SendTime 进行定位。
  3. 当未传入 SendTime 时,则根据 PageNumber 进行定位。

返回参数

参数类型示例值描述
PageNumberInteger1定位到的评论所在的页码。
PageSizeInteger10每页包含的评论数量。
TotalAmountInteger1互动脚本评论总数。
CommentsArray of Comments-评论配置信息。

Comments

参数类型示例值描述
IdLong1评论 ID。
SendTimeInteger10评论的发送时间。单位为秒。例如参数值为 10,则该条评论会在视频开始播放 10 秒后发送。

Role

Integer

1

发送评论的用户身份。取值如下:

  • 1:观众
  • 2:主持人
  • 3:助教
NicknameString观众 A用户昵称。
ContentString你好评论内容。

请求示例

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": "你好"
            }
        ]
    }
}

错误码

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