ListLiveMessageGroupByPage - 查询互动消息群组列表(支持翻页)

查询互动消息群组列表,并支持翻页功能。

接口说明

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

QPS 限制

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

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
AppIdstring

应用 ID。

demo
SortTypeinteger

排序方式,按群组创建时间先后进行排序。取值:

  • 1:正序。
  • 2:逆序。
1
PageSizeinteger

分页大小,取值范围为:[1,50]。

默认值为 20。

20
PageNumberinteger

取第几页,取值范围为:[1,10000]。

默认值为 1。

1
GroupStatusinteger

群组状态,默认值为 0。取值:

  • 0:查询全部群组。
  • 1:查询未被删除群组。
  • 2:查询已删除群组。
1
DataCenterstring

数据中心,需要与 CreateLiveMessageApp 中的数据中心一致,当前支持上海(取值为 cn-shanghai)、新加坡(取值为 ap-southeast-1)。

cn-shanghai

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

B5D95365-5A46-1A6A-BBF5-C7B6BDED****
TotalCountinteger

总条数。

50
PageNumberinteger

返回数据的当前页码。

1
PageSizeinteger

分页大小。

20
GroupListarray<object>

群组列表。

Groupsobject

群组对象。

GroupIdstring

群组 ID。

cU9MeBqf****
CreatorIdstring

创建者 ID。

user_77
AdminListarray

管理员用户 ID 列表。

Adminsstring

管理员用户 ID。

uid1
Createtimelong

创建时间,用 UNIX 时间戳表示,单位:秒。

1698299727
GroupNamestring

群组名。

mytestgroup
GroupInfostring

群组扩展信息。

testgroupinfo
Deleteboolean

是否已删除。

true

示例

正常返回示例

JSON格式

{
  "RequestId": "B5D95365-5A46-1A6A-BBF5-C7B6BDED****",
  "TotalCount": 50,
  "PageNumber": 1,
  "PageSize": 20,
  "GroupList": [
    {
      "GroupId": "cU9MeBqf****",
      "CreatorId": "user_77",
      "AdminList": [
        "uid1"
      ],
      "Createtime": 1698299727,
      "GroupName": "mytestgroup",
      "GroupInfo": "testgroupinfo",
      "Delete": true
    }
  ]
}

错误码

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

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