# hardwareDevice.send
本接口应在服务器端调用,详细说明参见服务端API。
开发者可以通过该接口向用户发送设备消息。
# 请求地址
POST https://api.weixin.qq.com/cgi-bin/message/device/subscribe/send?access_token=ACCESS_TOKEN
# 请求参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
access_token / cloudbase_access_token | string | 是 | 接口调用凭证 | |
to_openid_list | Object | 是 | 接收者(用户)的 openid 列表 | |
template_id | string | 是 | 所需下发的订阅模板id | |
sn | string | 是 | 设备唯一序列号。由厂商分配,长度不能超过128字节。字符只接受数字,大小写字母,下划线(_)和连字符(-)。 | |
model_id | string | 是 | 设备型号 id ,通过注册设备获得。 | |
page | string | 否 | 点击模板卡片后的跳转页面,仅限本小程序内的页面。支持带参数,(示例index?foo=bar)。该字段不填则模板无跳转。 | |
data | Object | 是 | 模板内容,格式形如 { "key1": { "value": "xxx" }, "key2": { "value": "xxx" } } ,value 为枚举值。 | |
miniprogram_state | string | 否 | 跳转小程序类型:developer为开发版;trial为体验版;formal为正式版;默认为正式版 | |
lang | string | 否 | 进入小程序查看”的语言类型,支持zh_CN(简体中文)、en_US(英文)、zh_HK(繁体中文)、zh_TW(繁体中文),默认为zh_CN |
# 返回值
# Object
返回的 JSON 数据包
属性 | 类型 | 说明 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误信息 |
errcode 的合法值
值 | 说明 | 最低版本 |
---|---|---|
40003 | to_openid_list字段为空或者不正确 | |
40037 | 订阅模板id为空不正确 | |
43101 | 用户拒绝接受消息,如果用户之前曾经订阅过,则表示用户取消了订阅关系 | |
47003 | 模板参数不准确,可能为空或者不满足规则,errmsg会提示具体是哪个字段出错 | |
41030 | page路径不正确,需要保证在现网版本小程序中存在,与app.json保持一致 |
# 接口限制
调用次数限制:1kw/日。
# 请求示例
{
"to_openid_list": ["OPENID_1", "OPENID_2"],
"sn": "XXXXXXX",
"template_id": "TEMPLATE_ID",
"page": "index",
"miniprogram_state": "formal",
"lang": "zh_CN",
"data": {
"time1": {
"value": "2021-09-10 19:00:00"
}
}
}
# 设备消息参数值内容限制说明
注意:设备消息的参数类别可以参考 subscribeMessage.send 接口,但参数值内容是由平台生成的,即 value 为枚举值,不能够自定义内容。
具体如何填写设备消息的模版内容,可以通过调用 subscribeMessage.getTemplateList 接口查看模版内容示例。