# 网络通信检测
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:callbackCheck
为了帮助开发者排查回调连接失败的问题,提供这个网络检测的API。它可以对开发者URL做域名解析,然后对所有IP进行一次ping操作,得到丢包率和耗时。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/cgi-bin/callback/check?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
- 本接口支持第三方平台使用 component_access_token 自己调用。
# 2. 请求参数
# 查询参数 Query String parameters
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证,可使用 access_token |
# 请求体 Request Payload
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
action | string | 是 | all | 检测动作:dns(域名解析)/ping(ping检测)/all(全部) |
check_operator | string | 是 | DEFAULT | 检测运营商:CHINANET(电信)/UNICOM(联通)/CAP(腾讯)/DEFAULT(自动) |
# 3. 返回参数
# 返回体 Response Payload
参数名 | 类型 | 说明 |
---|---|---|
dns | objarray | DNS解析结果列表 |
ping | objarray | PING检测结果列表 |
# Res.dns(Array) Object Payload
DNS解析结果列表
参数名 | 类型 | 说明 |
---|---|---|
ip | string | 解析出来的ip |
real_operator | string | ip对应的运营商 |
# Res.ping(Array) Object Payload
PING检测结果列表
参数名 | 类型 | 说明 |
---|---|---|
ip | string | ping的ip,执行命令为ping ip –c 1-w 1 -q |
from_operator | string | ping的源头的运营商,由请求中的check_operator控制 |
package_loss | string | ping的丢包率,0%表示无丢包,100%表示全部丢包。因为目前仅发送一个ping包,因此取值仅有0%或者100%两种可能。 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
{
"action": "all",
"check_operator": "DEFAULT"
}
返回示例
{
"dns": [
{
"ip": "111.161.64.40",
"real_operator": "UNICOM"
},
{
"ip": "111.161.64.48",
"real_operator": "UNICOM"
}
],
"ping": [
{
"ip": "111.161.64.40",
"from_operator": "UNICOM",
"package_loss": "0%",
"time": "23.079ms"
},
{
"ip": "111.161.64.48",
"from_operator": "UNICOM",
"package_loss": "0%",
"time": "21.434ms"
}
]
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
40201 | invalid url | 未设置回调URL |
40202 | invalid action | 不正确的action参数 |
40203 | invalid check_operator | 不正确的运营商参数 |
# 7. 适用范围
本接口在不同账号类型下的可调用情况:
小程序 | 公众号 | 服务号 | 小游戏 | 微信小店 | 联盟带货机构 | 带货助手 | 第三方平台 | 移动应用 | 网站应用 | 视频号助手 | 多端应用 |
---|---|---|---|---|---|---|---|---|---|---|---|
✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | 〇 | ✔ | ✔ | ✔ | ✔ |
- ✔:该账号可调用此接口
- 〇:第三方平台可使用 component_access_token 调用,是否支持代商家调用需看本文档 调用方式 部分