onebot11

Appearance

好友相关API ​

发送好友赞 ​

  • send_like
点击查看请求示例数据
json
{
  "user_id": 123456789,
  "times": 10
}

参数 ​

字段名数据类型默认值说明
user_idnumber-对方 QQ 号
timesnumber1赞的次数，每人每天最多 10 次

补充说明

Bot 非 VIP 时，每人每天最多 10 次
Bot 为 SVIP 时，每人每天最多 20 次
Bot 与 被点赞目标非好友时，可点赞 50 次(概率性成功 实测风控率极高)

响应数据 ​

提示

该 API 没有响应数据

处理加好友请求 ​

  • set_friend_add_request
点击查看请求示例数据
json
{
  "flag": "请求标识",
  "approve": true,
  "remark": "好友的备注"
}

// lagrange
{
  "flag": "string",
  "approve": true,
  "reason": "string" // 可选 拒绝原因
}

参数 ​

字段名数据类型默认值说明
flagstring-加好友请求的标识（需从上报的事件数据中获取）
approvebooleantrue是否同意请求
remarkstring空添加后的好友备注（仅在同意时有效）
  • Lagrange
字段名数据类型默认值说明
flagstring-加好友请求的标识（需从上报的事件数据中获取）
approvebooleantrue是否同意请求
reasonstring空拒绝原因

响应数据 ​

提示

该 API 没有响应数据

获取陌生人信息 ​

  • get_stranger_info
点击查看请求示例数据
json
{
  "user_id": 123456789,
  "no_cache": false // napcat 无效 无此参数
}
点击查看响应示例数据
json
// 特别声明一下 这个结果返回的参数非常多 请以实际为准
{
  "user_id": 123456789,
  "nickname": "某人",
  "sex": "male",
  "age": 20
}

参数 ​

字段名数据类型默认值说明
user_idnumber-QQ 号
no_cachebooleanfalse是否不使用缓存（使用缓存可能更新不及时，但响应更快）
  • NapCat
字段名数据类型默认值说明
user_idnumber-QQ 号

响应数据 ​

字段名数据类型说明
user_idnumber (int64)QQ 号
nicknamestring昵称
sexstring性别
agenumber (int32)年龄

特别声明一下 这个结果返回的参数非常多并且不同 请以实际为准

获取好友列表 ​

  • get_friend_list
点击查看请求示例数据
json
{
  "no_cache": true // 仅napcat有效
}
点击查看响应示例数据
json
[
  {
    "user_id": 123456789,
    "nickname": "某人",
    "remark": "备注"
  }
]
点击查看Lagrange响应示例数据
json
[
  {
    "birthday_year": 0,
    "birthday_month": 0,
    "birthday_day": 0,
    "user_id": 0,
    "age": 0,
    "phone_num": "string",
    "email": "string",
    "category_id": 0,
    "nickname": "string",
    "remark": "string",
    "sex": "string",
    "level": 0
  }
]
点击查看Lagrange响应示例数据
json
[
  {
    "user_id": 0,
    "q_id": "string",
    "nickname": "string",
    "remark": "string",
    "group": {
      "group_id": 0,
      "group_name": "string"
    }
  }
]

参数 ​

提示

该 API 没有响应数据

  • NapCat
字段名数据类型默认值说明
no_cachebooleanfalse是否不使用缓存（使用缓存可能更新不及时，但响应更快）

响应数据 ​

响应内容为 JSON 数组，每个元素如下：

字段名数据类型说明
user_idnumber (int64)QQ 号
nicknamestring昵称
remarkstring备注名
  • NapCat
字段名数据类型说明
user_idnumber (int64)QQ 号
nicknamestring昵称
remarkstring备注名
birthday_yearnumber (int32)生日年份
birthday_monthnumber (int32)生日月份
birthday_daynumber (int32)生日日期
agenumber (int32)年龄
phone_numstring手机号
emailstring邮箱
category_idnumber (int32)分组ID
sexstring性别
levelnumber (int32)等级
  • Lagrange
字段名数据类型说明
user_idnumber (int64)QQ 号
nicknamestring昵称
remarkstring备注名
q_idstringQID
groupobject分组信息
group.group_idnumber (int64)分组ID
group.group_namestring分组名称

获取单向好友列表 ​

  • get_unidirectional_friend_list (gocq拓展)
点击查看响应示例数据
json
[
  {
    "uin": 0,
    "uid": "string",
    "nick_name": "string",
    "age": 0,
    "source": "string"
  }
]

参数 ​

提示

该 API 没有响应数据

响应数据 ​

