icqq

Appearance

信息查询 API ​

本页介绍登录信息、好友与群列表、用户与成员信息、群荣誉、凭证（cookies / csrf）、能力探测、在线设备与群系统消息等查询接口。所有 ID 字段同时接受数字与数字字符串。

快速索引 ​

API描述
get_login_info获取登录号信息
get_stranger_info获取陌生人信息
get_friend_list获取好友列表
get_group_info获取群信息
get_group_list获取群列表
get_group_member_info获取群成员信息
get_group_member_list获取群成员列表
get_group_honor_info获取群荣誉信息
get_cookies获取 Cookies
get_csrf_token获取 CSRF Token
get_credentials获取凭证（cookies + token）
can_send_image检查能否发送图片
can_send_record检查能否发送语音
get_online_clients获取在线设备
get_group_system_msg获取群系统消息

获取登录号信息 ​

  • API: get_login_info
  • 描述: 获取当前登录账号的 QQ 号与昵称。

请求参数 ​

无。

响应参数 ​

字段类型说明备注
user_idnumber登录账号 QQ 号。-
nicknamestring登录账号昵称。-
json
{
  "user_id": 0,
  "nickname": ""
}

示例 ​

bash
curl -X POST 'http://127.0.0.1:5700/get_login_info' \
  -H 'Content-Type: application/json' \
  -d '{}'
js
const res = await fetch('http://127.0.0.1:5700/get_login_info', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({})
})

const body = await res.json()
console.log(body.data.user_id, body.data.nickname)

错误码 ​

retcode说明
0成功。

获取陌生人信息 ​

  • API: get_stranger_info
  • 描述: 获取任意用户的基本资料。

请求参数 ​

字段类型必填默认值说明
user_idnumber | string是-目标 QQ 号。
no_cacheboolean否-是否不使用缓存。
json
{
  "user_id": "<friend_id>"
}

响应参数 ​

字段类型说明备注
user_idnumberQQ 号。-
nicknamestring昵称。-
sexstring性别。male / female / unknown
agenumber年龄。-
levelnumber等级。-
login_daysnumber连续登录天数。-
qidstringQID。可能为空字符串。
areastring地区。可能为空字符串。
json
{
  "user_id": 0,
  "nickname": "",
  "sex": "unknown",
  "age": 0,
  "level": 0,
  "login_days": 0,
  "qid": "",
  "area": ""
}

示例 ​

bash
curl -X POST 'http://127.0.0.1:5700/get_stranger_info' \
  -H 'Content-Type: application/json' \
  -d '{"user_id":"<friend_id>"}'
js
const res = await fetch('http://127.0.0.1:5700/get_stranger_info', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    user_id: '<friend_id>'
  })
})

const body = await res.json()
console.log(body.data)
py
import requests

resp = requests.post(
    "http://127.0.0.1:5700/get_stranger_info",
    json={"user_id": "<friend_id>"},
    timeout=10,
)
resp.raise_for_status()
body = resp.json()
print(body["data"])

错误码 ​

retcode说明
0成功。
1400参数错误。

注意事项 ​

  • sex 取值为 male / female / unknown。
  • qid 和 area 可能返回空字符串。

获取好友列表 ​

  • API: get_friend_list
  • 描述: 获取当前账号的好友列表。

请求参数 ​

无。

响应参数 ​

字段类型说明备注
user_idnumber好友 QQ 号。-
nicknamestring昵称。-
remarkstring备注。-
json
[
  {
    "user_id": 0,
    "nickname": "",
    "remark": ""
  }
]

示例 ​

bash
curl -X POST 'http://127.0.0.1:5700/get_friend_list' \
  -H 'Content-Type: application/json' \
  -d '{}'
js
const res = await fetch('http://127.0.0.1:5700/get_friend_list', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({})
})

const body = await res.json()
console.log(body.data)

错误码 ​

retcode说明
0成功。缓存为空时返回空数组。

获取群信息 ​

  • API: get_group_info
  • 描述: 获取指定群的基本信息。

请求参数 ​

字段类型必填默认值说明
group_idnumber | string是-群号。
no_cacheboolean否-是否不使用缓存。
json
{
  "group_id": "<group_id>"
}

响应参数 ​

