• 快速入门
  • 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分组,以及分组下的FBox相关参数。

    • 请求地址:(二选一)

      旧版:

      URL: [App Server]/api/client/box/grouped

      新版:

      URL1: [Host Server]/api/client/box/grouped

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

    • 地址参数说明

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

      GET

    • Headers

      参数名 类型 参数描述
      Authorization string Bearer+ 空格+登录接口中获得的access_token
    • Body

      NULL

    • 返回字段

      服务器FBox分组返回一个数组,数组中每一个元素 {JSON对象类型}代表一个分组返回结构如下:

      分组单元JSON对象结构

      参数名 类型 参数描述
      id string FBox分组ID
      name string FBox分组名称
      boxRegs JSON Array 参考下表

      boxRegs JSON 数组元素属性:

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

      box 对象属性:

      参数名 类型 参数描述
      uid string FBox的Id,接口Url中的BoxId参数
      id string FBox的Id,接口Url中的BoxId参数
      boxNo string FBox序列号
      boxType int 0:标准盒子,1:mini盒子,2,4,7是lite盒子,5是link盒子
      connectionState int (FBox在线状态) 0:未知 1:已连接 2:超时 3:断开
      cs json对象 apiBaseUrl:盒子连接的服务器地址,signalrUrl:盒子数据推送的SignalR地址
      commserver 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:正常
      userPassword string 盒子密码
      currentSessionId string 当前进程id (参数无意义)
    • 返回码

      参数名 参数描述
      401 accessToken过期
      404 接口不存在,请检查URL
      429 调用接超过频率限制,详情见429状态码
      500 接口异常或者网络异常
    • 调用案例如下图

    • URL2返回参数示例:

    [{
        "id": "20506", // 分组Id
        "name": "Shared From Others", // 分组名称
        "node": "0", // 分级节点
        "boxRegs": [ // 盒子列表
            {
                "id": "129", // 盒子Id
                "alias": "DESKTOP", // 盒子别名
                "boxNo": "300015050009", // 盒子号码
                "boxType": 0, // 盒子类型   0:Standard,1:Mini,2,4:Lite 3 VPN,5:FLink 7:Lite-New
                "connState": 1, // 盒子状态 0:未知,1:在线,2:超时,3:断开
                "net": 1, // 盒子联网方式    1:以太网 2:2G 3:3G,4:WIFI 5:4G
                "carrier": "UnknowCarrier", // 运营商
                "boxnet": 1, // 盒子类型    1:以太网 2:2G  3:3G,4:WIFI, 5:4G
                "vers": { // 固件版本
                    "fcs": 1516,
                    "fds": 3111,
                    "floader": 1251
                },
                "shared": true, // 是否分享别人
                "given": false, // 是否是被分享 
                "owned": true, // 是否是拥有者
            }
        ]
    }]
    

    .

    Back to top Generated by DocFX