发送设备消息

发送设备消息

调试工具

接口应在服务器端调用，详细说明参见服务端API。

接口说明

接口英文名

sendHardwareDeviceMessage

功能描述

通过该接口向用户发送设备消息。

注意事项

调用次数限制：1kw/日。

调用方式

HTTPS 调用

POST https://api.weixin.qq.com/cgi-bin/message/device/subscribe/send?access_token=ACCESS_TOKEN 

第三方调用

• 调用方式以及出入参和HTTPS相同，仅是调用的token不同
• 该接口所属的权限集id为：118
• 服务商获得其中之一权限集授权后，可通过使用authorizer_access_token代商家进行调用

请求参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证，该参数为 URL 参数，非 Body 参数。使用access_token或者authorizer_access_token
template_id	string	是	所需下发的订阅模板id
sn	string	是	设备唯一序列号。由厂商分配，长度不能超过128字节。字符只接受数字，大小写字母，下划线（_）和连字符（-）。
page	string	是	点击模板卡片后的跳转页面，仅限本小程序内的页面。支持带参数,（示例index?foo=bar）。该字段不填则模板无跳转。
to_openid_list	array	是	接收者（用户）的 openid 列表
miniprogram_state	string	否	跳转小程序类型：developer为开发版；trial为体验版；formal为正式版；默认为正式版
modelId	string	是	设备型号 id ，通过注册设备获得。
data	string	是	这是个object，不是string。模板内容，格式形如 { "key1": { "value": "xxx" }, "key2": { "value": "xxx" } } ，value 为枚举值。
lang	string	是	进入小程序查看”的语言类型，支持zh_CN(简体中文)、en_US(英文)、zh_HK(繁体中文)、zh_TW(繁体中文)，默认为zh_CN

返回参数

属性	类型	说明
errcode	number	错误码
errmsg	string	错误信息

调用示例

示例说明: HTTPS请求示例

请求数据示例

{
  "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"
     }
  }
} 

返回数据示例

{
  "errcode": 0,
  "errmsg": "ok",
} 

错误码

错误码	错误码取值	解决方案
-1	system error	系统繁忙，此时请开发者稍候再试
40037	invalid template_id	不合法的 template_id
43101	user refuse to accept the msg	用户拒绝接受消息，如果用户之前曾经订阅过，则表示用户取消了订阅关系
47003	argument invalid!	模板参数不准确，可能为空或者不满足规则，errmsg会提示具体是哪个字段出错
41030	invalid page	page路径不正确，需要保证在现网版本小程序中存在，与app.json保持一致