调用ListComments批量查询弹幕消息-阿里云帮助中心

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

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
AppId	string	是	用户的应用ID，在控制台创建应用时生成。包含小写字母、数字，长度为6个字符。	7m***q
RoomId	string	是	房间的唯一标识，在调用CreateRoom时返回。	AE35****T95F
UserId	string	否	操作人用户ID，表示谁执行了批量查询弹幕消息的操作。	62**59
CreatorId	string	否	弹幕的创建者ID。	10**13
PageNum	integer	是	批量查询弹幕消息的分页页数。要求从1开始，每次分页拉取时递增加1。	1
PageSize	integer	是	批量查询弹幕消息的分页大小。最小不得小于1，最大不得超过100。如果超过100，会被截断为前100条。	50
SortType	integer	是	批量查询弹幕消息的排序方式。取值仅限0和1。 0：按照弹幕消息创建时间递减的顺序查询。 1：按照弹幕消息创建时间递增的顺序查询。	0

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求ID。	ER52****O9CA
Result	object	调用批量查询弹幕消息的返回结果。
CommentVOList	array	弹幕消息列表。
	object	弹幕消息信息。
AppId	string	应用ID。	7m***q
RoomId	string	房间ID。	AE35****T95F
CommentId	string	弹幕消息的唯一ID标识。	09***f8
SenderId	string	弹幕消息的发送者ID标识。	62**59
SenderNick	string	弹幕消息发送者的昵称。	Tom
CreateAt	Long	弹幕消息的创建时间，Unix时间戳，单位：毫秒。	1628438400000
Content	string	弹幕消息的内容。	Hello,World
Extension	object	扩展字段。
	string	扩展字段。	value
HasMore	boolean	是否还有下一页数据。true表示还有，false表示没有。	true
TotalCount	integer	批量查询弹幕消息的总数。	100
PageTotal	integer	分页查询弹幕消息列表的总页数。	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-25	OpenAPI 变更数据有误！