调用ListMessageGroup查询指定用户下消息组列表。

QPS限制

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

调试

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

请求参数

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

系统规定参数。取值:ListMessageGroup

UserId String de1**a0

用户UserId,用户自定义,在AppId下单独唯一。不同的用户需要使用不同的UserId。

AppId String VKL3***

互动消息应用ID。

SortType Integer 1

排列方式,取值:

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

页码,默认值:1。取值范围:1~100000。

PageSize Integer 20

单页显示消息组的数量,默认值:20。

取值范围:1~50。

返回数据

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

请求ID。

Result Object

返回结果。

Total Integer 5

消息组总数。

HasMore Boolean false

是否还有下一页,取值:

  • true:有下一页。
  • false:没有下一页。
GroupList Array of groupList

消息组列表。

GroupId String AE35-****-T95F

消息组ID。

AppId String VKL3***

互动消息应用ID。

CreateTime Long 1502280113

消息组创建UTC时间戳。

Status Integer 1

消息组状态。默认值为1,表示消息组状态正常。

CreatorId String as****hs

创建人ID。

Extension Map

拓展字段。

String test001

拓展字段。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=ListMessageGroup
&UserId=de1**a0
&SortType=1
&PageNum=10
&PageSize=20
&公共请求参数

正常返回示例

XML格式

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

<ListMessageGroupResponse>
    <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>
    <Result>
        <Total>5</Total>
        <HasMore>false</HasMore>
        <GroupList>
            <GroupId>AE35-****-T95F</GroupId>
            <AppId>VKL3***</AppId>
            <CreateTime>1502280113</CreateTime>
            <Status>1</Status>
            <CreatorId>as****hs</CreatorId>
            <Extension>
                <key>test001</key>
            </Extension>
        </GroupList>
    </Result>
</ListMessageGroupResponse>

JSON格式

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

{
  "RequestId" : "16A96B9A-****-CB92E68F4CD8",
  "Result" : {
    "Total" : 5,
    "HasMore" : false,
    "GroupList" : [ {
      "GroupId" : "AE35-****-T95F",
      "AppId" : "VKL3***",
      "CreateTime" : 1502280113,
      "Status" : 1,
      "CreatorId" : "as****hs",
      "Extension" : {
        "key" : "test001"
      }
    } ]
  }
}

错误码

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