状态码
更新时间:2025-01-08
说明
感谢您使用客悦专业版的API接口。为了确保您能够更准确地理解操作结果,我们提供了一套详尽的状态码说明,以便您在进行接口调用时能够快速识别和处理各种情况。
每次请求会返回响应的状态码和详细信息:
"code":{状态码},
"msg":{详细说明}
其中code对应下列表格中的状态码,msg是对状态的详细描述,比如在下列返回示例中,code=502007,对应失败状态码表格中的一行:
状态名 | 状态码 | 类别 |
---|---|---|
DATA_STATE_ERROR | 502007 | 数据状态不符合预期 |
该操作失败是因为试图通过接口删除一个已被删除的FAQ。
错误类别属于:数据状态不符合预期
详细说明为:该FAQ已删除
{
"code": 502007,
"msg": "该FAQ已删除",
"requestId": "xxxxxxxxxxxxxxx"
}
成功状态码
状态名 | 状态码 | 类别 |
---|---|---|
SUCCESS | 200 | 一般情况下操作成功,返回此状态码 |
APPROVED | 4002801 | 涉及数据增删改的操作,返回此状态码代表数据审核通过并操作成功。 |
失败状态码
目前,这些失败状态码主要在FAQ相关接口操作失败时返回。我们正在不断努力完善系统,并将逐步更新其他模块的接口状态码说明,以提供更加全面和准确的信息。
状态名 | 状态码 | 类别 |
---|---|---|
PARAM_FORMAT_INVALID | 400001 | 请求参数格式不合法 |
PARAM_CHECK_ERROR | 400002 | 请求参数检查错误 |
AUTH_PERMISSION_DENY | 401001 | 授权错误 |
GENERAL_DIRECTORY_ERROR | 402001 | 目录相关错误 |
GENERAL_IMPORT_ERROR | 402002 | 导入相关错误 |
GENERAL_EXPORT_ERROR | 402003 | 导出相关错误 |
DATA_NOT_EXIST | 502001 | 数据不存在 |
DATA_CREATE_FAILED | 502002 | 数据创建失败 |
DATA_DELETE_FAILED | 502003 | 数据删除失败 |
DATA_UPDATE_FAILED | 502004 | 数据更新失败 |
DATA_QUERY_FAILED | 502005 | 数据查询失败 |
DATA_CONSISTENCY_ERROR | 502006 | 数据不一致 |
DATA_STATE_ERROR | 502007 | 数据状态不符合预期 |