调用该接口向指定设备发送自定义消息,如向指定投影设备推送重要信息(营销,广告等)。

路径 /living/cloud/device/customizedmessage/notify
版本号 1.0.0
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权
超时时间 10000

请求参数

名称 类型 是否必选 示例值 描述
productKey String a1Z*****FX 产品的Key,设备证书信息之一。创建产品时,生活物联网平台为该产品颁发的全局唯一标识。
deviceName String a1Z*****FX 设备的名称,设备证书信息之一。在注册设备时,自定义的或系统生成的设备名称,具备产品维度内的唯一性。
iotId String a1Z*****0***iX 设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。物的唯一标识符,iotId与{productKey, deviceName}一一对应,两者选填一项即可。iotId与{productKey, deviceName}三者不可能同时不赋值。
messageContent Struct 发送的消息内容。Map对象类型,里面的字段和值有厂商自己定义。

返回数据

名称 类型 示例值 描述
code Int

接口返回码。200表示成功。

message String

调用失败时,返回的出错信息。

localizedMsg String

localizedMsg本地语言的错误消息。

data JSON

响应结果。

messageId String

云端和设备通信的消息Id。

data JSON

服务调用返回结果。

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.0"
	},
	"params":{
		"productKey": "a1Z*****FX",
		"deviceName": "a1Z*****FX",
		"iotId": "a1Z*****0***iX",
		"messageContent": "value3"
	}
}

正常返回示例

JSON 格式

{
    "id": "4de2c367-c1db-417c-aa15-8c585e595d92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data":{
        "messageId":"2065991***73",
        "data":{
            "timestamp":"1604475928924"
        }
    }
}

异常返回示例

JSON 格式

{
    "id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
    "code": 403,
    "message": "request forbidden.",
    "localizedMsg": "请求被禁止",
    "data": null
}