您当前的位置:首页 > 电脑百科 > 程序开发 > 移动端 > 百科

开源微信个人号 API | itchat 微信机器人

时间:2022-07-08 14:50:28  来源:  作者:VT漫步

今天来为大家介绍一个有意思的开源微信个人号 API,它是基于 Python/ target=_blank class=infotextkey>Python 调用微信网页版实现,只需要编写少量的代码,就可以完成一个能够处理所有信息的微信机器人。那它到底能实现了什么功能,接下来为大家一一介绍。

安装

想要使用它,首先得安装 itchat 模块:

$ pip3 install itchat

登陆

想要通过 itchat 操作微信接收、发送信息等,第一步需要先登陆微信网页版,为此 itchat 提供了 auto_login 方法,调用这个方法就能实现微信登陆。首先新建 mychat1.py 文件,代码如下:

# mychat1.py
import itchat
from itchat.content import TEXT

@itchat.msg_register(TEXT)   # 注册处理文本信息
def simple_reply(msg):
    print(msg.text)

itchat.auto_login(hotReload=True)  # hotReload=True表示短时间关闭程序后可重连
itchat.run()

然后通过执行命令 python mychat1.py 运行代码,这时会生成一个名为 QR.png 的二维码图片文件,通过扫描这个二维码就可以登陆微信网页版了,这时将会显示如下信息:

Login successfully as 你的微信昵称
Start auto replying.

如果你向这个登陆后的微信发送文本消息,则会直接把你发送的消息内容在终端打印出来。

关于登陆这里还有几点要说明下:

  1. itchat提供了登陆状态暂存,关闭程序后一定时间内不需要扫码即可登录。只需要在 auto_login 方法中传入 hotReload=True 即可。
  2. 为了方便在无图形界面使用itchat,程序内置了命令行二维码的显示。只需要在 auto_login 方法中传入 enableCmdQR=True 即可。
  3. 可以自定义登陆,比如更改提示语、二维码出现后邮件发送等。

关于自定义登陆所需要的方法,登陆的过程按顺序为:

  • 获取二维码uuid,方法名称:get_QRuuid
  • 获取二维码,方法名称:get_QR
  • 判断是否已经登陆成功,方法名称:check_login
  • 获取初始化数据,方法名称:web_init
  • 更新微信相关信息(通讯录、手机登陆状态),方法名称:get_friends、show_mobile_login
  • 循环扫描新信息(开启心跳),方法名称:start_receiving

以上简单介绍了下关于登陆相关的内容,如果想了解更详细信息请查看官方文档。

注册消息方法

itchat 将根据接收到的消息类型寻找对应的已经注册的方法,如果一个消息类型没有对应的注册方法,该消息将会被舍弃,就像我们上面代码只注册了 TEXT 类型的消息才会被打印出来。当然在运行过程当中也可以动态注册方法,注册方式与结果不变。

消息类型

itchat 支持多种类型的消息处理,具体类型和参数详见下表:

参数

类型

Text键值

TEXT

文本

文本内容

MAP

地图

位置文本

CARD

名片

推荐人字典

NOTE

通知

通知文本

SHARING

分享

分享名称

PICTURE

图片/表情

下载方法

RECORDING

语音

下载方法

ATTACHMENT

附件

下载方法

VIDEO

小视频

下载方法

FRIENDS

好友邀请

添加好友所需参数

SYSTEM

系统消息

更新内容的用户或群聊的UserName组成的列表

注册消息

注册消息有两种方法:

  1. 不带具体对象注册,将注册为普通消息的回复方法
  2. 带对象参数注册,对应消息对象将调用该方法
# mychat2.py
import itchat
from itchat.content import TEXT

# 不带具体对象注册,将注册为普通消息的回复方法
@itchat.msg_register(TEXT)
def simple_reply(msg):
    return 'I received: %s' % msg['Text']

# 带对象参数注册,对应消息对象将调用该方法
@itchat.msg_register(TEXT, isFriendChat=True, isGroupChat=True, isMpChat=False)
def text_reply(msg):
    msg.user.send('%s: %s' % (msg.type, msg.text))

itchat.auto_login(hotReload=True)
itchat.run()

然后通过执行命令 python mychat2.py 运行代码,扫码登陆并向该微信号发消息,这时你会发现你向它发什么消息,它会同样回复什么消息,而控制台并没有打印消息,很明显它只调用了带参数对象注册的方法,那么为什么不调用第一个不带对象注册的方法,下面我们就说说注册消息的优先级。

注册消息优先级

多次注册同一类型消息时,遵循以下规则:

  • 后注册消息先于先注册消息
  • 带参数消息先于不带参数消息

