一、简介
1、概述
什么时候需要回调服务
在集成企业微信与内部系统时,我们往往需要搭建一个回调服务。回调服务,可以实现:
- 自定义丰富的服务行为。比如,用户向应用发消息时,识别消息关键词,回复不同的消息内容;用户点击应用菜单时,转化为指令,执行自动化任务。
- 可以及时获取到状态变化。比如,通讯录发生变化时,不需要定时去拉取通讯录对比,而是实时地获取到变化的通讯录结点,进行同步。
回调流程:
- 企业微信会先判断URL服务是否具备解析企业微信推送消息的能力。
具体方式是,企业微信往URL服务上发一条Get请求带签名及密文参数到URL服务上,如果URL服务检查签名通过,并能正确返回密文参数对应的明文字符串,则验证通过。此时在企业微信的配置就开始生效。 - 后续的业务请求(比如应用菜单的点击事件,用户消息等),都会类似的方式(签名+密文)向服务URL推送消息。URL服务验证签名通过后,需要将POST数据解密,就可以得到对应的业务消息明文。
企业收到消息后,需要作如下处理:
- 对msg_signature进行校验
- 解密Encrypt,得到明文的消息结构体(消息结构体后面章节会详说)
- 如果需要被动回复消息,构造被动响应包
- 正确响应本次请求
· 企业微信服务器在五秒内收不到响应会断掉连接,并且重新发起请求,总共重试三次
· 当接收成功后,http头部返回200表示接收ok,其他错误码企业微信后台会一律当做失败并发起重试
2、相关文档地址
https://developer.work.weixin.qq.com/document/path/90930
https://developer.work.weixin.qq.com/document/10514
https://developer.work.weixin.qq.com/document/path/90968
https://developer.work.weixin.qq.com/document/path/90307
二、企微配置消息服务器
1、配置消息接收参数
URL:http://8.131.239.157 Token:UPN8pOCL EncodingAESKey:Wz0cWqM7VcqPOLpNrMCaaxMMif3USVLOjhvK19tEQaX
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-OZwjp3T2-1692458157388)(/Users/liyangda/Library/Application Support/typora-user-images/image-20230819222344569.png)]
2、参数解析
整体会用到8个参数。
参数 | 必须 | 说明 |
url | URL是企业后台接收企业微信推送请求的访问协议和地址,支持http或https协议。 | |
token | Token可由企业任意填写,用于生成签名。 | |
encodingAesKey | EncodingAESKey用于消息体的加密,是AES密钥的Base64编码。 | |
receiveid | 加解密库里,ReceiveId 在各个场景的含义不同: 1. 企业应用的回调,表示corpid。 2. 第三方事件的回调,表示suiteid。 3. 个人主体的第三方应用的回调,ReceiveId是一个空字符串 |
|
msg_signature | 是 | 企业微信加密签名,msg_signature结合了企业填写的token、请求中的timestamp、nonce参数、加密的消息体 |
timestamp | 是 | 时间戳 |
nonce | 是 | 随机数 |
echostr | 是 | 加密的字符串。需要解密得到消息内容明文,。 |
3、参数拼接规则
请求方式:GET
请求地址:
http://api.3dept.com/?msg_signature=ASDFQWEXZCVAQFASDFASDFSS×tamp=13500001234&nonce=123412323&echostr=ENCRYPT_STR
http://8.131.239.157?msg_signature=ed7c74fcb19645d3c8312e703063539fe96a532c×tamp=1692450209&nonce=1693051991&echostr=9fGql+XxePufd9E71gh4kXooAJJ+PtxH3MwwZWzxFNdZwTT3qccs6zHxFEDtGuaxJHWktTV97BiKkJI+rOhcPw==
三、代码编写—使用已有库
这次采用的是企微提供的已由库方式,进行验证。
1、代码下载
源代码地址:https://developer.work.weixin.qq.com/document/path/90307
2、代码修改
因为参数执行有一些问题,需要对提供的工具类进行修改。
修改内容
// 密钥,公众账号的app secret // 提取密文 // Object[] encrypt = JsonParse.extract(postData); Object[] encrypt = new Object[]{postData,postData};
3、服务代码编写
<dependency> <groupId>commons-codec</groupId> <artifactId>commons-codec</artifactId> <version>1.9</version> </dependency> <dependency> <groupId>org.json</groupId> <artifactId>json</artifactId> <version>20180813</version> </dependency>
代码编写
import com.lydms.demowechat0.WechatUtils.AesException; import com.lydms.demowechat0.WechatUtils.WXBizJsonMsgCrypt; import lombok.extern.slf4j.Slf4j; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @Slf4j @RestController public class AllTwoController { @RequestMapping("/*") public String getCheckInfo(String msg_signature, String timestamp, String nonce, String echostr) throws AesException { String token = "UPN8pOCL"; String encodingAesKey = "Wz0cWqM7VcqPOLpNrMCaaxMMif3USVLOjhvK19tEQaX"; String receiveid = "ww3e40cde07cc21a01"; log.info("msg_signature:{},timestamp:{},nonce:{},echostr:{}", msg_signature, timestamp, nonce, echostr); log.info("token:{},encodingAesKey:{},receiveid:{}", token, timestamp, receiveid); WXBizJsonMsgCrypt wxBizJsonMsgCrypt = new WXBizJsonMsgCrypt(token, encodingAesKey, receiveid); String str = wxBizJsonMsgCrypt.DecryptMsg(msg_signature, timestamp, nonce, echostr); log.info("return:{}", str); return str; } }
测试代码:
/** * 测试代码 * * @param args * @throws AesException */ public static void main(String[] args) throws AesException { // Token String token = "UPN8pOCL"; // String encodingAesKey = "Wz0cWqM7VcqPOLpNrMCaaxMMif3USVLOjhvK19tEQaX"; // String receiveid = "ww3e40cde07cc21a01"; // 企业微信加密签名 String msgSignature = "359410caca920fe74a426f5a3057ad437b3b9fa4"; // 时间戳 String timeStamp = "1692448043"; // 随机数 String nonce = "1692495025"; // 加密的字符串 String echostr = "BrO11qZxqM8TBczJq17VRzSnhJff5aGXgnTvWl+yGaoAZ+dd5xg1VxbmmPzMJMmkNPv6DSlpMQ6vz4lwoCXMjg=="; WXBizJsonMsgCrypt wxBizJsonMsgCrypt = new WXBizJsonMsgCrypt(token, encodingAesKey, receiveid); // 解析后的值:7695278663958312959 String s = wxBizJsonMsgCrypt.DecryptMsg(msgSignature, timeStamp, nonce, echostr); System.out.println(s); }
四、测试
将服务部署到配置的URL地址后:http://8.131.239.157
。点击保存
保存成功
查看用户消息