下发动作

更新时间:2024-06-24 09:09:37下载pdf

本文介绍下发动作的 API。

接口描述

根据设备 ID,立即向该设备下发动作执行指令。当设备不在线时,下发会失败。

接口地址

POST: /v2.0/cloud/thing/{device_id}/shadow/actions

请求参数

参数名类型参数位置是否必填说明
device_idStringpathtrue设备 ID。

body 说明

参数名类型参数位置是否必填说明
codeStringbodytrue设备的动作 code。
input_paramsStringbodytrue设备支持的动作的属性信息与下发的动作值。JSON 可解析的数据,key 是查询动作得出的 code,value 是需要变更的动作值。

返回参数

参数名类型说明
resultJSON返回业务结果,目前无返回值
successBoolean操作是否成功。
  • true:操作成功。
  • false:操作失败。
tLong时间戳。
tidString链路 ID。

请求示例

POST: /v2.0/cloud/thing/2132131*****/shadow/actions
{
  "code": "action",
  "input_params": "{\"color\":\"red\",\"name\":\"text\"}"
}

返回示例

{
    "tid": "77a9807fb74411edb9d75a827c79edfd",
    "result": {
    },
    "t": 1677574021435,
    "success": true
}

错误码

参考 错误码

调用频率限制

参考 调用频率限制