字段类型说明备注
group_idnumber群号。-
group_namestring群名称。-
member_countnumber成员数。-
max_member_countnumber最大成员数。-
group_create_timenumber群创建时间戳（秒）。-
group_levelnumber群等级。-
group_memostring群公告/备忘录。可能为空字符串。
json
{
  "group_id": 0,
  "group_name": "",
  "member_count": 0,
  "max_member_count": 0,
  "group_create_time": 0,
  "group_level": 0,
  "group_memo": ""
}

示例 ​

bash
curl -X POST 'http://127.0.0.1:5700/get_group_info' \
  -H 'Content-Type: application/json' \
  -d '{"group_id":"<group_id>"}'
js
const res = await fetch('http://127.0.0.1:5700/get_group_info', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    group_id: '<group_id>'
  })
})

const body = await res.json()
console.log(body.data)

错误码 ​

retcode说明
0成功。
1400参数错误。
1404群不存在。

获取群列表 ​

  • API: get_group_list
  • 描述: 获取当前账号已加入的群列表。

请求参数 ​

无。

响应参数 ​

字段类型说明备注
group_idnumber群号。-
group_namestring群名称。-
member_countnumber成员数。-
max_member_countnumber最大成员数。-
group_create_timenumber群创建时间戳（秒）。-
group_levelnumber群等级。-
group_memostring群公告/备忘录。可能为空字符串。
json
[
  {
    "group_id": 0,
    "group_name": "",
    "member_count": 0,
    "max_member_count": 0,
    "group_create_time": 0,
    "group_level": 0,
    "group_memo": ""
  }
]

示例 ​

bash
curl -X POST 'http://127.0.0.1:5700/get_group_list' \
  -H 'Content-Type: application/json' \
  -d '{}'
js
const res = await fetch('http://127.0.0.1:5700/get_group_list', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({})
})

const body = await res.json()
console.log(body.data)

错误码 ​

retcode说明
0成功。缓存为空时返回空数组。

获取群成员信息 ​

  • API: get_group_member_info
  • 描述: 获取指定群成员的详细信息。

请求参数 ​

字段类型必填默认值说明
group_idnumber | string是-群号。
user_idnumber | string是-成员 QQ 号。
no_cacheboolean否-是否不使用缓存。
json
{
  "group_id": "<group_id>",
  "user_id": "<friend_id>"
}

响应参数 ​

字段类型说明备注
group_idnumber群号。-
user_idnumber成员 QQ 号。-
nicknamestring昵称。-
cardstring群名片。-
sexstring性别。male / female / unknown
agenumber年龄。-
areastring地区。-
join_timenumber入群时间戳（秒）。-
last_sent_timenumber最后发言时间戳（秒）。-
levelnumber等级。-
rolestring角色。owner / admin / member
unfriendlyboolean是否不良记录成员。-
titlestring专属头衔。-
title_expire_timenumber头衔过期时间戳（秒）。-
card_changeableboolean是否允许修改群名片。-
shut_up_timestampnumber禁言到期时间戳（秒）。0 表示未被禁言。
json
{
  "group_id": 0,
  "user_id": 0,
  "nickname": "",
  "card": "",
  "sex": "unknown",
  "age": 0,
  "area": "",
  "join_time": 0,
  "last_sent_time": 0,
  "level": 0,
  "role": "member",
  "unfriendly": false,
  "title": "",
  "title_expire_time": 0,
  "card_changeable": false,
  "shut_up_timestamp": 0
}

示例 ​

bash
curl -X POST 'http://127.0.0.1:5700/get_group_member_info' \
  -H 'Content-Type: application/json' \
  -d '{"group_id":"<group_id>","user_id":"<friend_id>"}'
js
const res = await fetch('http://127.0.0.1:5700/get_group_member_info', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    group_id: '<group_id>',
    user_id: '<friend_id>'
  })
})

const body = await res.json()
console.log(body.data)

错误码 ​

retcode说明
0成功。
1400参数错误。
1404成员不存在。

注意事项 ​

  • sex 取值为 male / female / unknown。
  • role 取值为 owner / admin / member。
  • shut_up_timestamp 为 0 表示未被禁言。

获取群成员列表 ​

  • API: get_group_member_list
  • 描述: 获取指定群的所有成员列表。

请求参数 ​

字段类型必填默认值说明
group_idnumber | string是-群号。
json
{
  "group_id": "<group_id>"
}

响应参数 ​

