中国电信物联网开放平台 API 参考
1.5.1
(V4)
中国电信股份有限公司物联网分公司
二〇一八年十二月
编制单位:
编制单位
中国电信股份有限公司物联网分公司平台运营部
修订记录:
版本号
日期
描述
04
2018/12/06
中国电信物联网开放平台 API 参考 1.5.1
(1) 部分接口补充了流控错误码 1010004,创建设备
命令接口新增了错误码 100501;
(2) 查询设备历史数据接口,pageSize 增加最大值为
2000 的描述;
(3) 设备状态中 INBOX 状态不再使用,删除。
(4) 命令下发分类下增加批量创建设备命令接口,接
口功能使用批量任务接口功能实现。
03
2018/09/29
中国电信物联网开放平台 API 参考 1.5.1
(5) 删除了 NB-IoT 场景未使用到的几种订阅类型及对
应的通知消息;
(6) 对于每种订阅类型,增加说明订阅该通知类型
后,会对应推送哪种通知消息;
(7) 对 gatewayId 参数进行了更具体的填写说明描
述;
(8) timezone 参数的示例修改为 Asia/Shanghai;
(9) 修改了鉴权 token 错误时,返回错误码不一致问
题。
02
2018/07/04
中国电信物联网开放平台 API 参考 1.5.1
(1) “注册直连设备”和“删除直连设备”接口修改
为“注册设备”和“删除设备”;
(2) 修正了个别接口的接口的样例中 url 存在冗余空格
问题,以及存在中文逗号问题;
(3) 注册设备接口中,verifyCode 在 NB-IoT 场景为必
选参数;补充了 isSecure 参数,使用户可注册安
全设备。
01
2018/06/05
中国电信物联网开放平台 API 参考 1.5.1
(1) 删除设备管理下 NB-IoT 场景不使用的接口;
(2) 修正了部分接口的接口请求样例参数位置错误问
题;
(3) 更新了订阅平台业务数据接口;
(4) 消息推送接口的响应参数中,增加响应消息,并
增加了响应示例。
01
2018/04/28
中国电信物联网开放平台 API 参考 1.5.0 首次发布
目 录
1 总体说明 .......................................................................................................................................... 1
1.1 网络结构 ..................................................................................................................................................................... 1
1.2 兼容性说明 ................................................................................................................................................................. 1
2 接口列表 .......................................................................................................................................... 3
2.1 应用安全接入 ............................................................................................................................................................. 3
2.1.1 鉴权 .......................................................................................................................................................................... 3
2.1.2 刷新 token ................................................................................................................................................................ 6
2.2 设备管理 ..................................................................................................................................................................... 9
2.2.1 注册设备 .................................................................................................................................................................. 9
2.2.2 刷新设备密钥 ........................................................................................................................................................ 14
2.2.3 修改设备信息 ........................................................................................................................................................ 19
2.2.4 删除设备 ................................................................................................................................................................ 24
2.2.5 查询设备激活状态 ................................................................................................................................................ 27
2.3 批量处理 ................................................................................................................................................................... 30
2.3.1 创建批量任务 ........................................................................................................................................................ 30
2.3.2 查询指定批量任务信息 ........................................................................................................................................ 36
2.3.3 查询批量任务的子任务信息................................................................................................................................. 40
2.4 规则管理 ................................................................................................................................................................... 45
2.4.1 创建规则 ................................................................................................................................................................ 45
2.4.2 修改规则 ................................................................................................................................................................ 67
2.4.3 删除规则 ................................................................................................................................................................ 74
2.4.4 查找规则 ................................................................................................................................................................ 76
2.4.5 修改规则状态 ........................................................................................................................................................ 80
2.4.6 批量修改规则状态 ................................................................................................................................................ 83
2.5 订阅管理 ................................................................................................................................................................... 87
2.5.1 订阅平台业务数据 ................................................................................................................................................ 88
2.5.2 订阅平台管理数据 ................................................................................................................................................ 92
2.5.3 查询单个订阅 ........................................................................................................................................................ 95
2.5.4 批量查询订阅 ........................................................................................................................................................ 97
2.5.5 删除单个订阅 ...................................................................................................................................................... 101
2.5.6 批量删除订阅 ...................................................................................................................................................... 103
2.6 消息推送 ................................................................................................................................................................. 106
2.6.1 注册设备通知 ...................................................................................................................................................... 106
2.6.2 绑定设备通知 ...................................................................................................................................................... 110
2.6.3 设备信息变化通知 .............................................................................................................................................. 114
2.6.4 设备数据变化通知 .............................................................................................................................................. 118
2.6.5 批量设备数据变化通知 ...................................................................................................................................... 120
2.6.6 设备服务信息变化通知 ...................................................................................................................................... 123
2.6.7 删除设备通知 ...................................................................................................................................................... 125
2.6.8 命令状态变化通知 .............................................................................................................................................. 126
2.6.9 增加设备模型通知 .............................................................................................................................................. 128
2.6.10 删除设备模型通知 ............................................................................................................................................ 130
2.6.11 规则事件通知 .................................................................................................................................................... 132
2.6.12 软件升级状态变更通知 .................................................................................................................................... 135
2.6.13 软件升级结果通知 ............................................................................................................................................ 137
2.6.14 固件升级状态变更通知 .................................................................................................................................... 139
2.6.15 固件升级结果通知 ............................................................................................................................................ 141
2.7 命令下发 ................................................................................................................................................................. 143
2.7.1 创建设备命令 ...................................................................................................................................................... 143
2.7.2 查询设备命令 ...................................................................................................................................................... 150
2.7.3 修改设备命令 ...................................................................................................................................................... 157
2.7.4 批量创建设备命令 .............................................................................................................................................. 161
2.7.5 创建设备命令撤销任务 ...................................................................................................................................... 162
2.7.6 查询设备命令撤销任务 ...................................................................................................................................... 167
2.8 数据采集 ................................................................................................................................................................. 174
2.8.1 查询单个设备信息 .............................................................................................................................................. 175
2.8.2 批量查询设备信息 .............................................................................................................................................. 181
2.8.3 查询设备历史数据 .............................................................................................................................................. 190
2.8.4 查询设备服务能力 .............................................................................................................................................. 194
2.9 设备组管理 ............................................................................................................................................................. 201
2.9.1 创建设备组 .......................................................................................................................................................... 201
2.9.2 删除设备组 .......................................................................................................................................................... 205
2.9.3 修改设备组 .......................................................................................................................................................... 207
2.9.4 查询设备组列表 .................................................................................................................................................. 211
2.9.5 查询指定设备组 .................................................................................................................................................. 214
2.9.6 查询指定设备组成员 .......................................................................................................................................... 217
2.9.7 增加设备组成员 .................................................................................................................................................. 220
2.9.8 删除设备组成员 .................................................................................................................................................. 224
2.10 设备升级 ............................................................................................................................................................... 227
2.10.1 查询版本包列表 ................................................................................................................................................ 227
2.10.2 查询指定版本包 ................................................................................................................................................ 231
2.10.3 删除指定版本包 ................................................................................................................................................ 233
2.10.4 创建软件升级任务 ............................................................................................................................................ 235
2.10.5 创建固件升级任务 ............................................................................................................................................ 240
2.10.6 查询指定升级任务详情 .................................................................................................................................... 245
2.10.7 查询指定升级任务的子任务详情 ..................................................................................................................... 250
2.10.8 查询升级任务列表 ............................................................................................................................................ 254
3 术语表 .......................................................................................................................................... 260
1 总体说明
1 总体说明
1.1 网络结构
中国电信物联网开放平台(下文简称物联网平台)提供了海量 API 接口给第三方应用
开发者。通过调用平台的接口,开发者可以开发出基于多种行业设备的应用,如公共
事业、智慧家庭等,从而实现对设备的管理(包括设备的增、删、查、改)、数据采
集、命令下发和消息推送等功能。
1.2 兼容性说明
对于接口版本做了演进或者接口 url 做了修改的接口,其对应老版本的接口依然可以继
续使用,但接口的功能不再做增强。
1
建议使用新版本接口。
1 总体说明
2