萤石云 SDK 透传接口使用说明文档
I
修订历史
修订版本 修订内容 修
订
人
修订日期
v1.0
初稿
neil 2015.07.10
v1.1
增加第三方用户开通萤石云服务
相关接口
neil 2015.08.04
II
目录
萤石云 SDK 透传接口使用说明文档................................................................................................I
目录...................................................................................................................................................III
第一章 概述........................................................................................................................................1
第二章 萤石云透传接口....................................................................................................................2
2.1 萤石云透传接口规则...................................................................................................................2
2.1.1 功能描述............................................................................................................................2
2.1.2 透传接口请求数据格式规范............................................................................................2
2.1.3 透传接口应答数据格式规范............................................................................................2
2.1.4 返回值定义........................................................................................................................2
第三章 透传接口规范细则................................................................................................................5
3.1 设备布撤防...................................................................................................................................5
3.1.1 功能描述............................................................................................................................5
3.1.2 参数定义............................................................................................................................5
3.1.3 实现范例............................................................................................................................5
3.2 获取开通萤石云服务短信接口...................................................................................................6
3.2.1 功能描述............................................................................................................................6
3.2.2 参数定义............................................................................................................................6
3.2.3 实现范例............................................................................................................................6
3.3 开通萤石云服务接口...................................................................................................................7
3.3.1 功能描述............................................................................................................................7
3.3.2 参数定义............................................................................................................................7
3.3.3 实现范例............................................................................................................................8
3.4 获取安全验证短信接口...............................................................................................................8
3.4.1 功能描述............................................................................................................................8
3.4.2 参数定义............................................................................................................................8
3.4.3 实现范例............................................................................................................................9
3.5 安全验证接口...............................................................................................................................9
3.5.1 功能描述............................................................................................................................9
3.5.2 参数定义............................................................................................................................9
3.5.3 实现范例..........................................................................................................................10
3.6 添加设备接口.............................................................................................................................10
3.6.1 功能描述..........................................................................................................................10
3.6.2 参数定义..........................................................................................................................11
3.6.3 实现范例..........................................................................................................................11
3.7 获取单个设备信息接口.............................................................................................................12
3.7.1 功能描述..........................................................................................................................12
3.7.2 参数定义..........................................................................................................................12
3.7.3 实现范例..........................................................................................................................12
III
第一章 概述
本文用于说明第三方调用萤石 sdk（andriod、ios、pc）透传接口方法，主
要针对透传接口提供的功能和输入参数进行相关内容定义和介绍。
针对三大 sdk 提供的现有接口，开发者可以参考相应的 sdk 说明文档，sdk
后续版本输出的功能都通过透传接口实现。对应的透传接口可以参考三大 sdk
的说明文档。
1
第二章 萤石云透传接口
2.1 萤石云透传接口规则
2.1.1 功能描述
开发者调用萤石云 sdk（andriod、ios、pc）透传接口，实现相应的功能，
透传接口输入的请求参数(reqStr)需要满足相应的请求规则。
2.1.2 透传接口请求数据格式规范
透传接口请求数据 json 格式定义如下：
reqSt
r
#
#
method
请求执行方法
params <attr>:<val>,
……
<attr>:<val>
方法使用的参数集合
2.1.3 透传接口应答数据格式规范
result
#
#
msg
返回消息串
code
返回值
page size
分页大小
total
总数
data <attr>:<val>,
……
<attr>:<val>
方法返回的参数
2.1.4 返回值定义
2
