使用流程

第一步:创建我的应用

为了正常运行开发环境,您需要建立一个应用并获得相应的【应用标识】、【应用安全密钥】和【应用服务器地址】,具体步骤如下:

1.点击进入飞天智能管理平台登录页面,登录飞天智能管理平台。

2.在管理平台左侧列表中,点击【添加应用】,跳转至添加应用界面,进行应用添加。

3.输入【应用名称】,应用描述(可选),点击【保存】按钮后,页面跳转至应用列表可查看新添加应用的【应用标识】【应用安全密钥】【应用服务器地址】等关键信息,在API初始化时需要用到这些参数。

第二步:下载 Java SDK,请点击下面下载图标:

第三步:初始化

请求接口:public static void init(String serverUrl,     String appKey,    String appSecret)

接口功能:通过飞天的Java SDK与飞天智能物联网平台进行集成,需要先调用该初始化接口,此接口只需要调用一次。

参数名 参数说明
serverUrl 应用服务地址
appKey 应用标识
appSecret 应用安全密钥
参数名 参数说明
														  
															
															import com.ft.iot.sdk.CustomerApi;
																
															
															                                                   
															public static void main(String[] args) {
																String serverUrl = "<你的serverUrl>"; 
																String appKey = "<你的appKey>"; 
																String appSecret = "<你的appSecret>";
																CustomerApi.init(serverUrl, appKey, appSecret);
															}
															  
														  
														
第四步:集成您需要的接口

初始化完成之后,您可以根据您的业务需要进行接口集成,请参见SDK接口详细介绍

SDK初始化

请求接口: public static void init(String serverUrl,     String appKey,    String appSecret)

接口功能:通过飞天的Java SDK与飞天智能物联网平台进行集成,需要先调用该初始化接口,此接口只需要调用一次。

参数名 参数说明
serverUrl 应用服务地址
appKey 应用标识
appSecret 应用安全密钥
参数名 参数说明
										  
											
											import com.ft.iot.sdk.CustomerApi;
												
											
											                                                   
											public static void main(String[] args) {
												String serverUrl = "<你的serverUrl>"; 
												String appKey = "<你的appKey>"; 
												String appSecret = "<你的appSecret>";
												CustomerApi.init(serverUrl, appKey, appSecret);
											}
											  
										  
										

设备绑定

请求接口: public static string bindDevice(String deviceSN,    String paycode)

接口功能:将终端设备和商户二维码牌进行绑定。上传设备编号、二维码牌标识推送给消息服务平台,验证通过后,将此设备和码牌进行绑定。

参数名 参数说明
deviceSN 设备编号
paycode 收钱码(收钱码的二维码内容,或唯一标识)
参数名 参数说明
code 返回响应码
msg 结果描述
nonce 请求时的nonce,原样带回
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
													  
														
														import com.ft.iot.sdk.CustomerApi;
															
														
														                                                   
														public static void main(String[] args) {
															String deviceSN = "<你的设备编号>"; 
															String paycode = "<你的收钱码>"; 
															CustomerApi.bindDevice(deviceSN, paycode);
														}
														  
													  
													

消息推送(使用设备码)

请求接口:public static String push(String deviceSN,    int message,    int pushTemplate)

接口功能:向指定的设备推送消息。

参数名 参数说明
deviceSN 设备编号,可以指定设备编号向该设备推送消息
message 播报金额,int类型,单位:分
pushTemplate 语音模板(1支付宝;2微信;3扫码(默认);4银联)
参数名 参数说明
code 返回响应码
msg 结果描述
nonce 请求时的nonce,原样带回
pushsn 消息流水号
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
													  
														
														import com.ft.iot.sdk.CustomerApi;
															
														
														                                                   
														public static void main(String[] args) {
															String deviceSN = "<你的设备编号>"; 
															Integer message = "<播报金额>"; 
															Integer pushTemplate = "<你的模板编号>"; 
															CustomerApi.push(deviceSN, message, pushTemplate);
														}
														  
													  
													

消息推送(使用收钱码)

请求接口:public static String pushByPaycode(String paycode,    int message,      int pushTemplate)