响应内容为 JSON 数组，每个元素如下：

字段名数据类型说明
user_idnumber单向好友 QQ 号
nicknamestring单向好友昵称
  • NapCat
字段名数据类型说明
uinnumber单向好友 QQ 号
uidstring单向好友 QQ 号
nick_namestring单向好友昵称
agenumber单向好友年龄
sourcestring单向好友来源

删除好友 ​

  • delete_friend (gocq拓展)
点击查看请求示例数据
json
{
  "user_id": 123456789
}
点击查看NapCat请求示例数据
json
{
  "user_id": 123456789,
  "friend_id": 123456789,
  "temp_block": true,
  "temp_both_del": true
}
点击查看Lagrange请求示例数据
json
{
  "user_id": 123456789,
  "block": true,
}
点击查看NapCat响应示例数据
json
{
  "result": 0,
  "errMsg": "string"
}

参数 ​

字段名数据类型默认值说明
user_idnumber-好友 QQ 号

响应数据 ​

提示

该 API 没有响应数据

  • NapCat
字段名数据类型说明
resultnumber结果
errMsgstring错误信息

删除单向好友 ​

  • delete_unidirectional_friend (gocq拓展)
点击查看请求示例数据
json
{
  "user_id": 123456789
}

参数 ​

字段名数据类型默认值说明
user_idnumber-单向好友 QQ 号

响应数据 ​

提示

该 API 没有响应数据

设置好友备注 ​

  • set_friend_remark (NapCat拓展)
点击查看请求示例数据
json
{
  "user_id": 123456789,
  "remark": "新的备注"
}

参数 ​

字段名数据类型默认值说明
user_idnumber-好友QQ号
remarkstring-备注

响应数据 ​

提示

该 API 没有响应数据

获取分类的好友列表 ​

  • get_friends_with_category (NapCat拓展)
点击查看响应示例数据
json
[
  {
    "categoryId": 0,
    "categorySortId": 0,
    "categoryName": "string",
    "categoryMbCount": 0,
    "onlineCount": 0,
    "buddyList": [
      {
        "birthday_year": 0,
        "birthday_month": 0,
        "birthday_day": 0,
        "user_id": 0,
        "age": 0,
        "phone_num": "string",
        "email": "string",
        "category_id": 0,
        "nickname": "string",
        "remark": "string",
        "sex": "string",
        "level": 0
      }
    ]
  }
]

参数 ​

提示

该 API 无需参数

响应数据 ​

响应内容为 JSON 数组，每个元素如下：

字段名数据类型说明
categoryIdnumber分类ID
categorySortIdnumber分类排序ID
categoryNamestring分类名称
categoryMbCountnumber分类人数
onlineCountnumber在线人数
buddyListbuddyList好友列表

buddyList ​

字段名数据类型说明
birthday_yearnumber生日年份
birthday_monthnumber生日月份
birthday_daynumber生日日期
user_idnumber好友QQ号
agenumber年龄
phone_numstring手机号
emailstring邮箱
category_idnumber分类ID
nicknamestring昵称
remarkstring备注
sexstring性别
levelnumber等级

获取可疑好友请求 ​

  • get_doubt_friends_add_request (NapCat拓展)
点击查看响应示例数据
json
[
  {
    "flag": "string",
    "uin": "string",
    "nick": "string",
    "source": "string",
    "reason": "string",
    "msg": "string",
    "group_code": "string",
    "time": "string",
    "type": "string"
  }
]

参数 ​

提示

该 API 无需参数

响应数据 ​

返回内容为 JSON 数组，每个元素如下：

字段名数据类型说明
flagstring请求标识
uinstring好友QQ号
nickstring好友昵称
sourcestring来源
reasonstring原因
msgstring验证消息
group_codestring群号
timestring时间
typestring类型

处理可疑好友请求 ​

  • set_doubt_friends_add_request (NapCat拓展)
点击查看请求示例数据
json
{
  "request_id": "request_id",
  "approve": true // 该参数只允许传递true
}

参数 ​

字段名数据类型默认值说明
request_idstring-请求ID
approvebooleantrue是否同意请求

响应数据 ​

提示

该 API 没有响应数据

好友戳一戳 ​

  • friend_poke (NapCat拓展)
点击查看请求示例数据
json
{
  "user_id": 123456789,
  "target_id": 123456789
}

参数 ​

字段名数据类型默认值说明
user_idnumber-好友QQ号 与 target_id 二选一
target_idnumber-目标QQ号 与 user_id 二选一

响应数据 ​

提示

该 API 没有响应数据