1. 概述
1.1 应用场景
解决微信集成过程中遇到的各种问题,大大提高工作效率。例如,在微信集成过程中,发现网络不通没法访问微信服务、同步不到通讯录、推送收不到消息等等问题,可以通过微信调试工具来检测异常,根据异常来发现原因,帮助用户找到解决方向。
1.2 功能简介
提供微信/钉钉调试工具,开启调试模式,能够显示日志调试内容。调试功能如下:
基本属性
单点登录
推送消息
检测请求耗时
1.3 进入调试界面
微信调试页面
在BI 服务器地址后加上/url/weixin/start/debugger 进入微信调试页面。
钉钉调试页面
在BI 服务器地址后加上/url/dingtalk/start/debugger进入钉钉调试页面。
1.4 注意事项
对于微信管理插件和钉钉管理插件
V11.0.68 之前版本:微信和钉钉可以通过「访问链接」的方式,进入调试界面。
V11.0.68 及之后版本:访问微信钉钉旧调试入口会重定向至「微信管理/钉钉管理」页面,切换到「调试工具」即可使用。
集成插件 | 访问链接 |
---|---|
微信管理 | 在平台地址后加上/url/weixin/start/debugger |
钉钉管理 | 在平台地址后加上/url/dingtalk/start/debugger |
由于移动端集成的「调试工具」相同,本文以钉钉管理插件为例。
2. 微信调试
2.1 进入调试界面
1)进入微信调试界面:http://secure.finedevelop.com:63778/webroot/decision/url/weixin/start/debugger,页面显示如下图所示:
可调试的内容为:基本属性、单点登录、推送消息、检测请求耗时。如下图所示:
注:请填写合乎规范的信息,每项参数不可为空。
注:支持测试不在应用列表中的 corpid&secret 组,进行基本属性调试,可以正确输出 Token 、部门、服务器地址,可信域名提示「微信应用暂未添加,可信域名为空」。
2.2 基本属性
2.2.1 检测作用
检测点:查看用户信息获取情况。
作用:确认参数,网络,对应微信应用配置是否正确。
2.2.2 操作步骤
使用「微信管理」添加微信应用时用到的参数来测试,点击开始检测后,正常配置下现象如下图所示:
2.2.3 检测异常
异常现象 1 :若token没有获取到,会给出对应报错提示
可能的原因 1 :网络异常,用户环境可能无法访问微信服务器。解决方案:需要排查网络情况;
可能的原因 2 :使用的微信参数不正确,包括但不限于:① id 和 secret 不匹配;② 对应的 secret 被重置导致原来的 secret 不能用;③ 对应 secret 应用被删/被停用了。
异常现象 2 :若获取的部门用户列表是空
可能是原因 1 :是对应应用没有设置可见范围;
可能是原因 2 :可见范围设置的是单个用户(正常应该选择部门或者标签),但目前不支持可见范围只选择用户来获取用户信息。
2.3 单点登录
2.3.1 检测作用
查看用户的匹配是否正确,用户单点链接是否正确。
2.3.2 操作步骤
切换调试内容为单点登录,多出微信用户和主页/菜单链接两个参数,输入相应的信息,点击开始检测,显示出检测结果信息: Token、报表用户信息。正常情况下调试页面如下图所示:
2.3.3 检测异常
若调试结果不对,则需要检查参数填写是否有问题,匹配是否没有配置好,或者url生成的不对,可信域名配置不正确等,具体参考文档:企业微信(新微信企业号)集成
2.4 推送消息
2.4.1 操作步骤
切换调试内容为推送消息,多出推送用户参数,点击开始检测,输入相应的信息,正常情况下调试页面如下:
每每检测一次,都会由该微信应用发送一条测试消息至微信,如下图所示:
2.4.2 检测异常
若收不到测试消息,可能是微信应用那边的问题,比如手机没有开启消息接收,微信后台有请求拦截等。
2.5 检测请求耗时
2.5.1 检测作用
有些访问比较慢的客户场景,可以用检测工具查看一下再客户环境上的请求耗时,用来判断是否是网络影响了实际使用。
2.5.2 操作步骤
调试内容选择「检测请求耗时」并点击「开始检测」。如下图所示:
3. 钉钉调试
3.1 进入调试界面
1)进入钉钉调试界面:http://secure.finedevelop.com:63778/webroot/decision/url/dingtalk/start/debugger,页面显示如下图所示:
可调试的内容为:获取access_token、检查ip白名单、检测请求耗时。如下图所示:
注:请填写合乎规范的信息,每项参数不可为空。
注:使用钉钉管理添加钉钉应用时用到的参数来测试,详情参见文档:钉钉管理插件
3.2 获取access_token
3.2.1 检查作用
确认网络是否正常。
3.2.2 操作步骤
使用钉钉管理添加钉钉应用时用到的参数来测试,正常配置下现象如下图所示:
3.2.3 检查异常
若 token 没有获取到,大概率是网络异常,用户环境可能无法访问钉钉服务器,需要排查网络情况。
3.3 检查ip白名单
3.3.1 检查作用
作用:检查 ip 是否在白名单中。
相关场景:钉钉应用添加的时候会校验白名单 IP ,若钉钉管理后台没有配置这个 IP ,则应用添加不成功,但是应该填写具体什么IP,往往这个出口 IP 不知道怎么获取。
使用这个功能可以在用户添加钉钉应用之前先检查一下白名单配置,若 IP 不在白名单内,则检测结果中会把对应的 IP 打印出来,这样直接把这个 IP 复制到钉钉后台应用那边即可正常添加。
3.3.2 操作步骤
使用钉钉参数检查钉钉的 IP 白名单,若当前测试服务器的出口 IP 已经加在了钉钉应用的配置信息里,则显示如下图所示:
3.4 检测请求耗时
与微信操作步骤相同。详情参见本文 3.5 节。