接口功能:向指定的设备推送语音消息。

参数名 参数说明
paycode 收钱码,指定收钱码,向绑定的设备推送消息
message 播报金额,int类型,单位:分
pushTemplate 语音模板(1支付宝;2微信;3扫码(默认);4银联)
参数名 参数说明
code 返回响应码
msg 结果描述
pushsn 消息流水号
nonce 请求时的nonce,原样带回
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
													  
														
														import com.ft.iot.sdk.CustomerApi;
															
														
														                                                   
														public static void main(String[] args) {
															String paycode = "<你的收钱码>"; 
															Integer message = "<播报金额>"; 
															Integer pushTemplate = "<你的消息模板编号>"; 
															CustomerApi.pushByPaycode(paycode, message, pushTemplate);
														}
														  
													  
													

消息推送(使用设备码)

请求接口:public static String push(String deviceSN,    int message,    int pushTemplate,    String ticketInfo,    int ticketTemplate)

接口功能:云打印播报一体机指音箱在播报收款金额的同时打印商品消费明细小票。向指定的设备推送语音消息,根据打印模版打印商品消费明细小票。

参数名 参数说明
deviceSN 设备编号,可以指定设备编号向该设备推送消息
message 播报金额,int类型,单位:分
pushTemplate 语音模板(1支付宝;2微信;3扫码(默认);4银联)
ticketInfo
打印模板 传参 打印结果
商户名称:{1}
时间:{2}
金额:{3}
String ticketInfo = "张三水果店&2020.06.08&100元" 商户名称:张三水果店
时间:2020.06.08
金额:100元
商户名称:@name
时间:@time
金额:@money
{"name":"张三",
"time":"2020.06.08",
"money":"100元"}
商户名称:张三水果店
时间:2020.06.08
金额:100元
打印模板的参数分为@key方式和{1}{2}...两种方式。以上为两种打印模板的传参样例,具体参数根据打印模板内容(可去管理平台查看)来设定
ticketTemplate 打印模板编号,非必传,若不传依次优先级为设备,企业,若两个范围下都没有打印模板则检查是否有ticketInfo,如果传了ticketInfo则返回对应错误,如果没有传ticketInfo则直接播报不打印
参数名 参数说明
code 返回响应码
msg 结果描述
nonce 请求时的nonce,原样带回
pushsn 消息流水号
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
													  
														
														import com.ft.iot.sdk.CustomerApi;
															
														
														                                                   
														public static void main(String[] args) {
															String deviceSN = "<你的设备编号>";
															Integer message = "<播报金额>";
															Integer pushTemplate = "<你的模板编号>";
															String ticketInfo = "<小票数据>";
															Integer ticketTemplate = "<你的打印模板编号>";
															CustomerApi.push(deviceSN, message, pushTemplate, ticketInfo, ticketTemplate);
														}
														  
													  
													

消息推送(使用收钱码)

请求接口:public static String pushByPaycode(String paycode,    int message,    int pushTemplate,    String ticketInfo,    int ticketTemplate)

接口功能:云打印播报一体机指音箱在播报收款金额的同时打印商品消费明细小票。向指定的设备推送语音消息,根据打印模版打印商品消费明细小票。

