FBox 列表获取
- 接口功能
获取当前用户名下的所有FBox分组,以及分组下的FBox相关参数。
请求地址:(二选一)
旧版:
URL:
[App Server]/api/client/box/grouped
新版:
URL:
[Host Server]/api/client/box/grouped
URL :
[Host Server]/api/client/v2/box/grouped?lite=true
地址参数说明
参数名 类型 参数描述 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 接口异常或者网络异常 调用案例如下图