简要描述：

  • 通过调用该接口进行异步调用设备行为
  • 根据行为的定义中

接口版本：

版本号 制定人 制定日期 修订日期
1.0 张浩 2023-06-12

请求URL:

iot-platform/device-thing-model-server/v1/action/invoke

请求方式：

  • POST

请求头：

参数名 是否必须 类型 说明
Content-Type 是 string 请求类型： application/json
Authorization 是 string 鉴权信息

请求示例:

{
    "productId":"AAcmXyLkS1",
    "deviceId":"339a0519f96b432092d6c3451b2dd53e",
    "identifier":"clean",
    "module":"default",
    "input":{
        "type":"sweeping"
    },
    "retained":false
}

请求参数:

参数名 是否必须 类型 说明
productId 是 string 产品ID,最长10位
deviceId 是 string 设备ID，最长32位
identifier 是 String 行为标识符
module false String 模块标识符，如不传,默认为default模块
input 是 Object 行为入参
retained 否 Boolean 是否留存消息，当留存时设备上线时将进行一次推送，默认不留存

返回示例:

正确时返回:

{
  "code": 0,
  "msg": "ok",
  "err_code": 10000,
  "result":  {
    "messageId":"123",
    "resultData":{
        "finishTime":1686555865506
    }
  }
}

错误时返回:

{
  "code": -1,
  "msg": "${errorMessage}",
  "err_code": ${errorCode},
  "result": null
}

返回参数说明:

字段名称 字段类型 是否必须 描述
1 code int 是 状态码，为0时表示接口调用成功，不为0时表示接口调用失败
2 err_code int 是 错误码，当code为0时，返回10000，否则返回对应错误码
3 msg String 是 错误的具体消息
4 result Object 否 返回的结果，当调用失败时为空

result返回值描述：

字段名称 字段类型 是否必须 描述
1 messageId String 否 下发设备的行为调用消息ID，当为异步调用时不为空
2 resultData Object 否 行为触发结果，当为同步调用时不为空

备注:

  • 更多返回错误代码请看首页的错误代码描述
 创建时间：2023-06-12 15:22
最后编辑：admin  更新时间：2024-10-18 16:29