跳至主要內容

联系人相关

大约 7 分钟

注意

对于 Shamrock 尚未实现的 API,会在标题添加标记 未实现

获取陌生人信息

该接口用于获取陌生人的信息。

API 端点

/get_stranger_info

参数

字段类型必须说明
user_idint64QQ 号

响应

注意

该 API 可能会返回不存在于以下表格中的字段,请不要作为参考使用。

字段类型说明
user_idint64QQ 号
nicknamestring昵称
ageint32年龄
sexstring性别
extobject扩展字段(一堆垃圾)

获取好友列表

该接口用于获取好友列表。

API 端点

/get_friend_list

参数

提示

该接口无输入参数,除 refresh 参数决定是否刷新数据。可能不是立即生效。

响应

该接口返回的 data 数据为数组,每个元素为一个好友的信息,具体如下。

字段类型说明
user_idint64QQ 号
user_namestring昵称
user_displaynamestring显示名
user_remarkstring备注
ageint32年龄
genderint32性别
group_idint64分组 ID
platformstring平台
term_typestring终端类型

获取单向好友列表 未实现

该接口用于获取单向好友列表。

API 端点

/get_unidirectional_friend_list

参数

提示

该 API 无需参数

响应

响应内容为 json 数组, 每个元素如下:

字段名数据类型说明
user_idint64QQ 号
nicknamestring昵称
sourcestring来源

获取群信息

该接口用于获取群信息。

API 端点

/get_group_info

参数

字段类型必须说明
group_idint64群号

响应

注意

该 API 可能会返回不存在于以下表格中的字段,请不要作为参考使用。

字段类型说明
group_idint64群号
group_namestring群名称
group_remarkstring群备注
group_uinint64群 Uin
adminsList<int64>管理员列表
class_textstring群分类
is_frozenbool是否冻结
max_memberint32最大成员数
max_member_countint32最大成员数
member_numint32成员数量
member_countint32成员数量

获取群列表

该接口用于获取群列表。

API 端点

/get_group_list

参数

提示

该 API 无需参数

响应

该接口返回的 data 数据为数组,每个元素为一个群的信息,具体如下。

字段类型说明
group_idint64群号
group_namestring群名称
group_remarkstring群备注
group_uinint64群 Uin
adminsList<int64>管理员列表
class_textstring群分类
is_frozenbool是否冻结
max_memberint32最大成员数
max_member_countint32最大成员数
member_numint32成员数量
member_countint32成员数量

获取群成员信息

该接口用于获取群成员信息。

API 端点

/get_group_member_info

参数

字段类型必须说明
group_idint64群号
user_idint64QQ 号

响应

字段类型说明
user_idint64QQ 号
group_idint64群号
user_namestring昵称
sexstring性别
titlestring专属头衔
title_expire_timeint64专属头衔过期时间戳
nicknamestring群昵称
user_displaynamestring显示名
distanceint32距离
honorList<int32>群荣誉
join_timeint64入群时间
last_active_timeint64最后发言时间
last_sent_timeint64最后发言时间
unique_namestring群头衔
areastring地区
levelstring成员等级
rolestring角色
unfriendlybool是否不良记录成员
card_changeablebool是否允许修改群名片

获取群成员列表

该接口用于获取群成员列表。

API 端点

/get_group_member_list

参数

字段类型必须说明
group_idint64群号

响应

该接口返回的 data 数据为数组,每个元素为一个群成员的信息,具体如下。

字段类型说明
user_idint64QQ 号
group_idint64群号
user_namestring昵称
sexstring性别
titlestring专属头衔
title_expire_timeint64专属头衔过期时间戳
nicknamestring群昵称
user_displaynamestring显示名
distanceint32距离
honorList<int32>群荣誉
join_timeint64入群时间
last_active_timeint64最后发言时间
last_sent_timeint64最后发言时间
unique_namestring群头衔
areastring地区
levelstring成员等级
rolestring角色
unfriendlybool是否不良记录成员
card_changeablebool是否允许修改群名片

获取群荣誉信息

该接口用于获取群荣誉信息。

API 端点

/get_group_honor_info

参数

字段类型必须说明
group_idint64群号

响应

字段类型说明
group_idint64群号
current_talkativeList<HonorInfo>当前龙王
talkative_listList<HonorInfo>历史龙王
performer_listList<HonorInfo>群聊之火
legend_listList<HonorInfo>群聊炽焰
strong_newbie_listList<HonorInfo>冒尖小春笋
emotion_listList<HonorInfo>快乐之源
allList<HonorInfo>全部荣誉

HonorInfo

字段类型说明
user_idint64QQ 号
nicknamestring昵称
avatarstring头像链接
day_countint32持续天数
idint32ID
descriptionstring描述

获取群系统消息

该接口用于获取群系统消息。

API 端点

/get_group_system_msg

响应

字段类型说明
invited_requestsList<InvitedRequest>邀请消息列表
join_requestsList<JoinRequest>进群消息列表

注意

如果列表不存在任何消息, 将返回 null

InvitedRequest

字段类型说明
request_idint64请求ID
invitor_uinint64邀请者
invitor_nickstring邀请者昵称
group_idint64群号
group_namestring群名
checkedbool是否已被处理
actorint64处理者, 未处理为0
requester_uinint64被邀请者ID
flagstringflag,用于处理请求

JoinRequest

字段类型说明
request_idint64请求ID
requester_uinint64请求者ID
requester_nickstring请求者昵称
messagestring验证消息
group_idint64群号
group_namestring群名
checkedbool是否已被处理
actorint64处理者, 未处理为0
flagstringflag,用于处理请求

获取好友系统消息

该接口用于获取好友系统消息。

API 端点

/get_friend_system_msg

响应

该接口返回的 data 数据为数组,每个元素为一个好友请求的系统信息,具体如下。

字段类型说明
request_idint64请求id
requester_uinint64请求者QQ号
requester_nickstring请求者昵称
sourcestring来源
messagestring附加消息
source_group_namestring来源群名称,仅当从群添加好友时存在
source_group_idint64来源群号,仅当从群添加好友时存在
sexstring请求者性别
agestring请求者年龄
msg_detailstring处理结果
statusstring可选值:已同意已拒绝,为空则表示尚未处理
flagstringflag,用于处理请求

获取精华消息列表

该接口用于获取精华消息列表。

API 端点

/get_essence_msg_list

参数

字段类型说明
group_idint64群号

响应

响应内容为 JSON 数组,每个元素如下:

字段名数据类型说明
sender_idint64发送者QQ 号
sender_nickstring发送者昵称
sender_timeint64消息发送时间
operator_idint64操作者QQ 号
operator_nickstring操作者昵称
operator_timeint64精华设置时间
message_idint32消息ID,可能为0表示找不到消息映射
message_seqint32消息seq

QQ是否在黑名单内

获取好友/陌生人是否处于黑名单列表。

API 端点

/is_blacklist_uin

参数

字段类型必须说明
user_idint64QQ账号

响应

字段类型说明
isbool是否是黑名单