• 快速入门
  • HTTP文档
  • .NET开发指南
  • DEMO下载
  • 调用HTTP常见问题
    Show / Hide Table of Contents
    • 登录接口
      • 名词解释
      • 用户登录
      • 重新登录
    • 写值流程
      • 新增FBox分组
      • FBox新增
      • 新增监控点分组
      • 新增数据监控点
      • FBox列表获取
      • FBox监控点列表
      • 监控点值写入
      • 获取监控点值
    • 获取信息接口
      • 获取单个盒子
      • 获取监控点分组
      • 获取某些监控点
      • 根据监控点分组获取监控点
      • 获取物联网卡Iccid、Imei
      • 获取盒子地理位置
    • 远程下载
      • 获取FBox驱动列表
      • 下载盒子驱动
      • 获取连接设备的寄存器类型
      • 获取服务器驱动列表
    • 盒子修改接口
      • 修改FBox分组
      • FBox名称修改
      • 修改数据监控点
      • 修改省流量模式刷新间隔
    • 盒子删除接口
      • 删除FBox分组
      • FBox删除
      • 删除监控点分组
      • 删除数据监控点
    • 报警接口
      • 报警分组接口
        • 获取报警分组列表
        • 新增报警分组
        • 修改报警分组
        • 删除报警分组
      • 报警联系人接口
        • 获取报警联系人列表
        • 获取单个报警联系人
        • 新增报警联系人
        • 修改报警联系人
        • 删除报警联系人
      • 报警记录接口
        • 获取报警条目列表
        • 获取某些报警条目
        • 新增报警条目
        • 修改报警条目
        • 删除报警条目
        • 获取报警历史
        • 获取报警条目状态
        • 确认报警
    • 历史记录接口
      • 获取历史记录条目
      • 获取某些历史记录条目
      • 新增历史记录
      • 更新历史记录
      • 删除历史记录
      • 获取历史记录数据
    • 监控点推送控制接口
      • 开启某监控点组别
      • 停止某监控点组别
      • 开启监控点组别列表
      • 停止监控点组别列表
      • 开启FBox所有监控点
      • 停止FBox所有监控点
      • 开启某条监控点
      • 停止某条监控点
      • 开启某些监控点
      • 停止某些监控点
      • 只开启某些监控点
      • 只开启某监控点组
      • 只开启某些监控点组
    • 数据推送(SignalR)
      • 实时数据推送(signalR)
      • FBox状态变更推送
      • 实时数据推送
      • 报警触发推送
      • 报警还原推送
    • 统一写值
      • 获取所有统一写分组
      • 统一写分组值写入
    • 附录
      • 附录一
      • 附录二
      • 附录三
      • 429状态码

    获取单个盒子

    • 接口功能

      获取当前用户名下的所有FBox分组,以及分组下的FBox的相关参数

    • 请求地址:(二选一)

      旧版:

      URL:[App Server]/api/client/box/reg/boxno/{boxNo}

      新版:

      URL1:[Host Server]/api/client/box/reg/boxno/{boxNo}

      URL2:[Host Server]/api/client/v2/box/single (本接口返回参数请参照下URL2返回参数示例)

    • 地址参数说明

      参数名 类型 参数描述
      App Server string 详情见名词解释
      boxNo string 盒子编码
    • 请求方式

      GET

    • Headers

      参数名 类型 参数描述
      Authorization string Bearer+ 空格+登录接口中获得的access_token
    • Body (旧版,新版URL1地址的Body为NULL)

      字段名 类型 描述
      boxNo string 盒子号码
    • 响应成功

      注: 接口返回的参数很多,文档中列出来的参数是基本有需要用到的参数,其他的参数没有写在文档中的是用不到的参数,请大家忽略就好。

      返回字段

      参数名 类型 参数描述
      id string 用户添加(分享)盒子时系统分配的和本人账号关联的注册ID
      boxUid string FBox的id
      alias string FBox别名
      regData string FBox注册时间
      owned boolean 是否为拥有者
      shared boolean 是否被分享
      box json对象 参考下表
      group json对象 FBox所属分组
      group_Id string FBox所属分组id
      user json对象 FBox所属的用户信息
      user_Id string FBox所属用户名id

      box 对象属性:

      参数名 类型 参数描述
      id string FBox的uid
      boxNo string FBox序列号
      boxType string 0:标准盒子,1:mini盒子,2,4,7是lite盒子,3是vpn,5是link盒子
      connectionState int
      cs json对象 apiBaseUrl:盒子连接的服务器地址。
      signalrUrl:盒子数据推送的SignalR地址
      devicePrimarySource int FBox驱动数据源,0:FBox,1:服务器
      memo string 备注信息
      net int 0:未知 1:以太网2:GPRS 4:WIFI(不支持) 5:4G
      mode int 1:透传中,0:正常
      useLongitude double 手动定位的经度
      useLatitude double 手动定位的纬度
      longitude double 自动定位的经度
      latitude double 自动定位的纬度
      useAddress string 手动定位地址
      address string 自动定位详细地址
      radius int 经度半径

      group属性对象:

      参数名 类型 参数描述
      id string FBox所属分组id
      name string FBox所在的分组名称

      user属性对象:

      参数名 类型 参数描述
      userName string FBox所在的用户名称
      email string FBox所在用户的邮箱
      phoneNumber string FBox所在用户的手机号码
    • 返回码

      参数名 参数描述
      401 accessToken过期
      404 盒子不存在
    • URL2返回的参数示例:

      {
          "groupId": "-5664208223641498256", // 分组Id
          "groupName": "vSIM", // 分组名称
          "id": "-7595695330289513291", // 盒子Id
          "alias": "VSIM", // 别名
          "owner": { // 拥有者信息
              "userName": "BOX", // 用户名
              "email": "", // 邮箱
              "phoneNumber": "" // 手机号码
          },
          "boxNo": "300221041035", // 盒子号码
          "boxType": 0, //盒子类型 0:Standard,1:Mini,2,4:Lite,3:VPN,5:FLink,7:Lite-New
          "connState": 1, //盒子状态 0:未知,1:在线,2:超时,3:断开
          "net": 5,
          "carrier": "ChinaTelcom",
          "boxnet": 7,
          "vers": {
              "fcs": 1517,
              "fds": 3111,
              "floader": 1253
          },
          "shared": false,
          "given": false,
          "owned": true
      }
      
    Back to top Generated by DocFX