ListComments - 批量查询弹幕消息

调用ListComments批量查询弹幕消息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
AppIdstring

用户的应用ID,在控制台创建应用时生成。包含小写字母、数字,长度为6个字符。

7m***q
RoomIdstring

房间的唯一标识,在调用CreateRoom时返回。

AE35****T95F
UserIdstring

操作人用户ID,表示谁执行了批量查询弹幕消息的操作。

62**59
CreatorIdstring

弹幕的创建者ID。

10**13
PageNuminteger

批量查询弹幕消息的分页页数。要求从1开始,每次分页拉取时递增加1。

1
PageSizeinteger

批量查询弹幕消息的分页大小。最小不得小于1,最大不得超过100。如果超过100,会被截断为前100条。

50
SortTypeinteger

批量查询弹幕消息的排序方式。取值仅限0和1。

  • 0:按照弹幕消息创建时间递减的顺序查询。

  • 1:按照弹幕消息创建时间递增的顺序查询。

0

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求ID。

ER52****O9CA
Resultobject

调用批量查询弹幕消息的返回结果。

0io**Fs6Q384
CommentVOListarray

弹幕消息列表。

object

弹幕消息信息。

AppIdstring

应用ID。

7m***q
RoomIdstring

房间ID。

AE35****T95F
CommentIdstring

弹幕消息的唯一ID标识。

09***f8
SenderIdstring

弹幕消息的发送者ID标识。

62**59
SenderNickstring

弹幕消息发送者的昵称。

Tom
CreateAtLong

弹幕消息的创建时间,Unix时间戳,单位:毫秒。

1628438400000
Contentstring

弹幕消息的内容。

Hello,World
Extensionobject

扩展字段。

string

扩展字段。

value
HasMoreboolean

是否还有下一页数据。true表示还有,false表示没有。

true
TotalCountinteger

批量查询弹幕消息的总数。

100
PageTotalinteger

分页查询弹幕消息列表的总页数。

2

示例

请求示例

http(s)://[Endpoint]/?Action=ListComments
&AppId=7m***q
&RoomId=AE35****T95F
&UserId=62**59
&PageNum=1
&PageSize=50
&SortType=0
&公共请求参数

正常返回示例

JSON格式

{
    "RequestId": "ER52****O9CA",
    "Result": {
        "CommentVOList": [
            {
                "AppId": "7m***q",
                "RoomId": "AE35****T95F",
                "CommentId": "09***f8",
                "SenderId": "62**59",
                "SenderNick": "Tom",
                "CreateAt": 1628438400000,
                "Content": "Hello,World",
                "Extension": {
                    "key": "value"
                }
            }
        ],
        "HasMore": true,
        "TotalCount": 100,
        "PageTotal": 2
    }
}

XML格式

<ListCommentsResponse>
    <RequestId>ER52****O9CA</RequestId>
    <Result>
        <CommentVOList>
            <AppId>7m***q</AppId>
            <RoomId>AE35****T95F</RoomId>
            <CommentId>09***f8</CommentId>
            <SenderId>62**59</SenderId>
            <SenderNick>Tom</SenderNick>
            <CreateAt>1628438400000</CreateAt>
            <Content>Hello,World</Content>
            <Extension>
                <key>value</key>
            </Extension>
        </CommentVOList>
        <HasMore>true</HasMore>
        <TotalCount>100</TotalCount>
        <PageTotal>2</PageTotal>
    </Result>
</ListCommentsResponse>

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2021-10-25OpenAPI 变更数据有误!
阿里云首页 低代码音视频工厂 相关技术圈