参数名 参数说明
paycode 收钱码,指定收钱码,向绑定的设备推送消息
message 播报金额,int类型,单位:分
pushTemplate 语音模板(1支付宝;2微信;3扫码(默认);4银联)
ticketInfo
打印模板 传参 打印结果
商户名称:{1}
时间:{2}
金额:{3}
String ticketInfo = "张三水果店&2020.06.08&100元" 商户名称:张三水果店
时间:2020.06.08
金额:100元
商户名称:@name
时间:@time
金额:@money
{"name":"张三",
"time":"2020.06.08",
"money":"100元"}
商户名称:张三水果店
时间:2020.06.08
金额:100元
打印模板的参数分为@key方式和{1}{2}...两种方式。以上为两种打印模板的传参样例,具体参数根据打印模板内容(可去管理平台查看)来设定
ticketTemplate 打印模板编号,非必传,若不传依次优先级为设备,企业,若两个范围下都没有打印模板则检查是否有ticketInfo,如果传了ticketInfo则返回对应错误,如果没有传ticketInfo则直接播报不打印
参数名 参数说明
code 返回响应码
msg 结果描述
nonce 请求时的nonce,原样带回
pushsn 消息流水号
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
													  
														
														import com.ft.iot.sdk.CustomerApi;
															
														
														                                                   
														public static void main(String[] args) {
															String paycode = "<你的收钱码>";
															Integer message = "<播报金额>";
															Integer pushTemplate = "<你的模板编号>";
															String ticketInfo = "<小票数据>";
															Integer ticketTemplate = "<你的打印模板编号>";
															CustomerApi.pushByPaycode(paycode, message, pushTemplate, ticketInfo, ticketTemplate);
														}
														  
													  
													

TTS消息推送(使用设备码)

请求接口:public static String pushTTS(String deviceSN,    String message,    String ticketInfo,    int ticketTemplate)

接口功能:向指定的设备推送文本语音消息,并附带打印参数。针对播报打印一体机播报并打印。

参数名 参数说明
deviceSN 设备编号,可以指定设备编号向该设备推送消息
message 播报消息内容(使用utf-8编码,最长60字)
ticketInfo
打印模板 传参 打印结果
商户名称:{1}
时间:{2}
金额:{3}
String ticketInfo = "张三水果店&2020.06.08&100元" 商户名称:张三水果店
时间:2020.06.08
金额:100元
商户名称:@name
时间:@time
金额:@money
{"name":"张三",
"time":"2020.06.08",
"money":"100元"}
商户名称:张三水果店
时间:2020.06.08
金额:100元
打印模板的参数分为@key方式和{1}{2}...两种方式。以上为两种打印模板的传参样例,具体参数根据打印模板内容(可去管理平台查看)来设定
ticketTemplate 打印模板编号,非必传,若不传依次优先级为设备,企业,若两个范围下都没有打印模板则检查是否有ticketInfo,如果传了ticketInfo则返回对应错误,如果没有传ticketInfo则直接播报不打印
参数名 参数说明
code 返回响应码
msg 结果描述
pushsn 消息流水号
nonce 请求时的nonce,原样带回
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
													  
														
														import com.ft.iot.sdk.CustomerApi;
															
														
														                                                   
														public static void main(String[] args) {
															String deviceSN = "<设备编号>"; 
															String message = "<播报消息内容>"; 
															String ticketInfo = "<小票详情>"; 
															Integer ticketTemplate = "<打印模板编号>"; 
															CustomerApi.pushTTS(deviceSN, message, ticketInfo,ticketTemplate);
														}
														  
													  
													

TTS消息推送(使用收钱码)

请求接口:public static String pushTTSByPayCode(String paycode,    String message,     String ticketInfo,   int ticketTemplate)

接口功能:向指定的设备推送文本语音消息,并附带打印参数。针对播报打印一体机播报并打印。

参数名 参数说明
paycode 收钱码,指定收钱码,向绑定的设备推送消息
message 播报消息内容(使用utf-8编码,最长60字)
ticketInfo
打印模板 传参 打印结果
商户名称:{1}
时间:{2}
金额:{3}
String ticketInfo = "张三水果店&2020.06.08&100元" 商户名称:张三水果店
时间:2020.06.08
金额:100元
商户名称:@name
时间:@time
金额:@money
{"name":"张三",
"time":"2020.06.08",
"money":"100元"}
商户名称:张三水果店
时间:2020.06.08
金额:100元
打印模板的参数分为@key方式和{1}{2}...两种方式。以上为两种打印模板的传参样例,具体参数根据打印模板内容(可去管理平台查看)来设定
ticketTemplate 打印模板编号,非必传,若不传依次优先级为设备,企业,若两个范围下都没有打印模板则检查是否有ticketInfo,如果传了ticketInfo则返回对应错误,如果没有传ticketInfo则直接播报不打印
参数名 参数说明
code 返回响应码
msg 结果描述
pushsn 消息流水号
nonce 请求时的nonce,原样带回
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
													  
														
														import com.ft.iot.sdk.CustomerApi;
															
														
														                                                   
														public static void main(String[] args) {
															String paycode = "<你的收钱码>"; 
															String message = "<播报消息内容>"; 
															String ticketInfo = "<小票详情>"; 
															Integer ticketTemplate = "<打印模板编号>"; 
															CustomerApi.pushTTSByPayCode(paycode, message, ticketInfo,ticketTemplate);
														}
														  
													  
													

