itchat

一. 安裝

$ pip install itchat

特殊的字典使用方式
通過(guò)打印 itchat 的用戶以及注冊(cè)消息的參數(shù), 可以發(fā)現(xiàn)這些值都是字典.

但實(shí)際上 itchat 精心構(gòu)造了相應(yīng)的消息,用戶,群聊,公眾號(hào)等.

其所有的鍵值都可以通過(guò)這一方式訪問(wèn):

@itchat.msg_register(TEXT)
def _(msg):
    # equals to print(msg['FromUserName'])
    print(msg.fromUserName)

屬性名為鍵值首字母小寫后的內(nèi)容.

author = itchat.search_frients(nickName="LittleCoder")[0]
author.send("greeting ,  LittleCoder!")

二. 登錄

一般而言, 會(huì)在完成消息的注冊(cè)后登錄.

強(qiáng)調(diào)三點(diǎn):

• 登錄狀態(tài)緩存, 短時(shí)間關(guān)閉重連, 關(guān)閉程序后一定時(shí)間內(nèi)不需要掃碼即可登錄. 由于目前微信網(wǎng)頁(yè)版提供上一次登錄的微信號(hào)不掃碼直接手機(jī)確認(rèn)登錄, 所以如果開(kāi)啟登錄狀態(tài)暫存, 將會(huì)自動(dòng)使用這一功能.
• 命令行二維碼,
• 自定義登錄內(nèi)容(如更改提示語(yǔ), 二維碼出現(xiàn)后郵件發(fā)送等).

1. 短時(shí)間關(guān)閉程序后重連.

即使程序關(guān)閉,，一定時(shí)間內(nèi)重新開(kāi)啟也可以不用重新掃碼.

使用 auto_login 方法傳入值為真的 hotReload.
該方法會(huì)生成一個(gè)靜態(tài)文件 itchat.pkl, 用于存儲(chǔ)登錄的狀態(tài).

import itchat
from itchat.content import TEXT

@itchat.msg_register(TEXT)
def simple_reply(TEXT):
    print(msg.text)

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

通過(guò)設(shè)置 statusStorageDir 可以將靜態(tài)文件指定為其他的值. 這一內(nèi)置選項(xiàng),相當(dāng)于使用了以下兩個(gè)函數(shù)的這一段程序:

import itchat
from itchat.content import TEXT

if itchat.load_login_status():  # itchat.load_login_status() 用于讀取設(shè)置
    @itchat.msg_register(TEXT):
    def simple_reply(msg):
        print(msg["Text"])

    itchat.run()
    itchat.dump_login_status()  # itchat.dump_login_status() 用于導(dǎo)出設(shè)置

else:
    itchat.auto_login()
    itchat.dump_login_status()
    print("Config stored, so exit.")

通過(guò)設(shè)置傳入的 fileDir 的值, 可以設(shè)定導(dǎo)入導(dǎo)出的文件.

2. 命令行二維碼

通過(guò)如下命令在登錄的時(shí)候, 使用命令行顯示 二維碼.

itchat.auto_login(enableCmdQR=True)

部分系統(tǒng)可能字符寬度有出入, 可以通過(guò)將 enableCmdQR 賦值為特定的倍數(shù)進(jìn)行調(diào)整.

# 如部分 Linux 系統(tǒng), 塊字符的寬度為一個(gè)字符(正常為兩個(gè)字符), 故賦值為 2
itchat.auto_login(enableCmdQR=2)

默認(rèn)控制臺(tái)背景顏色為暗色(黑色), 若背景色為淺色, 可將 enableCmdQR 賦值為負(fù)值:

itchat.auto_login(enableCmdQR=-1)

3. 自定義登錄過(guò)程

itchat 提供了登錄所需的每一步的方法, 登錄的過(guò)程按殊勛為:
1) 獲取二維碼 uuid, 并返回該 uuid

- 方法名稱: `get_QRuuid()`
- 參數(shù): 無(wú)
- 返回值: 成功返回 uuid, 失敗返回 None

2) 獲取二維碼 : 根據(jù)uuid獲取二維碼并打開(kāi).

- 方法名: `get_QR()`
- 參數(shù): uuid
- 返回值: True, False

3) 判斷是否已登錄成功

- 方法名稱: `check_login()`
- 參數(shù): uuid
- 返回值: 200 登錄成功, 201 以掃描二維碼, 408 二維碼失效, 0 未獲取到信息.

