前言:
前段时间因为公司业务需求,需要将微信小程序与企业微信对接通,也就是把小程序绑定到对应的企业微信账号下,在该企业微信的用户可以将该小程序绑定到工作台中,然后可以在工作台中打开该小程序并授权。不过将微信小程序与企业微信对接通需要后台去做数据回调URL和指令回调URL验证,因为第一次接触这个然后企业微信文档写的也不是很详细,并且在全网没有找到一篇.NET相关企业微信回调配置验证有用的文章,所以这里把自己的配置详细过程分享出来,希望能够帮助更多的同学。
企业微信回调配置相关文档
回调配置:
主要讲的是回调配置的一些验证流程和请求接口。
C#解密类库:
https://open.work.weixin.qq.com/wwopen/downloadfile/csharp.zip
.NET6完整示例代码
别忘了给我个Star哦!!!
企业微信回调配置验证完整流程
注意:配置回调服务时,需要能同时支持HttpGet以及HttpPost两种能力,注意接口一定要是https的安全域名地址。
- HttpGet接口用于验证数据回调URL有效性
- HttpPost接口用于验证指令回调URL有效性
所以我们可以只定义一个接口,通过企业微信请求过来的类型进行不同回调URL的有效性验证。
处理企业号的信息接口:
public class EnterpriseWechatCallbackController : Controller { //企业微信后台开发者设置的token, corpID, EncodingAESKey private readonly string sToken = "追逐时光者";//企业微信后台,开发者设置的Token private readonly string sCorpID = "追逐时光者";//企业号corpid是企业号的专属编号(CorpID)[不同场景含义不同,详见文档说明(ToUserName:企业微信的CorpID,当为第三方应用回调事件时,CorpID的内容为suiteid)] private readonly string sEncodingAESKey = "追逐时光者";//企业微信后台,开发者设置的EncodingAESKey /// <summary> /// 处理企业号的信息 /// get:数据回调URL验证; /// post:指令回调URL验证; /// </summary> public ActionResult EtWechatCommunication() { string httpMethod = Request.HttpMethod.ToUpper(); if (httpMethod == "POST") { //获取请求中的xml数据 string postString = GetXMLParameters(Request); string responseContent = "响应失败,未获取到xml中的请求参数"; if (!string.IsNullOrEmpty(postString)) { //指令响应回调 responseContent = CommandCallback(Request, postString); } return Content(responseContent); } else { return EtWachatCheckVerifyURL(); } } /// <summary> /// 数据回调URL验证 /// </summary> /// <returns></returns> public ActionResult EtWachatCheckVerifyURL() { string signature = Request.QueryString["msg_signature"];//微信加密签名,msg_signature结合了企业填写的token、请求中的timestamp、nonce参数、加密的消息体 string timestamp = Request.QueryString["timestamp"];//时间戳 string nonce = Request.QueryString["nonce"];//随机数 string httpMethod = Request.HttpMethod.ToUpper(); if (httpMethod == "GET")//验证回调URL(注意:企业回调的url-该url不做任何的业务逻辑,仅仅微信查看是否可以调通) { try { //在1秒内响应GET请求,响应内容为上一步得到的明文消息内容decryptEchoString(不能加引号,不能带bom头,不能带换行符) string echostr = Request.QueryString["echostr"];//加密的随机字符串,以msg_encrypt格式提供。需要解密并返回echostr明文,解密后有random、msg_len、msg、$CorpID四个字段,其中msg即为echostr明文 if (!IsNullOrWhiteSpace(signature) && !IsNullOrWhiteSpace(timestamp) && !IsNullOrWhiteSpace(nonce) && !IsNullOrWhiteSpace(echostr)) { string decryptEchoString = null; if (CheckVerifyURL(sToken, signature, timestamp, nonce, sCorpID, sEncodingAESKey, echostr, ref decryptEchoString)) { if (!string.IsNullOrEmpty(decryptEchoString)) { //必须要返回解密之后的明文 return Content(decryptEchoString); } } } else { return Content("fail"); } } catch (Exception ex) { return Content("fail"); } } return Content("fail"); } /// <summary> /// 验证URL有效性 /// </summary> /// <param name="token">企业微信后台,开发者设置的Token</param> /// <param name="signature">签名串,对应URL参数的msg_signature</param> /// <param name="timestamp">时间戳</param> /// <param name="nonce">随机数</param> /// <param name="corpId">ToUserName为企业号的CorpID</param> /// <param name="encodingAESKey">企业微信后台,开发者设置的EncodingAESKey</param> /// <param name="echostr">随机串,对应URL参数的echostr</param> /// <param name="retEchostr">解密之后的echostr,当return返回0时有效</param> /// <returns></returns> private bool CheckVerifyURL(string token, string signature, string timestamp, string nonce, string corpId, string encodingAESKey, string echostr, ref string retEchostr) { WXBizMsgCrypt wxcpt = new WXBizMsgCrypt(token, encodingAESKey, corpId); int result = wxcpt.VerifyURL(signature, timestamp, nonce, echostr, ref retEchostr); if (result != 0) { return false;//FAIL } //result==0表示验证成功、retEchostr参数表示明文 //用户需要将retEchostr作为get请求的返回参数、返回给企业微信号 return true; } /// <summary> /// 指令响应回调 /// </summary> /// <param name="Request"></param> /// <param name="postString">post请求的xml参数</param> /// <returns></returns> private string CommandCallback(HttpRequestBase Request, string postString) { string signature = Request.QueryString["msg_signature"];//微信加密签名,msg_signature结合了企业填写的token、请求中的timestamp、nonce参数、加密的消息体 string timestamp = Request.QueryString["timestamp"];//时间戳 string nonce = Request.QueryString["nonce"];//随机数 var xmlDoc = XDocument.Parse(postString);//xml数据转化 try { //https://work.weixin.qq.com/api/doc/90001/90143/90613 //在发生授权、通讯录变更、ticket变化等事件时,企业微信服务器会向应用的“指令回调URL”推送相应的事件消息。 //消息结构体将使用创建应用时的EncodingAESKey进行加密(特别注意, 在第三方回调事件中使用加解密算法,receiveid的内容为suiteid),请参考接收消息解析数据包。 本章节的回调事件,服务商在收到推送后都必须直接返回字符串 “success”,若返回值不是 “success”,企业微信会把返回内容当作错误信息。 if (xmlDoc.Root.Element("Encrypt") != null) { //将post请求的数据进行xml解析,并将<Encrypt> 标签的内容进行解密,解密出来的明文即是用户回复消息的明文 //接收并读取POST过来的XML文件流 string decryptionParame = null; // 解析之后的明文 // 注意注意:sCorpID // @param sReceiveId: 不同场景含义不同,详见文档说明([消息加密时为 CorpId]ToUserName:企业微信的CorpID,当为第三方应用回调事件时,CorpID的内容为suiteid) WXBizMsgCrypt crypt = new WXBizMsgCrypt(sToken, sEncodingAESKey, xmlDoc.Root.Element("ToUserName").Value); var result = crypt.DecryptMsg(signature, timestamp, nonce, postString, ref decryptionParame); if (result != 0) { return "fial"; } //响应应答处理 return new InstructionCallbackResponse().ReceiveResponse(decryptionParame, timestamp, signature,sToken, sEncodingAESKey, sCorpID); } } catch (Exception ex) { //LoggerHelper._.Debug("异常:" + ex.Message); } return "fail"; } /// <summary> /// 验证是否为空 /// </summary> /// <param name="strParame">验证参数</param> /// <returns></returns> private bool IsNullOrWhiteSpace(string strParame) { if (string.IsNullOrWhiteSpace(strParame)) { return true; } else { return false; } } /// <summary> /// 获取post请求中的xml参数 /// </summary> /// <returns></returns> private string GetXMLParameters(HttpRequestBase Request) { string replyMsg; using (Stream stream = Request.InputStream) { Byte[] postBytes = new Byte[stream.Length]; stream.Read(postBytes, 0, (Int32)stream.Length); replyMsg = Encoding.UTF8.GetString(postBytes); } return replyMsg; } }
指令回调响应应答处理:
/// <summary> /// 指令回调响应应答处理 /// </summary> public class InstructionCallbackResponse { /// <summary> /// 响应应答处理 /// </summary> /// <param name="sMsg">解密参数</param> /// <param name="timestamp">时间戳</param> /// <param name="signature">签名</param> /// <param name="sToken">企业微信后台,开发者设置的Token</param> /// <param name="sEncodingAESKey">开发者设置的EncodingAESKey</param> /// <param name="sCorpID">业号corpid是企业号的专属编号(CorpID)</param> /// <returns></returns> public string ReceiveResponse(string sMsg, string timestamp, string signature, string sToken, string sEncodingAESKey, string sCorpID) { string responseMessage = "success";//响应内容 var xmlDoc = XDocument.Parse(sMsg);//xml数据转化 //区分普通消息与第三方应用授权推送消息,MsgType有值说明是普通消息,反之则是第三方应用授权推送消息 if (xmlDoc.Root.Element("MsgType") != null) { var msgType = (ResponseMsgType)Enum.Parse(typeof(ResponseMsgType), xmlDoc.Root.Element("MsgType").Value, true); switch (msgType) { case ResponseMsgType.Text://文本消息 responseMessage = ResponseMessageText(xmlDoc, timestamp, signature,sToken,sEncodingAESKey,sCorpID); break; case ResponseMsgType.Image: responseMessage = ResponseMessageImage(); break; case ResponseMsgType.Voice: responseMessage = ResponseMessageVoice(); break; case ResponseMsgType.Video: responseMessage = ResponseMessageVideo(); break; case ResponseMsgType.News: responseMessage = ResponseMessageNews(); break; } } else if (xmlDoc.Root.Element("InfoType") != null) { //第三方回调 var infoType = (ResponseInfoType)Enum.Parse(typeof(ResponseInfoType), xmlDoc.Root.Element("InfoType").Value, true); switch (infoType) { case ResponseInfoType.suite_ticket: { //LoggerHelper._.Warn("suite_ticket===>>>>>,进来了,获取到的SuiteTicket票据为" + xmlDoc.Root.Element("SuiteTicket").Value); } break; } } else { //其他情况 } // result==0表示解密成功,sMsg表示解密之后的明文xml串 //服务器未正确返回响应字符串 “success” return responseMessage; } #region 相关事件实现 /// <summary> /// 消息文本回复 /// </summary> /// <returns></returns> public string ResponseMessageText(XDocument xmlDoc, string timestamp, string nonce,string sToken,string sEncodingAESKey,string sCorpID) { string FromUserName = xmlDoc.Root.Element("FromUserName").Value; string ToUserName = xmlDoc.Root.Element("ToUserName").Value; string Content = xmlDoc.Root.Element("Content").Value; string xml = "<xml>"; xml += "<ToUserName><![CDATA[" + ToUserName + "]]></ToUserName>"; xml += "<FromUserName><![CDATA[" + FromUserName + "]]></FromUserName>"; xml += "<CreateTime>" + GetCurrentTimeUnix() + "</CreateTime>"; xml += "<MsgType><![CDATA[text]]></MsgType>"; xml += "<Content><![CDATA[" + Content + "]]></Content>"; xml += "</xml>"; //"" + Content + "0";//回复内容 FuncFlag设置为1的时候,自动星标刚才接收到的消息,适合活动统计使用 WXBizMsgCrypt wxcpt = new WXBizMsgCrypt(sToken, sEncodingAESKey, sCorpID); string sEncryptMsg = "";// 加密后的可以直接回复用户的密文; wxcpt.EncryptMsg(xml, timestamp, nonce, ref sEncryptMsg); //返回 return sEncryptMsg; } /// <summary> /// 图片消息 /// </summary> /// <returns></returns> public string ResponseMessageImage() { return "success"; } /// <summary> /// 语音消息 /// </summary> /// <returns></returns> public string ResponseMessageVoice() { return "success"; } /// <summary> /// 视频消息 /// </summary> /// <returns></returns> public string ResponseMessageVideo() { return "success"; } /// <summary> /// 图文消息 /// </summary> /// <returns></returns> public string ResponseMessageNews() { return "success"; } #endregion /// <summary> /// 获取当前时间戳 /// </summary> /// <returns></returns> public static string GetCurrentTimeUnix() { TimeSpan cha = (DateTime.Now - TimeZone.CurrentTimeZone.ToLocalTime(new System.DateTime(1970, 1, 1))); long t = (long)cha.TotalSeconds; return t.ToString(); } }