itchat
itchat是一个开源的微信个人号接口,使用python调用微信从未如此简单。
使用不到三十行的代码,你就可以完成一个能够处理所有信息的微信机器人。
安装
可以通过本命令安装itchat:
pip install itchat
通过该命令判断是否安装成功:
python3 -c "import itchat"
如果没有报错信息说明你已经安装完成。
接下来,让我们一起进入python操作微信的奇妙之旅吧
1. 实现微信消息的获取
itchat的注册时根据类型注册的。微信有各种类型的数据,例如图片、语音、名片、分享等,也对应不同的注册参数:
- 图片对应
itchat.content.PICTURE
- 语音对应
itchat.content.RECORDING
- 名片对应
itchat.content.CARD
- 其余的这里就不一一列举
在获取相应类型的信息时会调用该函数。我们现在只需要获取最简单的文本消息,那么只需要这样注册:
import itchat
@itchat.msg_register(itchat.content.TEXT)
def print_content(msg):
print(msg['Text'])
itchat.auto_login()
itchat.run()
其中第三行即注册的操作,通过消息注册装饰器itchat.msg_register将print_content函数
注册为处理文本消息的函数。
执行命令
python test.py
就可看到我们开始登陆微信(自动下载登录二维码,扫码后登陆成功)。扫码完成以后最基础的文本信息的接收就完成了,你可以尝试用他人的微信给自己发一条信息。
如果你不想要每次运行程序都扫码,可以在登陆命令中进行设置:
itchat.auto_login(hotReload=True)
显然登陆使用的是itchat提供了auto_login
方法,调用即可完成登录。一般而言,我们都会在完成消息的注册后登陆。
当然这里需要特别强调的是三点,分别是短时间关闭重连、命令行二维码与自定义登陆内容。
- itchat提供了登陆状态暂存,关闭程序后一定时间内不需要扫码即可登录。
- 由于目前微信网页版提供上一次登录的微信号不扫码直接手机确认登陆,所以如果开启登陆状态暂存将会自动使用这一功能。
- 为了方便在无图形界面使用itchat,程序内置了命令行二维码的显示。
- 如果你需要就登录状态就一些修改(例如更改提示语、二维码出现后邮件发送等)
入门
1. 最简单的回复
通过如下代码,可以完成回复所有文本信息(包括群聊,公众号)。
import itchat
from itchat.content import TEXT
@itchat.msg_register(TEXT, isFriendChat=True, isGroupChat=True, isMpChat=True)
def simple_reply(msg):
return '我收到: %s' % msg.text
itchat.auto_login(True)
itchat.run()
2. 常用消息的配置(注册)
itchat支持所有的消息类型与群聊,下面的示例中演示了对于这些消息类型简单的配置。
import itchat, time
from itchat.content import *
@itchat.msg_register([TEXT, MAP, CARD, NOTE, SHARING])
def text_reply(msg):
msg.user.send('%s: %s' % (msg.type, msg.text))
@itchat.msg_register([PICTURE, RECORDING, ATTACHMENT, VIDEO])
def download_files(msg):
msg.download(msg.fileName)
typeSymbol = {
PICTURE: 'img',
VIDEO: 'vid', }.get(msg.type, 'fil')
return '@%s@%s' % (typeSymbol, msg.fileName)
@itchat.msg_register(FRIENDS)
def add_friend(msg):
msg.user.verify()
msg.user.send('Nice to meet you!')
@itchat.msg_register(TEXT, isGroupChat=True)
def text_reply(msg):
if msg.isAt:
msg.user.send(u'@%s\u2005I received: %s' % (
msg.actualNickName, msg.text))
itchat.auto_login(True)
itchat.run(True)
登录
1. 登陆——短时间关闭程序后重连
这样即使程序关闭,一定时间内重新开启也可以不用重新扫码。
最简单的用法就是给auto_login
方法传入值为真的hotReload。
该方法会生成一个静态文件itchat.pkl
,用于存储登陆的状态。
import itchat
@itchat.msg_register(itchat.content.TEXT)
def print_content(msg):
print(msg['Text'])
itchat.auto_login(hotReload = True)
itchat.run()
通过设置statusStorageDir可以将静态文件指定为其他的值。
这一内置选项其实就相当于使用了以下两个函数的这一段程序:
import itchat
from itchat.content import TEXT
if itchat.load_login_status():
@itchat.msg_register(TEXT)
def simple_reply(msg):
print(msg['Text'])
itchat.run()
itchat.dump_login_status()
else:
itchat.auto_login()
itchat.dump_login_status()
print('配置已存储,退出')
其中load_login_status与dump_login_status分别对应读取与导出设置。
通过设置传入的fileDir的值可以设定导入导出的文件。
2.登陆—二维码命令行显示
通过以下命令可以在登陆的时候使用命令行显示二维码:
itchat.auto_login(enableCmdQR=True)
部分系统可能字幅宽度有出入,可以通过将enableCmdQR赋值为特定的倍数进行调整:
# 如部分的系统,块字符的宽度为一个字符(正常应为两字符),故赋值为2
itchat.auto_login(enableCmdQR=2)
默认控制台背景色为暗色(黑色),若背景色为浅色(白色),可以将enableCmdQR赋值为负值:
itchat.auto_login(enableCmdQR=-1)
3. 登陆—自定义登录过程
如果需要控制登录的过程,itchat也提供了登陆所需的每一步的方法,登陆的过程按顺序为:
获取二维码uuid,并返回。:
- 方法名称:
get_QRuuid
- 所需值:无
- 返回值:成功->uuid,失败->None
获取二维码:
- 方法名称:
get_QR
- 所需值:uuid
- 返回值:成功->True,失败->False
判断是否已经登陆成功
- 方法名称:
check_login
- 所需值:uuid
- 返回值:登陆成功->'200',已扫描二维码->'201',二维码失效->'408',未获取到信息->'0'
获取初始化数据
- 方法名称:
web_init
- 所需值:无
- 返回值:存储登录微信用户信息的字典
获取微信通讯录
- 方法名称:
get_friends
(曾用名:get_contact
)- 所需值:无
- 返回值:存储好友信息的列表
更新微信相关信息(通讯录、手机登陆状态)
在手机上显示登录状态。
- 方法名称:
show_mobile_login
- 所需值:无
- 返回值:无
循环扫描新信息(开启心跳)
- 方法名称:
start_receiving
- 所需值:无
- 返回值:无
itchat自带的auto_login
通过如下代码可以实现:
import itchat, time, sys
def output_info(msg):
print('[INFO] %s' % msg)
def open_QR():
for get_count in range(10):
output_info('Getting uuid')
uuid = itchat.get_QRuuid()
while uuid is None: uuid = itchat.get_QRuuid();time.sleep(1)
output_info('Getting QR Code')
if itchat.get_QR(uuid): break
elif get_count >= 9:
output_info('Failed to get QR Code, please restart the program')
sys.exit()
output_info('Please scan the QR Code')
return uuid
uuid = open_QR()
waitForConfirm = False
while 1:
status = itchat.check_login(uuid)
if status == '200':
break
elif status == '201':
if waitForConfirm:
output_info('Please press confirm')
waitForConfirm = True
elif status == '408':
output_info('Reloading QR Code')
uuid = open_QR()
waitForConfirm = False
userInfo = itchat.web_init()
itchat.show_mobile_login()
itchat.get_friends(True)
output_info('Login successfully as %s'%userInfo['NickName'])
itchat.start_receiving()
# 开始自动回复
@itchat.msg_register
def simple_reply(msg):
if msg['Type'] == 'Text':
return 'I received: %s' % msg['Content']
itchat.run()
回复
itchat提供五种回复方法,直接建议使用send
方法。
1. send方法
- 方法:
send(msg='Text Message', toUserName=None)
- 所需值:
- msg:消息内容
- '@fil@文件地址'将会被识别为传送文件,'@img@图片地址'将会被识别为传送图片,'@vid@视频地址'将会被识别为小视频
- toUserName:发送对象,如果留空将会发送给自己
- 返回值:发送成功->True, 失败->False
举例:
import itchat
itchat.auto_login()
itchat.send('Hello world!')
# 请确保该程序目录下存在:gz.gif以及xlsx.xlsx
itchat.send('@img@%s' % 'gz.gif')
itchat.send('@fil@%s' % 'xlsx.xlsx')
itchat.send('@vid@%s' % 'demo.mp4')
2.send_msg方法
- 方法:
send_msg(msg='Text Message', toUserName=None)
- 所需值:
- 消息:消息内容
- toUserName:发送对象,如果留空将会发送给自己
- 返回值:发送成功 - >True,失败 - >False
程序示例:
import itchat
itchat.auto_login()
itchat.send_msg('Hello world')
3.由send_file方法
- 方法:
send_file(fileDir, toUserName=None)
- 所需值:
- fileDir:文件路径(不存在该文件时将打印无此文件的提醒)
- toUserName:发送对象,如果留空将会发送给自己
- 返回值:发送成功 - >True,失败 - >False
程序示例:
import itchat
itchat.auto_login()
# 请确保该程序目录下存在:xlsx.xlsx
itchat.send_file('xlsx.xlsx')
4. send_img方法
- 方法:
send_img(fileDir, toUserName=None)
- 所需值:
- fileDir:文件路径(不存在该文件时将打印无此文件的提醒)
- toUserName:发送对象,如果留空将会发送给自己
- 返回值:发送成功 - >True,失败 - >False
程序示例:
import itchat
itchat.auto_login()
# 请确保该程序目录下存在:gz.gif
itchat.send_img('gz.gif')
5. send_video方法
- 方法:
send_video(fileDir, toUserName=None)
- 所需值:
- fileDir:文件路径(不存在该文件时将打印无此文件的提醒)
- toUserName:发送对象,如果留空将会发送给自己
- 返回值:发送成功 - >True,失败 - >False
- 需要保证发送的视频为一个实质的MP4文件
举例:
import itchat
itchat.auto_login()
# 请确保该程序目录下存在:demo.mp4
itchat.send_file('demo.mp4')
注册消息方法
itchat将根据接收到的消息类型寻找对应的已经注册的方法。
如果一个消息类型没有对应的注册方法,该消息将会被舍弃。
在运行过程当中也可以动态注册方法,注册方式与结果不变。
1. 注册
你可以通过两种方式注册消息方法
import itchat
from itchat.content import *
# 不带具体对象注册,将注册为普通消息的回复方法
@itchat.msg_register(TEXT)
def simple_reply(msg):
return 'I received: %s' % msg['Text']
# 带对象参数注册,对应消息对象将调用该方法
@itchat.msg_register(TEXT, isFriendChat=True, isGroupChat=True, isMpChat=True)
def text_reply(msg):
msg.user.send('%s: %s' % (msg.type, msg.text))
2. 消息类型
向注册方法传入的msg包含微信返回的字典的所有内容。
本api增加Text
、Type
(也就是参数)键值,方便操作。
itchat.content中包含所有的消息类型参数,内容如下表所示:
参数 | 类型 | Text键的值 |
---|---|---|
TEXT | 文本 | 文本内容 |
MAP | 地图 | 位置文本 |
CARD | 名片 | 推荐人字典 |
NOTE | 通知 | 通知文本 |
SHARING | 分享 | 分享名称 |
PICTURE | 图片/表情 | 下载方法 |
RECORDING | 语音 | 下载方法 |
ATTACHMENT | 附件 | 下载方法 |
VIDEO | 小视频 | 下载方法 |
FRIENDS | 好友邀请 | 添加好友所需参数 |
SYSTEM | 系统消息 | 更新内容的用户或群聊的UserName组成的列表 |
比如你需要存储发送给你的附件:
@itchat.msg_register(ATTACHMENT)
def download_files(msg):
msg['Text'](msg['FileName'])
值得注意的是,群消息增加了三个键值:
- isAt: 判断是否@本号
- ActualNickName: 实际NickName
- Content: 实际Content
可以通过本程序测试:
import itchat
from itchat.content import TEXT
@itchat.msg_register(TEXT, isGroupChat=True)
def text_reply(msg):
print(msg.isAt)
print(msg.actualNickName)
print(msg.text)
itchat.auto_login()
itchat.run()
3. 注册消息的优先级
优先级分别为:后注册消息先于先注册消息,带参数消息先于不带参数消息。
以下面的两个程序为例:
import itchat
from itchat.content import *
itchat.auto_login()
@itchat.msg_register(TEXT)
def text_reply(msg):
return '这是旧的注册'
@itchat.msg_register(TEXT)
def text_reply(msg):
return '这是新的注册'
itchat.run()
在私聊发送文本时将会回复“这是新的注册”。
import itchat
from itchat.content import *
itchat.auto_login()
@itchat.msg_register
def general_reply(msg):
return '我收到一个 %s' % msg.type
@itchat.msg_register(TEXT)
def text_reply(msg):
return '你私聊我说:%s' % msg.text
itchat.run()
在私聊时发送文本将会回复 ’你私聊我说:
’,其余情况将会回复 “我收到一个....
”。
5. 动态注册消息
动态注册时可以选择将itchat.run()
放入另一线程或使用configured_reply()
方法处理消息。
两种方法分别是:
# 使用另一线程,但注意不要让程序运行终止
import thread
thread.start_new_thread(itchat.run, ())
# 使用configured_reply方法
while 1:
itchat.configured_reply()
# 一些其他的函数
time.sleep(1)
以下给出一个动态注册的例子:
import thread
import itchat
from itchat.content import *
#群聊
replyToGroupChat = True
functionStatus = False
def change_function():
if replyToGroupChat != functionStatus:
if replyToGroupChat:
@itchat.msg_register(TEXT, isGroupChat=True)
def group_text_reply(msg):
if u'关闭' in msg['Text']:
replyToGroupChat = False
return u'已关闭'
elif u'开启' in msg['Text']:
return u'已经在运行'
return u'输入"关闭"或者"开启"测试功能'
else:
@itchat.msg_register(TEXT, isGroupChat=True)
def group_text_reply(msg):
if u'开启' in msg['Text']:
replyToGroupChat = True
return u'重新开启成功'
functionStatus = replyToGroupChat
thread.start_new_thread(itchat.run, ())
while 1:
change_function()
time.sleep(.1)
消息内容
1. 微信一般消息内容
{
"FromUserName": "",
"ToUserName": "",
"Content": "",
"StatusNotifyUserName": "",
"ImgWidth": 0,
"PlayLength": 0,
"RecommendInfo": {},
"StatusNotifyCode": 0,
"NewMsgId": "",
"Status": 0,
"VoiceLength": 0,
"ForwardFlag": 0,
"AppMsgType": 0,
"Ticket": "",
"AppInfo": {},
"Url": "",
"ImgStatus": 0,
"MsgType": 0,
"ImgHeight": 0,
"MediaId": "",
"MsgId": "",
"FileName": "",
"HasProductId": 0,
"FileSize": "",
"CreateTime": 0,
"SubMsgType": 0
}
微信回复的所有消息都遵循上面一格式,下面将就每种消息类型具体分析。
2. 消息的具体内容——微信初始化消息
MsgType: 51
FromUserName: 自己ID
ToUserName: 自己ID
StatusNotifyUserName: 最近联系的联系人ID
Content:
<msg>
<op id='4'>
<username>
# 最近联系的联系人
filehelper,xxx@chatroom,wxid_xxx,xxx,...
</username>
<unreadchatlist>
<chat>
<username>
# 朋友圈
MomentsUnreadMsgStatus
</username>
<lastreadtime>
1454502365
</lastreadtime>
</chat>
</unreadchatlist>
<unreadfunctionlist>
# 未读的功能账号消息,群发助手,漂流瓶等
</unreadfunctionlist>
</op>
</msg>
3. 消息的具体内容——文本消息
MsgType: 1
FromUserName: 发送方ID
ToUserName: 接收方ID
Content: 消息内容
4. 消息的具体内容——图片消息
MsgType: 3
FromUserName: 发送方ID
ToUserName: 接收方ID
MsgId: 用于获取图片
Content:
<msg>
<img length="6503" hdlength="0" />
<commenturl></commenturl>
</msg>
itchat添加了Text键,键值为下载该图片的方法。
5. 消息的具体内容——小视频消息
MsgType: 62
FromUserName: 发送方ID
ToUserName: 接收方ID
MsgId: 用于获取小视频
Content:
<msg>
<img length="6503" hdlength="0" />
<commenturl></commenturl>
</msg>
itchat添加了Text键,键值为下载该视频的方法。
6. 消息的具体内容——地理位置消息
MsgType: 1
FromUserName: 发送方ID
ToUserName: 接收方ID
Content: http://weixin.qq.com/cgi-bin/redirectforward?args=xxx
itchat添加了Text键,键值为该地点的文本形式。
7. 消息的具体内容——名片消息
MsgType: 42
FromUserName: 发送方ID
ToUserName: 接收方ID
Content:
<?xml version="1.0"?>
<msg bigheadimgurl="" smallheadimgurl="" username="" nickname="" shortpy="" alias="" imagestatus="3" scene="17" province="" city="" sign="" sex="1" certflag="0" certinfo="" brandIconUrl="" brandHomeUrl="" brandSubscriptConfigUrl="" brandFlags="0" regionCode="" />
RecommendInfo:
{
"UserName": "xxx", # ID
"Province": "xxx",
"City": "xxx",
"Scene": 17,
"QQNum": 0,
"Content": "",
"Alias": "xxx", # 微信号
"OpCode": 0,
"Signature": "",
"Ticket": "",
"Sex": 0, # 1:男, 2:女
"NickName": "xxx", # 昵称
"AttrStatus": 4293221,
"VerifyFlag": 0
}
itchat添加了Text键,键值为该调用add_friend
需要的属性。
8. 消息的具体内容——语音消息
MsgType: 34
FromUserName: 发送方ID
ToUserName: 接收方ID
MsgId: 用于获取语音
Content:
<msg>
<voicemsg endflag="1" cancelflag="0" forwardflag="0" voiceformat="4" voicelength="1580" length="2026" bufid="216825389722501519" clientmsgid="49efec63a9774a65a932a4e5fcd4e923filehelper174_1454602489" fromusername="" />
</msg>
itchat添加了Text键,键值为下载该语音文件的方法。
9. 消息的具体内容——动画表情
MsgType: 47
FromUserName: 发送方ID
ToUserName: 接收方ID
Content:
<msg>
<emoji fromusername = "" tousername = "" type="2" idbuffer="media:0_0" md5="e68363487d8f0519c4e1047de403b2e7" len = "86235" productid="com.tencent.xin.emoticon.bilibili" androidmd5="e68363487d8f0519c4e1047de403b2e7" androidlen="86235" s60v3md5 = "e68363487d8f0519c4e1047de403b2e7" s60v3len="86235" s60v5md5 = "e68363487d8f0519c4e1047de403b2e7" s60v5len="86235" cdnurl = "http://emoji.qpic.cn/wx_emoji/eFygWtxcoMF8M0oCCsksMA0gplXAFQNpiaqsmOicbXl1OC4Tyx18SGsQ/" designerid = "" thumburl = "http://mmbiz.qpic.cn/mmemoticon/dx4Y70y9XctRJf6tKsy7FwWosxd4DAtItSfhKS0Czr56A70p8U5O8g/0" encrypturl = "http://emoji.qpic.cn/wx_emoji/UyYVK8GMlq5VnJ56a4GkKHAiaC266Y0me0KtW6JN2FAZcXiaFKccRevA/" aeskey= "a911cc2ec96ddb781b5ca85d24143642" ></emoji>
<gameext type="0" content="0" ></gameext>
</msg>
itchat添加了Text键,键值为下载该图片表情的方法。
由于版权问题,部分微信商店提供的表情是无法下载的,注意。
10. 消息的具体内容——普通链接或应用分享消息
MsgType: 49
AppMsgType: 5
FromUserName: 发送方ID
ToUserName: 接收方ID
Url: 链接地址
FileName: 链接标题
Content:
<msg>
<appmsg appid="" sdkver="0">
<title></title>
<des></des>
<type>5</type>
<content></content>
<url></url>
<thumburl></thumburl>
...
</appmsg>
<appinfo>
<version></version>
<appname></appname>
</appinfo>
</msg>
11. 消息的具体内容——音乐链接消息
MsgType: 49
AppMsgType: 3
FromUserName: 发送方ID
ToUserName: 接收方ID
Url: 链接地址
FileName: 音乐名
AppInfo: # 分享链接的应用
{
Type: 0,
AppID: wx485a97c844086dc9
}
Content:
<msg>
<appmsg appid="wx485a97c844086dc9" sdkver="0">
<title></title>
<des></des>
<action></action>
<type>3</type>
<showtype>0</showtype>
<mediatagname></mediatagname>
<messageext></messageext>
<messageaction></messageaction>
<content></content>
<contentattr>0</contentattr>
<url></url>
<lowurl></lowurl>
<dataurl>
http://ws.stream.qqmusic.qq.com/C100003i9hMt1bgui0.m4a?vkey=6867EF99F3684&guid=ffffffffc104ea2964a111cf3ff3edaf&fromtag=46
</dataurl>
<lowdataurl>
http://ws.stream.qqmusic.qq.com/C100003i9hMt1bgui0.m4a?vkey=6867EF99F3684&guid=ffffffffc104ea2964a111cf3ff3edaf&fromtag=46
</lowdataurl>
<appattach>
<totallen>0</totallen>
<attachid></attachid>
<emoticonmd5></emoticonmd5>
<fileext></fileext>
</appattach>
<extinfo></extinfo>
<sourceusername></sourceusername>
<sourcedisplayname></sourcedisplayname>
<commenturl></commenturl>
<thumburl>
http://imgcache.qq.com/music/photo/album/63/180_albumpic_143163_0.jpg
</thumburl>
<md5></md5>
</appmsg>
<fromusername></fromusername>
<scene>0</scene>
<appinfo>
<version>29</version>
<appname>摇一摇搜歌</appname>
</appinfo>
<commenturl></commenturl>
</msg>
12. 消息的具体内容——群消息
MsgType: 1
FromUserName: @@xxx
ToUserName: @xxx
Content:
@xxx:<br/>xxx
itchat增加了三个群聊相关的键值:
- isAt: 判断是否@本号
- ActualNickName: 实际NickName
- Content: 实际Content
13. 消息的具体内容——红包消息
MsgType: 49
AppMsgType: 2001
FromUserName: 发送方ID
ToUserName: 接收方ID
Content: 未知
13. 消息的具体内容——系统消息
MsgType: 10000
FromUserName: 发送方ID
ToUserName: 自己ID
Content:
"你已添加了 xxx ,现在可以开始聊天了。"
"如果陌生人主动添加你为朋友,请谨慎核实对方身份。"
"收到红包,请在手机上查看"
账号
在使用个人微信的过程当中主要有三种账号需要获取,分别为:
- 好友
- 公众号
- 群聊
itchat为这三种账号都提供了整体获取方法与搜索方法。
而群聊多出获取用户列表方法以及创建群聊、增加、删除用户的方法。
这里我们分这三种分别介绍如何使用。最后还介绍了如何通过Uin来唯一的确定好友与群聊。
1. 好友
好友的获取方法为get_friends
,将会返回完整的好友列表。
- 其中每个好友为一个字典
- 列表的第一项为本人的账号信息
- 传入update键为True将可以更新好友列表并返回
好友的搜索方法为search_friends
,有四种搜索方式:
1. 仅获取自己的用户信息
2. 获取特定UserName
的用户信息
3. 获取备注、微信号、昵称中的任何一项等于name
键的值的用户
4. 获取备注、微信号、昵称分别等于相应键值的用户
其中三、四项可以一同使用,下面是示例程序:
# 获取自己的用户信息,返回自己的属性字典
itchat.search_friends()
# 获取特定UserName的用户信息
itchat.search_friends(userName='@abcdefg1234567') #微信号
# 获取任何一项等于name键的值的用户
itchat.search_friends(name='littlecodersh')
# 获取分别对应相应键值的用户
itchat.search_friends(wechatAccount='littlecodersh') #微信号
# 三、四项功能可以一同使用
itchat.search_friends(name='LittleCoder机器人', wechatAccount='littlecodersh')
更新用户信息的方法为update_friend
。
- 该方法需要传入用户的
UserName
,返回指定用户的最新信息 - 同样也可以传入
UserName
组成的列表,那么相应的也会返回指定用户的最新信息组成的列表
memberList = itchat.update_friend('@abcdefg1234567') #用户名
2. 公众号
公众号的获取方法为get_mps
,将会返回完整的公众号列表。
- 其中每个公众号为一个字典
- 传入update键为True将可以更新公众号列表并返回
公众号的搜索方法为search_mps
,有两种搜索方法:
1. 获取特定UserName
的公众号
2. 获取名字中含有特定字符的公众号
如果两项都做了特定,将会仅返回特定UserName
的公众号,下面是示例程序:
# 获取特定UserName的公众号,返回值为一个字典
itchat.search_mps(userName='@abcdefg1234567')
# 获取名字中含有特定字符的公众号,返回值为一个字典的列表
itchat.search_mps(name='LittleCoder') #公众号名字
# 以下方法相当于仅特定了UserName
itchat.search_mps(userName='@abcdefg1234567', name='LittleCoder')
3. 群聊
群聊的获取方法为get_chatrooms
,将会返回完整的群聊列表。
- 其中每个群聊为一个字典
- 传入update键为True将可以更新群聊列表并返回通讯录中保存的群聊列表
- 群聊列表为后台自动更新,如果中途意外退出存在极小的概率产生本地群聊消息与后台不同步
- 为了保证群聊信息在热启动中可以被正确的加载,即使不需要持续在线的程序也需要运行
itchat.run()
- 如果不想要运行上述命令,请在退出程序前调用
itchat.dump_login_status()
,更新热拔插需要的信息
群聊的搜索方法为search_chatrooms
,有两种搜索方法:
1. 获取特定UserName
的群聊
2. 获取名字中含有特定字符的群聊
如果两项都做了特定,将会仅返回特定UserName
的群聊,下面是示例程序:
# 获取特定UserName的群聊,返回值为一个字典
itchat.search_chatrooms(userName='@@abcdefg1234567')
# 获取名字中含有特定字符的群聊,返回值为一个字典的列表
itchat.search_chatrooms(name='LittleCoder')
# 以下方法相当于仅特定了UserName
itchat.search_chatrooms(userName='@@abcdefg1234567', name='LittleCoder')
群聊用户列表的获取方法为update_chatroom
。
- 同样,如果想要更新该群聊的其他信息也可以用该方法
- 群聊在首次获取中不会获取群聊的用户列表,所以需要调用该命令才能获取群聊的成员
- 该方法需要传入群聊的
UserName
,返回特定群聊的详细信息 - 同样也可以传入
UserName
组成的列表,那么相应的也会返回指定用户的最新信息组成的列表
memberList = itchat.update_chatroom('@@abcdefg1234567', detailedMember=True)
创建群聊、增加、删除群聊用户的方法如下所示:
- 由于之前通过群聊检测是否被好友拉黑的程序,目前这三个方法都被严格限制了使用频率
- 删除群聊需要本账号为群管理员,否则会失败
- 将用户加入群聊有直接加入与发送邀请,通过
useInvitation
设置 - 超过40人的群聊无法使用直接加入的加入方式,特别注意
memberList = itchat.get_friends()[1:]
# 创建群聊,topic键值为群聊名
chatroomUserName = itchat.create_chatroom(memberList, 'test chatroom')
# 删除群聊内的用户
itchat.delete_member_from_chatroom(chatroomUserName, memberList[0])
# 增加用户进入群聊
itchat.add_member_into_chatroom(chatroomUserName, memberList[0], useInvitation=False)
4. Uins
Uin 就是微信中用于标识用户的方式,每一个用户、群聊都有唯一且不同的Uin。
那么通过Uin,即使退出了重新登录,也可以轻松的确认正在对话的是上一次登陆的哪一个用户。
但注意,Uin与其他值不同,微信后台做了一定的限制,必须通过特殊的操作才能获取。
最简单来说,首次点开登陆用的手机端的某个好友或者群聊,itchat就能获取到该好友或者群聊的Uin。
如果想要通过程序获取,也可以用程序将某个好友或者群聊置顶(取消置顶)。
这里提供一个提示群聊更新的程序:
import re, sys, json
import itchat
from itchat.content import *
itchat.auto_login(True)
@itchat.msg_register(SYSTEM)
def get_uin(msg):
if msg['SystemInfo'] != 'uins': return
ins = itchat.instanceList[0]
fullContact = ins.memberList + ins.chatroomList + ins.mpList
print('** Uin 更新了 **')
for username in msg['Text']:
member = itchat.utils.search_dict_list(
fullContact, 'UserName', username)
print(('%s: %s' % (
member.get('NickName', ''), member['Uin']))
.encode(sys.stdin.encoding, 'replace'))
itchat.run(True)
每当Uin更新了,就会打印相应的更新情况。
同样的,如果你想要获取Uin更新的情况也通过获取SYSTEM类型消息实现。
部署
1. Windows系统
直接运行即可。
2. Linux系统
若需要后台命令行运行可以:
nohup python run.py &
之后手动打开二维码扫描或者让二维码在命令行显示。
好了,itchat介绍的相当完全了,接下来我们就来实现查看微信撤回消息。
实战——python+itchat实现查看微信撤回消息
完整代码如下(有详细注释):
'''
查看微信撤回消息
'''
import re
import os
import time
import itchat
import platform
from itchat.content import *
#存放接受消息的信息
msg_info = {}
#表情有一个bug,接受信息和接受note的msg_id不一致
face_package = None
#处理接受的消息,放入msg_info字典,对字典中超时消息清理以防内存占用,不存储不具有撤回功能的消息。
#微信中支持撤回的包括【文本,图片,名片,分享,语言,附件,视频,地图(位置)】
#[TEXT, PICTURE, MAP, CARD, SHARING, RECORDING, ATTACHMENT, VIDEO, FRIENDS, NOTE]
@itchat.msg_register([TEXT,PICTURE,MAP,CARD,SHARING,RECORDING,ATTACHMENT,VIDEO,FRIENDS],isFriendChat = True,isMpChat = True)
def handle_msg(msg):
#全局变量
global face_pacakage
#通过格式化本地时间戳获取接受消息的时间
msg_rev_time = time.strftime("%Y-%m-%d %H:%M:%S", time.localtime())
#消息发送人
try:
msg_from = itchat.search_friends(userName=msg['FromUserName'])['NickName']
except:
msg_from = '微信官方账号'
#消息id
msg_id =msg['MsgId']
#发送消息的时间
msg_send_time = msg['CreateTime']
#消息内容
msg_content = None
#消息链接
msg_url = None
#文本或者好友邀请
if msg['Type'] in ['Text','Friends']:
msg_content = msg['Text']
print('[文本/好友邀请]: %s' % msg_content)
#语言,附件,视频,图片
elif msg['Type'] in ['Recording','Attachment','Video','Picture']:
msg_content = msg['FileName']
#保存文件
msg['Text'](str(msg_content))
print('[语言/附件/视频/图片]: %s' % msg_content)
#名片
elif msg['Type'] == 'Card':
msg_content = msg['RecommendInfo']['NickName'] + '的名片,'
if msg['RecommendInfo']['Sex'] == 1:
msg_content += '性别男。'
else:
msg_content += '性别女。'
print('[推荐名片]:%s' % msg_content)
#位置
elif msg['Type'] == 'Map':
x, y, location = re.search\
("<location x=\"(.*?)\" y=\"(.*?)\".*label=\"(.*?)\".*", msg['OriContent']).group(1, 2, 3)
if location is None:
msg_content = r"纬度:" + x.__str__() + ", 经度:" + y.__str__()
else:
msg_content = r"" + location
print('[位置]:%s' % msg_content)
#分享的
elif msg['Type'] == 'Sharing':
msg_content = msg['Text']
msg_url = msg['Url']
print('[分享]: %s' % msg_content)
face_package = msg_content
#更新msg_info字典
msg_info.update(
{
msg_id:{
"msg_from": msg_from,
"msg_send_time": msg_send_time,
"msg_rev_time": msg_rev_time,
"msg_type": msg["Type"],
"msg_content": msg_content,
"msg_url": msg_url
}
}
)
#监听是否有消息撤回(NOTE)并进行相应操作
@itchat.msg_register([NOTE],isFriendChat=True,isGroupChat=True, isMpChat=True)
def send_msg_filehelper(msg):
global face_package
print(msg['Content'])
if "撤回了一条消息" in msg['Content']:
#re匹配最后一次撤回消息的id
recall_msg_id = re.search(r"<msgid>(.*?)</msgid>",msg['Content']).group(1)
#读取msg_info中该id对应的消息
recall_msg = msg_info.get(recall_msg_id)
print('[撤回]: %s' % recall_msg)
#撤回的是表情包
if len(recall_msg_id) < 11:
itchat.send_file(face_package,toUserName = 'filehelper')
os.remove(face_package)
else:
msg_body = itchat.search_friends()['NickName'] +',您好:\n\n['+recall_msg.get('msg_from')+']撤回了一条'+recall_msg.get('msg_type')+\
'消息\n' + recall_msg.get('msg_rev_time')+'\n内容如下:\n'+recall_msg.get('msg_content')
if recall_msg['msg_type'] == 'Sharing':
msg_body = msg_body +"\n就是这个链接:" + recall_msg.get('msg_url')
#将撤回的消息(msg_body)发送到文件助手
itchat.send(msg_body,toUserName = 'filehelper')
#有文件的话也要将文件发送
if recall_msg['msg_type'] in ['Recording','Attachment','Video','Picture']:
file = '@fil@%s' % (recall_msg['msg_content'])
itchat.send(msg=file, toUserName='filehelper')
os.remove(recall_msg['msg_content'])
#一次撤回信息查看后删除msg_info字典中的信息
msg_info.pop(recall_msg_id)
if __name__ == '__main__':
#platform.platform()获取操作系统名称及版本号
if platform.platform()[:7] == 'Windows':
itchat.auto_login(enableCmdQR=False, hotReload=True)
else:
itchat.auto_login(enableCmdQR=True, hotReload=True)
itchat.run()