开始使用
  • English
  • 简体中文
前往官网
开始使用
  • English
  • 简体中文
前往官网
  • 开始使用
  • 核心概念
  • 开发指南
  • 设备能力与事件参考
  • API 参考
    • 公共约定
    • HTTP 开发规范
    • accessToken(管理员 Token)
    • API 请求示例
    • 错误码
    • 接口调用限额
    • 账号与授权
    • 设备接口
    • 直播地址
    • 推送配置
    • 云存储
    • 资源池额度管理
    • 旧版接口(不再维护)
  • SDK 与工具
  • 方案
  • 平台与支持
本页目录
如何阅读
通用成功码
开放平台通用
签名与请求校验
Token 鉴权
设备与通道
Wi-Fi 配网
短信验证码
短信发送限额
消息回调
云存储套餐
云录像
直播地址
本地录像计划
角色与用户授权
设备分组
用户与订单
P2P 取流鉴权
综治员绑定
设备本地存储
配件
接入额度与流量
人脸库与 AI 分析
用户登录
手机号变更
子账号
OAuth 授权(OA)

错误码

错误码

HTTP 响应里 result.code 为字符串。0 表示成功。各 API 方法页「错误码」节通过片段引用与本页相同的分表(见 HTTP 开发规范 §5)。

如何阅读

  1. 看 result.code 字母前缀(到第一个数字前),用本页目录或页内搜索定位业务节。
  2. 签名、Token 类与 HTTP 开发规范 有关。
  3. 设备与通道类请对照设备绑定态与各接口说明。
  4. HTTP 200 时仍可能有业务 code 非 0;以 body 内 result.code 为准。
  5. 本页仅覆盖 OpenAPI 网关/业务 HTTP(result.code)。能力 device.property.* / device.service.invoke 返回体内的 DV20xx 等见各能力页与 能力错误码。
  6. 按接口 日调用上限 超限返回 OP1014,见 接口调用限额。

通用成功码

错误码说明场景
0操作成功

开放平台通用

错误码说明场景
OP1001操作失败
OP1002缺少参数,请确认是否漏传参数请求体中 params 缺少必填项
OP1003参数值不合法(格式错误或为空),请修正参数值1. 请求体中必填项为空("" 或 null);2. 参数类型与接口约定不符;3. 传入参数的格式不符合合法取值说明
OP1004请求内容为空请求内容为空
OP1005无效的请求 URL无效的请求 URL
OP1006SDK 异常1. 调用 SDK 时,请求体中 head 为空;2. head 中缺少字段;3. head 中存在空字段
OP1007无效的方法调用1. 调用对外接口时,system.appId 为空("" 或 null);2. 调用非用户模块接口时,params.token 不存在或 params.token 为空("" 或 null)
OP1008appId 为空system.appId 取值不符合规范
OP1009权限不足,无法执行此操作1. 设备未被当前用户绑定;2. 调用直播相关接口时,appId 不在白名单中;3. 调用直播相关接口时,token 不是管理员 token
OP1010应用已冻结当前 App 状态为已冻结
OP1011接口调用次数超限(应用级/未发布应用等)总额度或应用级限流场景;按接口日限额超限见 OP1014 与 接口调用限额
OP1012调用接口权限不足调用接口权限不足
OP1013接口调用次数超限(总次数)部分接口设有总调用次数上限,开发者调用超过配置次数时将返回此错误码
OP1014接口调用次数超限(每日)部分接口设有每日调用次数上限,开发者调用超过配置次数时将返回此错误码
OP1015权限不足,无法执行此操作。(设备非开放平台绑定设备)权限不足,无法执行此操作。(该设备非开放平台绑定设备)
OP1016请求的设备相关接口已达上限开发者每周可操作的设备通道数不能超过当前开发者购买的设备接入数
OP1019该时段未生成录像该时段未生成录像
OP1021获取回放地址失败获取回放地址失败
OP1023kitToken 已过期,请重新获取kitToken 已过期,请重新获取
OP1026请求过于频繁,请稍后再试同一用户同时请求同一 token 相关接口时,少数情况下会出现此错误码

签名与请求校验

错误码说明场景
SN1001签名校验异常请求体中 system.sign 的值与 OpenApi 计算的签名不一致
SN1002签名超时请求体中 system.time 与请求时间戳偏差不应超过 5 分钟
SN1003签名参数错误请求体中 system.time 不是数值(含字母或特殊字符)
SN1004非法 appId非法 appId
SN1005nonce 重复开发者调用开放平台接口时传入的 nonce 在 5 分钟内不可重复,否则将返回此错误码

Token 鉴权

错误码说明场景
TK1001该账号(手机号)对应用户已绑定到您的应用
TK1002token 已过期或不存在,请重新获取 tokentoken 已过期或不存在,请重新获取 token
TK1003非法 token,请传入正确的 token请检查 token 与 appId 是否对应;若多个 appId 账号的 token 混用异常,将返回此错误码
TK1004当前用户手机号尚未绑定到您的应用请先进行「用户绑定」操作
TK1005绑定用户数超过上限未发布应用绑定用户数超过上限
TK1006当前手机号不是开发者账号手机号。开发者创建应用后,可在开放平台网站 > 开发中心 > 应用详情页查看管理员账号。
TK2001csrfToken 无效

设备与通道

错误码说明场景
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 分钟
DV1037NB 设备的 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 超时
WF1002Wi-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 取流鉴权

错误码说明场景
P2P001P2P 鉴权接口:鉴权 ID 已过期
P2P002P2P 鉴权接口:header 字段参数缺失
P2P003token 已过期
P2P004无设备权限

综治员绑定

错误码说明场景
AD1001未绑定总管理员

设备本地存储

错误码说明场景
LD1001设备本地无存储介质

配件

错误码说明场景
AP1001配件不存在
AP1002配件离线

接入额度与流量

错误码说明场景
FL1001开发者剩余接入次数不足开发者可登录开放平台网站,在「已购资源」中查看剩余设备通道接入次数
FL1002开发者当前无可用带宽音视频预览(实时预览、录像回放)时,系统检测到开发者无剩余流量且未购买带宽,将返回错误。可登录开放平台网站,在「已购资源」中查看剩余流量与可用带宽
FL1003开发者当前带宽超过配额上限音视频预览(实时预览、录像回放)时,系统检测到开发者带宽使用超限,将返回错误。可登录开放平台网站,在控制台「我的资源」中查看剩余流量与可用带宽
FL1004开发者剩余流量不足音视频预览(实时预览、录像回放)时,系统检测到开发者无剩余流量且未购买带宽,将返回错误。可登录开放平台网站,在「已购资源」中查看剩余流量与可用带宽
FL1005开发者拉取音视频时无可用带宽且剩余流量不足音视频预览(实时预览、录像回放)时,系统检测到开发者无剩余流量且未购买带宽,将返回错误。可登录开放平台网站,在「已购资源」中查看剩余流量与可用带宽

人脸库与 AI 分析

错误码说明场景
PF1001repositoryToken 不存在
PF1002faceToken 不存在
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授权码无效授权码过期或已使用
OA1007OAuth appId 无效OAuth 项目 Access Key 与请求上下文不匹配
OA1008refreshToken 已过期refresh_token 刷新被拒绝
API 请求示例
接口调用限额