电信物网开放平台_北向PI Jv SDK说明文档_v10_第1页
电信物网开放平台_北向PI Jv SDK说明文档_v10_第2页
电信物网开放平台_北向PI Jv SDK说明文档_v10_第3页
电信物网开放平台_北向PI Jv SDK说明文档_v10_第4页
电信物网开放平台_北向PI Jv SDK说明文档_v10_第5页
已阅读5页,还剩63页未读 继续免费阅读

下载本文档

版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领

文档简介

中国电信物联网开放平台_北向API Java SDK说明文档(V1)中国电信股份有限公司物联网分公司二二二二年一月编制单位:编制单位中国电信股份有限公司物联网分公司平台运营部修订记录:版本号日期描述012017/11/06中国电信物联网开放平台_北向API Java SDK说明文档目 录1 前言12 开发者必读23 SDK使用介绍53.1 SDK的使用53.2 accessToken与appId的概念53.2.1 接口入参中的accessToken53.2.2 接口入参中的appId64 接口列表64.1 应用安全接入64.1.1 获取鉴权Token64.1.2 刷新鉴权Token74.2 设备管理84.2.1 注册直连设备84.2.2 查询设备激活状态104.2.3 删除直连设备104.2.4 修改设备信息114.2.5 刷新设备密钥134.3 数据采集144.3.1 按条件批量查询设备信息列表144.3.2 查询单个设备信息174.3.3 查询设备历史数据184.3.4 查询设备能力204.3.5 应用订阅平台数据234.4 信令传送244.4.1 创建设备命令V4244.4.2 查询设备命令V4264.4.3 修改设备命令V4284.4.4 创建设备命令撤销任务V4304.4.5 查询设备命令撤销任务V4314.5 设备服务调用324.5.1 设备服务调用324.6 批量处理354.6.1 创建批量任务354.6.2 查询单个任务信息364.6.3 查询任务详情信息384.7 规则引擎394.7.2 更新规则474.7.3 修改规则状态484.7.4 删除规则484.7.5 查询规则494.7.6 批量修改规则状态504.8 证书认证514.8.1 测试双向认证514.8.2 自定义双向认证525 SDK的其他说明525.1 SDK依赖的开源组件535.2 异常介绍535.3 直连设备与非直连设备的概念546 常用数据结构定义16.1 DeviceInfo类说明16.2 DeviceService类说明26.3 Pagination类说明36.4 AsynCommandDTO类说明36.5 SDK中类方法的说明36.5.1 NorthApiClient类方法36.5.2 Clientinfo类方法46.5.3 NorthApiException类方法46.5.4 SSLConfig类57 附录57.1 非直连设备的添加57.2 NB-IoT方案集成简介87.3 softradio简介错误!未定义书签。1 前言导读本文描述了针对中国电信物联网开放平台(下文简称平台)北向接口的SDK(Software Development Kit)。通过使用SDK,合作伙伴的应用服务器可以快速接入平台。本文档主要包含如下几个部分:章节说明备注开发者必读主要是介绍SDK提供的能力SDK使用介绍介绍了SDK使用须知接口列表主要是描述能力开放的接口集合,详细介绍每个接口的功能、输入参数、输出参数等信息。常用数据结构定义主要是给出主要的数据结构、枚举的定义。附录拓展说明附件Java SDK包,以及使用SDK包的样例代码2 开发者必读1. 简介本文档是中国电信物联网开放平台(后文以平台或IoT平台指代中国电信物联网开放平台)北向Java SDK的说明文档。本SDK用于伙伴应用服务器与平台的对接。通过调用SDK接口,可以实现平台服务的调用。SDK是将原先供伙伴服务器调用restful API封装起来,因此在调用平台服务时,需要通过SSL证书的双向认证。2. 接口全景图集成开发者通过全景图了解到:SDK提供了哪些功能?每个功能包含哪些接口?接口之间的逻辑关系如何?从而更快速的找到正确的接口来实现具体业务。功能接口说明双向认证配置NorthApiClient.initSSLConfig双向认证初始化,根据入参的不同,有测试双向认证和自定义双向认证两个重载方法应用安全接入Authentication.getAuthToken获取鉴权accessTokenAuthentication.refreshAuthToken刷新鉴权accessTokenAuthentication.logoutAuthToken注销 accessToken设备管理DeviceManagement.regDirectDevice注册直连设备DeviceManagement.modifyDeviceInfo修改设备信息DeviceManagement.queryDeviceStatus查询设备激活状态DeviceManagement.deleteDidrectDevice删除直连设备DeviceManagement.refreshDeviceSecret刷新设备密钥DeviceManagement.setEncrypt设置加密数据采集DataCollection.queryDeviceData查询单个设备信息DataCollection.querydevices按条件批量查询设备信息列表DataCollection.queryDeviceCapabilities查询设备能力DataCollection.queryDataHistory查询设备历史数据DataCollection.subscribeNotify伙伴服务器订阅平台数据信令传送SignalDelivery.postDeviceCommand创建设备命令V4SignalDelivery.queryDeviceCommand查询设备命令V4SignalDelivery.updateDeviceCommand修改设备命令V4SignalDelivery.createDeviceCmdCancelTaskV4创建设备命令你个撤销任务V4SignalDelivery.queryDeviceCmdCancelTask查询设备命令撤销任务V4设备服务调用DeviceServiceInvocation.invocateDeviceService设备服务调用批量处理BatchProcess.createBatchTask创建批量任务BatchProcess.queryOneTask查询单个任务信息BatchProcess.queryTaskDetails查询任务详情信息规则引擎RuleEngine.creatRule创建规则RuleEngine.deleteRule更新规则RuleEngine.queryRules修改规则状态RuleEngine.updateRule删除规则RuleEngine.changeRuleStatus查找规则RuleEngine.batchChangeRuleStatus批量修改规则状态3 SDK使用介绍3.1 SDK的使用SDK API为伙伴提供应用安全接入、设备管理、数据采集、信令传送、设备服务调用、批量处理、规则等业务功能。功能的实现依赖于SDK中NorthApiClient类,其使用步骤如下:/1 新建对象NorthApiClientNorthApiClient northApiClient = new NorthApiClient();/2初始化ClientInfoClientInfo clientInfo = new ClientInfo();String appId = ax2M*XJEa;String secret = u3rJ*35oa;clientInfo.setAppId(appId);clientInfo.setPlatformIp(100.*.*.30);clientInfo.setPlatformPort(8743);clientInfo.setSecret(secret);northApiClient.setClientInfo(clientInfo);/3 证书配置,使用默认调试证书可以如下配置northApiClient.initSSLConfig();/4 新建服务对象,并初始化,以鉴权为例Authentication auth = new Authentication(northApiClient);/5 调用SDK APIAuthOutDTO authOutDTO = auth.getAuthToken();3.2 accessToken与appId的概念3.2.1 接口入参中的accessToken伙伴的服务器携带在平台产生的appId和secret调用鉴权接口,获取鉴权accessToken。在后续业务服务每次调用都需要携带accessToken,平台对accessToken进行鉴权。accessToken在一段时间(一般平台配置的是3600s)后会失效。为了便于伙伴的服务器对token进行管理,每次调用SDK API接口都需要重新输入accessToken,来保证调用成功。3.2.2 接口入参中的appIdappId是应用的唯一标志,应用与应用之间可以存在授权与被授权关系,如若应用A被应用B授权,应用A就可以通过在入参中携带应用B的appId,对应用B下的设备进行管理与业务调用。不是所有接口都在入参中携带有appId,只有携带有appId的接口才可以进行授权的调用。如下“创建设备命令”接口,在入参中携带有appId。public PostDeviceCommandOutDTO postDeviceCommand(PostDeviceCommandInDTO pdcid,String appId, String accessToken)throws NorthApiException如果不存在应用授权关系,入参中的appId可以不赋值或赋值为自身的appId。4 接口列表SDK API为伙伴提供应用安全接入、设备管理、数据采集、信令传送、设备服务调用、批量处理、规则。4.1 应用安全接入伙伴的服务器携带在平台产生的appId和secret调用鉴权接口,获取鉴权token。4.1.1 获取鉴权Token接口功能获取平台accessToken。接口描述public AuthOutDTO getAuthToken() throws NorthApiException接口所属类Authentication参数说明appId和secret使用NorthApiClient成员变量的ClientInfo中的值。接口返回值AuthOutDTO字段类型描述scopeString范围,默认值defaulttokenTypeString鉴权token类型,默认值bearerexpiresInInteger平台生成并返回accessToken的有效时间,单位秒accessTokenStringOauth 2.0 鉴权参数refreshTokenStringOauth 2.0 鉴权参数,用来刷新accessToken。(1个月的有效期)4.1.2 刷新鉴权Token接口功能accessToken快过期时,第三方系统通过调用此接口,重新获取可用token。接口描述public AuthRefreshOutDTO refreshAuthToken(AuthRefreshInDTO arid) throws NorthApiException接口所属类Authentication参数说明AuthRefreshInDTO字段必选/可选类型描述appId必选String用户名,填写应用程序IDsecret必选String登录用户口令,填写应用程序密码refreshToken必选String刷新令牌,用于获取一个新的accessToken接口返回值AuthRefreshOutDTO字段类型描述scopeString范围tokenTypeString鉴权token类型,默认值bearerexpiresInString平台生成并返回accessToken的有效时间,单位秒4.2 设备管理设备管理为伙伴应用服务器提供了申请设备的增,删,改,查以及修改设备基本信息的接口实现对新增设备接入灵活操作。4.2.1 注册直连设备接口功能应用程序添加直连设备,获取设备的验证码(即下文中的verifyCode),并在设备绑定时携带验证码,获取设备唯一标识和密码。接口描述public RegDirectDeviceOutDTO regDirectDevice(RegDirectDeviceInDTO rddid, String appId, String accessToken) throws NorthApiException接口所属类DeviceManagement参数说明字段必选/可选类型描述appId可选String应用唯一标志。供被授权的应用使用。accessToken必选String通过鉴权接口获得。RegDirectDeviceInDTO字段必选/可选类型描述verifyCode可选String若应用服务器携带出verifyCode则返回的就是这个verifyCode。如果不指定,系统自动生成。verifyCode一般需要指定,如智慧家庭解决方案多用设备的mac地址,而NB-IoT方案设备使用设备IMEI。nodeId必选String设备唯一标识, 如:MAC或SIM卡号或设备esn号等。与设备对接时,必须与设备上报的nodeId一致。备注:nodeId和verifyCode需要填写为设备唯一标识。高通芯片设备的唯一标识为urn:imei:xxxx,xxxx为IMEI号;海思芯片设备的唯一标识为IMEI号,其他种类芯片的设备唯一标识请联系模组厂商确认。endUserId可选String终端用户Id,如手机号码,email地址psk可选Stringpsk码,用于生成设备鉴权参数;如不传入,系统自动生成timeout可选Integer单位秒,不填使用默认值(180s), 填写0则永不过期,非0表示在指定时间内设备进行绑定,超过时间验证码无效接口返回值RegDirectDeviceOutDTO字段类型描述deviceIdString设备唯一标识,1-64个字节verifyCodeString申请的临时验证码,设备可以通过验证码获取id和密码timeoutInteger验证码有效时间,单位秒,设备需要在有效时间内接入平台pskStringpsk码,用于生成设备鉴权参数4.2.2 查询设备激活状态接口功能根据设备的deviceId查询设备的激活状态。接口描述public QueryDeviceStatusOutDTO queryDeviceStatus(String deviceId, String appId, String accessToken) throws NorthApiException接口所属类DeviceManagement参数说明字段必选/可选类型描述appId可选String应用唯一标志。供被授权的应用使用。accessToken必选String通过鉴权接口获得。deviceId必选String设备唯一标识,1-64个字节接口返回值QueryDeviceStatusOutDTO字段类型描述deviceIdString设备唯一标识,1-64个字节activatedboolean是否通过验证码获取密码的状态标识true:已激活;false:未激活nameString设备名称4.2.3 删除直连设备接口功能用来删除直连设备。接口描述public void deleteDirectDevice(String deviceId, String appId, String accessToken) throws NorthApiException接口所属类DeviceManagement参数说明字段必选/可选类型描述appId可选String应用唯一标志。供被授权的应用使用。accessToken必选String通过鉴权接口获得。deviceId必选String设备唯一标识,1-64个字节接口返回值null4.2.4 修改设备信息接口功能开放给伙伴服务器的修改设备信息的接口。本接口在NB-IoT方案中必选,否则无法将设备与对应的Profile文件关联。详见附录中NB-IoT方案集成简介。接口描述public void modifyDeviceInfo(ModifyDeviceInfoInDTO mdiid, String appId, String accessToken)接口所属类DeviceManagement参数说明字段必选/可选类型描述appId可选String应用唯一标志。供被授权的应用使用。accessToken必选String通过鉴权接口获得。ModifyDeviceInfoInDTO字段必选/可选类型描述name可选String设备名称endUser可选String终端用户,若设备为网关,则endUser可选;若设备是通过网关接入的,则endUser必须为null。mute可选Enum表示设备是否处于冻结状态,即是否上报数据(处于冻结状态,则不上报数据),取值有“TRUE”,“FALSE”manufacturerId可选String厂商IDmanufacturerName可选String厂商名location可选String设备的位置deviceType可选String设备类型: 大驼峰命名方式MultiSensorContactSensorCameraGatewaymodel可选String型号z-wave: ProductType + ProductId16 进制: XXXX-XXXX 补0对齐如:001A-0A12其他协议再定protocolType可选String设备协议类型deviceConfig可选DeviceConfigDTO设备配置信息,自定义结构体(见下表)region可选String设备所在地区organization可选String设备所属组织timezone可选String设备所在时区DeviceConfigDTO字段必选/可选类型描述dataConfig可选DataConfigDTO数据配置信息,自定义结构体(见下表)DataConfigDTO字段必选/可选类型描述dataAgingTime可选Integer0,90数据老化时长配置,取值:090,单位:天接口返回值null4.2.5 刷新设备密钥接口功能支持刷新注册到本应用的设备和授予权限(详见章节接口入参中的appId)的其它应用的设备;密钥刷新后,deviceId不变,nodeId值发生变化,设备需要重新绑定。接口描述public RefreshVerifyCodeOutDTO refreshDeviceSecret(RefreshVerifyCodeInDTO rdsid, String appId, String accessToken) throws NorthApiException接口所属类DeviceManagement参数说明字段必选/可选类型描述appId可选String应用唯一标志。供被授权的应用使用。accessToken必选String通过鉴权接口获得。RefreshVerifyCodeInDTO字段必选/可选类型描述deviceId必选String(256)设备Idrequest必选RefreshVerifyCodeDTO详见下表RefreshVerifyCodeDTO字段必选/可选类型描述verifyCode可选String客户端给出verifyCode则返回的就是这个verifyCode,即使用客户端给出的verifyCode。如果不指定,系统自动生成。NB场景下,verifyCode必须与nodeId保持一致。nodeId必选String设备唯一标识, 如:MAC或SIM卡号或设备esn号等。与设备对接时,必须与设备上报的nodeId一致。备注:nodeId和verifyCode需要填写相同的值。高通芯片设备的唯一标识为urn:imei:xxxx,xxxx为IMEI号;海思芯片设备的唯一标识为IMEI号,其他种类芯片的设备唯一标识请联系模组厂商确认。timeout可选Integer单位秒,不填使用默认值(180s), 填写0则永不过期,非0表示在指定时间内设备进行绑定,超过时间验证码无效接口返回值RefreshVerifyCodeOutDTO字段类型描述verifyCodeString申请的临时验证码,设备可以通过验证码获取id和密码timeoutInteger验证码有效时间,单位秒,设备需要在有效时间内接入平台4.3 数据采集平台支持对设备事件的订阅,同时还支持查看设备上报的历史数据,能按时、天、月等维度查看传感器上报的历史数据。数据采集实现了对设备数据收集注册直连设备4.3.1 按条件批量查询设备信息列表接口功能按条件批量查询设备信息列表,如查询指定设备下的所有设备信息列表。接口描述public QueryDevicesOutDTO queryDevices(QueryDevicesInDTO qdid, String appId, String accessToken) throws NorthApiException接口所属类DataCollection参数说明字段必选/可选类型描述appId可选String应用唯一标志。供被授权的应用使用。accessToken必选String通过鉴权接口获得。QueryDevicesOutDTO字段必选/可选类型描述gatewayId条件可选String设备唯一标识(含网关的设备唯一标识)。当设备是直连设备时,gatewayId为设备本身的deviceId。当设备是非直连设备时,gatewayId为设备所关联的直连设备(即网关)的deviceId。gatewayId和pageNo不能同时为null,二者必选其一。nodeType可选String指定节点的类:ENDPOINT: 传感器.GATEWAY: 网关.deviceType可选String设备类型protocolType可选String协议类型(v1.3.0url携带)pageNo条件可选Integer分页查询参数, pageNo=null时查询内容不分页;取值大于等于0的整数时分页查询,等于0时查询第一页。gatewayId和pageNo不能同时为null,二者必选其一。gatewayId条件可选String设备唯一标识(含网关的设备唯一标识)。当设备是直连设备时,gatewayId为设备本身的deviceId。当设备是非直连设备时,gatewayId为设备所关联的直连设备(即网关)的deviceId。gatewayId和pageNo不能同时为null,二者必选其一。pageSize可选Integer分页查询参数,取值大于等于1的整数,缺省:1status可选String设备状态,取值:ONLINE在线;OFFLINE 不在线;ABNORMAL异常状态startTime可选String查询注册设备信息时间在startTime之后的记录。时间格式:yyyyMMddTHHmmssZ 如: 20151212T121212ZendTime可选String查询注册设备信息时间在endTime之前的记录。时间格式:yyyyMMddTHHmmssZ 如: 20151212T121212Zsort可选String指定返回记录的排序,可取值ASC按注册设备的时间升序排列; DESC按注册设备的时间降序排列缺省:DESC注:gatewayId和pageNo不能同时为空。接口返回值QueryDevicesOutDTO字段类型描述totalCountLong查询的记录数量pageNoLong返回的页码序号(大于等于0的整数,0代表第一页)pageSizeLong页码大小,当不分页查询时,取值等于totalCountdevicesList设备分页列表信息,见下表 QueryDeviceDTO字段类型描述deviceIdString设备唯一标识,1-64个字节gatewayIdString设备唯一标识。当设备是直连设备时,gatewayId为设备本身的deviceId。当设备是非直连设备时,gatewayId为设备所关联的直连设备(即网关)的deviceId。nodeTypeString指定节点的类型ENDPOINT: 传感器.GATEWAY: 网关.createTimeString设备注册时间;时间格式:yyyyMMddTHHmmssZ 如: 20151212T121212ZlastModifiedTimeString最新修改时间;时间格式:yyyyMMddTHHmmssZ 如: 20151212T121212ZdeviceInfoDeviceInfoDeviceInfo的定义参见DeviceInfo结构体说明servicesListDeviceService的定义参见DeviceService结构体说明4.3.2 查询单个设备信息接口功能查询指定设备的信息,信息包括设备的基本属性信息、是否在线、最后一次上报的业务数据等接口描述public QueryDeviceDataOutDTO queryDeviceData(String deviceId, String appId, String accessToken) throws NorthApiException接口所属类DataCollection参数说明字段必选/可选类型描述appId可选String应用唯一标志。供被授权的应用使用。accessToken必选String通过鉴权接口获得。deviceId必选String设备Id接口返回值QueryDeviceDataOutDTO字段类型描述deviceIdString设备唯一标识,1-64个字节gatewayIdString设备唯一标识。当设备是直连设备时,gatewayId为设备本身的deviceId。当设备是非直连设备时,gatewayId为设备所关联的直连设备(即网关)的deviceId。nodeTypeString指定节点的类型ENDPOINT: 传感器.GATEWAY: 网关.createTimeString设备注册时间;时间格式:yyyyMMddTHHmmssZ 如: 20151212T121212ZlastModifiedTimeString最新修改时间;时间格式:yyyyMMddTHHmmssZ 如: 20151212T121212ZdeviceInfoDeviceInfoDeviceInfo的定义参见DeviceInfo结构体说明servicesListDeviceService的定义参见DeviceService结构体说明4.3.3 查询设备历史数据接口功能查询设备历史上报的业务数据。接口描述public QueryDataHistoryOutDTO queryDataHistory(QueryDataHistoryInDTO qdhid, String appId, String accessToken) throws NorthApiException接口所属类DataCollection参数说明字段必选/可选类型描述appId可选String应用唯一标志。供被授权的应用使用。accessToken必选String通过鉴权接口获得。QueryDataHistoryInDTO字段必选/可选类型描述gatewayId必选String查询参数,网关的设备唯一标识。当设备是直连设备时,gatewayId为设备本身的deviceId。当设备是非直连设备时,gatewayId为设备所关联的直连设备(即网关)的deviceId。serviceId可选String服务Idproperty可选String服务属性数据appId可选String应用唯一标识pageNo可选Integer分页查询参数, pageNo=null时查询内容不分页;取值大于等于0的整数时分页查询,等于0时查询第一页pageSize可选Integer分页查询参数,取值大于等于1的整数,缺省值为1设备历史数据最多保存10万条,这个数值有可能被运营商修改startTime可选String查询参数,根据时间段查询的起始时间; 时间格式:yyyyMMddTHHmmssZ 如: 20151212T121212Z设备历史数据最多保存90天,这个数值有可能被运营商修改endTime可选String查询参数,根据时间段查询的结束时间; 时间格式:yyyyMMddTHHmmssZ 如: 20151212T121212Z接口返回值QueryDataHistoryOutDTO字段类型描述totalCountLong查询的记录数量pageNoLong返回的页码序号(大于等于0的整数,0代表第一页)pageSizeLong页码大小,当不分页查询时,取值等于totalCountdevicesList见下表 DeviceDataHistoryDTO字段类型描述serviceIdString服务IDdeviceIdString设备唯一标识,1-64个字节gatewayIdString网关的设备唯一标识,1-64个字节。当设备是直连设备时,gatewayId为设备本身的deviceId。当设备是非直连设备时,gatewayId为设备所关联的直连设备(即网关)的deviceId。appIdString应用程序IDdataJsonObject设备上报的数据,数据是键值对,取值请参见Profile文件中服务能力表里面的propertyties。timestampString上报数据的时间戳时间格式:yyyyMMddTHHmmssZ 如: 20151212T121212Z4.3.4 查询设备能力接口功能查询指定设备的能力,设备能力在Profile中定义。接口描述public QueryDeviceCapabilitiesOutDTO queryDeviceCapabilities(QueryDeviceCapabilitiesInDTO qdcid, String appId, String accessToken) throws NorthApiException接口所属类DataCollection参数说明参数说明字段必选/可选类型描述appId可选String应用唯一标志。供被授权的应用使用。accessToken必选String通过鉴权接口获得。QueryDeviceCapabilitiesInDTO字段必选/可选类型描述deviceId必选String设备唯一标识,1-64个字节gatewayId可选String设备的网关id。当设备是直连设备时,gatewayId务必与deviceId保持一致。当设备是非直连设备时,gatewayId为设备所关联的直连设备(即网关)的deviceId。接口返回值QueryDeviceCapabilitiesOutDTO字段类型描述deviceCapabilitiesList见下表DeviceCapabilitiyDTO字段类型描述deviceIdString设备唯一标识,1-64个字节serviceCapabilitiesList设备的服务能力列表,见下表ServiceCapabilityDTO字段类型描述serviceIdString服务标识serviceTypeString服务类型descriptionString描述commandsList支持的命令名称列表,ServiceCommand结构体,见下表。propertiesList支持的属性名称列表, ServiceProperty结构体,见下表ServiceCommand字段类型描述commandNameString(256)命令名称parasServiceCommandPara属性列表responsesServiceCommandResponse响应列表ServiceCommandPara字段类型描述paraNameString(256)参数名称dataTypeString(256)数据类型requiredboolean是否必选minString最小maxString最大stepDouble步长maxLengthInt最大长度unitString单位(符号)enumListList枚举类型列表ServiceCommandResponse字段类型描述responseNameString(256)响应名称parasList属性列表ServiceProperty字段类型描述propertyNameString(256)属性名称dataTypeString(256)数据类型requiredboolean是否必选minString最小maxString最大stepdouble步长maxLengthint最大长度methodString(256)访问方法:RWE 可读R,可写W,可观察EunitString单位(符号)enumListList枚举类型列表4.3.5 应用订阅平台数据接口功能应用订阅设备变更通知,当设备发生变更时平台会推送给应用。接口描述public void subscribeNotify(SubscribeInDTO sid, String accessToken)throws NorthApiException接口所属类DataCollection参数说明SubscribeInDTO字段必选/可选类型描述notifyType必选String通知类型,如:1、deviceAdded(添加新设备)2、deviceInfoChanged(设备信息变化)3、deviceDataChanged(设备数据变化)4、deviceDeleted(删除设备)5、deviceEvent(设备事件)6、messageConfirm(消息确认)7、commandRsp(响应命令)8、serviceInfoChanged(设备信息)9、ruleEvent(规则事件)10、bindDevice(设备绑定激活)11、deviceDatasChanged(设备数据批量变化)callbackurl必选String回调的url地址。必须使用HTTPS信道回调地址,同时回调地址中必须指定回调地址的端口。(说明:HTTP信道只可用于调测)接口返回值null4.4 信令传送伙伴服务器通过平台给设备发送消息,多用于NB-IoT的解决方案。平台分别提供了下发至设备的接口,下发消息的具体格式需要与设备约定。4.4.1 创建设备命令V4接口功能创建设备命令。接口描述public PostDeviceCommandOutDTO postDeviceCommand(PostDeviceCommandInDTO pdcid,String appId, String accessToken)throws NorthApiException接口所属类SignalDelivery参数说明字段必选/可选类型描述appId可选String应用唯一标志。供被授权的应用使用。accessToken必选String通过鉴权接口获得。PostDeviceCommandInDTO字段必选/可选类型描述deviceId必选String(64)下发命令的设备IDcommand必选AsynCommandDTO下发命令的信息,见AsynCommandDTO类说明callbackUrl可选String(1024)命令状态变化通知地址,必须使用HTTPS信道回调地址 (说明:HTTP信道只可用于调测,不可用于商用环境);当命令状态变化时(执行失败,执行成功,超时,发送,已送达)会通知伙伴服务器,平台会以POST方式发送HTTP消息给应用,请求Body为json字符串,格式形如:deviceId:deviceId,commandId:commandId,result:status:SUCCESS,result:expireTime可选Integer(=0)下发命令有效的超期时间,单位为秒,表示设备命令在创建后expireTime秒内有效,超过这个时间范围后命令将不再下发,如果未设置则默认为48小时接口返回值PostDeviceCommandOutDTO字段类型描述commandIdString(1-64)设备命令IDappIdString(1-64)设备命令撤销任务所属的应用IDdeviceIdString(1-64)设备命令指定的设备IDcommandAsynCommandDTO下发命令的信息,见AsynCommandDTO类说明callbackUrlString(1024)命令状态变化通知地址,必须使用HTTPS信道回调地址 (说明:HTTP信道只可用于调测,不能用于商用环境);当命令状态变化时(执行失败,执行成功,超时,发送,已送达)会

温馨提示

  • 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

评论

0/150

提交评论