查询直播互动群组详细信息。
接口说明
调用本接口前,您必须已经调用 CreateLiveMessageGroup 创建互动消息群组。
QPS 限制
本接口的单用户 QPS 限制为 50 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
live:DescribeLiveMessageGroup |
get |
*Rtc
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| AppId |
string |
是 |
应用 ID。 |
demo |
| GroupId |
string |
是 |
群组 ID。 |
grouptest |
| DataCenter |
string |
否 |
数据中心,需要与 CreateLiveMessageApp 中的数据中心一致,当前支持上海(取值为 cn-shanghai)、新加坡(取值为 ap-southeast-1)。 |
cn-shanghai |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回参数。 |
||
| RequestId |
string |
请求 ID。 |
1815A27D-BAE2-10E6-89FD-D477951C**** |
| GroupId |
string |
群组 ID。 |
grouptest |
| CreatorId |
string |
创建者 ID。 |
uid1 |
| AdminList |
array |
管理员列表。 |
|
|
string |
管理员。 |
["uid1","uid2"] |
|
| Createtime |
integer |
创建时间,用 UNIX 时间戳表示,单位:秒。 |
1698305471 |
| GroupName |
string |
群组名。 |
mytestgroup |
| GroupInfo |
string |
群组扩展信息。 |
testgroupinfo |
| Delete |
boolean |
是否已删除。 |
false |
| TotalTimes |
integer |
总 Session 次数。群组存在时才有此参数。 |
50 |
| OnlineUserCounts |
integer |
当前在线的群用户数。群组存在时才有此参数。 |
2 |
| MsgAmount |
object |
消息数分类统计。群组存在时才有此参数。 |
|
|
integer |
消息数。 |
{1 : 20, 2 : 30} |
|
| Deletatime |
integer |
删除时间。群组已被删除时才有此参数。用 UNIX 时间戳表示,单位:秒。 |
1698299827 |
| Deletor |
string |
删除者。群组已被删除时才有此参数。 |
uid1 |
| SuperLargeGroup |
boolean |
群组是否为超级大群。
|
False |
示例
正常返回示例
JSON格式
{
"RequestId": "1815A27D-BAE2-10E6-89FD-D477951C****",
"GroupId": "grouptest",
"CreatorId": "uid1",
"AdminList": [
"[\"uid1\",\"uid2\"]"
],
"Createtime": 1698305471,
"GroupName": "mytestgroup",
"GroupInfo": "testgroupinfo",
"Delete": false,
"TotalTimes": 50,
"OnlineUserCounts": 2,
"MsgAmount": {
"key": 0
},
"Deletatime": 1698299827,
"Deletor": "uid1",
"SuperLargeGroup": true
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InputInvalid | %s. | 输入参数不合法 |
| 500 | ServerError | %s. | 未知错误,请稍后重试或提交工单咨询。 |
| 403 | NoAuth | %s. | 没有权限 |
| 404 | ResourceNotExist | %s. | 请求资源不存在,请检查后重新尝试 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。