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

开源微信个人号 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   点击:()  评论:()
声明:本站部分内容及图片来自互联网,转载是出于传递更多信息之目的,内容观点仅代表作者本人,不构成投资建议。投资者据此操作,风险自担。如有任何标注错误或版权侵犯请与我们联系,我们将及时更正、删除。
▌相关推荐
中国三大运营商共同发布通过GSMA Open Gateway认证的一次性密码 API
3月26日,北京:中国三大领先的移动运营商&mdash;&mdash;中国移动、中国电信和中国联通今日发布商用OTP API(一次性密码API)服务,并通过了GSMA Open Gateway认证。此次发布标志着中...【详细内容】
2024-03-26  Search: API  点击:(24)  评论:(0)  加入收藏
如何免费访问和使用Gemini API?
Gemini是谷歌开发的一个新模型。有了Gemini可以为查询提供图像、音频和文本,获得几乎完美的答案。 我们在本教程中将学习Gemini API以及如何在机器上设置它。我们还将探究各...【详细内容】
2024-02-19  Search: API  点击:(65)  评论:(0)  加入收藏
构建 Web API 的两种流行选择:REST vs GraphQL
在 RESTful 和 GraphQL API 之间的选择取决于您的具体用例。RESTful API 适用于需要高可伸缩性的简单应用程序,而 GraphQL 则适用于具有不同数据需求的复杂应用程序。简介RES...【详细内容】
2024-01-09  Search: API  点击:(66)  评论:(0)  加入收藏
FastAPI:高性能Web框架的简介与应用
正文:在当今互联网时代,构建高性能的WebAPI是许多开发人员的关注重点。而FastAPI作为一个现代、快速的Web框架,为基于标准Python类型提示的API构建提供了强大的支持。FastAPI的...【详细内容】
2023-12-27  Search: API  点击:(107)  评论:(0)  加入收藏
理解 Spark 写入 API 的数据处理能力
这张图解释了 Apache Spark DataFrame 写入 API 的流程。它始于对写入数据的 API 调用,支持的格式包括 CSV、JSON 或 Parquet。流程根据选择的保存模式(追加、覆盖、忽略或报...【详细内容】
2023-12-13  Search: API  点击:(154)  评论:(0)  加入收藏
如何在Python中使用ChatGPT API处理实时数据
译者 | 李睿审校 | 重楼OpenAI公司推出的GPT如今已经成为全球最重要的人工智能工具,并精通基于其训练数据处理查询。但是,它不能回答未知话题的问题,例如: 2021年9月之后的近期...【详细内容】
2023-12-13  Search: API  点击:(251)  评论:(0)  加入收藏
伪原创API是什么?六个角度了解伪原创API
伪原创API,听起来可能对许多人来说是一个陌生的术语。然而,在当今数字化时代,尤其是在内容创作和网络营销领域,伪原创API正逐渐崭露头角。在本文中,我将向您深入介绍伪原创API是...【详细内容】
2023-12-11  Search: API  点击:(162)  评论:(0)  加入收藏
使用FastAPI部署YOLO模型的步骤
在计算机视觉领域,You Only Look Once (YOLO) 算法已经崭露头角,成为一种改变游戏规则的算法。它承诺具有卓越准确性的实时目标检测,使其成为从监视和自动驾驶车辆到图像和视频...【详细内容】
2023-12-06  Search: API  点击:(165)  评论:(0)  加入收藏
构建强大REST API的十个最佳实践
在项目开发中,我们经常会使用REST风格进行API的定义,这篇文章为大家提供10条在使用REST API时的最佳实践。希望能够为你带来灵感和帮助。1、使用具体且有意义的资源名称选择能...【详细内容】
2023-12-06  Search: API  点击:(151)  评论:(0)  加入收藏
前端请求到后端API的中间件流程解析
在前端请求到后端API的典型流程中,经过一系列中间件的处理,确保请求的顺利处理和安全性。以下是中间件的详细解析:1. 前端请求用户在前端发起请求,包括请求的URL、参数、以及其...【详细内容】
2023-12-06  Search: API  点击:(127)  评论:(0)  加入收藏
▌简易百科推荐
一文搞明白Hive与数据库区别
Hive 采用了类似SQL 的查询语言 HQL (Hive Query Language),因此很容易将 Hive 理解为数据库。其实Hive 是为数据仓库设计的,是数据仓库的客户端,所以要搞清楚Hive与数据库的区...【详细内容】
2023-11-02    尚硅谷教育  Tags:Hive   点击:(187)  评论:(0)  加入收藏
Google Play上线问题及解决方案
将应用上线到Google Play商店也可能会面临一些问题,在上线应用到Google Play商店之前,确保你充分测试应用,遵循Google Play的开发者政策和要求,以及关注用户的反馈,这些都能帮助...【详细内容】
2023-08-24  北京APP外包    Tags:Google Play   点击:(209)  评论:(0)  加入收藏
Google Play应用成功上架秘籍:如何避免封号、拒审、下架?
Google Play是全球最大的移动应用商店之一,它是运行Android操作系统的设备的官方应用商店。它提供各种数字内容,包括应用程序(应用)、游戏、音乐、书籍等,包括免费和付费选项。这...【详细内容】
2023-08-17  Balen跨境说    Tags:Google play   点击:(290)  评论:(0)  加入收藏
开发移动应用如何高效利用Taro工具
最近公司的一些项目需要跨端框架,技术老大选了Taro,实践了一段时间下来,愈发觉得Taro是个好东西,所以在本篇文章中稍微介绍下。什么是Taro?Taro(或称为Taro框架)是一种用于构建跨平...【详细内容】
2023-06-07  Onegun    Tags:Taro工具   点击:(400)  评论:(0)  加入收藏
如何获得GitHub Copilot并结合VS Code使用?
​译者 | 布加迪审校 | 重楼GitHub Copilot是一种基于AI的代码生成工具。它使用OpenAI的GPT(生成式预训练Transformer)技术来提供建议。它可以根据您正在编写的代码上下文建议...【详细内容】
2023-04-17  布加迪  51CTO  Tags:GitHub   点击:(271)  评论:(0)  加入收藏
全面讲解在Rust中处理错误的有效方法
错误不可避免,可能由于各种原因而发生:从无效的用户输入到网络故障、硬件故障或编程错误,不一而足。错误处理是检测和报告错误并从中恢复的机制,以防程序崩溃或数据损坏。有效的...【详细内容】
2023-04-17  布加迪  51CTO  Tags:Rust   点击:(224)  评论:(0)  加入收藏
DevOps 在移动应用程序开发中的作用是什么?
本文探讨了 DevOps 在移动应用程序开发中扮演的角色以及它如何帮助开发人员和企业。您想将您的移动应用程序开发过程提升到一个新的水平吗?如果您在开发应用程序时实施 DevOp...【详细内容】
2023-04-09  科技狠活与软件技术  今日头条  Tags:DevOps   点击:(222)  评论:(0)  加入收藏
一名C++程序员的 Rust入门初体验
作 者 | 吴强强(去鸿)作者最近尝试写了一些Rust代码,本文主要讲述了对Rust的看法和Rust与C++的一些区别。背景S2在推进团队代码规范时,先后学习了盘古编程规范,CPP core guide...【详细内容】
2023-03-31  阿里云云栖号     Tags:Rust   点击:(246)  评论:(0)  加入收藏
利用微信公众号的图片上传接口,创造属于自己的图床功能!
作为一个技术博主,了不起不是在创作就是在创作的路上(当然偶尔也会有点恰饭文~还指望大家多多支持),特别是在写一些技术文章的时候,经常会用到图片,然而为了在多个平台同步发文,就...【详细内容】
2023-03-27  Java极客技术  微信公众号  Tags:接口   点击:(235)  评论:(0)  加入收藏
移动开发中Docker等容器技术如何落地?
移动应用程序的开发面临着很多挑战,包括开发环境的设置、测试的困难、部署的复杂性等。由于移动应用程序通常需要在多个平台上运行,因此开发人员需要花费大量的时间来构建和测...【详细内容】
2023-03-22  Onegun    Tags:移动开发   点击:(148)  评论:(0)  加入收藏
站内最新
站内热门
站内头条