依据这两个规则,上例代码只执行第二个带参数注册的方法就很正常了,另外 itchat 还支持动态注册消息,一种方法是生成一个守护线程动态注册消息,另一种是使用 configured_reply 方法,具体如何实现请参考官方文档 。

消息回复

itchat 提供了五种消息回复的方法:

1. send方法

import itchat

# 可发送多种类型消息
itchat.send(msg='文本消息', toUserName=None)
itchat.send('@img@%s' % '表情图片.gif')
itchat.send('@fil@%s' % '文件.docx')
itchat.send('@vid@%s' % '测试.mp4')

参数说明:

  • msg:消息内容。'@fil@文件地址'将会被识别为传送文件,'@img@图片地址'将会被识别为传送图片,'@vid@视频地址'将会被识别为小视频。
  • toUserName:发送对象,如果留空将会发送给自己。

返回值:

  • 发送成功:True
  • 失败:False

2. send_msg方法

send_msg(msg='文本消息', toUserName=None)

参数说明:

  • msg:消息内容,仅文本
  • toUserName:发送对象,如果留空将会发送给自己

返回值:

  • 发送成功:True
  • 失败:False

3. send_file、send_img、send_video方法

send_file(fileDir, toUserName=None)
send_img(fileDir, toUserName=None)
send_video(fileDir, toUserName=None)

参数说明:

  • fileDir:文件路径(不存在该文件时将打印无此文件的提醒)
  • toUserName:发送对象,如果留空将会发送给自己

返回值:

  • 发送成功:True
  • 失败:False

通过以上几种可以看出,几种方法各有特点,可以随自己喜好使用,不过官方推荐直接使用 send 方法。

消息内容

在上面介绍注册消息时,我们知道了 itchat 支持微信回复的以下几种类型的消息,包括:微信初始化消息、文本消息、图片消息、小视频消息、地理位置消息、名片消息、 语音消息、动画表情、普通链接和应用分享、音乐链接、群消息、红包消息、系统消息。接下来我们选几种常见消息和大家简单介绍下。

文本消息

文本消息是最常见的消息,基本格式如下:

MsgType: 1   # 消息类型 
FromUserName: 发送方ID
ToUserName: 接收方ID
Content: 消息内容

图片消息

MsgType: 3   # 消息类型 
FromUserName: 发送方ID
ToUserName: 接收方ID
MsgId: 用于获取图片
Content:
    <msg>
        <img length="6503" hdlength="0" />
        <commenturl></commenturl>
    </msg>

小视频消息

MsgType: 62   # 小视频消息
FromUserName: 发送方ID
ToUserName: 接收方ID
MsgId: 用于获取小视频
Content:
    <msg>
        <img length="6503" hdlength="0" />
        <commenturl></commenturl>
    </msg>

篇幅有限,先展示这几种消息结构,有个大概的认识,更多的消息结构请参考官网文档。

账号类型

我们平时使用微信中,经常接触的三种账号,分别为好友、公众号、群聊。 itchat 为这三种类型的账号分别提供了整体获取和根据条件搜索的方法,接下来我们分别介绍下每种类型的使用方式。

好友

1、好友的获取方法为 get_friends,将会返回完整的好友列表:

  • 其中每个好友为一个字典
  • 列表的第一项为本人的账号信息
  • 传入 update 键为 True 将可以更新好友列表并返回

2、好友的搜索方法为 search_friends,目前有如下四种搜索方式:

  • 仅获取自己的用户信息: search_friends()
  • 获取特定 UserName 的用户信息: search_friends(userName='好友昵称')
  • 获取备注、微信号、昵称中的任何一项等于name键值的用户:search_friends(name='搜索名称')
  • 获取备注、微信号、昵称分别等于相应键值的用户:search_friends(wechatAccount='搜索名称')
  • 以上第3和4项功能可以一同使用:itchat.search_friends(name='小白', wechatAccount='littleboy')

3、更新用户信息的方法为 update_friend,该方法需要传入用户的 UserName,返回指定用户的最新信息。当然也可以传入 UserName 组成的列表,那么相应的也会返回指定用户的最新信息组成的列表。

公众号

1、公众号的获取方法为 get_mps,将会返回完整的公众号列表:

  • 其中每个公众号为一个字典
  • 传入 update 键为 True 将可以更新公众号列表并返回

2、公众号的搜索方法为 search_mps,有两种搜索方法:

  • 获取特定 UserName 的公众号:search_mps(userName='公众号名')
  • 获取名字中含有特定字符的公众号,返回值为一个字典的列表:search_mps(name='littleboy')

群聊