字段类型说明备注
group_idnumber群号。-
user_idnumber成员 QQ 号。-
nicknamestring昵称。-
cardstring群名片。-
rolestring角色。owner / admin / member
json
[
  {
    "group_id": 0,
    "user_id": 0,
    "nickname": "",
    "card": "",
    "role": "member"
  }
]

示例 ​

bash
curl -X POST 'http://127.0.0.1:5700/get_group_member_list' \
  -H 'Content-Type: application/json' \
  -d '{"group_id":"<group_id>"}'
js
const res = await fetch('http://127.0.0.1:5700/get_group_member_list', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    group_id: '<group_id>'
  })
})

const body = await res.json()
console.log(body.data)

错误码 ​

retcode说明
0成功。未加载的群返回空数组。
1400参数错误。

注意事项 ​

  • 每项字段与 get_group_member_info 相同。
  • 未加载的群返回空数组而非报错。

获取群荣誉信息 ​

  • API: get_group_honor_info
  • 描述: 获取群荣誉信息（龙王、群聊之火等）。

请求参数 ​

字段类型必填默认值说明
group_idnumber | string是-群号。
typestring是-荣誉类型。
json
{
  "group_id": "<group_id>",
  "type": "all"
}

响应参数 ​

字段类型说明备注
group_idnumber群号。-
current_talkativeobject当前龙王信息。仅在龙王存在时出现。
talkative_listobject[]历史龙王列表。-
performer_listobject[]群聊之火列表。-
legend_listobject[]群聊炽焰列表。-
strong_newbie_listobject[]冒尖小春笋列表。-
emotion_listobject[]快乐之源列表。-
json
{
  "group_id": 0,
  "current_talkative": {
    "user_id": 0,
    "nickname": "",
    "avatar": "",
    "day_count": 0
  },
  "talkative_list": [
    {
      "user_id": 0,
      "nickname": "",
      "avatar": "",
      "description": ""
    }
  ],
  "performer_list": [],
  "legend_list": [],
  "strong_newbie_list": [],
  "emotion_list": []
}

示例 ​

bash
curl -X POST 'http://127.0.0.1:5700/get_group_honor_info' \
  -H 'Content-Type: application/json' \
  -d '{"group_id":"<group_id>","type":"all"}'
js
const res = await fetch('http://127.0.0.1:5700/get_group_honor_info', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    group_id: '<group_id>',
    type: 'all'
  })
})

const body = await res.json()
console.log(body.data)
py
import requests

resp = requests.post(
    "http://127.0.0.1:5700/get_group_honor_info",
    json={
        "group_id": "<group_id>",
        "type": "all",
    },
    timeout=10,
)
resp.raise_for_status()
body = resp.json()
print(body["data"])

错误码 ​

retcode说明
0成功。仅包含所请求类别对应的字段。
1400参数错误或未知 type。
1500拉取失败。

注意事项 ​

  • type 取值为 talkative / performer / legend / strong_newbie / emotion / all。
  • type=all 时拉取全部类别。
  • current_talkative 仅在当前存在龙王时出现。

获取 Cookies ​

  • API: get_cookies
  • 描述: 获取指定域名的 Cookies。

请求参数 ​

字段类型必填默认值说明
domainstring否""目标域名。缺省时只含基础形态。
json
{
  "domain": "qun.qq.com"
}

响应参数 ​

字段类型说明备注
cookiesstringCookie 字符串。-
json
{
  "cookies": ""
}

示例 ​

bash
curl -X POST 'http://127.0.0.1:5700/get_cookies' \
  -H 'Content-Type: application/json' \
  -d '{"domain":"qun.qq.com"}'
js
const res = await fetch('http://127.0.0.1:5700/get_cookies', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    domain: 'qun.qq.com'
  })
})

const body = await res.json()
console.log(body.data.cookies)

错误码 ​

retcode说明
0成功。

获取 CSRF Token ​

  • API: get_csrf_token
  • 描述: 获取 CSRF Token（bkn）。

请求参数 ​

无。

响应参数 ​

字段类型说明备注
tokennumberCSRF Token（bkn）。-
json
{
  "token": 0
}

示例 ​

bash
curl -X POST 'http://127.0.0.1:5700/get_csrf_token' \
  -H 'Content-Type: application/json' \
  -d '{}'
js
const res = await fetch('http://127.0.0.1:5700/get_csrf_token', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({})
})