4) 獲取初始化數(shù)據(jù): 獲取微信用戶信息以及心跳所需要的數(shù)據(jù).

- 方法名稱: `web_init()`
- 參數(shù): 無(wú)
- 返回值: 存儲(chǔ)登錄微信用戶信息的字典.

5) 獲取微信通訊錄, 獲取微信的所有好友信息并更新

- 方法名稱: `get_frients()`
- 參數(shù): 無(wú)
- 返回值: 存儲(chǔ)好友信息的列表

6) 更新微信手機(jī)登錄狀態(tài), 在手機(jī)上顯示登錄狀態(tài).

- 方法名稱: `show_mobile_login()`
- 參數(shù): 無(wú)
- 返回值: 無(wú)

7) 循環(huán)掃描新信息(開(kāi)啟心跳)

- 方法名稱: `start_receiving()`
- 參數(shù): 無(wú)
- 返回值: 無(wú)

4. auto_login的實(shí)現(xiàn)代碼:

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")
        uuit = itchat.get_QRuuid()
        while uuid is None:
            uuitd = itchat.get_QRuuid();
            time.sleep(1)
        output_info("Getting QR code")
        if itchat.get_QR(uuid):
            break
        elif get_coun >= 9:
            output_info("Failed to get QR code, plz restart the program")
            sys.exit()

    output_info("Plz scan the QE 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("Plz 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()

# start auto-replying
@itchat.msg_register
def simple_reply(msg):
    if msg["Type"] == "Text":
        return "I received: %s" % msg["Content"]

itchat.run()

5. 退出及登錄完成后調(diào)用的特定方法

登錄完成后的方法需要賦值在 loginCallback 中
退出后的方法,需要賦值在 exitCallback 中.

import itchat, time
def lc():
    print("Finash Login!")
def ec():
    print("exit")

itchat.auto_login(loginCallback=lc, exitCallback=ec)
time.sleep()
itchat.logout()

若不設(shè)置 loginCallback 的值, 將會(huì)自動(dòng)刪除二維碼圖片并清空命令行顯示.

6. 用戶多開(kāi)

import itchat
netInstance = itchat.new_instance()
netInstance.auto_login(hotReload=True, statusStorageDir="newInstance.pkl")

@newInstance.msg_register(TEXT)
def reply(msg):
    return msg.text

netInstance.run()

三. 回復(fù)

五種回復(fù)方法, 建議直接使用 send 方法

1. send

• 方法: send(msg="Text Message", toUserName=None)

• 參數(shù):

  • msg : 文本消息內(nèi)容
  • @fil@path_to_file : 發(fā)送文件
  • @img@path_to_img : 發(fā)送圖片
  • @vid@path_to_video : 發(fā)送視頻
  • toUserName : 發(fā)送對(duì)象, 如果留空, 將發(fā)送給自己.
• 返回值: True, 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')

2. send_msg

• 方法: send_msg(msg='Text Message', toUserName=None)
• 參數(shù):
  • msg: 消息內(nèi)容
  • toUserName: 發(fā)送對(duì)象, 如果留空, 將發(fā)送給自己.
• 返回值: True, False

• 示例代碼:

  import itchat
  
  itchat.auto_login()
  itchat.send_msg("hello world.")

3. send_file

• 方法: send_file(fileDir, toUserName=None)
• 參數(shù):
  • fileDir : 文件路徑, 當(dāng)文件不存在時(shí), 將打印無(wú)此文件的提醒.
  • toUserName : 發(fā)送對(duì)象, 如果留空, 將發(fā)送給自己.
• 返回值: True, False

• 示例代碼:

  import itchat
  
  itchat.auto_login()
  itchat.send_file("/tmp/test.txt")

4. send_img

• 方法: send_img(fileDir, toUserName=None)
• 參數(shù):
  • fileDir : 文件路徑, 當(dāng)文件不存在時(shí), 將打印無(wú)此文件的提醒.
  • toUserName : 發(fā)送對(duì)象, 如果留空, 將發(fā)送給自己.
• 返回值: True, False

• 示例代碼:

  import itchat
  
  itchat.auto_login()
  itchat.send_img("/tmp/test.txt")

5. send_video

• 方法: send_video(fileDir, toUserName=None)
• 參數(shù):
  • fileDir : 文件路徑, 當(dāng)文件不存在時(shí), 將打印無(wú)此文件的提醒.
  • toUserName : 發(fā)送對(duì)象, 如果留空, 將發(fā)送給自己.
• 返回值: True, False

• 示例代碼:

  import itchat
  
  itchat.auto_login()
  itchat.send_video("/tmp/test.txt")

四. 注冊(cè)消息方法

itchat 將根據(jù)接受到的消息類型尋找對(duì)應(yīng)的已注冊(cè)的方法.

如果一個(gè)消息類型沒(méi)有對(duì)應(yīng)的注冊(cè)方法, 該消息將會(huì)被舍棄.

在運(yùn)行過(guò)程中也可以動(dòng)態(tài)注冊(cè)方法, 注冊(cè)方式與結(jié)果不變.

1. 注冊(cè)方法:

兩種方法注冊(cè)消息.

• 不帶具體對(duì)象注冊(cè), 將注冊(cè)為普通消息的回復(fù)方法.

  import itchat
  from itchat.content import *
  
  @itchat.msg_register(TEXT)
  def simple_reply(msg):
      return "T reveived: %s" % msg["Text"]

• 帶對(duì)象參數(shù)注冊(cè), 對(duì)應(yīng)消息對(duì)象將調(diào)用該方法.

  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))

