调用ListMessage查询消息列表。

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ListMessage

系统规定参数。取值：ListMessage。

GroupId String 是 AE35-****-T95F

消息组ID。
AppId String 是 VKL3***

互动消息应用ID。
Type Integer 否 10002

用户自定义消息类型，需大于10000。
SortType Integer 否 1

排列方式，取值：

  • 0：时间递增顺序。
  • 1：时间递减顺序。
PageNum Integer 是 10

页码，默认值：1。取值范围：1~100000。
PageSize Integer 是 20

单页显示用户的数量，默认值：20。取值范围：1~50。

返回数据

名称 类型 示例值 描述
RequestId String 16A96B9A-****-CB92E68F4CD8

请求ID。
Result Object

返回结果。
HasMore Boolean false

是否还有下一页，取值：

  • true：有下一页。
  • false：没有下一页。
MessageList Array of messageList

消息列表。
GroupId String AE35-****-T95F

消息组ID。
MessageId String qt***

消息ID。
Type Integer 10002

消息类型。
SenderId String yi***

消息发送者ID。
Data String test

消息体，JSONString类型。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=ListMessage
&GroupId=AE35-****-T95F
&AppId=VKL3***
&Type=10002
&SortType=1
&PageNum=10
&PageSize=20
&公共请求参数

正常返回示例

XML格式 

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

<ListMessageResponse>
    <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>
    <Result>
        <HasMore>false</HasMore>
        <MessageList>
            <GroupId>AE35-****-T95F</GroupId>
            <MessageId>qt***</MessageId>
            <Type>10002</Type>
            <SenderId>yi***</SenderId>
            <Data>test</Data>
        </MessageList>
    </Result>
</ListMessageResponse>

JSON格式 

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

{
  "RequestId" : "16A96B9A-****-CB92E68F4CD8",
  "Result" : {
    "HasMore" : false,
    "MessageList" : [ {
      "GroupId" : "AE35-****-T95F",
      "MessageId" : "qt***",
      "Type" : 10002,
      "SenderId" : "yi***",
      "Data" : "test"
    } ]
  }
}

错误码

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