1、群聊的获取方法为 get_chatrooms,将会返回完整的群聊列表:

  • 其中每个群聊为一个字典
  • 传入 update 键为 True 将可以更新群聊列表并返回通讯录中保存的群聊列表
  • 群聊列表为后台自动更新,如果中途意外退出存在极小的概率产生本地群聊消息与后台不同步
  • 为了保证群聊信息在热启动中可以被正确的加载,即使不需要持续在线的程序也需要运行 itchat.run()
  • 如果不想要运行上述命令,请在退出程序前调用 itchat.dump_login_status(),更新热拔插需要的信息

2、群聊的搜索方法为 search_chatrooms,有两种搜索方法,分别是通过传参 userName 和 name 进行搜索,方式同公众号搜索相似。

3、群聊用户列表的获取方法为 update_chatroom,同时需要关注以下几点:

  • 如果想要更新该群聊的其他信息也可以用该方法
  • 群聊在首次获取中不会获取群聊的用户列表,所以需要调用该命令才能获取群聊的成员
  • 该方法需要传入群聊的 UserName,返回特定群聊的详细信息
  • 同样也可以传入 UserName 组成的列表,那么相应的也会返回指定用户的最新信息组成的列表

4、创建、增加、删除群聊用户的方法如下所示:

memberList = itchat.get_friends()[1:]
# 创建群聊,topic键值为群聊名
chatroomName = itchat.create_chatroom(memberList, '测试群聊')
# 删除群聊内的群友
itchat.delete_member_from_chatroom(chatroomName, memberList[0])
# 增加好友进入群聊
itchat.add_member_into_chatroom(chatroomName, memberList[0], useInvitation=False)

不过还需要注意以下几点:

  • 由于之前通过群聊检测是否被好友拉黑的程序,目前这三个方法都被严格限制了使用频率
  • 删除群聊需要本账号为群管理员,否则会失败
  • 将用户加入群聊有直接加入与发送邀请,通过 useInvitation 设置
  • 超过40人的群聊无法使用直接加入的加入方式,特别注意

总结

本文为大家简单介绍了 itchat 所提供的大部分功能,通过这些功能我们完全可以非常方便的开发出一个微信聊天机器人。还有目前微信对新账号有限制,即不能登陆微信网页版,所以这种账号也不能通过 itchat 登陆。另外 GitHub 上也有很多基于 itchat 做的开源机器人项目,有兴趣可以去搜索,再次感谢各位开源作者的贡献。

参考

  • itchat 文档:https://itchat.readthedocs.io/zh/latest/


