Skip to content

错误码

响应格式

hapi / mapi

HTTP 200
{ "code": 0, "message": "成功", "data": ... }

hapi/mapi 的业务错误和服务器错误均返回 HTTP 200,通过 code 字段区分(0 = 成功,非 0 = 错误)。

ztmp

ztmp 区分 HTTP 状态码:

成功

HTTP 200
[ ... ]  // gateway 批量结果数组

业务错误(BizError):

HTTP 4xx
{ "code": "ERROR_KEY", "message": "中文错误描述" }

服务器错误

HTTP 500
{ "code": "SERVER_ERROR", "message": "..." }

ztmp 错误码

与 hapi 共用的错误码

键名 (code)HTTP Status说明
VALIDATE_ERROR400参数错误 / 参数缺失 / 参数不匹配
USER_AUTH_FAILED401未登录 / Token 过期 / Token 无效
MOBILE_OR_PWD_ERROR401手机号或密码错误 / 旧密码错误
USER_NOT_FOUND401用户不存在 / 找不到会员
NO_PERMISSION403账号类型不符,无权操作
DEVICE_NOT_FOUND404设备/网关不存在
DEVICE_BEEN_BOUND409设备/网关已被其他账号绑定
HTTP_NOT_FOUND404服务不存在
SERVER_ERROR500服务器异常 / 配置错误 / 编号生成失败
SERVICE_UNAVAILABLE500Redis 服务不可用

ztmp 独有的错误码

键名 (code)HTTP Status说明
RECORD_NOT_FOUND404无法找到对应的记录
PROJECT_NOT_FOUND404项目不存在或无权操作
INVITATION_EXPIRED404该家庭已被接收,或者二维码已失效
TRANSFER_REJECTED409家庭移交已被拒绝
TRANSFER_SELF400不能将家庭移交给自己
DEVICE_SN_MISSING400该设备未获取到网关 SN
PROJECT_KEY_MISSING400项目未获取到 private_key
CODE_DUPLICATE409编号已存在
ROLE_NOT_CONFIGURED500未配置对应的角色,请联系管理员

注意GATEWAY_BEEN_BOUND 作为 DEVICE_BEEN_BOUND 的 message 文本保留,用于前端兼容判断。

hapi 错误码

错误码键名说明
0SUCCESS成功
10000UNKNOWN未知错误
10403HTTP_FORBIDDEN拒绝访问
10404HTTP_NOT_FOUND接口未找到
10500SERVER_ERROR服务器异常
11001VALIDATE_ERROR参数错误
11400NO_PERMISSION没有权限
21001MOBILE_OR_PWD_ERROR手机号码或密码错误
21003USER_AUTH_FAILED用户认证失败
21004USER_NOT_FOUND未找到此用户
21007OLD_PASSWORD_ERROR旧密码错误
31001LACK_OF_HEADERS缺少 headers 信息
31002DEVICE_AUTH_FAILED / MODULE_AUTH_FAILED设备认证失败
31003TIMESTAMP_INVALID无效的时间戳
32001MODEL_NOT_FOUND未找到设备型号
33001LICENSE_NOT_FOUND未找到设备 license
34001DEVICE_NOT_FOUND未找到此设备
34002DEVICE_BEEN_BOUND设备被其他人绑定
51004HOTEL_NOT_FOUND酒店不存在
71001ROOM_NOT_FOUND没找到这个房间
72005CLIENT_TOKEN_EXPIRED控制码已失效
91001OPEN_API_VALIDATE_ERROR认证错误
91002OPEN_API_TIMESTAMP_ERROR时间无效
91003OPEN_API_SIGNATURE_ERROR签名错误

mapi 认证

result说明
allow允许 MQTT 连接
deny拒绝 MQTT 连接(mq_pass 不匹配或 status≠1)