2. 消息類型

向注冊(cè)方法傳入的 msg 包含微信返回的字典的所有內(nèi)容.
itchat 增加 Text, Type(也就是參數(shù)) 鍵值, 方便操作.

itcaht.content 中包含所有的消息類型參數(shù), 如下表:

代碼示例: 存儲(chǔ)接受的文件

@itchat.msg_register(ATTACHMENT)
def download_files(msg):
    msg["Text"](msg["FileName"])

附件的下載與發(fā)送
itchat 的附件下載方法存儲(chǔ)在 msg 的 Text 鍵中.

發(fā)送的文件名(圖片給出的默認(rèn)文件名), 都存儲(chǔ)在 msg 的 FileName 鍵中.

下載方法, 接受一個(gè)可用的位置參數(shù)(包括文件名), 并將文件響應(yīng)的存儲(chǔ).

@itchat.msg_register([PICTURE, RECORDING, ATTACHMENT, VIDEO])
def download_files(msg):
    msg.download(msg.fileName)
    itchat.send('@%s@%s' % ('img' if msg['Type'] == 'Picture' else 'fil', msg["FileName"]), msg["FromUserName"])

    return "%s received" % msg["Type"]

如果不需要下載到本地, 僅需要讀取二進(jìn)制串進(jìn)一步處理可以不傳入?yún)?shù), 方法將會(huì)返回圖片的二進(jìn)制串.

@itchat.msg_register([PICTURE, RECORDING, ATTACHMENT, VIDEO])
def download_files(msg):
    with open(msg.fileName, 'wb') as f:
        f.write(msg.download())

群消息增加了三個(gè)鍵值:

• isAt : 判斷是否 @ 本號(hào)
• ActualNickName : 實(shí)際 NickName
• Content : 實(shí)際 Content

測(cè)試程序:

import itcaht
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. 注冊(cè)消息的優(yōu)先級(jí)

優(yōu)先級(jí)規(guī)則:

• 后注冊(cè)消息 > 先注冊(cè)消息
• 帶參數(shù)消息 > 不帶參數(shù)消息

4. 動(dòng)態(tài)注冊(cè)消息

• 將 itchat.run() 放入另一線程

  import thread
  thread.start_new_thread(itcaht.run(), ())

• 使用 configured_reply() 方法處理消息.

  while 1:
      itcaht.configured_reply()
      # some other functions
      time.sleep()

示例:

#coding=utf-8
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'關(guān)閉' in msg["Text"]:
                    replyToGroupChat = False
                    return u"以關(guān)閉"
                elif u"開(kāi)啟" in msg["Text"]:
                    return u"已經(jīng)在運(yùn)行"
                return u'輸入"關(guān)閉" 或者 "開(kāi)啟" 測(cè)試功能'
        else:
            @itcaht.msg_register(TEXT, isGroupCaht=True)
            def group_text_reply(msg):
                if u"開(kāi)啟" in msg["Text"]:
                    replyToGroupChat = True
                    return u"重新開(kāi)啟成功"

        functionStatus = replyToGroupChat

thread.start_new_thread(itcaht.run, ())
while 1:
    change_function()
    time.sleep(1)

# 各類消息的注冊(cè): 通過(guò)如下代碼, 微信已經(jīng)可以就日常的各種信息進(jìn)行獲取與回復(fù).

