Files
WeChatHookBot/docs/内部接口清单.md

3.1 KiB
Raw Blame History

内部接口清单HttpClient

本文档整理当前项目内 HttpClient 封装的低层接口(直接对应 HTTP API。 一般插件请优先使用 WechatHookClient,仅在需要更底层控制时再使用 HttpClient

说明:

  • 这些方法会直接向 Hook HTTP API 发请求。
  • 返回值大多为 booldict(详见方法注释与实现)。

基础

  • await http_client.post(endpoint, data=None) 发送 POST 请求(低层)
  • await http_client.get(endpoint, params=None) 发送 GET 请求(低层)
  • await http_client.close() 关闭客户端
  • await http_client.sqlite_exec(db_name, sql_fmt) 执行 SQLite 查询(新接口)
  • await http_client.get_db_handle() 获取数据库句柄列表(新接口)

消息发送

  • await http_client.send_text(wxid, msg) 发送文本
  • await http_client.send_image(wxid, image_path) 发送图片
  • await http_client.send_file(wxid, file_path) 发送文件
  • await http_client.send_voice(wxid, voice_path) 发送语音(新接口为 silkPath
  • await http_client.send_at_text(room_id, msg, wxids) 群聊 @ 文本
  • await http_client.send_card(wxid, card_wxid) 发送名片
  • await http_client.send_xml(wxid, xml) 发送 XML
  • await http_client.send_app_msg(wxid, appmsg_content, msg_type) 发送 appmsg如链接卡片
  • await http_client.revoke_message(new_msg_id) 撤回消息

好友管理

  • await http_client.get_friend_list() 获取好友列表
  • await http_client.get_friend_info(wxid) 获取好友资料(网络)
  • await http_client.get_friend_info_cache(wxid) 获取好友资料(缓存)
  • await http_client.add_friend(wxid, verify_msg="", scene=3) 添加好友
  • await http_client.accept_friend(v3, v4, scene) 同意好友请求
  • await http_client.delete_friend(wxid) 删除好友
  • await http_client.set_friend_remark(wxid, remark) 修改好友备注

群聊管理

  • await http_client.get_chatroom_members(room_id) 获取群成员列表
  • await http_client.get_chatroom_info(room_id) 获取群信息
  • await http_client.get_group_member_contact(room_id, member_wxid) 获取群成员详细信息(含头像)
  • await http_client.create_chatroom(wxid_list) 创建群聊
  • await http_client.invite_to_chatroom(room_id, wxid_list) 邀请进群
  • await http_client.remove_chatroom_member(room_id, wxid_list) 踢出群成员
  • await http_client.quit_chatroom(room_id) 退出群聊
  • await http_client.set_chatroom_announcement(room_id, announcement) 修改群公告

媒体下载

  • await http_client.cdn_download_image(fileid, aeskey, save_path, img_type=1, timeout=60.0) CDN 下载图片
  • await http_client.download_image(to_user, from_user, msg_id, total_len, save_path) 下载图片
  • await http_client.download_video(msg_id, new_msg_id, total_len, save_path) 下载视频

初始化与个人信息

  • await http_client.wechat_init() 微信初始化好友/群列表缓存
  • await http_client.get_self_info() 获取本人信息(缓存)
  • await http_client.set_nickname(nickname) 修改自己昵称