const body = await res.json()
console.log(body.data.token)

错误码 ​

retcode说明
0成功。

获取凭证 ​

  • API: get_credentials
  • 描述: 一次性获取 Cookies 和 CSRF Token。

请求参数 ​

字段类型必填默认值说明
domainstring否""目标域名。
json
{
  "domain": "qun.qq.com"
}

响应参数 ​

字段类型说明备注
cookiesstringCookie 字符串。-
tokennumberCSRF Token（bkn）。-
json
{
  "cookies": "",
  "token": 0
}

示例 ​

bash
curl -X POST 'http://127.0.0.1:5700/get_credentials' \
  -H 'Content-Type: application/json' \
  -d '{"domain":"qun.qq.com"}'
js
const res = await fetch('http://127.0.0.1:5700/get_credentials', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    domain: 'qun.qq.com'
  })
})

const body = await res.json()
console.log(body.data.cookies, body.data.token)

错误码 ​

retcode说明
0成功。

检查能否发送图片 ​

  • API: can_send_image
  • 描述: 检查当前实例是否支持发送图片。

请求参数 ​

无。

响应参数 ​

字段类型说明备注
yesboolean是否支持发送图片。-
json
{
  "yes": true
}

示例 ​

bash
curl -X POST 'http://127.0.0.1:5700/can_send_image' \
  -H 'Content-Type: application/json' \
  -d '{}'
js
const res = await fetch('http://127.0.0.1:5700/can_send_image', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({})
})

const body = await res.json()
console.log(body.data.yes)

错误码 ​

retcode说明
0成功。

检查能否发送语音 ​

  • API: can_send_record
  • 描述: 检查当前实例是否支持发送语音。

请求参数 ​

无。

响应参数 ​

字段类型说明备注
yesboolean是否支持发送语音。-
json
{
  "yes": true
}

示例 ​

bash
curl -X POST 'http://127.0.0.1:5700/can_send_record' \
  -H 'Content-Type: application/json' \
  -d '{}'
js
const res = await fetch('http://127.0.0.1:5700/can_send_record', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({})
})

const body = await res.json()
console.log(body.data.yes)

错误码 ​

retcode说明
0成功。

获取在线设备 ​

  • API: get_online_clients
  • 描述: 获取当前账号的其他在线设备列表。

请求参数 ​

字段类型必填默认值说明
no_cacheboolean否-是否不使用缓存。
json
{}

响应参数 ​

字段类型说明备注
clientsobject[]在线设备列表。无其他在线设备时为空数组。
json
{
  "clients": [
    {
      "app_id": 0,
      "device_name": "",
      "device_kind": ""
    }
  ]
}

示例 ​

bash
curl -X POST 'http://127.0.0.1:5700/get_online_clients' \
  -H 'Content-Type: application/json' \
  -d '{}'
js
const res = await fetch('http://127.0.0.1:5700/get_online_clients', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({})
})

const body = await res.json()
console.log(body.data.clients)
py
import requests

resp = requests.post(
    "http://127.0.0.1:5700/get_online_clients",
    json={},
    timeout=10,
)
resp.raise_for_status()
body = resp.json()
print(body["data"]["clients"])

错误码 ​

retcode说明
0成功。无其他在线设备时 clients 为空数组。
1500拉取失败。

获取群系统消息 ​

  • API: get_group_system_msg
  • 描述: 获取群系统消息（加群请求、邀请等）。

请求参数 ​

无。

响应参数 ​

字段类型说明备注
invited_requestsobject[]邀请入群请求列表。无请求时为空数组。
join_requestsobject[]加群请求列表。无请求时为空数组。
json
{
  "invited_requests": [],
  "join_requests": []
}

示例 ​

bash
curl -X POST 'http://127.0.0.1:5700/get_group_system_msg' \
  -H 'Content-Type: application/json' \
  -d '{}'
js
const res = await fetch('http://127.0.0.1:5700/get_group_system_msg', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({})
})

const body = await res.json()
console.log(body.data)
py
import requests

resp = requests.post(
    "http://127.0.0.1:5700/get_group_system_msg",
    json={},
    timeout=10,
)
resp.raise_for_status()
body = resp.json()
print(body["data"])

错误码 ​

retcode说明
0成功。
1500拉取失败。

Copyright © 2026-present icqqjs contributors