跳转到主要内容

概述

YCloud 使用 HTTP 状态码和结构化错误体,以便您的应用程序决定是修复、拒绝还是重试请求。

响应

失败的请求将返回 error 对象。

错误字段

错误代码

使用 error.code 区分具有相同 HTTP 状态码的失败情况。此目录列出了 YCloud API 错误代码;特定端点可能会说明其他错误。 有关账户和发送方配额,请参阅 速率限制。 在请求到达 WhatsApp 后,Meta 错误也可能会显示在 error.whatsappApiError 中。请将这些详细信息与 YCloud 错误代码一起保存。

如何处理响应

请求关联

记录端点、HTTP 方法、响应状态、YCloud requestId 以及您自己的关联 ID。移除 API 密钥和个人数据。这样既能为您排查故障提供充分的依据,又不会泄露机密信息。

安全重试

当失败是暂时性的时候,可以重试只读请求。对于消息发送和其他创建操作,请谨慎操作。重复的 POST 可能会创建第二个资源或发送重复的消息。 如果请求架构(Schema)支持,请将 externalId 设置为您系统中的唯一值。在请求成功后,存储 YCloud 响应 ID。
如果您有专属商务经理,请与他们联系。否则,请通过 YCloud 工单服务 提交工单。请提供 requestId、端点、HTTP 状态和故障发生时间。在分享这些详细信息之前,请务必移除 API 密钥和个人数据。

实施核对清单

  • 通过 code 解析错误,而不是通过匹配 message 文本。
  • 为每个出站请求设置超时。
  • 仅重试临时性错误。
  • 添加指数退避、抖动以及最大重试次数限制。
  • 在以下情况下,使用您自己稳定的标识符来防止重复的 POST 影响 请求支持该参数。