ListMessageGroup - 查询指定用户下消息组(旧版)

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

接口说明

QPS 限制

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

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

live:ListMessageGroup

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

UserId

string

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

说明

正确填写此参数内容,才能正常查询。

de1**a0

AppId

string

互动消息应用 ID。

说明

正确填写此参数内容,才能正常查询。

VKL3***

SortType

integer

排列方式,取值:

  • 0:时间递增顺序。

  • 1:时间递减顺序。

1

PageNum

integer

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

10

PageSize

integer

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

取值范围:1~50。

20

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

16A96B9A-****-CB92E68F4CD8

Result

object

返回结果。

GroupList

array

消息组列表。

object

消息组详情。

AppId

string

互动消息应用 ID。

VKL3***

CreateTime

integer

消息组创建 UTC 时间戳。

1502280113

CreatorId

string

创建人 ID。

as****hs

Extension

object

拓展字段。

string

拓展字段。

test001

GroupId

string

消息组 ID。

AE35-****-T95F

Status

integer

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

1

HasMore

boolean

是否还有下一页,取值:

  • true:有下一页。

  • false:没有下一页。

false

Total

integer

消息组总数。

5

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息,参考变更详情