InvokeThingsService

更新时间:2024-09-14 07:22:19

调用该接口批量调用设备服务。

使用说明

目前只支持异步调用该接口。

调用服务到设备端后,设备会返回调用结果给接口的调用方。设备端响应逻辑及响应结果,需您在设备端完成开发。设备返回结果的数据格式必须符合标准的Alink协议,Alink JSON格式如下:


{
	"id": "58***89",
	"code": 200,
	"data": {},
	"message": "success",
	"localizedMsg": "localizedMsg"
}

说明

  • id为物联网平台生成的唯一ID,设备从服务调用请求中获取,并原文返回。
  • code为整型数字,会返回给接口调用方,用于判断服务调用结果。
  • data为调用设备服务的结果数据,会返回给接口调用方。数据必须为JSON格式,由用户自行定义返回内容。
  • messagelocalizedMsg根据业务需要进行返回。

请求参数

名称 类型 是否必选 示例值 描述
Action String InvokeThingsService 系统规定参数。取值:InvokeThingsService。
Args String {“param1”:1} 要启用服务的入参信息,数据格式为JSON String,例如Args={“param1”:1} 。若此参数为空时,需传入Args={}重要 物模型功能定义数据类型为float或double时,对应参数值(即使值为整数)至少携带一位小数位。例如10.0、11.1。
DeviceName.N RepeatList device1 要调用服务的设备的名称列表。最多支持传入100个设备名称。
Identifier String Set 服务的标识符。设备的服务Identifier的查看方式: + 登录物联网平台控制台,在设备所属产品的功能定义 中查看。 + 调用接口QueryThingModel,从返回的物模型信息中查看。 说明 如果是自定义(非默认)模块testFb下服务testService,则参数值为testFb:testService
ProductKey String a1BwAGV**** 要调用服务的设备所隶属的产品** ProductKey**。
IotInstanceId String iot_instc_pu****_c*-v64********* 实例ID。您可在物联网平台控制台的** 实例概览页面,查看当前实例的 ID**。** 重要** + 若有ID值,必须传入该** ID值,否则调用会失败。 + 若无 实例概览页面或 ID**值,则无需传入。实例的更多信息,请参见实例概述。
Qos Integer 1 指定调用本接口时,消息的发送方式。取值: + ** 0**(默认):最多发送一次。 + ** 1**:最少发送一次。如果QoS=1消息未接收到PUBACK消息,会在设备重连时,重新推送给设备。

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException 调用失败时,返回的错误码。更多信息,请参见错误码。
ErrorMessage String 系统异常 调用失败时,返回的出错信息。
RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 涂鸦云为该请求生成的唯一标识符。
Success Boolean true 表示是否调用成功。 + true:调用成功,但不代表调用的服务执行成功。执行情况,以设备端日志为准。 + false:调用失败。

示例

请求示例

https://iot.****.tuya.com/?Action=InvokeThingsService
&Args=%7B%20%20%20%20%20%22walk%22%3A%22a~z%22%2C%20%20%20%20%20%22city%22%3A%22shanghai%22%20%7D
&DeviceName.1=1102andriod02
&DeviceName.2=1102android01
&Identifier=TimeReset
&ProductKey=a1hWjHD****
&<公共请求参数>

正常返回示例

JSON格式

{
  "RequestId": "059C3274-6197-4BEC-95E4-49A076330E57",
  "Success": true
}