查询互动消息群组列表,并支持翻页功能。
接口说明
调用本接口前,您必须已经调用 CreateLiveMessageGroup 创建互动消息群组。
QPS 限制
本接口的单用户 QPS 限制为 50 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppId | string | 是 | 应用 ID。 | demo |
SortType | integer | 是 | 排序方式,按群组创建时间先后进行排序。取值:
| 1 |
PageSize | integer | 否 | 分页大小,取值范围为:[1,50]。 默认值为 20。 | 20 |
PageNumber | integer | 否 | 取第几页,取值范围为:[1,10000]。 默认值为 1。 | 1 |
GroupStatus | integer | 否 | 群组状态,默认值为 0。取值:
| 1 |
DataCenter | string | 否 | 数据中心,需要与 CreateLiveMessageApp 中的数据中心一致,当前支持上海(取值为 cn-shanghai)、新加坡(取值为 ap-southeast-1)。 | cn-shanghai |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InputInvalid | %s. | 输入参数不合法 |
403 | NoAuth | %s. | 没有权限 |
404 | ResourceNotExist | %s. | 请求资源不存在,请检查后重新尝试 |
500 | ServerError | %s. | 未知错误,请稍后重试或提交工单咨询。 |
访问错误中心查看更多错误码。