跳至主要内容

错误码参考

所有 API 遵循统一的响应格式。

响应格式

{
"code": 1,
"msg": "ok",
"data": ""
}

业务状态码

code说明
1请求成功
-1请求失败,具体原因见 msg 字段

常见错误消息

code-1 时,msg 字段会返回以下常见错误描述:

msg说明排查建议
appid不存在应用标识无效检查 appid 是否正确,前往 设置 > 开发设置 查看
签名校验失败HMAC-SHA256 签名不匹配检查 AppSecret 是否正确,确认 payload JSON 格式与签名时一致
timestamp已过期请求时间戳超出有效范围使用当前时间戳,确保服务器时间同步
参数缺失必填参数未传检查请求体是否包含所有必填字段
会话不存在操作的会话 ID 无效确认会话未被删除或解散
群聊不存在操作的群聊 ID 无效确认群聊未被解散
kefu_id不存在客服 ID 无效前往 团队 > 客服列表 确认客服 ID
排查建议
  • 签名问题:确保 JSON 不进行排序、不格式化(不 pretty print)、不 urlencode,使用压缩后的单行 JSON
  • 时间戳问题:使用秒级时间戳,确保与服务器时间偏差不超过 5 分钟
  • 详见 鉴权与签名 文档