2020-10-10 从零搭建一个企业微信(flask作为后台)

1.首先,你需要拥有一个企业应用,并且获得公司的id以及企业应用secret。

corpid

公司的id可在管理后台“我的企业”-“企业信息”下查看“企业ID”(需要有管理员权限),该图引用自企业微信API文档
2020-10-10 从零搭建一个企业微信(flask作为后台)_第1张图片

secret

企业应用secret在管理后台->“应用与小程序”->“应用->”“基础”,点进某个应用,点开“API”小按钮,即可看到,该图引用自企业微信API文档
2020-10-10 从零搭建一个企业微信(flask作为后台)_第2张图片

在获取这两个信息之后,可以在https://work.weixin.qq.com/api/devtools/devtool.php 地址进行验证

2.接着 当然是 配置回调服务,配置步骤:开发 --> 基本设置 (填写URL Token EncodingAESKey)

  需要有三个配置项,分别是:URLTokenEncodingAESKey

  URL:即用来接收微信消息和事件的接口URL

  Token:自动生成

  EncodingAESKey:自动生成

  (在这里我们首先需要获取将Token,以及  EncodingAESKey记录下来)

  在填写好URL,自动生成了其他两个参数之后,你点击确认按钮一定会显示失败,无法保存等信息,因为你还没有进行验证操作。

3.进行验证操作,这一步可将企业微信服务器与我们的flask后台链接起来。

  在前两步中我们已经获得了进行验证操作所需要的参数

  sToken:Token

  sEncodingAESKey:EncodingAESKey

  sCorpID:也就是企业ID 

  在进行验证操作之前,我们需要了解的是,与微信公众号不同的是,在首发消息方面,企业微信是默认进行加密的,微信公众号中你可以选择加密也可以选择明文。

  也就是说,如果我们需要与企业微信应用进行交互,首先需要解决的便是对企业微信服务器发送过来的密文进行解密,以及对我们后台发送给企业微信服务器的消息进行加密。

  该解决方案其实已经有了,这里不做过多的介绍,直接放出代码,将文件命名为WXBizMsgCrypt_qy.py


"""  python3对企业微信发送给企业后台的消息加解密,支持中文
"""
# ------------------------------------------------------------------------
 
import base64
import string
import random
import hashlib
import time
import struct
import binascii
 
from Crypto.Cipher import AES
import xml.etree.cElementTree as ET
import socket
import ierror
 
"""
关于Crypto.Cipher模块,ImportError: No module named 'Crypto'解决方案
请到官方网站 https://www.dlitz.net/software/pycrypto/ 下载pycrypto。
下载后,按照README中的“Installation”小节的提示进行pycrypto安装。
"""
 
 
class FormatException(Exception):
    pass
 
 
def throw_exception(message, exception_class=FormatException):
    """my define raise exception function"""
    raise exception_class(message)
 
 
class SHA1:
    """计算企业微信的消息签名接口"""
 
    def getSHA1(self, token, timestamp, nonce, encrypt):
        """用SHA1算法生成安全签名
        @param token:  票据
        @param timestamp: 时间戳
        @param encrypt: 密文
        @param nonce: 随机字符串
        @return: 安全签名
        """
        try:
            sortlist = [token, timestamp, nonce, encrypt]
            sortlist.sort()
            sha = hashlib.sha1()
            sha.update(("".join(sortlist)).encode('utf8'))    # python3
            return ierror.WXBizMsgCrypt_OK, sha.hexdigest()
        except Exception as e:
            print(e)
            return ierror.WXBizMsgCrypt_ComputeSignature_Error, None
 
 