Tags:API   点击:()  评论:()
声明:本站部分内容及图片来自互联网,转载是出于传递更多信息之目的,内容观点仅代表作者本人,如有任何标注错误或版权侵犯请与我们联系(Email:2595517585@qq.com),我们将及时更正、删除,谢谢。
▌相关推荐
一、Forest1.1 业务需求一般情况下是后端提供接口,前端调用,解决需求,但是有的时候为了方便,复用别人的接口(网上的,公共的第三方接口(短信、天气等)),就出现了后端调用后端接口的情况...【详细内容】
2022-10-27  Tags: API  点击:(20)  评论:(0)  加入收藏
作者:Colin Wu转载自金色财经原文:《新型黑客手法:3Commas API KEY 泄露;在 FTX 等对敲盗币 全过程记录》21日一名杭州用户向吴说爆料:他的 FTX 账户在19日晚突然“疯狂”地进行...【详细内容】
2022-10-26  Tags: API  点击:(12)  评论:(0)  加入收藏
【CSDN 编者按】API是Application Program Interface,应用程序连接接口的缩写,作为数据传输流转的重要通道,API网关更成为云原生时代的重要入口。作者 | 温铭,Apache APISIX PMC...【详细内容】
2022-10-18  Tags: API  点击:(8)  评论:(0)  加入收藏
本期推荐的优质项目是基于 Java开发的微服务聚合网关,是拥有自主知识产权的应用网关国产化替代方案,能够实现热服务编排聚合、自动授权选择、线上服务脚本编码、在线测试、高...【详细内容】
2022-10-06  Tags: API  点击:(45)  评论:(0)  加入收藏
API 网关作为一个存在时间比较长的基础组件,一直致力于提供业务层面的限流限速、身份认证、可观测性等多方面的功能。随着服务端系统的迭代,越来越多的服务开始从裸金属迁移到...【详细内容】
2022-09-29  Tags: API  点击:(56)  评论:(0)  加入收藏
" Type="normal"SectionTitle="他们中的许多人在微服务和 API 之间存在混淆。在本文中,您将对两者都有一个清晰的了解。" Type="normal"@@ 如果您正在阅读此博客,则意味着您已...【详细内容】
2022-09-24  Tags: API  点击:(30)  评论:(0)  加入收藏
钉钉小程序官方文档:文档 - 钉钉开放平台吐槽一下,当时文档很不友好(2019年年底前),还会出现打不开的情况,可能现在会好一些吧???踩过很多坑,边调研边开发模式,技术栈uni-app+TS,以下主...【详细内容】
2022-09-21  Tags: API  点击:(62)  评论:(0)  加入收藏
这次iPhone 14 Pro系列的发布没有让人眼前一亮,特别是药丸挖孔设计让不少人无法接受,但是苹果为了美化开孔而设计的灵动岛功能则获得大批用户的肯定。据了解iPhone 14 Pro系列...【详细内容】
2022-09-20  Tags: API  点击:(85)  评论:(0)  加入收藏
此前,已设计过多应用多平模块的基础开篇。本篇,准备对接微信V2JsApi支付基础模块,并基于此模块实现具体的业务功能逻辑。开发思路如下 微信下单网络请求配置定义微信统一下单网...【详细内容】
2022-09-10  Tags: API  点击:(48)  评论:(0)  加入收藏
微服务网关 数据交互示意图 数据同步 admin与网关进行数据同步。数据同步是指在 shenyu-admin 后台操作数据以后,使用何种策略将数据同步到 Apache ShenYu 网关。Apache Shen...【详细内容】
2022-09-09  Tags: API  点击:(114)  评论:(0)  加入收藏
▌简易百科推荐
本期主角:cola_os,它是一个300多行代码实现的多任务管理的OS,在很多MCU开发中,功能很简单,实时性要求不强,任务多了管理不当又很乱。如果使用RTOS显得太浪费,这时候可以尝试使用使...【详细内容】
2022-09-25  嵌入式Linux  今日头条  Tags:OS   点击:(39)  评论:(0)  加入收藏
今天来为大家介绍一个有意思的开源微信个人号 API,它是基于 Python 调用微信网页版实现,只需要编写少量的代码,就可以完成一个能够处理所有信息的微信机器人。那它到底能实现了...【详细内容】
2022-07-08  VT漫步    Tags:API   点击:(141)  评论:(0)  加入收藏
6月2日,据微信团队官方更新公告,为了提升小程序/小游戏的使用效率,在本次开发中新增FD接口,可以提高文件存取读写速度。 (图片来自:微信开发者公众号) FD接口是微信团队新增的高性...【详细内容】
2022-06-02  雷科技    Tags:微信开发   点击:(85)  评论:(0)  加入收藏
软件特色1、视觉设计师App Builder为我们提供了许多视觉和非视觉控件,我们可以将它放在应用程序的设计器中。 定时器,HTTP客户端,文本输入,按钮和更多可供使用的控件。2、基于...【详细内容】
2022-02-07  快乐咸鱼每一天    Tags:编程工具   点击:(144)  评论:(0)  加入收藏
众所周知,应用安装包的体积会十分影响用户的应用下载速度和安装速度。据 GooglePlay 平台对外发布相关的包大小对转化率影响的数据,我们可以看到随着包大小的增加,安装转化率总...【详细内容】
2022-01-19  像程序那样思考    Tags:Android包   点击:(167)  评论:(0)  加入收藏
我们有时候在音频通话过程中,想要改成视频通话。如果挂断当前的通话再重新发起视频通话就会显得比较麻烦。 因此很多app提供了将音频通话升级成视频通话的功能,同时也有将视频...【详细内容】
2021-12-23  充满元气的java爱好者  博客园  Tags:WebRTC   点击:(236)  评论:(0)  加入收藏
随着移动互联网的发展和智能手机的普及,手机端成为了最大的流量入口,占据着一半以上的流量来源。所以很多企业在开发网站之前,也会考虑到开发手机网站。不过,手机端网站并非是对...【详细内容】
2021-11-03  小刘吃吃吃  搜狐号  Tags:手机网站   点击:(168)  评论:(0)  加入收藏
2010年,谷歌宣布正式退出国内市场,随后,各大厂商推出的手机也不再预装GMS(谷歌移动服务)。 与海外安卓用户不同,国内安卓用户对软件的需求不需要基于来自GMS框架下的Google Play(谷...【详细内容】
2021-10-08  雷科技    Tags:安卓App   点击:(203)  评论:(0)  加入收藏
一、滑屏操作不需要看到欢迎页面,直接做里面的后续操作就好了。也就是我想记住一些用户的习惯, 不要像第一次访问一样,有一个重置与否,给它关闭了。# 重置与否desired_caps["noR...【详细内容】
2021-06-17  美好一点    Tags:Appium   点击:(216)  评论:(0)  加入收藏
架构也因项目而异。不同的项目需求不同,对应的架构也会不同。架构分层API的设计完毕之后。接下来我就会考虑App项目的总体架构了。总体怎样架构,我也以前做过不少尝试。早期的...【详细内容】
2021-05-24  每周IT  今日头条  Tags:App架构   点击:(274)  评论:(0)  加入收藏
站内最新
站内热门
站内头条