在鸿云文档Appearance
sendDeviceMsg
调用该接口给设备发送消息。
使用说明
暂无
接口地址
/gateway/openapi
请求方式
POST
请求参数
请求头
| 名称 | 类型 | 描述 |
|---|---|---|
| tokenauthorization | String | 平台颁发的token |
| apiCode | String | 固定值：sendDeviceMsg |
请求参数
SendDeviceMsgRequest
| 名称 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| productKey | String | 是 | 设备所属产品productKey |
| deviceName | String | 是 | 设备名称 |
| commandPid | String | 是 | 命令标识符 |
| blockId | String | 否 | 模块ID，默认模块为空 |
| commandParamMap | Map<String,Object> | 否 | 消息内容 |
| commandName | String | 否 | 命令名称 |
| defaultBlock | String | 否 | 是否默认模块：
|
| reqid | String | 否 | 消息ID号。全局唯一，用于消息回复或系统消息追踪 |
返回数据
SendDeviceMsgResponse
| 名称 | 类型 | 描述 |
|---|---|---|
| code | String | 调用成功，返回0，调用失败，查看错误信息。 |
| msg | String | 调用成功，提示"操作成功"，调用失败，查看错误信息。 |
| data | Object | 返回结果。true表示成功，false表示失败 |
示例
请求示例
json
{
"productKey": "r1FnjRnGR",
"deviceName": "52A35D3iD",
"defaultBlock": "1",
"commandPid": "safe",
"commandName": "下发安全码",
"commandParamMap": {
"key": "safeCode"
}
}返回示例
json
{
"code": "0",
"msg": "操作成功",
"data": true
}