class XMLParse:
    """提供提取消息格式中的密文及生成回复消息格式的接口"""
 
    # xml消息模板
    AES_TEXT_RESPONSE_TEMPLATE = """


%(timestamp)s

"""
 
    def extract(self, xmltext):
        """提取出xml数据包中的加密消息
        @param xmltext: 待提取的xml字符串
        @return: 提取出的加密消息字符串
        """
        try:
            xml_tree = ET.fromstring(xmltext)
            encrypt = xml_tree.find("Encrypt")
            return ierror.WXBizMsgCrypt_OK, encrypt.text
        except Exception as e:
            print(e)
            return ierror.WXBizMsgCrypt_ParseXml_Error, None, None
 
    def generate(self, encrypt, signature, timestamp, nonce):
        """生成xml消息
        @param encrypt: 加密后的消息密文
        @param signature: 安全签名
        @param timestamp: 时间戳
        @param nonce: 随机字符串
        @return: 生成的xml字符串
        """
        resp_dict = {
            'msg_encrypt': encrypt,
            'msg_signaturet': signature,
            'timestamp': timestamp,
            'nonce': nonce,
        }
        resp_xml = self.AES_TEXT_RESPONSE_TEMPLATE % resp_dict
        return resp_xml
 
 
class PKCS7Encoder():
    """提供基于PKCS7算法的加解密接口"""
 
    block_size = 32
 
    def encode(self, text):
        """ 对需要加密的明文进行填充补位
        @param text: 需要进行填充补位操作的明文
        @return: 补齐明文字符串
        """
        text_length = len(text)
        # 计算需要填充的位数
        amount_to_pad = self.block_size - (text_length % self.block_size)
        if amount_to_pad == 0:
            amount_to_pad = self.block_size
        # 获得补位所用的字符
        pad = chr(amount_to_pad).encode()
        return text + pad * amount_to_pad
 
    def decode(self, decrypted):
        """删除解密后明文的补位字符
        @param decrypted: 解密后的明文
        @return: 删除补位字符后的明文
        """
        pad = ord(decrypted[-1])
        if pad < 1 or pad > 32:
            pad = 0
        return decrypted[:-pad]
 
 
class Prpcrypt(object):
    """提供接收和推送给企业微信消息的加解密接口"""
 
    def __init__(self, key):
 
        # self.key = base64.b64decode(key+"=")
        self.key = key
        # 设置加解密模式为AES的CBC模式
        self.mode = AES.MODE_CBC
 
    def encrypt(self, text, receiveid):
        """对明文进行加密
        @param text: 需要加密的明文
        @return: 加密得到的字符串
        """
        # 16位随机字符串添加到明文开头
        len_str = struct.pack("I", socket.htonl(len(text.encode())))
        # text = self.get_random_str() + struct.pack("I", socket.htonl(len(text))) + text + receiveid
        text = self.get_random_str() + len_str + text.encode() + receiveid.encode()
        # 使用自定义的填充方式对明文进行补位填充
        pkcs7 = PKCS7Encoder()
        text = pkcs7.encode(text)
        # 加密
        cryptor = AES.new(self.key, self.mode, self.key[:16])
        try:
            ciphertext = cryptor.encrypt(text)
            # 使用BASE64对加密后的字符串进行编码
            return ierror.WXBizMsgCrypt_OK, base64.b64encode(ciphertext).decode('utf8')
        except Exception as e:
            print(e)
            return ierror.WXBizMsgCrypt_EncryptAES_Error, None
 
    def decrypt(self, text, receiveid):
        """对解密后的明文进行补位删除
        @param text: 密文
        @return: 删除填充补位后的明文
        """
        try:
            cryptor = AES.new(self.key, self.mode, self.key[:16])
            # 使用BASE64对密文进行解码,然后AES-CBC解密
            # plain_text = cryptor.decrypt(base64.b64decode(text))                   # python2
            plain_text = cryptor.decrypt(base64.b64decode(text)).decode('utf-8')     # python3
        except Exception as e:
            print(e)
            return ierror.WXBizMsgCrypt_DecryptAES_Error, None
        try:
            pad = ord(plain_text[-1])
            # 去掉补位字符串
            # pkcs7 = PKCS7Encoder()
            # plain_text = pkcs7.encode(plain_text)
            # 去除16位随机字符串
            content = plain_text[16:-pad].encode('utf-8')
            xml_len = socket.ntohl(struct.unpack("I", content[: 4])[0])
            xml_content = content[4: xml_len + 4]
            from_receiveid = content[xml_len + 4:].decode()
        except Exception as e:
            print(e)
            return ierror.WXBizMsgCrypt_IllegalBuffer, None
        if from_receiveid != receiveid:
            return ierror.WXBizMsgCrypt_ValidateCorpid_Error, None
        return 0, xml_content.decode()
 
    def get_random_str(self):
        """ 随机生成16位字符串
        @return: 16位字符串
        """
        # rule = string.letters + string.digits           # python2
        rule = string.ascii_letters + string.digits       # python3
        str = random.sample(rule, 16)
        return "".join(str).encode()
 
 
