查询互动消息群组列表

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

使用说明

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

QPS限制

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String ListLiveMessageGroups

系统规定参数。取值:ListLiveMessageGroups

AppId String demo

应用ID。

SortType Integer 1

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

  • 1:正序。
  • 2:逆序。
NextPageToken Long 1001

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

GroupStatus Integer 1

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

  • 0:查询全部群组。
  • 1:查询未被删除群组。
  • 2:查询已删除群组。
DataCenter String cn-shanghai

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

返回数据

名称

类型

示例值

描述

RequestId String B5D95365-5A46-1A6A-BBF5-C7B6BDED****

请求ID。

Hasmore Boolean false

是否有下一页。

NextpageToken String 1001

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

GroupList Array of Groups

群组列表。

GroupId String cU9MeBqf****

群组ID。

CreatorId String user_77

创建者ID。

AdminList Array of String uid1

管理员。

Createtime Long 1698299727

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

GroupName String mytestgroup

群组名。

GroupInfo String testgroupinfo

群组扩展信息。

Delete Boolean true

是否已删除。

示例

请求示例

http(s)://live.aliyuncs.com?Action=ListLiveMessageGroups
&AppId=demo
&SortType=1
&NextPageToken=1001
&DataCenter=cn-shanghai
&公共请求参数

正常返回示例

XML格式

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

<ListLiveMessageGroupsResponse>
    <RequestId>B5D95365-5A46-1A6A-BBF5-C7B6BDED****</RequestId>
    <Hasmore>false</Hasmore>
    <GroupList>
        <GroupId>cU9MeBqf****</GroupId>
        <CreatorId>user_77</CreatorId>
        <AdminList>uid1</AdminList>
        <Createtime>1698299727</Createtime>
        <GroupName>mytestgroup</GroupName>
        <GroupInfo>testgroupinfo</GroupInfo>
        <Delete>true</Delete>
    </GroupList>
</ListLiveMessageGroupsResponse>

JSON格式

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

{
  "RequestId" : "B5D95365-5A46-1A6A-BBF5-C7B6BDED****",
  "Hasmore" : false,
  "GroupList" : {
    "GroupId" : "cU9MeBqf****",
    "CreatorId" : "user_77",
    "AdminList" : "uid1",
    "Createtime" : 1698299727,
    "GroupName" : "mytestgroup",
    "GroupInfo" : "testgroupinfo",
    "Delete" : true
  }
}

错误码

HttpCode

错误码

错误信息

描述

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

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