错误码
错误码
HTTP 响应里 result.code 为字符串。0 表示成功。各 API 方法页「错误码」节通过片段引用与本页相同的分表(见 HTTP 开发规范 §5)。
如何阅读
- 看
result.code字母前缀(到第一个数字前),用本页目录或页内搜索定位业务节。 - 签名、Token 类与 HTTP 开发规范 有关。
- 设备与通道类请对照设备绑定态与各接口说明。
- HTTP 200 时仍可能有业务
code非 0;以 body 内result.code为准。 - 本页仅覆盖 OpenAPI 网关/业务 HTTP(
result.code)。能力device.property.*/device.service.invoke返回体内的DV20xx等见各能力页与 能力错误码。 - 按接口 日调用上限 超限返回
OP1014,见 接口调用限额。
通用成功码
| 错误码 | 说明 | 场景 |
|---|---|---|
| 0 | 操作成功 |
开放平台通用
| 错误码 | 说明 | 场景 |
|---|---|---|
| OP1001 | 操作失败 | |
| OP1002 | 缺少参数,请确认是否漏传参数 | 请求体中 params 缺少必填项 |
| OP1003 | 参数值不合法(格式错误或为空),请修正参数值 | 1. 请求体中必填项为空("" 或 null);2. 参数类型与接口约定不符;3. 传入参数的格式不符合合法取值说明 |
| OP1004 | 请求内容为空 | 请求内容为空 |
| OP1005 | 无效的请求 URL | 无效的请求 URL |
| OP1006 | SDK 异常 | 1. 调用 SDK 时,请求体中 head 为空;2. head 中缺少字段;3. head 中存在空字段 |
| OP1007 | 无效的方法调用 | 1. 调用对外接口时,system.appId 为空("" 或 null);2. 调用非用户模块接口时,params.token 不存在或 params.token 为空("" 或 null) |
| OP1008 | appId 为空 | system.appId 取值不符合规范 |
| OP1009 | 权限不足,无法执行此操作 | 1. 设备未被当前用户绑定;2. 调用直播相关接口时,appId 不在白名单中;3. 调用直播相关接口时,token 不是管理员 token |
| OP1010 | 应用已冻结 | 当前 App 状态为已冻结 |
| OP1011 | 接口调用次数超限(应用级/未发布应用等) | 总额度或应用级限流场景;按接口日限额超限见 OP1014 与 接口调用限额 |
| OP1012 | 调用接口权限不足 | 调用接口权限不足 |
| OP1013 | 接口调用次数超限(总次数) | 部分接口设有总调用次数上限,开发者调用超过配置次数时将返回此错误码 |
| OP1014 | 接口调用次数超限(每日) | 部分接口设有每日调用次数上限,开发者调用超过配置次数时将返回此错误码 |
| OP1015 | 权限不足,无法执行此操作。(设备非开放平台绑定设备) | 权限不足,无法执行此操作。(该设备非开放平台绑定设备) |
| OP1016 | 请求的设备相关接口已达上限 | 开发者每周可操作的设备通道数不能超过当前开发者购买的设备接入数 |
| OP1019 | 该时段未生成录像 | 该时段未生成录像 |
| OP1021 | 获取回放地址失败 | 获取回放地址失败 |
| OP1023 | kitToken 已过期,请重新获取 | kitToken 已过期,请重新获取 |
| OP1026 | 请求过于频繁,请稍后再试 | 同一用户同时请求同一 token 相关接口时,少数情况下会出现此错误码 |
签名与请求校验
| 错误码 | 说明 | 场景 |
|---|---|---|
| SN1001 | 签名校验异常 | 请求体中 system.sign 的值与 OpenApi 计算的签名不一致 |
| SN1002 | 签名超时 | 请求体中 system.time 与请求时间戳偏差不应超过 5 分钟 |
| SN1003 | 签名参数错误 | 请求体中 system.time 不是数值(含字母或特殊字符) |
| SN1004 | 非法 appId | 非法 appId |
| SN1005 | nonce 重复 | 开发者调用开放平台接口时传入的 nonce 在 5 分钟内不可重复,否则将返回此错误码 |
Token 鉴权
| 错误码 | 说明 | 场景 |
|---|---|---|
| TK1001 | 该账号(手机号)对应用户已绑定到您的应用 | |
| TK1002 | token 已过期或不存在,请重新获取 token | token 已过期或不存在,请重新获取 token |
| TK1003 | 非法 token,请传入正确的 token | 请检查 token 与 appId 是否对应;若多个 appId 账号的 token 混用异常,将返回此错误码 |
| TK1004 | 当前用户手机号尚未绑定到您的应用 | 请先进行「用户绑定」操作 |
| TK1005 | 绑定用户数超过上限 | 未发布应用绑定用户数超过上限 |
| TK1006 | 当前手机号不是开发者账号手机号。开发者创建应用后,可在开放平台网站 > 开发中心 > 应用详情页查看管理员账号。 | |
| TK2001 | csrfToken 无效 |
设备与通道
| 错误码 | 说明 | 场景 |
|---|---|---|
| DV1001 | 设备已被其他账号绑定 | |
| DV1002 | 设备不存在 | |
| DV1003 | 设备已被当前账号绑定 | |
| DV1004 | 更新通道名称失败 | |
| DV1005 | 设备验证码错误 | |
| DV1006 | 无需更新设备,设备已是最新版本 | |
| DV1007 | 设备离线 | |
| DV1008 | 绑定设备数超过上限,请先解绑其他多余设备 | 未发布应用绑定设备数超过上限 |
| DV1009 | 设备忙,请稍后再试 | 待操作的设备正在处理上一请求 |
| DV1010 | 抓图请求过于频繁,请稍后再试 | 抓图接口调用过于频繁,同一设备在 1 秒内多次请求抓图 |
| DV1011 | 设备尚未添加,请先绑定设备 | 待操作的设备尚未被当前账号添加 |
| DV1012 | 权限不足,设备为授权(或分享)设备 | |
| DV1013 | 设备注册满 3 天后绑定。客户端与设备须在同一局域网;设备断电重启后可再次绑定。 | |
| DV1014 | 连续绑定错误超过 10 次,限制绑定 30 分钟 | |
| DV1015 | 连续绑定错误超过 20 次,限制绑定 24 小时 | |
| DV1016 | 设备密码错误 | |
| DV1018 | 设备已注册到平台且超过三天未绑定,须在局域网内绑定,或重启设备后再绑定 | 设备在平台注册后超过三天仍未绑定 |
| DV1019 | 设备能力集不支持此操作 | |
| DV1020 | 设备通道离线 | |
| DV1021 | 设备异常 | |
| DV1022 | 收藏点数量超过上限 | |
| DV1023 | 收藏点已存在 | |
| DV1024 | 收藏点不存在 | |
| DV1025 | 设备 SC 码或设备密码错误 | |
| DV1026 | 设备不支持调用此功能 | |
| DV1027 | 设备安全码错误 | |
| DV1028 | 用户未绑定该设备,或设备通道号不存在 | |
| DV1029 | 设备已被绑定 | |
| DV1030 | 设备休眠中 | |
| DV1031 | 电量过低拒绝升级(带电池设备) | |
| DV1034 | 设备未初始化 | |
| DV1035 | 设备初始化失败 | |
| DV1036 | 注销失败,设备离线未满 5 分钟 | |
| DV1037 | NB 设备的 imei 与 device id 不匹配 | |
| DV1038 | 电量过低时无法添加临时密钥 | |
| DV1039 | 不满足临时密钥生成条件 | |
| DV1040 | 设备绑定失败已达 20 次,限制绑定 24 小时 | |
| DV1041 | 转移设备数量超过设定上限 | |
| DV1042 | 设备密码错误次数达上限,设备已锁定 | |
| DV1043 | 不支持的项目属性 | |
| DV1044 | 设备 IP 不在同一局域网 | |
| DV1045 | 设备冲突 | |
| DV1047 | 设备已启用自定义加密 | |
| DV1049 | 设备无存储介质 | |
| DV1050 | 临时密钥生成次数超过上限 | |
| DV1051 | 人脸库不存在 | |
| DV1052 | 新增人脸数超过人脸库上限 | |
| DV1053 | 抓图失败,请检查网络 | 调用手动抓图接口时,因网络原因设备未及时返回图片 |
Wi-Fi 配网
| 错误码 | 说明 | 场景 |
|---|---|---|
| WF1001 | 请求超时 | 连接 Wi-Fi 超时 |
| WF1002 | Wi-Fi 密码错误 | 连接 Wi-Fi 时,请求体中 params.password 错误 |
短信验证码
| 错误码 | 说明 | 场景 |
|---|---|---|
| SM1001 | 验证码输入错误 | 1. 绑定用户时 params.smsCode 填写错误;2. 绑定用户时验证码已过期 |
| SM1002 | 验证码已过期,请重新获取验证码 | |
| SM1003 | 服务端处理错误 | |
| SM1004 | 发送验证码短信失败 | |
| SM1005 | 当日获取短信验证码次数已达上限 | 1. 未发布应用绑定用户时,获取短信验证码次数超限;2. 已发布应用绑定用户时,获取短信验证码次数超限 |
| SM1006 | 短信发送过于频繁,请稍后再试 | 获取短信接口调用过于频繁 |
短信发送限额
| 错误码 | 说明 | 场景 |
|---|---|---|
| SMS01 | 短信发送次数超过上限 | |
| SMS02 | 短信发送次数超过上限 |
消息回调
| 错误码 | 说明 | 场景 |
|---|---|---|
| TH1001 | 当前方法错误,非透传接口方法 | |
| TH1003 | 消息回调 URL 格式不正确 |
云存储套餐
| 错误码 | 说明 | 场景 |
|---|---|---|
| ST1001 | 当前设备默认云存储套餐已过期,操作失败 | 开启默认云存储套餐时,默认套餐已过期 |
| ST1002 | 当前设备无默认云存储套餐,操作失败 | |
| ST1003 | 当前使用的云存储套餐非默认云存储套餐,操作失败 | |
| ST1004 | 云存储套餐未开通 | |
| ST1005 | 云存储套餐已过期 | |
| ST1006 | 云存储套餐不存在 | |
| ST1007 | 激活云存储接口调用次数不足一次 | |
| ST1008 | 当前设备正在使用的定时录像计划云存储套餐需暂停 | |
| ST1009 | 操作失败。当前设备仍有未过期的付费云存储套餐策略 | |
| ST1010 | 设备不支持对应的云存储套餐策略 | |
| ST1011 | 接口调用次数超限,同一套餐 24 小时内只能解绑一次 | |
| ST1012 | 免费云存储不支持解绑 |
云录像
| 错误码 | 说明 | 场景 |
|---|---|---|
| RC1001 | 未找到云录像 | 根据云录像片段信息查询的云录像不存在 |
直播地址
| 错误码 | 说明 | 场景 |
|---|---|---|
| LV1001 | 直播已存在 | 调用绑定直播地址接口时,当前设备与 rtsp 地址源已绑定直播地址 |
| LV1002 | 直播不存在 | |
| LV1004 | 设备已自定义加密密钥 | 绑定或播放直播时设备已开启自定义视频加密且密钥不匹配 |
| LV1005 | 直播信息不存在 | |
| LV1006 | 操作失败。同一 rtsp 源地址同一天只能绑定一次 | |
| LV1008 | 创建直播需完成实名认证。请前往开放平台网站「基本信息」页完善资料:个人用户请上传身份证,企业客户请上传营业执照等 | |
| LV1020 | 直播已绑定,无法删除 |
本地录像计划
| 错误码 | 说明 | 场景 |
|---|---|---|
| YL1001 | 定时拉流模式下,拉流时间不能落在定时录像的计划时段内 | |
| YL1002 | 定时计划时间参数重叠,重叠时段为 XX-XX | |
| YL1003 | 操作失败。存在有效的云存储录像计划,请关闭云存储录像计划后重试 | |
| YL1004 | 操作失败。存在有效的动检计划,请关闭动检计划后重试 | |
| YL1005 | 操作失败。请开通支持设置云存储录像计划的云存储策略套餐 |
角色与用户授权
| 错误码 | 说明 | 场景 |
|---|---|---|
| GT1001 | 授权角色已存在 | |
| GT1002 | 添加角色失败 | |
| GT1003 | 用户授权已存在 | |
| GT1004 | 创建用户授权失败 | |
| GT1005 | 用户授权不存在 | |
| GT1006 | 角色不存在 | |
| GT1007 | 该角色为默认角色 | |
| GT1008 | 授权超过上限 | |
| GT1009 | 不能授权给自己 | |
| GT1010 | 获取授权列表失败 | |
| GT1011 | 传入的访问权限列表参数不正确 |
设备分组
| 错误码 | 说明 | 场景 |
|---|---|---|
| GP1001 | 设备分组名称已存在 | |
| GP1002 | 设备分组 Id 不存在 | |
| GP1003 | 设备已加入该分组 |
用户与订单
| 错误码 | 说明 | 场景 |
|---|---|---|
| US1001 | 用户不存在 | |
| US1002 | 该用户无此授权关系 |
P2P 取流鉴权
| 错误码 | 说明 | 场景 |
|---|---|---|
| P2P001 | P2P 鉴权接口:鉴权 ID 已过期 | |
| P2P002 | P2P 鉴权接口:header 字段参数缺失 | |
| P2P003 | token 已过期 | |
| P2P004 | 无设备权限 |
综治员绑定
| 错误码 | 说明 | 场景 |
|---|---|---|
| AD1001 | 未绑定总管理员 |
设备本地存储
| 错误码 | 说明 | 场景 |
|---|---|---|
| LD1001 | 设备本地无存储介质 |
配件
| 错误码 | 说明 | 场景 |
|---|---|---|
| AP1001 | 配件不存在 | |
| AP1002 | 配件离线 |
接入额度与流量
| 错误码 | 说明 | 场景 |
|---|---|---|
| FL1001 | 开发者剩余接入次数不足 | 开发者可登录开放平台网站,在「已购资源」中查看剩余设备通道接入次数 |
| FL1002 | 开发者当前无可用带宽 | 音视频预览(实时预览、录像回放)时,系统检测到开发者无剩余流量且未购买带宽,将返回错误。可登录开放平台网站,在「已购资源」中查看剩余流量与可用带宽 |
| FL1003 | 开发者当前带宽超过配额上限 | 音视频预览(实时预览、录像回放)时,系统检测到开发者带宽使用超限,将返回错误。可登录开放平台网站,在控制台「我的资源」中查看剩余流量与可用带宽 |
| FL1004 | 开发者剩余流量不足 | 音视频预览(实时预览、录像回放)时,系统检测到开发者无剩余流量且未购买带宽,将返回错误。可登录开放平台网站,在「已购资源」中查看剩余流量与可用带宽 |
| FL1005 | 开发者拉取音视频时无可用带宽且剩余流量不足 | 音视频预览(实时预览、录像回放)时,系统检测到开发者无剩余流量且未购买带宽,将返回错误。可登录开放平台网站,在「已购资源」中查看剩余流量与可用带宽 |
人脸库与 AI 分析
| 错误码 | 说明 | 场景 |
|---|---|---|
| PF1001 | repositoryToken 不存在 | |
| PF1002 | faceToken 不存在 | |
| PF1003 | 未检测到人脸 | |
| PF1004 | 暂不支持此功能 | |
| PF1005 | 图片大小超过 2M 限制 | |
| PF1006 | 类型不匹配 | |
| PF1007 | 获取特征值失败,请先进行图片检测 |
用户登录
| 错误码 | 说明 | 场景 |
|---|---|---|
| UR1000 | 用户未登录 | |
| UR1001 | 不支持邮箱登录 |
手机号变更
| 错误码 | 说明 | 场景 |
|---|---|---|
| PH1001 | 手机号修改频率已达上限 |
子账号
| 错误码 | 说明 | 场景 |
|---|---|---|
| SUB1000 | 当前子账号无接口访问权限 | |
| SUB1001 | 当前子账号无接口访问权限 | |
| SUB1002 | 当前子账号无接口访问权限 | |
| SUB1005 | 子账号 token 已过期 | |
| SUB1006 | 子账号与设备之间无授权关系 | |
| SUB1007 | 创建子账号失败 | |
| SUB1008 | 子账号与当前应用无绑定关系 |
OAuth 授权(OA)
| 错误码 | 说明 | 场景 |
|---|---|---|
| OA1001 | 授权关系不存在 | 缺少 OAuth 授权关系 |
| OA1005 | 该 API 不支持 OAuth 用户操作 | 使用 OAuth 用户 token 调用了未开放 OAuth 的接口 |
| OA1006 | 授权码无效 | 授权码过期或已使用 |
| OA1007 | OAuth appId 无效 | OAuth 项目 Access Key 与请求上下文不匹配 |
| OA1008 | refreshToken 已过期 | refresh_token 刷新被拒绝 |
