该类用于该项目多个方法的返回值
该类用于该项目的一些参数,在获取WeChat实例前,可以通过修改该类的属性来修改默认参数
| 属性 | 类型 | 默认值 | 描述 |
|---|---|---|---|
| ENABLE_FILE_LOGGER | bool | True | 是否启用日志文件 |
| DEFAULT_SAVE_PATH | str | ./wxautox | 下载文件/图片默认保存路径 |
| ✨MESSAGE_HASH | bool | False | 是否启用消息哈希值用于辅助判断消息,开启后会稍微影响性能 |
| DEFAULT_MESSAGE_XBIAS | int | 51 | 头像到消息X偏移量,用于消息定位,点击消息等操作 |
| FORCE_MESSAGE_XBIAS | bool | True | 是否强制重新自动获取X偏移量,如果设置为True,则每次启动都会重新获取,系统设置了分辨率缩放时开启 |
| LISTEN_INTERVAL | int | 1 | 监听消息时间间隔,单位秒 |
| ✨LISTENER_EXCUTOR_WORKERS | int | 4 | 监听执行器线程池大小,根据自身需求和设备性能设置 |
| SEARCH_CHAT_TIMEOUT | int | 5 | 搜索聊天对象超时时间,单位秒 |
| ✨NOTE_LOAD_TIMEOUT | int | 30 | 微信笔记加载超时时间,单位秒 |
示例:

| 属性 | 类型 | 描述(以上图为例) |
|---|---|---|
| name | str | 对方名(诸葛孔明) |
| msg | str | 申请信息(wxautox) |
| acceptable | bool | 是否可接受(True) |
同意添加好友
参数:
| 参数名 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| remark | str | None | 备注 |
| tags | list | None | 标签 |
| permission | str | '朋友圈' | 朋友圈权限,可选值:'全部'、'仅聊天' |
删除好友申请
参数:无
回复好友申请
参数:
| 参数名 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| text | str | 必填 | 回复信息 |
获取申请添加的好友的账号信息
{{< callout type="info" >}} 该方法仅接受好友申请后,已经成为好友,才能获取到对方账号信息 {{< /callout >}}
参数:
| 参数名 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| wait | int | 5 | 等待时间 |
返回值:str
{{< cards >}} {{< card link="/docs/example/#6-自动登录" title="👉查看自动登录、二维码示例" tag="点击跳转" tagType="info" >}} {{< /cards >}}
该类用于微信登录、获取二维码等操作

参数:
| 参数名 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| app_path | str | None | 微信客户端路径 |
属性:无
登录微信
参数:
| 参数名 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| timeout | int | 10 | 登录超时时间 |
返回值:WxResponse
获取二维码
参数:
| 参数名 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| path | str | None | 二维码图片的保存路径,None即本地目录下的wxauto_qrcode文件夹 |
返回值:str,二维码图片的路径
重新打开微信,为了避免各种弹窗影响操作,建议调用该方法后再执行login或get_qrcode
参数:无
返回值:无
启动微信,建议在初始化的时候传入app_path参数,否则可能会启动失败
参数:无
返回值:无
微信图片/视频窗口类,用于处理微信图片或图片窗口的各种操作

识别图片中的文字,仅支持图片,不支持视频
参数:
| 参数名 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| wait | int | 10 | 隐性等待时间 |
返回值:str,识别到的文字
保存图片/视频
参数:
| 参数名 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| dir_path | str | None | 保存的目录路径,None即本地路径下自动生成 |
| timeout | int | 10 | 保存超时时间 |
返回值:Path,保存的文件路径
关闭图片/视频窗口
参数:无
返回值:无
微信对话框对象,用于处理微信对话框的各种操作

选择对话框中的选项,如“确定”、“取消”等
参数:无
返回值:WxResponse对象
获取对话框中所有的文字内容
参数:无
返回值:str
关闭对话框
参数:无
返回值:无
获取所有已登录的微信3.9客户端
返回值:List[WeChat]
wxauto项目不支持一切违反官方用户协议的操作,不建议、不支持、不提供微信多开的方法或行为。 但是如果你自行使用其他方法多开微信,wxauto不承担由你自行多开的行为导致的风险,也不保证所有功能的正常调用。
返回值:List[LoginWnd]
wxauto项目不支持一切违反官方用户协议的操作,不建议、不支持、不提供微信多开的方法或行为。 但是如果你自行使用其他方法多开微信,wxauto不承担由你自行多开的行为导致的风险,也不保证所有功能的正常调用。