API 接口全部错误码定义及对应的处理建议
当 API 调用发生错误时,响应中的 code 字段为非 0 值,message 字段包含可读的错误描述:
{
"code": 1001,
"message": "签名验证失败,请检查 AppSecret 是否正确",
"data": null,
"traceId": "trace_xxxxxx"
}遇到错误时,请记录 traceId。联系技术支持时提供 traceId,可以快速定位问题。
| 错误码 | 错误信息 | 原因 | 处理建议 |
|---|---|---|---|
| 1001 | 签名验证失败 | AppSecret 不正确或签名算法有误 | 检查 AppSecret,确认签名算法实现正确 |
| 1002 | 时间戳过期 | 请求时间与服务端时间差超过 5 分钟 | 同步服务器时间,确保时间戳准确 |
| 1003 | AppId 不存在 | AppId 错误或应用已删除 | 检查 AppId 是否正确,确认应用状态 |
| 1004 | 频率限制 | 调用频率超过限制(100 QPS) | 降低调用频率,或联系商务提额 |
| 1005 | 服务不可用 | 服务端临时故障 | 等待后重试,如持续出现请联系技术支持 |
| 1006 | 参数校验失败 | 必填参数缺失或格式不正确 | 检查请求参数是否符合文档要求 |
| 1007 | IP 不在白名单 | 调用 IP 未配置在安全白名单中 | 在控制台安全设置中添加 IP |
| 错误码 | 错误信息 | 说明 |
|---|---|---|
| 2001 | 合同文件格式不支持 | 仅支持 PDF、Word (.doc/.docx)、OFD 格式 |
| 2002 | 签署方信息不完整 | 签署方姓名或手机号缺失 |
| 2003 | 合同状态不允许此操作 | 当前合同状态下无法执行该操作 |
| 2004 | 签署方身份验证失败 | 实名认证未通过或认证已过期 |
| 2005 | 超出批量创建上限 | 单次批量创建合同不超过 500 份 |
| 2006 | 文件大小超出限制 | 单个文件不超过 50MB |
| 2007 | 签署截止日期不合法 | 截止日期必须在当前日期之后 |
| 2008 | 企业未完成认证 | 需先完成企业实名认证才可使用此接口 |
| 2009 | 印章未授权 | 当前用户无此印章的使用权限 |
| 2010 | 合同已被篡改 | 合同文件哈希值与签署时不一致 |