Skip to main content

获取所有群组

接口概述

该接口用于获取用户加入的群聊信息,包括群聊类型、群ID等

该接口需要chat权限

接口 URL

GET https://ydzx.panretro.com/external/api/v1/im/getGroupList?access_token=DIRKxecYxHm3DzghKA2a3rQtP1nEZYf5RSVYB8Hf3Ck0zRFEUWwTCwQbFw2b

请求参数

参数名类型必填描述
access_tokenstringOAuth2 授权访问令牌,用于验证用户身份

注意:access_token 必须有效,否则接口会返回授权失败。

响应说明

接口返回 JSON 格式数据,主要字段如下:

响应示例

{
"code": 200,
"msg": "success",
"data": {
"qqGroupList": [
{
"groupId": 758150709,
"groupName": "远东在线小测",
"groupType": 4,
"hasAvatar": true,
"unreadMessages": 3,
"updateTime": 1761655372732,
"groupNamePinyin": "yuan3 dong1 zai4 xian4 xiao3 ce4"
}
],
"botIsOnline": true,
"fareastGroupList": [
{
"groupId": 1850509900,
"groupName": "645",
"groupType": 1,
"hasAvatar": false,
"unreadMessages": 0,
"updateTime": 1761142164290,
"groupNamePinyin": "645"
}
]
}
}

响应字段说明

字段名类型描述
codeint状态码,200 表示请求成功
msgstring返回信息,成功时为 "success"
data.qqGroupListArray: GroupInfo用户个人QQ号中群聊/私聊
data.botIsOnlinebool用户个人QQ机器人是否在线,在线为true
data.fareastGroupListArray: GroupInfo用户加入的远东群组

GroupInfo

字段名类型描述
groupIdlong聊天室ID
groupNamestring聊天室名称
groupTypeint聊天室类型
hasAvatarboolean是否有头像
unreadMessagesint未读消息数(上限 99,超过显示为 [99+]
updateTimelong群组最后消息时间戳(毫秒)
groupNamePinyinstring群组名称拼音(带数字声调,如 "yuan3 dong1 zai4 xian4 xiao3 ce4"),方便英文用户阅读
groupNamePinyinString群组名称拼音(带数字声调,如 "yuan3 dong1 zai4 xian4"),方便英文用户阅读

响应示例说明

data.botIsOnline为用户个人QQ机器人是否在线,在线为true,建议当用户QQ机器人在线时才显示data.qqGroupList

data.qqGroupList是用户个人QQ中加入的群聊,在用户将QQ登入远东在线后收到消息时会刷新,未登入远东在线的用户此列表将为空