Skip to main content

发送模板消息通知

接口Method

message.template.send

请求BizContent参数

参数名示例值参数类型参数描述
hotelId1470724195833876500Long酒店id 说明:如果传入该参数,则无需传入iotId、productKey和deviceName。如果您同时传入hotelId和组合(iotId、productKey与deviceName),则以hotelId为准。
roomNo701String房间号 说明:如果要推送智慧屏或智能音箱则必传此字段
iotIdQ7uOhVRdZRRlDnTLv3433400100String要查询的设备id。物联网平台为该设备颁发的id,设备的唯一标识符。说明:如果传入该参数,则无需传入productKey和deviceName。iotId作为设备唯一标识符,和productKey与deviceName组合是一一对应的关系。如果您同时传入iotId和productKey与deviceName组合,则以iotId为准。
deviceNameiottestString要查询的设备名称。说明:如果传入该参数,需同时传入productKey。
productKey9daw7832dfString要查询的设备所隶属的产品productKey。说明:如果传入该参数,需同时传入deviceName。
toUser["PMS"]String Array消息通知对象(包含PMS、ZHI_HUI_PING-智慧屏/智能音箱)
templateId14707241958331236000Long模板消息id
isVoiceRemind0int是否需要语音提醒,0-不需要,1-需要
bizData-object模板数据

举例说明:若模板消息格式为"{{deviceType}}{{deviceNum}}由于{{reason}}导致配送异常,订单号为{{orderId}}",则对应的bizData数据如下

{
"hotelId":1470724195833876500,
"roomNo":"701",
"iotId":"Q7uOhVRdZRRlDnTLv3433400100",
"deviceName":"iottest",
"productKey":"9daw7832df",
"toUser":["PMS"],
"templateId":14707241958331236000,
"isVoiceRemind":0,
"bizData":{
"deviceType":"机器人",
"deviceNum":"4567",
"reason":"顾客超时未取",
"orderId":"2133113213389071234"
}
}

成功响应示例

参数名示例值参数类型参数描述
datatruebool推送结果,true-成功,false-失败
{
"code": 0,
"message": "成功",
"data": true
}

错误响应示例

{
"code": 4000,
"message": "鉴权失败",
"data": null
}

目前已接入模板

模板id模板标题
1522424903842664509机器人接餐并开始送餐
1522424497003565092机器人餐品已送达房间
1519562651363971092送物异常上报