开始使用
  • English
  • 简体中文
前往官网
开始使用
  • English
  • 简体中文
前往官网
  • 开始使用
  • 核心概念
  • 开发指南
  • 设备能力与事件参考
  • API 参考
    • 公共约定
    • HTTP 开发规范
    • accessToken(管理员 Token)
    • API 请求示例
    • 错误码
    • 接口调用限额
    • 账号与授权
    • 设备接口
      • bindDevice(绑定设备)
      • unBindDevice(解绑设备)
      • device.detail.list(按 ID 批量详情)
      • device.detail.page(分页详情)
      • device.status.get(查询在离线)
      • device.prebind.get(绑定前信息)
      • device.bindstate.get(是否已绑定)
      • subAccountDeviceInfo(获取子账号指定授权设备详情)
      • subAccountDeviceList(分页获取子账号授权设备详情)
      • setDeviceSnap(设备抓图)
      • setDeviceSnapEnhanced(设备抓图增强)
      • timeZoneConfigByDay(按日期设置设备时区夏令时)
      • timeZoneConfigByWeek(按周设置设备时区夏令时)
      • timeZoneQueryByDay(按日查询设备时区夏令时)
      • timeZoneQueryByWeek(按周查询设备时区夏令时)
    • 直播地址
    • 推送配置
    • 云存储
    • 资源池额度管理
    • 旧版接口(不再维护)
  • SDK 与工具
  • 方案
  • 平台与支持
本页目录
功能详情
请求地址
最小权限
传入参数说明
样例输入
返回 data 字段说明
样例输出
错误码

device.prebind.get(绑定前信息)

device.prebind.get:绑定前信息

功能详情

扫码 / 配网用。走设备容量查询,不走已绑定关系。本方法不会出现在 device.capability.list 里。返回为设备级,无 channelList。

请求地址

POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.prebind.get

最小权限

管理员 / 子用户 / 子账号 token 均可,只验 token。

传入参数说明

参数名参数类型是否必填默认值合法值参数说明
tokenString是管理员、子用户或子账号 accessToken
deviceIdString是设备序列号
productIdString否可选提示
deviceCodeModelString否配网辅助
deviceModelNameString否配网辅助
ncCodeString否配网辅助

样例输入

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "system": {
 "ver": "1.0",
 "appId": "lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time": 1706511734,
 "nonce": "f5a1ae2d-c09c-4d39-a744-83a5c2c653c2"
 },
 "params": {
 "token": "<yourAccessToken>",
 "deviceId": "TESTIPC000012345"
 }
}

返回 data 字段说明

参数名参数类型参数说明
deviceIdString设备序列号
productIdString型号
supportBoolean是否支持接入:true / false
initStatusString初始化状态
deviceExistString"exist" / "notExist"
bindStatusString绑定状态
userAccountString仅已被其他账号绑定时返回,值为绑定者账号;未绑定或本账号绑定则不返回该字段
accessTypeString接入类型
statusString状态
wifiConfigModeString当前配网方式
defaultWifiConfigModeString默认配网方式
wifiConfigModeOptionalString可选配网方式
wifiTransferModeString频段
brandString品牌
deviceCodeModelString设备码型号
deviceModelNameString型号名
catalogString大类
typeString类型
channelNumInt通道数
deviceModelString型号
deviceTypeString设备类型
deviceSpecString规格
capabilityIdsString[]一组能力的 id。不要拿去发 get / set / invoke
deviceHeartbeatInt未绑定(bindStatus: "unbind")且响应中含非空 productId 时返回:1 表示设备心跳正常,0 表示未检测到有效心跳;已绑定或无 productId 时不返回该字段
httpPortString海外端口
rtspPortString海外端口
tlsPrivatePortString海外端口

样例输出

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "deviceId": "TESTIPC000012345",
 "productId": "56WGTET2",
 "support": true,
 "initStatus": "uninitialized",
 "deviceExist": "exist",
 "bindStatus": "unbind",
 "status": "offline",
 "wifiConfigMode": "SMARTCONFIG",
 "defaultWifiConfigMode": "SMARTCONFIG",
 "wifiConfigModeOptional": "SMARTCONFIG,SOUNDWAVE",
 "wifiTransferMode": "2.4G",
 "brand": "lechange",
 "deviceCodeModel": "",
 "deviceModelName": "IPC-C22EP",
 "catalog": "IPC",
 "type": "IPC",
 "channelNum": 1,
 "deviceModel": "IPC-C22EP",
 "deviceType": "IPC",
      "deviceSpec": "",
      "deviceHeartbeat": 1,
      "capabilityIds": ["detection.motion"]
 }
 }
}

错误码

本接口可能返回下列码;完整分组见 错误码 与 能力错误码。

网关与鉴权(SN / TK / OP)

错误码错误码说明下一步
SN1001签名校验异常按 HTTP 开发规范 核对 sign
TK1002token 无效或过期重新获取 accessToken
OP1002缺少必填参数补必填字段
OP1003参数不合法按本页参数表核对
OP1009权限不足核对 token 与设备绑定/分享权限
OP1013接口总次数超限降低调用频率
OP1014接口日限额超限见 接口调用限额
DV1007设备离线等设备上线

更多见 错误码 · OP/SN/TK。

设备绑定(DV10xx)

错误码错误码说明下一步
DV1001已被其他账号绑定解绑或换设备
DV1002设备不存在核对序列号
DV1003已被当前账号绑定无需重复绑定
DV1005验证码错误核对设备机身码
DV1008绑定数量超限解绑冗余设备
DV1011设备未绑定先执行绑定
DV1029设备已被绑定勿重复绑定

更多见 错误码 · DV。

device.status.get(查询在离线)
device.bindstate.get(是否已绑定)