ListLiveMessageGroups - 查询直播互动群组列表

调用ListLiveMessageGroups查询互动消息群组列表。

接口说明

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

QPS 限制

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:ListLiveMessageGroupslist
  • Rtc
    acs:live::{#accountId}:rtc/{#AppId}

请求参数

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

应用 ID。

demo
SortTypeinteger

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

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

查询页的起始位置,若为空或-1,则默认为首页。

1001
GroupStatusinteger

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

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

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

cn-shanghai

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。

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

是否有下一页。

false
NextpageTokenstring

下一页的起始位置,当 Hasmore 为 false 时,不返回该字段。

1001
GroupListarray<object>

群组列表。

Groupsobject

群组数据。

GroupIdstring

群组 ID。

cU9MeBqf****
CreatorIdstring

创建者 ID。

user_77
AdminListarray

管理员列表。

Adminsstring

管理员。

uid1
Createtimelong

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

1698299727
GroupNamestring

群组名。

mytestgroup
GroupInfostring

群组扩展信息。

testgroupinfo
Deleteboolean

是否已删除。

true

示例

正常返回示例

JSON格式

{
  "RequestId": "B5D95365-5A46-1A6A-BBF5-C7B6BDED****",
  "Hasmore": false,
  "NextpageToken": "1001",
  "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.未知错误,请稍后重试或提交工单咨询。

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

变更历史

变更时间变更内容概要操作
2024-05-23OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情