TTS消息推送(使用设备码)

请求接口:public static String pushTTS(String deviceSN,    String message)

接口功能:向指定的设备推送语音消息,不需要预先添加模板,使用平台的TTS功能。

参数名 参数说明
deviceSN 设备编号
message 播报消息内容(使用utf-8编码,最大60字)
参数名 参数说明
code 返回响应码
msg 结果描述
pushsn 消息流水号
nonce 请求时的nonce,原样带回
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
													  
														
														import com.ft.iot.sdk.CustomerApi;
															
														
														                                                   
														public static void main(String[] args) {
																String deviceSN = "<你的设备编号>";
																String message = "<播报消息内容>";
																CustomerApi.pushTTS(deviceSN, message);
														}
														  
													  
													

TTS消息推送(使用收钱码)

请求接口:public static String pushTTSByPayCode(String paycode,    String message)

接口功能:向指定的设备推送语音消息,不需要预先添加模板,使用平台的TTS功能。

参数名 参数说明
paycode 收钱码,指定收钱码,向绑定的设备推送消息
message 播报消息内容(使用utf-8编码,最长60字)
参数名 参数说明
code 返回响应码
msg 结果描述
pushsn 消息流水号
nonce 请求时的nonce,原样带回
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
													  
														
														import com.ft.iot.sdk.CustomerApi;
															
														
														                                                   
														public static void main(String[] args) {
															String paycode = "<你的收钱码>";
															String message = "<播报消息内容>";
															CustomerApi.pushTTSByPayCode(paycode, message);
														}
														  
													  
													

优惠金消息推送(使用设备码)

请求接口:public static String push(String deviceSN,    int message,    int pushTemplate,    int discountAmt,    int discountTemplate)

接口功能:向指定的设备推送语音消息。

参数名 参数说明
deviceSN 设备编号,可以指定设备编号向该设备推送消息
message 播报金额,int类型,单位:分
pushTemplate 语音模板(1支付宝;2微信;3扫码(默认);4银联)
field_discount_amt 优惠金额,单位:分
field_discount_template 优惠金额模板
参数名 参数说明
code 返回响应码
msg 结果描述
pushsn 消息流水号
nonce 请求时的nonce,原样带回
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
													  
														
														import com.ft.iot.sdk.CustomerApi;
															
														
														                                                   
														public static void main(String[] args) {
															String deviceSN = "<你的设备编号>";
															Integer message = "<播报金额>";
															Integer pushTemplate = "<你的模板编号>";
															Integer discountAmt = "<优惠金额>";
															Integer discountTemplate = "<你的优惠金模板编号>";
															CustomerApi.push(deviceSN, message, pushTemplate, discountAmt, discountTemplate);
														}
														  
													  
													

优惠金消息推送(使用收钱码)

请求接口:public static String pushByPaycode(String paycode,    int message,    int pushTemplate,    int discountAmt,    int discountTemplate)

接口功能:向指定的设备推送语音消息。

参数名 参数说明
paycode 收钱码,指定收钱码,向绑定的设备推送消息
message 播报金额,int类型,单位:分
pushTemplate 语音模板(1支付宝;2微信;3扫码(默认);4银联)
field_discount_amt 优惠金额,单位:分
field_discount_template 优惠金额模板
参数名 参数说明
code 返回响应码
msg 结果描述
pushsn 消息流水号
nonce 请求时的nonce,原样带回
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
													  
														
														import com.ft.iot.sdk.CustomerApi;
															
														
														                                                   
														public static void main(String[] args) {
															String paycode = "<你的收钱码>";
															Integer message = "<播报金额>";
															Integer pushTemplate = "<你的模板编号>";
															Integer discountAmt = "<优惠金额>";
															Integer discountTemplate = "<你的优惠金模板编号>";
															CustomerApi.pushByPaycode(paycode, message, pushTemplate, discountAmt, discountTemplate);
														}
														  
													  
													

