物联使能
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 物联使能 > 物联使能 API > 设备管理 > 同步调用设备行为

同步调用设备行为

最近更新时间：2023-07-19 17:34:52

我的收藏

本页目录：

1. 接口描述

接口请求域名：iot.cloud.tencent.com/api/exploreropen/serviceapi。 本接口（ServiceCallDeviceActionSync）用于同步调用设备行为。

2. 输入参数

名称
类型
必选
描述
Action
String
是
公共参数，本接口取值：ServiceCallDeviceActionSync。
RequestId
String
是
公共参数，唯一请求 ID，可自行生成，推荐使用 uuid。定位问题时，需提供该次请求的 RequestId。
AppKey
String
是
公共参数，物联网 SaaS 的 AppKey ，用于标识对应的物联网 SaaS。
Signature
String
是
公共参数，请求签名，需用户自行生成，用于校验请求的合法性。
Timestamp
Int64
是
公共参数，请求的 Unix 时间戳（秒级）。
Nonce
Int
是
公共参数，随机正整数，与 Timestamp 联合起来，防止重放攻击。
ProductId
String
是
产品 ID。
DeviceName
String
是
设备名。
ActionId
String
是
产品数据模板中行为功能的标识符，由开发者自行根据设备的应用场景定义。
InputParams
String
否
输入参数。

3. 输出参数

名称
类型
描述
RequestId
String
公共参数，唯一请求 ID，与入参相同。
ClientToken
String
调用 ID。
OutputParams
String
输出参数。
Status
String
返回状态。

4. 示例

输入示例
POST https://iot.cloud.tencent.com/api/exploreropen/serviceapi HTTP/1.1
content-type: application/json
{
    "RequestId": "f92406b3-****-4fe8-bc43-45e3d794bb68",
    "Timestamp": 1599468019,
    "Nonce": 170533123,
    "AppKey": "AppKey",
    "Signature": "Signature",
    "Action": "ServiceCallDeviceActionSync",
    "ProductId":"22****II7O",
    "DeviceName":"light1",
    "ActionId": "echo",
    "InputParams": "{\\"message\\":\\"hello.\\"}"
 }

输出示例: 成功
{
	"Response": {
		"ClientToken": "45016a4****74abcb05e25790b916dc3",
		"OutputParams": "{\\"message\\":\\"hello.\\"}",
		"RequestId": "f92406b3-****-4fe8-bc43-45e3d794bb68",
		"Status": "succ"
	}
}


5. 错误码

错误码
描述
InternalError
内部错误。
ErrorRequiredParamNotFound
必选参数缺失。
InvalidAction
Action 非法。
InvalidParameterValue
参数非法。
InvalidParameterValue.InvalidJSON
请求格式不是 JSON。

中国站