class WXBizMsgCrypt(object):
    # 构造函数
    def __init__(self, sToken, sEncodingAESKey, sReceiveId):
        try:
            self.key = base64.b64decode(sEncodingAESKey + "=")
            assert len(self.key) == 32
        except:
            throw_exception("[error]: EncodingAESKey unvalid !", FormatException)
            # return ierror.WXBizMsgCrypt_IllegalAesKey,None
        self.m_sToken = sToken
        self.m_sReceiveId = sReceiveId
 
        # 验证URL
        # @param sMsgSignature: 签名串,对应URL参数的msg_signature
        # @param sTimeStamp: 时间戳,对应URL参数的timestamp
        # @param sNonce: 随机串,对应URL参数的nonce
        # @param sEchoStr: 随机串,对应URL参数的echostr
        # @param sReplyEchoStr: 解密之后的echostr,当return返回0时有效
        # @return:成功0,失败返回对应的错误码
 
    def VerifyURL(self, sMsgSignature, sTimeStamp, sNonce, sEchoStr):
        sha1 = SHA1()
        ret, signature = sha1.getSHA1(self.m_sToken, sTimeStamp, sNonce, sEchoStr)
        if ret != 0:
            return ret, None
        if not signature == sMsgSignature:
            return ierror.WXBizMsgCrypt_ValidateSignature_Error, None
        pc = Prpcrypt(self.key)
        ret, sReplyEchoStr = pc.decrypt(sEchoStr, self.m_sReceiveId)
        return ret, sReplyEchoStr
 
    def EncryptMsg(self, sReplyMsg, sNonce, timestamp=None):
        # 将企业回复用户的消息加密打包
        # @param sReplyMsg: 企业号待回复用户的消息,xml格式的字符串
        # @param sTimeStamp: 时间戳,可以自己生成,也可以用URL参数的timestamp,如为None则自动用当前时间
        # @param sNonce: 随机串,可以自己生成,也可以用URL参数的nonce
        # sEncryptMsg: 加密后的可以直接回复用户的密文,包括msg_signature, timestamp, nonce, encrypt的xml格式的字符串,
        # return:成功0,sEncryptMsg,失败返回对应的错误码None
        pc = Prpcrypt(self.key)
        ret, encrypt = pc.encrypt(sReplyMsg, self.m_sReceiveId)
        if ret != 0:
            return ret, None
        if timestamp is None:
            timestamp = str(int(time.time()))
        # 生成安全签名
        sha1 = SHA1()
        ret, signature = sha1.getSHA1(self.m_sToken, timestamp, sNonce, encrypt)
        if ret != 0:
            return ret, None
        xmlParse = XMLParse()
        return ret, xmlParse.generate(encrypt, signature, timestamp, sNonce)
 
    def DecryptMsg(self, sPostData, sMsgSignature, sTimeStamp, sNonce):
        # 检验消息的真实性,并且获取解密后的明文
        # @param sMsgSignature: 签名串,对应URL参数的msg_signature
        # @param sTimeStamp: 时间戳,对应URL参数的timestamp
        # @param sNonce: 随机串,对应URL参数的nonce
        # @param sPostData: 密文,对应POST请求的数据
        #  xml_content: 解密后的原文,当return返回0时有效
        # @return: 成功0,失败返回对应的错误码
        # 验证安全签名
        xmlParse = XMLParse()
        ret, encrypt = xmlParse.extract(sPostData)
        if ret != 0:
            return ret, None
        sha1 = SHA1()
        ret, signature = sha1.getSHA1(self.m_sToken, sTimeStamp, sNonce, encrypt)
        if ret != 0:
            return ret, None
        if not signature == sMsgSignature:
            return ierror.WXBizMsgCrypt_ValidateSignature_Error, None
        pc = Prpcrypt(self.key)
        ret, xml_content = pc.decrypt(encrypt, self.m_sReceiveId)
        return ret, xml_content

  接着我们就能够进行验证操作了,下面放出代码,也就是我们之后主程序的文件。