验证码推送(使用设备码)

请求接口:public static String pushVerifyCode(String deviceSN,    String code,    int codeTemplate)

接口功能:向指定的设备推送验证码消息。

参数名 参数说明
deviceSN 设备编号,可以指定设备编号向该设备推送消息
code 验证码(可选,可手动输入,也可自动生成,自动生成可调用验证码验证接口)
codeTemplate 验证码模板
参数名 参数说明
code 返回响应码
msg 结果描述
pushsn 消息流水号
nonce 请求时的nonce,原样带回
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
													  
														
														import com.ft.iot.sdk.CustomerApi;
															
														
														                                                   
														public static void main(String[] args) {
															String deviceSN = "<你的设备编号>";
															String code = "<你的验证码(可选)>";
															Integer codeTemplate = "<你的验证码模板编号>";
															CustomerApi.pushVerifyCode(deviceSN, code, codeTemplate);			// 手动输入方式
															CustomerApi.pushVerifyCode(deviceSN, codeTemplate);					// 自动生成方式
														}
														  
													  
													

验证码推送(使用收钱码)

请求接口:public static String pushVerifyCodeByPaycode(String paycode,    String code,    int codeTemplate)

接口功能:向指定的设备推送验证码消息。

参数名 参数说明
paycode 收钱码,指定收钱码,向绑定的设备推送消息
code 验证码(可选,可手动输入,也可自动生成,自动生成可调用验证码验证接口)
codeTemplate 验证码模板
参数名 参数说明
code 返回响应码
msg 结果描述
pushsn 消息流水号
nonce 请求时的nonce,原样带回
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
													  
														
														import com.ft.iot.sdk.CustomerApi;
															
														
														                                                   
														public static void main(String[] args) {
															String paycode = "<你的收钱码>";
															String code = "<你的验证码(可选)>";
															Integer codeTemplate = "<你的验证码模板编号>";
															CustomerApi.pushVerifyCodeByPaycode(paycode, code, codeTemplate);			// 手动输入方式
															CustomerApi.pushVerifyCodeByPaycode(paycode, codeTemplate);					// 自动生成方式
														}
														  
													  
													

推送验证码验证(使用设备码)

请求地址:public static String checkVerifyCode(String deviceSN,    String code)

接口功能:验证向指定的设备推送的验证码(推送验证码的方式为自动生成的方式,验证接口才有效)。

参数名 参数说明
deviceSN 设备编号
code 验证码(自动生成的验证码)
参数名 参数说明
code 返回响应码
msg 结果描述
pushsn 消息流水号
nonce 请求时的nonce,原样带回
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
													  
														
														import com.ft.iot.sdk.CustomerApi;
															
														
														                                                   
														public static void main(String[] args) {
															String deviceSN = "<你的设备编号>";
															String code = "<你的验证码>";
															CustomerApi.checkVerifyCode(deviceSN, code);			
														}
														  
													  
													

推送验证码验证(使用收钱码)

请求接口:public static String checkVerifyCodeByPaycode(String paycode,    String code)

接口功能:验证向指定的设备推送的验证码(推送验证码的方式为自动生成的方式,验证接口才有效)。

参数名 参数说明
paycode 收钱码
code 验证码(自动生成的验证码)
参数名 参数说明
code 返回响应码
msg 结果描述
pushsn 消息流水号
nonce 请求时的nonce,原样带回
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
													  
														
														import com.ft.iot.sdk.CustomerApi;
															
														
														                                                   
														public static void main(String[] args) {
															String paycode = "<你的收钱码>";
															String code = "<你的验证码>";
															CustomerApi.checkVerifyCode(paycode, code);			
														}
														  
													  
													

动态二维码显示设置