import  itchat, time
from itchat.content import *

@itchat.msg_register([TEXT, MAP, NOTE, SHARING])
def text_replay(msg):
    msg.user.send('%s %s' % (msg.type, msg.text))

@itchat.msg_register([PICTURE, RECORDING, ATTACHMENT, VIDEO])
def download_file(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_replay(msg):
    if msg.isAt:
        msg.user.send(u'@$s\u2005I received: %s' % (msg.actualNickName, msg.text))

itchat.auto_login(True)
itchat.run(True)    

五. 消息內(nèi)容

1. 微信一般消息內(nèi)容

微信回復(fù)的所有消息都遵循這一格式.

{
    "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. 消息具體內(nèi)容

1) 初始化消息

    MsgType: 51
    FromUserName: 自己ID
    ToUserName: 自己ID
    StatusNotifyUserName: 最近聯(lián)系的聯(lián)系人ID
    Content:
        <msg>
            <op id='4'>
                <username>
                    # 最近聯(lián)系的聯(lián)系人
                    filehelper,xxx@chatroom,wxid_xxx,xxx,...
                </username>
                <unreadchatlist>
                    <chat>
                        <username>
                        # 朋友圈
                            MomentsUnreadMsgStatus
                        </username>
                        <lastreadtime>
                            1454502365
                        </lastreadtime>
                    </chat>
                </unreadchatlist>
                <unreadfunctionlist>
                # 未讀的功能賬號(hào)消息,，群發(fā)助手，漂流瓶等
                </unreadfunctionlist>
            </op>
        </msg>

2) 文本消息

    MsgType: 1
    FromUserName: 發(fā)送方ID
    ToUserName: 接收方ID
    Content: 消息內(nèi)容

3) 圖片消息
itchat 增加了 Text 鍵, 鍵值為 下載該圖片的方法.

    MsgType: 3
    FromUserName: 發(fā)送方ID
    ToUserName: 接收方ID
    MsgId: 用于獲取圖片
    Content:
        <msg>
            <img length="6503" hdlength="0" />
            <commenturl></commenturl>
        </msg>

4) 小視頻消息
itchat 增加了 Text 鍵, 鍵值為 下載該視頻的方法.

    MsgType: 62
    FromUserName: 發(fā)送方ID
    ToUserName: 接收方ID
    MsgId: 用于獲取小視頻
    Content:
        <msg>
            <img length="6503" hdlength="0" />
            <commenturl></commenturl>
        </msg>

5) 地理位置消息
itchat 增加了 Text 鍵, 鍵值為 該地點(diǎn)的文本形式.

    MsgType: 1
    FromUserName: 發(fā)送方ID
    ToUserName: 接收方ID
    Content: http://weixin.qq.com/cgi-bin/redirectforward?args=xxx

6) 名片消息
itchat 增加了 Text 鍵, 鍵值為 該調(diào)用 add_friend 需要的屬性.

    MsgType: 42
    FromUserName: 發(fā)送方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", # 微信號(hào)
            "OpCode": 0, 
            "Signature": "", 
            "Ticket": "", 
            "Sex": 0, # 1:男, 2:女
            "NickName": "xxx", # 昵稱
            "AttrStatus": 4293221, 
            "VerifyFlag": 0
        }

7) 語(yǔ)音消息
itchat 增加了 Text 鍵, 鍵值為 下載該語(yǔ)音文件的方法.

    MsgType: 34
    FromUserName: 發(fā)送方ID
    ToUserName: 接收方ID
    MsgId: 用于獲取語(yǔ)音
    Content:
        <msg>
            <voicemsg endflag="1" cancelflag="0" forwardflag="0" voiceformat="4" voicelength="1580" length="2026" bufid="216825389722501519" clientmsgid="49efec63a9774a65a932a4e5fcd4e923filehelper174_1454602489" fromusername="" />
        </msg>

8) 動(dòng)畫表情
itchat添加了Text鍵,，鍵值為下載該圖片表情的方法,。

由于版權(quán)問(wèn)題，部分微信商店提供的表情是無(wú)法下載的,，注意,。

    MsgType: 47
    FromUserName: 發(fā)送方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./wx_emoji/eFygWtxcoMF8M0oCCsksMA0gplXAFQNpiaqsmOicbXl1OC4Tyx18SGsQ/" designerid = "" thumburl = "http://mmbiz./mmemoticon/dx4Y70y9XctRJf6tKsy7FwWosxd4DAtItSfhKS0Czr56A70p8U5O8g/0" encrypturl = "http://emoji./wx_emoji/UyYVK8GMlq5VnJ56a4GkKHAiaC266Y0me0KtW6JN2FAZcXiaFKccRevA/" aeskey= "a911cc2ec96ddb781b5ca85d24143642" ></emoji> 
            <gameext type="0" content="0" ></gameext>
        </msg>

