# 网络通信检测

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：callbackCheck

为了帮助开发者排查回调连接失败的问题，提供这个网络检测的API。它可以对开发者URL做域名解析，然后对所有IP进行一次ping操作，得到丢包率和耗时。

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/cgi-bin/callback/check?access_token=ACCESS_TOKEN
```

### 云调用

- 本接口不支持云调用。

### 第三方调用

- 本接口支持第三方平台使用 [component_access_token](/doc/oplatform/developers/dev/ComponentAccessToken.md) 自己调用，同时还支持代商家调用。

- 服务商获得任意权限集授权后，即可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "说明": "接口调用凭证，可使用 [access_token](api_getaccesstoken)、[component_access_token](/doc/oplatform/openApi/ticket-token/api_getcomponentaccesstoken.md)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "action",
    "类型": "string",
    "必填": "是",
    "示例": "all",
    "说明": "检测动作：dns(域名解析)/ping(ping检测)/all(全部)",
    "枚举": "-"
  },
  {
    "参数名": "check_operator",
    "类型": "string",
    "必填": "是",
    "示例": "DEFAULT",
    "说明": "检测运营商：CHINANET(电信)/UNICOM(联通)/CAP(腾讯)/DEFAULT(自动)",
    "枚举": "CHINANET\nUNICOM\nCAP\nDEFAULT"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "dns",
    "类型": "objarray",
    "说明": "DNS解析结果列表"
  },
  {
    "参数名": "ping",
    "类型": "objarray",
    "说明": "PING检测结果列表"
  }
]
```

">

### Res.dns(Array) `Object Payload`

DNS解析结果列表

```json
[
  {
    "参数名": "ip",
    "类型": "string",
    "说明": "解析出来的ip"
  },
  {
    "参数名": "real_operator",
    "类型": "string",
    "说明": "ip对应的运营商"
  }
]
```

">

### Res.ping(Array) `Object Payload`

PING检测结果列表

```json
[
  {
    "参数名": "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. 代码示例

请求示例

``` json
{
  "action": "all",
  "check_operator": "DEFAULT"
}
```

返回示例

``` json
{
  "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. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "40201",
    "错误描述": "invalid url",
    "解决方案": "未设置回调URL"
  },
  {
    "错误码": "40202",
    "错误描述": "invalid action",
    "解决方案": "不正确的action参数"
  },
  {
    "错误码": "40203",
    "错误描述": "invalid check_operator",
    "解决方案": "不正确的运营商参数"
  }
]
```

## 7. 适用范围

本接口在不同账号类型下的可调用情况：

```json
[
  {
    "小程序": "✔",
    "公众号": "✔",
    "服务号": "✔",
    "小游戏": "✔",
    "微信小店": "✔",
    "联盟带货机构": "✔",
    "带货助手": "✔",
    "小店供货商": "✔",
    "第三方平台": "〇",
    "移动应用": "✔",
    "网站应用": "✔",
    "视频号助手": "✔",
    "多端应用": "✔"
  }
]
```

- ✔：该账号可调用此接口。
- 〇：第三方平台可使用 [component_access_token](/doc/oplatform/developers/dev/ComponentAccessToken.md) 调用，是否支持代商家调用需看本文档 调用方式 部分。