请求接口:public static String pushQrCode(String deviceSn,    String qrtype,    String qrcode,    String message)

接口功能:对带屏音箱设置显示二维码/或普通文本。

参数名 参数说明
devicesn 设备编号
qrtype 二维码类型(0、默认1、右侧展示URL2、全屏)
qrcode 二维码内容
message 文本内容(最大长度64)
参数名 参数说明
code 返回响应码
msg 结果描述
nonce 请求时的nonce,原样带回
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
													  
														
														import com.ft.iot.sdk.CustomerApi;	
														
														                                                   
														public static void main(String[] args) {
															String devicesn = "<你的设备编号>";
															String qrtype = "<你的二维码类型(0、默认1、右侧展示URL2、全屏)>";
															String qrcode = "<你的二维码内容>";
															String message =  "<你的文本内容>";
															CustomerApi.pushQrCode(devicesn, qrtype, qrcode, message);			
														}
														  
													  
													

获取码牌绑定设备

请求接口: public static String getBindDevice(String paycode)

接口功能:获取码牌绑定的设备信息。

参数名 参数说明
paycode 收钱码(收钱码的二维码内容,或唯一标识)
参数名 参数说明
code 返回响应码
msg 结果描述
deviceSN 设备编号
nonce 请求时的nonce,原样带回
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
参数名 参数说明
code 返回响应码
msg 结果描述
pushsn 消息流水号
nonce 请求时的nonce,原样带回
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
													  
														
														import com.ft.iot.sdk.CustomerApi;
															
														
														                                                   
														public static void main(String[] args) {
															String paycode = "<你的收钱码>";
															CustomerApi.getBindDevice(paycode);			
														}
														  
													  
													

获取设备信息

请求接口:public static String getDeviceInfo(String deviceSN)

接口功能:检查某个指定的设备的信息。

参数名 参数说明
deviceSN 设备编号
参数名 参数说明
code 返回响应码
msg 结果描述
status 设备的绑定状态(0未绑定,1已绑定)
state 设备状态(0正常,1禁用)
is_online 是否在线(0在线,1离线)
version 当前版本
last_online_time 最后在线时间
last_offline_time 最后离线时间
location_info 设备定位信息,例:{"descp","北京市 海淀区 学清路 靠近汇智大厦"}
nonce 请求时的nonce,原样带回
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
													  
														
														import com.ft.iot.sdk.CustomerApi;
															
														
														                                                   
														public static void main(String[] args) {
															String deviceSN = "<你的设备编号>";
															CustomerApi.getDeviceInfo(deviceSN);			
														}
														  
													  
													

设备解绑

请求接口:public static String unbindDevice(String deviceSN)

接口功能:解除终端设备和二维码牌的绑定关系。

参数名 参数说明
deviceSN 设备编号
参数名 参数说明
code 返回响应码
msg 结果描述
nonce 请求时的nonce,原样带回
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
													  
														
														import com.ft.iot.sdk.CustomerApi;
															
														
														                                                   
														public static void main(String[] args) {
															String deviceSN = "<你的设备编号>";
															CustomerApi.unbindDevice(deviceSN);			
														}
														  
													  
													

设置设备开机模板

请求接口: public static String setDevicePowerOnVoice(String content,    String deviceSN)

接口功能:设置设备范围生效的播报模板信息。

参数名 参数说明
content 模板内容,最大长度25
deviceSN 生效的设备编号列表。使用”,”(半角英文逗号)分隔。 批量设置最多支持10个设备, 此参数最大长度1024字符
参数名 参数说明
code 返回响应码
msg 结果描述
nonce 请求时的nonce,原样带回
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
													  
														
														import com.ft.iot.sdk.CustomerApi;
														
														                                                   
														public static void main(String[] args) {
															String content = "<你的模板内容>";
															String deviceSN = "<生效的设备编号列表>";
															CustomerApi.setDevicePowerOnVoice(content,deviceSN);			
														}
														  
													  
													

设置设备关机模板

请求接口: public static String setDevicePowerOffVoice(String content,    String deviceSN)