9) 普通鏈接或應(yīng)用分享消息

    MsgType: 49
    AppMsgType: 5
    FromUserName: 發(fā)送方ID
    ToUserName: 接收方ID
    Url: 鏈接地址
    FileName: 鏈接標(biāo)題
    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>

10) 音樂(lè)鏈接消息

    MsgType: 49
    AppMsgType: 3
    FromUserName: 發(fā)送方ID
    ToUserName: 接收方ID
    Url: 鏈接地址
    FileName: 音樂(lè)名

    AppInfo: # 分享鏈接的應(yīng)用
        {
            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>

11) 群消息
itchat 增加了三個(gè)群聊相關(guān)的鍵值:

• isAt : 判斷是否 @ 本號(hào)
• ActualNickName : 實(shí)際 NickName

• Content : 實(shí)際 Content

  MsgType: 1
  FromUserName: @@xxx
  ToUserName: @xxx
  Content:
      @xxx:<br/>xxx

12) 紅包消息

    MsgType: 49
    AppMsgType: 2001
    FromUserName: 發(fā)送方ID
    ToUserName: 接收方ID
    Content: 未知

13) 系統(tǒng)消息

    MsgType: 10000
    FromUserName: 發(fā)送方ID
    ToUserName: 自己ID
    Content:
        "你已添加了 xxx ，現(xiàn)在可以開(kāi)始聊天了,。"
        "如果陌生人主動(dòng)添加你為朋友,，請(qǐng)謹(jǐn)慎核實(shí)對(duì)方身份。"
        "收到紅包,，請(qǐng)?jiān)谑謾C(jī)上查看"

六. 賬號(hào)類型

itchat 為三種賬號(hào)都提供了 整體獲取方法與搜索方法.

群聊多出了獲取用戶列表方法以及創(chuàng)建群聊,增加/刪除用戶的方法.

1. 好友

• get_friends : 返回完整的好友列表

  • 每個(gè)好友為一個(gè)字典, 其中第一項(xiàng)為本人的賬號(hào)信息;
  • 傳入 update=True, 將更新好友列表并返回, get_friends(update=True).

• search_friends : 好友搜索, 有四種搜索方式

  • 僅獲取自己的用戶信息

    # 獲取自己的用戶信息,，返回自己的屬性字典
    itchat.search_friends()

  • 獲取特定 UserName 的用戶信息

    # 獲取特定UserName的用戶信息
    itchat.search_friends(userName='@abcdefg1234567')

  • 獲取備注,微信號(hào), 昵稱中的任何一項(xiàng)等于name鍵值的用戶. (可以與下一項(xiàng)配置使用.)

    # 獲取任何一項(xiàng)等于name鍵值的用戶
    itchat.search_friends(name='littlecodersh')

  • 獲取備注,微信號(hào), 昵稱分別等于相應(yīng)鍵值的用戶. (可以與上一項(xiàng)配置使用.)

    # 獲取分別對(duì)應(yīng)相應(yīng)鍵值的用戶
    itchat.search_friends(wechatAccount='littlecodersh')
    # 三、四項(xiàng)功能可以一同使用
    itchat.search_friends(name='LittleCoder機(jī)器人', wechatAccount='littlecodersh')

• update_friend : 好友更新

  • 特定用戶: 傳入用戶UserName, 返回指定用戶的最新信息.
  • 用戶列表: 傳入 UserName 組成的列表, 返回用戶最新信息組成的列表.

  memberList = itchat.update_friend('@abcdefg1234567')

2. 公眾號(hào)

• get_mps : 將返回完整的工作號(hào)列表.

  • 每個(gè)公眾號(hào)為一個(gè)字典,
  • 傳入 update=True 將更新公眾號(hào)列表, 并返回.

• search_mps : 有兩種搜索方法:

  • 獲取特定UserName的公眾號(hào)

    # 獲取特定UserName的公眾號(hào),，返回值為一個(gè)字典
    itchat.search_mps(userName='@abcdefg1234567')

  • 獲取名字中還有特定字符的公眾號(hào).

    # 獲取名字中含有特定字符的公眾號(hào),，返回值為一個(gè)字典的列表
    itchat.search_mps(name='LittleCoder')

  • 當(dāng)兩項(xiàng)都是勇士, 將僅返回特定UserName的公眾號(hào).

