# 接口报错诊断

微信开发者平台「工具箱」为开发者提供统一的接口诊断和调试服务，帮助开发者快速定位和解决 API 调用过程中遇到的问题。

「工具箱」目前包含「调用日志查询」和「API 报错诊断」两项能力。其中「API 报错诊断」通过填写 `rid` 信息或包含 `rid` 的返回包，可诊断 API 接口问题。

`rid` 指在处理一次 API 请求时生成的唯一请求标识符（Request ID），用于标记并追踪这次请求。服务端 API 调用出错时必然会返回该值。

**操作路径**

- [微信开发者平台](https://developers.weixin.qq.com/platform/) - 控制台 - 工具箱 - API 报错诊断
- 快速体验：[https://developers.weixin.qq.com/console/devtools/debug?tab=errorDiag](https://developers.weixin.qq.com/console/devtools/debug?tab=errorDiag)

注意：当前已升级支持 AI 智能诊断模式，可快速精准定位和解决问题。

## 1、使用步骤

### 1.1 输入 rid 信息

在「API 报错诊断」页面的输入框中填写 `rid` 信息，支持两种输入方式：

- **直接输入 rid**：如果已经获得了具体的 `rid` 值，可以直接将其粘贴到输入框中。系统会自动识别并验证 `rid` 的格式。
- **输入包含 rid 的返回包**：如果开发者有完整的 API 返回包，可以将整个返回包内容粘贴到输入框中。系统会自动解析并提取其中的**第一个 rid 值**。

### 1.2 执行诊断

点击「诊断」按钮后，系统会自动匹配 `rid` 值。

- 如果未匹配到相关信息，需确保 `rid` 正确。如无法匹配到，可复现后取最新 `rid` 重新诊断。
- 如果匹配到对应 `rid`，会立即开始进行分析。

### 1.3 查看诊断结果

诊断完成后，页面会根据**查询结果**和**账户权限**显示相应的信息。

## 2、诊断结果说明

### 2.1 查询成功且有权限查看

![](https://res.wx.qq.com/op_res/ASa8ueOhtASWd5ET6B3nOQ0fziWiLqhf8g5Hjy0pORFLFeUqumkcc2HcrdhijczFw9BawcqzkV-RRprnvGAD2w)

若当前账号是 `rid` 对应调用账号的管理员或开发者时，会显示**完整的诊断信息**，包括：

**基本信息**

- **调用账号**：显示发起请求的账号昵称、头像和类别标签。对于第三方平台代调用的情况，会同时显示第三方平台信息和被代调用的小程序或公众号信息。
- **接口地址**：被调用的 API 接口路径，以 `/` 开头，点击「接口文档」可查看该接口的详情。
- **接口适用范围**：该接口允许调用的账号类型。
- **其他信息**：账号类型、AppID、请求 `rid`、调用时间、接口功能描述。

**请求信息**

- **服务端耗时**：接口在微信服务器端的处理时间。
- **调用 IP 地址**：发起请求的调用方 IP 地址。
- **HTTP 状态码**：请求的 HTTP 响应状态码。
- **UA 信息**：请求时的 User-Agent 信息。
- **请求包**：完整的请求参数，以 JSON 格式高亮显示。
- **响应包**：完整的响应数据，以 JSON 格式高亮显示。

**调用分析**

- 已支持基于 AI 提供智能诊断功能，详情可查看 [开发者 AI 助手](aibot)。

### 2.2 查询成功但权限不符

![](https://res.wx.qq.com/op_res/ASa8ueOhtASWd5ET6B3nOd8QlgKqgTTV6t2EZcf_3PW4m59cNChq4JY3wUZWo68g6KC2kYI7UfO0IhrdjArCOw)

当前登录账号如不具备该 `rid` 关联账号的管理员或开发者权限，系统只会显示脱敏信息，如接口地址、调用时间等非敏感信息。

### 2.3 查询成功但无关联账号

当 `rid` 没有关联的账号信息时，系统会显示提示。通常发生在开发者发送请求时未填写正确的 `AppID`。

### 2.4 查询失败或 RID 过期

当系统无法找到对应的 `rid` 信息或 `rid` 已过期时（有效期为 7 天）会触发。开发者需确保 `rid` 正确，可复现后取最新 `rid` 重新诊断。

## 3、第三方平台代调用

第三方平台代调用指的是在得到管理员授权后，第三方服务商通过「第三方平台账号」代调用官方接口。

- **调用身份展示**：页面会清晰地显示调用关系，包括第三方平台信息和被代调用的身份账号信息。
- **权限隔离原则**：遵循「调用时的 token 谁造的，就应该谁来查看」的原则。

![](https://res.wx.qq.com/op_res/ASa8ueOhtASWd5ET6B3nOTSijGFVZaGelaKFrrsexKYvMpf3K_l1sNh6roqmpSZLRIIFOa2LumAyVMSNYqehvQ)