接口功能:设置设备范围生效的播报模板信息。

参数名 参数说明
content 模板内容,最大长度25
deviceSN 生效的设备编号列表。使用”,”(半角英文逗号)分隔。 批量设置最多支持10个设备, 此参数最大长度1024字符
参数名 参数说明
code 返回响应码
msg 结果描述
nonce 请求时的nonce,原样带回
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
													  
														
														import com.ft.iot.sdk.CustomerApi;
														
														                                                   
														public static void main(String[] args) {
															String content = "<你的模板内容>";
															String deviceSN = "<生效的设备编号列表>";
															CustomerApi.setDevicePowerOffVoice(content, deviceSN);			
														}
														  
													  
													

设置机构开机模板

请求接口: public static String setOrgPowerOnVoice(String content,    String orgCode)

接口功能:设置机构范围生效的播报模板信息。

参数名 参数说明
content 模板内容,最大长度25
orgCode 生效的机构编号列表。使用”,”(半角英文逗号)分隔。 批量设置最多支持10个机构, 此参数最大长度1024字符
参数名 参数说明
code 返回响应码
msg 结果描述
nonce 请求时的nonce,原样带回
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
													  
														
														import com.ft.iot.sdk.CustomerApi;
														
														                                                   
														public static void main(String[] args) {
															String content = "<你的模板内容>";
															String orgCode = "<生效的机构编号列表>";
															CustomerApi.setOrgPowerOnVoice(content, orgCode);			
														}
														  
													  
													

设置机构关机模板

请求接口: public static String setOrgPowerOffVoice(String content,    String orgCode)

接口功能:设置机构范围生效的播报模板信息。

参数名 参数说明
content 模板内容,最大长度25
orgCode 生效的机构编号列表。使用”,”(半角英文逗号)分隔。 批量设置最多支持10个机构, 此参数最大长度1024字符
参数名 参数说明
code 返回响应码
msg 结果描述
nonce 请求时的nonce,原样带回
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
													  
														
														import com.ft.iot.sdk.CustomerApi;
														
														                                                   
														public static void main(String[] args) {
															String content = "<你的模板内容>";
															String orgCode = "<生效的机构编号列表>";
															CustomerApi.setOrgPowerOffVoice(content, orgCode);			
														}
														  
													  
													

设置企业开机模板

请求接口: public static String setCompanyPowerOnVoice(String content)

接口功能:设置企业生效的播报模板信息。

参数名 参数说明
content 模板内容,最大长度25
参数名 参数说明
code 返回响应码
msg 结果描述
nonce 请求时的nonce,原样带回
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
													  
														
														import com.ft.iot.sdk.CustomerApi;
														
														                                                   
														public static void main(String[] args) {
															String content = "<你的模板内容>";
															CustomerApi.setCompanyPowerOnVoice(content);			
														}
														  
													  
													

设置企业关机模板

请求接口: public static String setCompanyPowerOffVoice(String content)

接口功能:设置企业生效的播报模板信息。

参数名 参数说明
content 模板内容,最大长度25
参数名 参数说明
code 返回响应码
msg 结果描述
nonce 请求时的nonce,原样带回
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
													  
														
														import com.ft.iot.sdk.CustomerApi;
														
														                                                   
														public static void main(String[] args) {
															String content = "<你的模板内容>";
															CustomerApi.setCompanyPowerOffVoice(content);			
														}
														  
													  
													

设置设备广告模板

请求接口: public static String setDeviceADVoice(String content,    String deviceSN,    String ruleType,    String ruleValue)

接口功能:设置设备范围生效的播报模板信息。