3. 群聊

• get_chatrooms : 返回完整的群聊列表.

• search_chatrooms : 群聊搜索.

• update_chatroom : 獲取群聊用戶列表或更新該群聊.

  群聊在首次獲取中不會(huì)獲取群聊的用戶列表, 所以需要調(diào)用該命令才能獲取群聊成員.

  • 傳入群聊的 UserName , 返回特定群聊的詳細(xì)信息.
  • 傳入UserName組成的列表, 返回指定用戶的最新信息組成的列表.

  memberList = itchat.update_chatroom('@@abcdefg1234567', detailedMember=True)

• 創(chuàng)建群聊,增加/刪除群聊用戶:

  • 由于之前通過(guò)群聊檢測(cè)是否被好友拉黑的程序, 目前這三個(gè)方法都被嚴(yán)格限制了使用頻率.
  • 刪除群聊需要本賬號(hào)為管理員, 否則無(wú)效.
  • 將用戶加入群聊有直接加入與發(fā)送邀請(qǐng), 通過(guò) useInvitation 設(shè)置.

  • 超過(guò) 40 人的群聊無(wú)法使用直接加入的加入方式.

    memberList = itchat.get_frients()[1:]
    # 創(chuàng)建群聊, topic 鍵值為群聊名稱.
    chatroomUserName = itchat.create_chatroom(memberList, "test chatroom")
    # 刪除群聊內(nèi)的用戶
    itchat.delete_member_from_chatroom(chatroomUserName, memberList[0])
    # 增加用戶進(jìn)入群聊.
    itchat.add_member_into_chatroom(chatroomUserName, memberList[0], useInvitation=False)

4. Uins : 通過(guò)Uin唯一的確定好友與群聊。

Uin 是微信中用于標(biāo)識(shí)用戶的方式, 每一個(gè)用戶/群聊都有唯一且不同的 Uin.
通過(guò) Uin, 即使退出了重新登錄, 也可以輕松的確認(rèn)正在對(duì)話的是上一次登錄的哪一個(gè)用戶.

Uin 與其他值不同, 微信后臺(tái)做了一些限制, 必須通過(guò)特殊的操作才能獲取. 首次點(diǎn)開(kāi)登錄用的手機(jī)端的某個(gè)好友或者群聊, itchat 就能獲取到該好友或者群聊 Uin. 如果想要通過(guò)程序獲取, 可以用程序?qū)⒛硞€(gè)好友或者群聊置頂(取消置頂).

示例程序:

import re, sys, json
import itchat
from itchat.content import *

itcaht.auto_login()

@itchat.msg_register(SYSTEM)
def get_uin(msg):
    if msg["SystemInfo"] != 'unis':
        return
    ins = itchat.instanceList[0]
    fullContact = ins.memberList + ins.chatroomList + ins.mpList
    print("** Uin updated **")
    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)

每當(dāng) Uin 更新了, 就會(huì)打印相應(yīng)的更新情況. 同樣, 吐過(guò)希望獲取 Uin 更新的情況, 也統(tǒng)過(guò)獲取SYSTEM類型的消息實(shí)現(xiàn).

七. Q & A

1. 中文文件名文件上傳

   Q: 為什么中文的文件沒(méi)有辦法上傳,？

   A: 這是由于requests的編碼問(wèn)題導(dǎo)致的,。若需要支持中文文件傳輸，將fields.py(py3版本見(jiàn)這里)文件放入requests包的packages/urllib3下即可

2. 命令行顯示二維碼

   Q: 為什么我在設(shè)定了itchat.auto_login()的enableCmdQR為True后還是沒(méi)有辦法在命令行顯示二維碼,？

   A: 這是由于沒(méi)有安裝可選的包pillow,，可以使用右邊的命令安裝：pip install pillow

3. 如何通過(guò)itchat實(shí)現(xiàn)控制器

   Q: 如何通過(guò)這個(gè)包將自己的微信號(hào)變?yōu)榭刂破鳎?/p>

   A: 有兩種方式：發(fā)送、接受自己UserName的消息,；發(fā)送接收文件傳輸助手（filehelper）的消息

八. itchat 方法匯總:

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

九. Github

itchat