python的微信库itchat的使用

简介

itchat是一个开源的微信个人号接口，使用python调用微信从未如此简单。使用不到三十行的代码，你就可以完成一个能够处理所有信息的微信机器人。当然，该api的使用远不止一个机器人，更多的功能等着你来发现，比如这些。该接口与公众号接口itchatmp共享类似的操作方式，学习一次掌握两个工具。如今微信已经成为了个人社交的很大一部分，希望这个项目能够帮助你扩展你的个人的微信号、方便自己的生活。

安装

pip  install itchat

简单用例

发消息文本或其他、下载文件、添加好友、登陆等

import itchat, time

@itchat.msg_register(['Text', 'Map', 'Card', 'Note', 'Sharing'])
def text_reply(msg):
    itchat.send('%s: %s'%(msg['Type'], msg['Text']), msg['FromUserName'])

@itchat.msg_register(['Picture', 'Recording', 'Attachment', 'Video'])
def download_files(msg):
    fileDir = '%s%s'%(msg['Type'], int(time.time()))
    msg['Text'](fileDir)
    itchat.send('%s received'%msg['Type'], msg['FromUserName'])
    itchat.send('@%s@%s'%('img' if msg['Type'] == 'Picture' else 'fil', fileDir), msg['FromUserName'])

@itchat.msg_register('Friends')
def add_friend(msg):
    itchat.add_friend(**msg['Text'])
    itchat.get_contract()
    itchat.send('Nice to meet you!', msg['RecommendInfo']['UserName'])

@itchat.msg_register('Text', isGroupChat = True)
def text_reply(msg):
    if msg['isAt']:
        itchat.send(u'@%s\u2005I received: %s'%(msg['ActualNickName'], msg['Content']), msg['FromUserName'])

itchat.auto_login()
itchat.run()

下面解释上诉代码

回复消息

send(msg="Text Message", toUserName=None)
参数
msg : 文本消息内容
@fil@path_to_file : 发送文件
@img@path_to_img : 发送图片
@vid@path_to_video : 发送视频
toUserName : 发送对象, 如果留空, 将发送给自己.
返回值
ture false

#例如
# coding-utf-8
import itchat
itchat.auto_login()
itchat.send("Hello World!")
ithcat.send("@fil@%s" % '/tmp/test.text')
ithcat.send("@img@%s" % '/tmp/test.png')
ithcat.send("@vid@%s" % '/tmp/test.mkv')

注册消息方法

itchat 将根据接受到的消息类型寻找对应的已注册的方法.

如果一个消息类型没有对应的注册方法, 该消息将会被舍弃.

在运行过程中也可以动态注册方法, 注册方式与结果不变.

1.不带具体对象注册, 将注册为普通消息的回复方法.

import itchat
from itchat.content import *
@itchat.msg_register(TEXT)  #这里的TEXT表示如果有人发送文本消息，那么就会调用下面的方法
def simple_reply(msg):
  #这个是向发送者发送消息
  itchat.send_msg('已经收到了文本消息，消息内容为%s'%msg['Text'],toUserName=msg['FromUserName'])
  return "T reveived: %s" % msg["Text"]   #返回的给对方的消息，msg["Text"]表示消息的内容

2.带对象参数注册, 对应消息对象将调用该方法，其中isFriendChat表示好友之间，isGroupChat表示群聊，isMapChat表示公众号

import itchat
from itchat.content import *
 
@itchat.msg_register(TEXT, isFriendChat=True, isGroupChat=True,isMpChat=True)
def text_reply(msg):
  msg.user.send("%s : %s" % (mst.type, msg.text))

消息类型

向注册方法传入的 msg 包含微信返回的字典的所有内容.itchat 增加 Text, Type(也就是参数) 键值, 方便操作.

itcaht.content 中包含所有的消息类型参数, 如下表

参数	l类型	Text 键值
TEXT	文本	文本内容(文字消息)
MAP	地图	位置文本(位置分享)
CARD	名片	推荐人字典(推荐人的名片)
SHARING	分享	分享名称(分享的音乐或者文章等)
PICTURE 下载方法		图片/表情
RECORDING	语音	下载方法
ATTACHMENT	附件	下载方法
VIDEO	小视频	下载方法
FRIENDS	好友邀请	添加好友所需参数
SYSTEM	系统消息	更新内容的用户或群聊的UserName组成的列表
NOTE	通知	通知文本(消息撤回等)

附件的下载与发送

itchat 的附件下载方法存储在 msg 的 Text 键中.
发送的文件名(图片给出的默认文件名), 都存储在 msg 的 FileName 键中.
下载方法, 接受一个可用的位置参数(包括文件名), 并将文件响应的存储.
注意：下载的文件存储在指定的文件中，直接将路径与FileName连接即可，如msg["Text"]('/tmp/weichat'+msg['FileName'])

@itchat.msg_register([PICTURE, RECORDING, ATTACHMENT, VIDEO])
def download_files(msg):
  #msg.download(msg['FileName'])  #这个同样是下载文件的方式
  msg['Text'](msg['FileName'])   #下载文件
  #将下载的文件发送给发送者
  itchat.send('@%s@%s' % ('img' if msg['Type'] == 'Picture' else 'fil', msg["FileName"]), msg["FromUserName"])

群消息

增加了三个键值，如下：

isAt 判断是否@本号

ActualNickName:实际昵称

Content :实际内容

import itcaht
from itchat.content import TEXT
 
@itchat.msg_register(TEXT, isGroupChat=True)
def text_reply(msg):
  if(msg.isAt):  #判断是否有人@自己
  #如果有人@自己，就发一个消息告诉对方我已经收到了信息
  itchat.send_msg("我已经收到了来自{0}的消息，实际内容为{1}".format(msg['ActualNickName'],msg['Text']),toUserName=msg['FromUserName'])
 
itchat.auto_login()
itchat.run()

更多

方法汇总

itchat.add_friend         
itchat.new_instance        
itchat.add_member_into_chatroom  
itchat.originInstance       
itchat.auto_login         
itchat.returnvalues        
itchat.check_login         
itchat.run             
itchat.components         
itchat.search_chatrooms      
itchat.config           
itchat.search_friends       
itchat.configured_reply      
itchat.search_mps         
itchat.content           
itchat.send            
itchat.core            
itchat.send_file          
itchat.Core            
itchat.send_image         
itchat.create_chatroom       
itchat.send_msg          
itchat.delete_member_from_chatroom 
itchat.send_raw_msg        
itchat.dump_login_status      
itchat.send_video         
itchat.get_chatrooms        
itchat.set_alias          
itchat.get_contact         
itchat.set_chatroom_name      
itchat.get_friends         
itchat.set_logging         
itchat.get_head_img        
itchat.set_pinned         
itchat.get_mps           
itchat.show_mobile_login      
itchat.get_msg           
itchat.start_receiving       
itchat.get_QR           
itchat.storage           
itchat.get_QRuuid         
itchat.update_chatroom       
itchat.instanceList        
itchat.update_friend        
itchat.load_login_status      
itchat.upload_file         
itchat.log             
itchat.utils            
itchat.login            
itchat.VERSION           
itchat.logout           
itchat.web_init          
itchat.msg_register