功能描述:
这个功能可以实现,企业微信内部用户通过对话框与自建应用进行通信,对话框中发送的内容会用接口的方式发送给自建应用的服务,自建应用收到消息后处理进行响应回复消息。
效果演示:
我们来实现他吧!
1、在企业微信中添加自建应用
2、连接“接收消息”API
3、设置接收消息的参数
在企业的管理端后台,进入需要设置接收消息的目标应用,点击“接收消息”的“设置API接收”按钮,进入配置页面。
注意:
url:要按照规定去填写、要公网的域名、还要该域名属于企业微信认证的实体的。(如何符合仍然显示不通过,那么去找客服处理,我当时的域名是子公司的,企业微信是总公司的,显示域名不通过,然后找了客服处理就通过了。)
token、EncodingAESKey选择随机获取即可。
4、保存(验证URL有效性):
当点击“保存”提交以上信息时,企业微信会发送一条验证消息到填写的URL,发送方法为GET。
企业的接收消息服务器接收到验证请求后,需要作出正确的响应才能通过URL验证。
(这是模拟企业微信向你的自建应用发送GET请求,进行验证)
假设接收消息地址设置为:http://api.3dept.com/,企业微信将向该地址发送如下验证请求:
请求方式:GET
请求地址:http://api.3dept.com/?msg_signature=ASDFQWEXZCVAQFASDFASDFSS×tamp=13500001234&nonce=123412323&echostr=ENCRYPT_STR
参数说明:
企业后台收到请求后,需要做如下操作:
1、对收到的请求做Urldecode处理
2、通过参数msg_signature对请求进行校验,确认调用者的合法性。
3、解密echostr参数得到消息内容(即msg字段)
4、在1秒内原样返回明文消息内容(不能加引号,不能带bom头,不能带换行符)
以上2~3步骤可以直接使用验证URL函数一步到位。
之后接入验证生效,接收消息开启成功。
下面介绍如何代码部分:
对接这个接口主要要给官方提供两个接口
1、一个get请求的校验接口:验证你的项目官方是不是可以调通(只做验证)
2、一个是post请求的内容发送接口:是给企业微信传输内容的接口(实际传输)
下次就展示代码,我这边用的是springBoot项目
qw.aes里面的类都是官方提供的
下载地址:https://work.weixin.qq.com/api/doc/90000/90138/90307
我这边是java的所以只展示Java的,可以点击下面直接下载
xml版本(2018年10月11日更新,点击下载)
package com.shimaruanchuang.yunmao.admin.v2.controller;
import cn.hutool.core.util.XmlUtil;
import com.shimaruanchuang.yunmao.admin.v2.serviceImpl.qw.aes.WXBizMsgCrypt;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import java.io.PrintWriter;
/**
* <p>
* 合同主体 前端控制器
* </p>
*
* @author mmx
* @since 2023-09-15
*/
@Slf4j
@Controller
@RequestMapping("/v2/api/qw")
public class QwTestController {
//内容填写自己企业微信中配置的
//自建应用中的开通api接口消息详情里的sToken
String sToken = "";
//企业微信后台的企业微信id
String sCorpID = "";
//自建应用的开通api接口消息详情里的sEncodingAESKey
String sEncodingAESKey = "";
/**
* @param request 获取请求类型,因为在自建应用中添加接收api时用的是get请求,接收企业微信收到的消息时用的是post请求,当前处理只做消息接收,未添加消息安全性校验
* @return
* @throws Exception
*/
@RequestMapping("/qwtest")
@ResponseBody
private String test( HttpServletRequest request, HttpServletResponse response) throws Exception {
log.info("回调开始");
String method = request.getMethod();
log.info("method",method);
WXBizMsgCrypt wxcpt = new WXBizMsgCrypt(sToken, sEncodingAESKey, sCorpID);
// 微信加密签名
String msg_signature = request.getParameter("msg_signature");
// 时间戳
String timestamp = request.getParameter("timestamp");
// 随机数
String nonce = request.getParameter("nonce");
// 随机字符串
String echostr = request.getParameter("echostr");
String result = null;
if (method.equals("GET")) {
try {
PrintWriter out = response.getWriter();
// 解密消息并将明文返回给企业微信,即可以开通api接收消息
result = wxcpt.VerifyURL(msg_signature, timestamp, nonce, echostr);
if (result == null) {
result = sToken;
}
out.print(result);
out.close();
return result;
} catch (Exception e) {
//验证URL失败,错误原因请查看异常
e.printStackTrace();
}
} else {
request.setCharacterEncoding("UTF-8");
response.setCharacterEncoding("UTF-8");
response.setContentType("text/html;charset=UTF-8");
String timeMillis = System.currentTimeMillis() + "";
DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
DocumentBuilder db = dbf.newDocumentBuilder();
Document document = db.parse(request.getInputStream());
Element root = document.getDocumentElement();
String corpID = root.getElementsByTagName("ToUserName").item(0).getTextContent();
String agentID = root.getElementsByTagName("AgentID").item(0).getTextContent();
String encrypt = root.getElementsByTagName("Encrypt").item(0).getTextContent();//用户发送的内容
System.out.println("CorpID = " + corpID);
System.out.println("agentID = " + agentID);
System.out.println("encrypt = " + encrypt);
result = wxcpt.VerifyURL(msg_signature, timestamp, nonce, encrypt);
System.out.println("result = " + result);
Document parse = XmlUtil.readXML(result);
String fromUserName = parse.getElementsByTagName("FromUserName").item(0).getTextContent();
String createTime = parse.getElementsByTagName("CreateTime").item(0).getTextContent();
String msgType = parse.getElementsByTagName("MsgType").item(0).getTextContent();
String content = parse.getElementsByTagName("Content").item(0).getTextContent();
String msgId = parse.getElementsByTagName("MsgId").item(0).getTextContent();
System.out.println("FromUserName = " + fromUserName);
System.out.println("CreateTime = " + createTime);
System.out.println("MsgType = " + msgType);
System.out.println("Content = " + content);
System.out.println("MsgId = " + msgId);
String msg = "";
//对用户发送过来的内容选择要回复的内容
//PS:这边你就可以对用户传过来的参数进行自己的判断,并增加自己的相关业务逻辑,返回回复的内容。
if (content.contains("你好")) {
content = content.substring(2);
msg = "收到消息!";
}
String replyMsg = "<xml>"
+ "<ToUserName><![CDATA[" + fromUserName + "]]></ToUserName>"//成员UserID
+ "<FromUserName><![CDATA[" + corpID + "]]></FromUserName>"//企业微信CorpID
+ "<CreateTime>" + timeMillis + "</CreateTime>"//消息创建时间(整型)
+ "<MsgType><![CDATA[text]]></MsgType>"//消息类型,此时固定为:text
+ "<Content><![CDATA[" + msg + "]]></Content>"//文本消息内容,最长不超过2048个字节,超过将截断
+ "<MsgId>" + msgId + "</MsgId>" //一定加
+ "<AgentID>" + agentID + "</AgentID>"//一定加
+ " </xml>";
System.out.println("replyMsg = " + replyMsg);//打印出来
//这里可以存放你要自动回复给用户的信息
String encryptMsg = wxcpt.EncryptMsg(replyMsg, timeMillis, nonce);
System.out.println("11111111111encryptMsg = " + encryptMsg);
return encryptMsg;
}
return null;
}
}