查询群组消息列表_视频直播(LIVE)-阿里云帮助中心

使用说明

调用本接口前，您必须已经调用CreateLiveMessageGroup创建互动消息群组。

QPS限制

本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	ListLiveMessageGroupMessages	系统规定参数。取值：ListLiveMessageGroupMessages。
AppId	String	是	demo	需要查询的互动消息应用ID。
GroupId	String	是	grouptest	需要查询的群组的GroupID。
PageSize	Integer	是	10	一次显示的消息数量，取值范围[10,50]。
SortType	Integer	是	1	排序方式，按消息发送时间先后进行排序。取值： 1：正序 2：逆序
NextPageToken	Long	否	1	查询页的起始位置，若为空则默认为首页。
MsgType	Long	否	1	需要查询的消息类型，若为空则默认为全部类型。
BeginTime	Long	否	1697783235	查询起始时间，用UNIX时间戳表示，单位：秒。若为空则默认为最早时间。
EndTime	Long	否	1698301635	查询结束时间，用UNIX时间戳表示，单位：秒。若为空则默认为最晚时间。
DataCenter	String	否	cn-shanghai	数据中心，需要与CreateLiveMessageApp中的数据中心一致，当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。

返回数据

名称	类型	示例值	描述
RequestId	String	1668FDC3-63D7-102F-B5D4-3D2F91D1****	请求ID。
GroupId	String	grouptest	需要查询的群组的GroupID。
NextPageToken	Long	0	下一页的起始位置，若没有下一页则为0。
Hasmore	Boolean	false	是否有下一页。
MessageList	Array of Messages		消息列表。
Sender	Object		消息参数详情。
UserId	String	uid2	消息发送用户的ID。
UserInfo	String	testusermeta2	消息发送用户的扩展信息。
Body	String	step2 helo, cc group	消息体。
Timestamp	Long	1697081134	消息创建时间。用UNIX时间戳表示，单位：秒。
MsgTid	String	c-1-1-0	消息标识。
MsgType	Long	2	消息类型。
SeqNumber	Long	1	消息序列号。
TotalMessages	Long	1	总消息数量。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=ListLiveMessageGroupMessages
&AppId=demo
&GroupId=grouptest
&PageSize=10
&SortType=1
&NextPageToken=1
&MsgType=1
&BeginTime=1697783235
&EndTime=1698301635
&DataCenter=cn-shanghai
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListLiveMessageGroupMessagesResponse>
    <RequestId>1668FDC3-63D7-102F-B5D4-3D2F91D1****</RequestId>
    <GroupId>grouptest</GroupId>
    <NextPageToken>0</NextPageToken>
    <Hasmore>false</Hasmore>
    <MessageList>
        <Sender>
            <UserId>uid2</UserId>
            <UserInfo>testusermeta2</UserInfo>
        </Sender>
        <Body>step2 helo, cc group</Body>
        <Timestamp>1697081134</Timestamp>
        <MsgTid>c-1-1-0</MsgTid>
        <MsgType>2</MsgType>
        <SeqNumber>1</SeqNumber>
        <TotalMessages>1</TotalMessages>
    </MessageList>
</ListLiveMessageGroupMessagesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "1668FDC3-63D7-102F-B5D4-3D2F91D1****",
  "GroupId" : "grouptest",
  "NextPageToken" : 0,
  "Hasmore" : false,
  "MessageList" : [ {
    "Sender" : {
      "UserId" : "uid2",
      "UserInfo" : "testusermeta2"
    },
    "Body" : "step2 helo, cc group",
    "Timestamp" : 1697081134,
    "MsgTid" : "c-1-1-0",
    "MsgType" : 2,
    "SeqNumber" : 1,
    "TotalMessages" : 1
  } ]
}

错误码

HttpCode	错误码	错误信息	描述
400	InputInvalid	%s.	输入参数不合法
403	NoAuth	%s.	没有权限
404	ResourceNotExist	%s.	请求资源不存在，请检查后重新尝试
500	ServerError	%s.	未知错误，请稍后重试或提交工单咨询。

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