错误码参考
所有 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 分钟
- 详见 鉴权与签名 文档