帮你快速理解、总结文档立即下载

同步调用设备行为

最近更新时间:2024-10-08 18:37:11
我的收藏

1. 接口描述

接口请求域名:iot.cloud.tencent.com/api/exploreropen/tokenapi。 本接口(AppCallDeviceActionSync)用于用户向已成功绑定的设备发起同步行为调用。

2. 输入参数

名称
类型
必选
描述
AccessToken
String
是
公共参数,AccessToken 用于对一个已经登录的用户鉴权。
RequestId
String
是
公共参数,唯一请求 ID,可自行生成,推荐使用 uuId。定位问题时,需提供该次请求的 RequestId。
Action
String
是
AppCallDeviceActionSync
ProductId
String
是
产品 ID。
DeviceName
String
是
设备名称。
ActionId
String
是
行为功能的标识符,ActionId 在产品物模型的行为中定义。
InputParams
String
否
输入参数。

3. 输出参数

名称
类型
描述
RequestId
String
公共参数,唯一请求 ID,可自行生成,推荐使用 uuId。定位问题时,需提供该次请求的 RequestId。
ClientToken
String
调用 ID。
Status
String
返回状态。
OutputParqams
String
输出参数。
注意:此字段可能返回 null,表示取不到有效值。

4. 示例

示例1

输入示例
POST https://iot.cloud.tencent.com/api/exploreropen/tokenapi HTTP/1.1
content-type: application/json
{
"AccessToken": "accesstoken***********acc",
"RequestId": "026fe48b-0c31-4a7c-aaf6-83ba3e9s4bcf",
"ProductId": "AB*****2345",
"DeviceName": "DEV",
"ActionId": "actionid",
"InputParams": "{\\"color\\":6}",
"Action": "AppCallDeviceActionSync"
}

输出示例: 成功
{
"Response": {
"ClientToken": "1ee12***********7df703e0d",
"OutputParams": "",
"RequestId": "026fe48b-0c31-4a7c-aaf6-83ba3e9s4bcf",
"Status": "succ"
}
}


5. 错误码

错误码
描述
InternalError
内部错误。
InvalidParameterValue
参数取值错误。
InvalidParameterValue.InvalidAccessToken
Token 无效。