#-*- coding:utf-8 -*-
from flask import Flask,request, redirect, url_for
from wechatpy.exceptions import InvalidSignatureException
import xml.etree.cElementTree as ET
from WXBizMsgCrypt_qy import WXBizMsgCrypt
import sys
app = Flask(__name__)
import logging

# 下面填写之前步骤获取的参数
sToken = 'Vx.........'
sEncodingAESKey = 'm6.........................................'
sCorpID = 'wx....................'
wxcpt=WXBizMsgCrypt(sToken,sEncodingAESKey,sCorpID)

# 微信消息接口
@app.route('/',methods=["POST","GET"])
def main():
    logging.debug('进入主页面')
    if(len(request.args)<2):
        return redirect(url_for('index'))
    try:
        #获取url验证时微信发送的相关参数
        sVerifyMsgSig=request.args.get('msg_signature')
        sVerifyTimeStamp=request.args.get('timestamp')
        sVerifyNonce=request.args.get('nonce')
        sVerifyEchoStr=request.args.get('echostr')
        #验证url
        if sVerifyEchoStr:
            try:
                print('正在验证服务器签名')
                ret,sEchoStr=wxcpt.VerifyURL(sVerifyMsgSig, sVerifyTimeStamp,sVerifyNonce,sVerifyEchoStr)
                print('验证签名成功')
                return sEchoStr
            except InvalidSignatureException as e:
                print('检查签名出错: '.format(e))
                return 'Check Error'

        #接收客户端消息
        if request.method == 'POST':
            #赋值url验证请求相同的参数,使用上面注释掉的request.form.get方式获取时,测试有问题
            sReqMsgSig = sVerifyMsgSig    
            sReqTimeStamp = sVerifyTimeStamp
            sReqNonce = sVerifyNonce
            sReqData = request.data
            print(sReqData)
            # 
            ret,sMsg=wxcpt.DecryptMsg( sReqData, sReqMsgSig, sReqTimeStamp, sReqNonce)
            print(sMsg)
            #解析发送的内容并打印           
            xml_tree = ET.fromstring(sMsg)
            content = xml_tree.find("Content").text
            print(content)
            #被动响应消息,将微信端发送的消息返回给微信端
            sRespData = '''
                            
                            
                            1348831860
                            
                            
                            1234567890123456
                            1
                            '''
            ret,sEncryptMsg=wxcpt.EncryptMsg(sRespData, sReqNonce, sReqTimeStamp)
            return sEncryptMsg
    # 处理异常情况或忽略
    except Exception as e:
        print("exception")

@app.route('/index',methods=["GET"])
def index():
    print('GET访问')
    return 'The index page'

if __name__ == '__main__':
    app.run(host='0.0.0.0',port='5001',debug=True)

  然后,我们运行这个文件,点击  之前页面里点击了显示失败的按钮,我们会发现成功保存了。

  查看flask后台,会发现每隔几秒微信企业服务器就会发送一次访问请求。

  在企业微信应用里发送消息,会发现后台返回了相同的文字消息。

  如此,我们便实现了服务器与我们的后台的连接,接下来便可以进行自定义的功能实现。