参数名 参数说明
content 模板内容,最大长度50
deviceSN 生效的设备编号列表。使用”,”(半角英文逗号)分隔。 批量设置最多支持10个设备, 此参数最大长度1024字符
ruleType 播报规则。可选值:
1、每次开机后播报一次
2、定时播报,每间隔n分钟播报一次,n由ruleValue参数指定
3、固定播报,每n次收款到账后播报一次,n由ruleValue参数指定
ruleValue 播报规则设置值,当ruleType为2或3时有效。 指定广告播报的间隔时间或间隔次数
参数名 参数说明
code 返回响应码
msg 结果描述
nonce 请求时的nonce,原样带回
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
													  
														
														import com.ft.iot.sdk.CustomerApi;
															
														
														                                                   
														public static void main(String[] args) {
															String content = "<你的模板内容>";
															String deviceSN = "<生效的设备编号列表>";
															String ruleType = "<播报规则>";
															String ruleValue = "<播报规则设置值>";
															CustomerApi.setDeviceADVoice( content,  deviceSN, ruleType, ruleValue);			
														}
														  
													  
													

设置机构广告模板

请求接口: public static String setOrgADVoice(String content,    String orgCode,    String ruleType,    String ruleValue)

接口功能:设置机构范围生效的播报模板信息。

参数名 参数说明
content 模板内容,最大长度50
orgCode 生效的机构编号列表。使用”,”(半角英文逗号)分隔。 批量设置最多支持10个机构, 此参数最大长度1024字符
ruleType 播报规则。可选值:
1、每次开机后播报一次
2、定时播报,每间隔n分钟播报一次,n由ruleValue参数指定
3、固定播报,每n次收款到账后播报一次,n由ruleValue参数指定
ruleValue 播报规则设置值,当ruleType为2或3时有效。 指定广告播报的间隔时间或间隔次数
参数名 参数说明
code 返回响应码
msg 结果描述
nonce 请求时的nonce,原样带回
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
													  
														
														import com.ft.iot.sdk.CustomerApi;
															
														
														                                                   
														public static void main(String[] args) {
															String content = "<你的模板内容>";
															String orgCode = "<生效的机构编号列表>";
															String ruleType = "<播报规则>";
															String ruleValue = "<播报规则设置值>";
															CustomerApi.setOrgADVoice( content,  orgCode, ruleType, ruleValue);			
														}
														  
													  
													

设置企业广告模板

请求接口: public static String setCompanyADVoice(String content,     String ruleType,    String ruleValue)

接口功能:设置企业的播报模板信息。

参数名 参数说明
content 模板内容,最大长度50
ruleType 播报规则。可选值:
1、每次开机后播报一次
2、定时播报,每间隔n分钟播报一次,n由ruleValue参数指定
3、固定播报,每n次收款到账后播报一次,n由ruleValue参数指定
ruleValue 播报规则设置值,当ruleType为2或3时有效。 指定广告播报的间隔时间或间隔次数
参数名 参数说明
code 返回响应码
msg 结果描述
nonce 请求时的nonce,原样带回
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
													  
														
														import com.ft.iot.sdk.CustomerApi;
															
														
														                                                   
														public static void main(String[] args) {
															String content = "<你的模板内容>";
															String ruleType = "<播报规则>";
															String ruleValue = "<播报规则设置值>";
															CustomerApi.setCompanyADVoice(content, ruleType, ruleValue);			
														}
														  
													  
													

设置自定义播报模板

请求接口: public static String setDeviceCustomVoice(String content,    String deviceSN,    String customRule)

接口功能:设置设备范围生效的播报模板信息。

参数名 参数说明
content 模板内容,最大长度25
deviceSN 生效的设备编号列表。使用”,”(半角英文逗号)分隔。 批量设置最多支持10个设备, 此参数最大长度1024字符
customRule 播报规则。可选值:
1、作为前缀播报
2、作为后缀播报
3、仅播报自定义部分+金额
4、仅播报自定义部分
参数名 参数说明
code 返回响应码
msg 结果描述
nonce 请求时的nonce,原样带回
sign 响应数据的签名 Base64(HmacSHA256(待签名参数, appsecret)) 待签名参数生成规则和请求签名生成规则相同
													  
														
														import com.ft.iot.sdk.CustomerApi;
														
														                                                   
														public static void main(String[] args) {
															String content = "<你的模板内容>";
															String deviceSN = "<生效的设备编号列表>";
															String customRule = "<播报规则>";
															CustomerApi.setDeviceCustomVoice( content, deviceSN, customRule);			
														}