Skip to content

sendSyncCommand

调用该接口给设备发送命令,如果物模型定义的命令是同步,则同步发送命令消息,如果设备10秒内没有回复结果则认为失败。

使用说明

暂无

接口地址

/gateway/openapi

请求方式

POST

请求参数

请求头

名称类型描述
tokenauthorizationString平台颁发的token
apiCodeString固定值:sendSyncCommand

请求参数

DeviceDebugOnlineCommandBean

名称类型是否必选描述
productKeyString设备所属产品productKey
deviceNameString设备名称
commandPidString命令标识符
blockIdString模块ID,默认模块为空
commandParamMapMap<String,Object>消息内容
commandNameString命令名称
defaultBlockString是否默认模块:
  • 0-不是
  • 1-是
reqidString消息ID号。全局唯一,用于消息回复或系统消息追踪

返回数据

名称类型描述
codeString调用成功,返回0,调用失败,查看错误信息。
msgString调用成功,提示"操作成功",调用失败,查看错误信息。
dataObject返回结果。true表示发送成功,false表示发送失败,当发送的命令定义为同步时,发送此命令时,true表示发送成功设备返回执行成功。

示例

请求示例

json
{
  "productKey": "r1FnjRnGR",
  "deviceName": "52A35D3iD",
  "defaultBlock": "1",
  "commandPid": "safe",
  "commandName": "下发安全码",
  "commandParamMap": {
    "key": "safeCode"
  }
}

返回示例

json
{
    "code": "0",
    "msg": "操作成功",
    "data": true
}