4.接下来分享几个小的技术(后续会持续更新)

  4.1企业微信实现语音识别:

  不同于微信公众号,微信公众号是自带语音识别接口的,不知道为啥企业微信没有(哭。。。)

  所以我们所要做的,便是需要先解密,然后得到语音消息的MediaId,根据MediaId下载得到语音文件,将语音文件进行转码amr->wav,调用API接口(我用了讯飞语音识别,之前我试了个speech_recognition包,可能是因为我用的离线识别,准确率低哭了)得到语音识别文字。

  第一步的解密我们已经解决了,直接调用WXBizMsgCrypt_qy即可。

  第二步直接就可以从解密过的数据中获取到得到语音消息的MediaId

  第三步下载文件,这一步需要进行两个小步骤,首先获取 ACCESS_TOKEN,然后调用下载媒体文件的API获取下载得到语音文件,下面直接贴出代码。

import requests
import os


def get_token_qy(): 
    corpid = 'wx......'
    secrect ='RP.................................'
    token_url='https://qyapi.weixin.qq.com/cgi-bin/gettoken?corpid='+corpid+'&corpsecret='+secrect
    r=requests.get(token_url)
    dict_result= (r.json())
    return dict_result['access_token']

def down_vedio(MEDIA_ID):
    ACCESS_TOKEN= get_token_qy() 
    MEDIA_url ='https://qyapi.weixin.qq.com/cgi-bin/media/get?access_token=' + ACCESS_TOKEN + '&media_id=' + MEDIA_ID
    global MEDIA_name
    MEDIA_name = os.path.dirname(__file__) + '\\MEDIA_FILE\\'+ MEDIA_ID + '.amr'
    r = requests.get(MEDIA_url) 
    with open(MEDIA_name, "wb") as code:
        code.write(r.content)

    第四步转码,这里同样贴出代码


import os
def audio2wav(audio_path):
    """
    任意音频格式转换为wav格式,需要安装ffmpeeg
    """
    output_name=audio_path.replace('.amr','.wav')
    # os.system("ffmpeg -y -i "+ audio_path+ " -acodec pcm_s16le -f s16le -ac 1 -ar 16000 " + output_name )
    os.system("ffmpeg -i "+ audio_path+ " -ac 1 -ar 16000 -ab 12.2k -y " + output_name )

    第五步调用API接口,这个需要自己先去讯飞申请账号并且购买语音识别,该代码就不全贴了,讯飞上有python的demo,直接复制调用就可以了,不过需要注意的是讯飞给的demo里并没有直接的返回识别结果,需要自己再进行处理一下,我贴一下这里的处理代码。


# 收到websocket消息的处理
def on_message(ws, message):
    try:
        code = json.loads(message)["code"]
        sid = json.loads(message)["sid"]
        if code != 0:
            errMsg = json.loads(message)["message"]
            # print("sid:%s call error:%s code is:%s" % (sid, errMsg, code))

        else:
            data = json.loads(message)["data"]["result"]["ws"]
            # print(json.loads(message))
            result = ""
            for i in data:
                for w in i["cw"]:
                    result += w["w"] 
            # 讯飞的语音识别还会返回?。这种结果,这里直接过滤掉不要了
            if len(result)>1:
                global return_mes
                return_mes = result
            # print("sid:%s call success!,data is:%s" % (sid, json.dumps(data, ensure_ascii=False)))
            return
    except Exception as e:
        print("receive msg,but parse exception:", e)

#返回语音识别结果
def ret_video_mes(video_path):
    # 调用格式转换
    audio2wav(video_path) 
    video_path_ot=video_path.replace('.amr','.wav')
    # 测试时候在此处正确填写相关信息即可运行 
    global wsParam
    wsParam = Ws_Param(APPID='。。。。', APIKey='。。。。。。。。。',
                       APISecret='。。。。。。。。。',
                       AudioFile=video_path_ot)
    wsUrl = wsParam.create_url()
    ws = websocket.WebSocketApp(wsUrl, on_message=on_message, on_error=on_error, on_close=on_close)
    ws.on_open = on_open
    ws.run_forever(sslopt={"cert_reqs": ssl.CERT_NONE})  
    mes = return_mes
    return mes

如此便实现了语音的识别

 

   

你可能感兴趣的:(学习进度,python,flask)