# 发送模板消息

调试工具

接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南

接口英文名：sendTemplateMessage

本接口用于向用户发送模板消息

# 1. 调用方式

# HTTPS 调用

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

# 云调用

• 调用方法：officialAccount.messageTemplate.send

• 出入参和 HTTPS 调用相同，调用方式可查看 云调用 说明文档

# 第三方调用

• 本接口支持第三方平台代商家调用。

• 该接口所属的权限集 id 为：7、100-101

• 服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String parameters

# 请求体 Request Payload

# Body.miniprogram Object Payload

跳转小程序时填写（url 和 miniprogram 同时不填，无跳转，page 和 miniprogram 同时填写，优先跳转小程序）

# Body.data Object Payload

模板内容，需根据模板给定的格式给出（参考注意事项），格式形如 { "key1": { "value": any }, "key2": { "value": any } }

# 3. 返回参数

# 返回体 Response Payload

# 4. 注意事项

url和miniprogram都是非必填字段，若都不传则模板无跳转；若都传，会优先跳转至小程序。开发者可根据实际需要选择其中一种跳转方式即可。当用户的微信客户端版本不支持跳小程序时，将会跳转至url。

各 DATA 注意事项：

• 符号：表示除中文、英文、数字外的常见符号，不能带有换行等控制字符。
• 时间：格式支持HH:MM:SS或者HH:MM。
• 日期：包含年月日，为y年m月d日，y年m月、m月d日格式，或者用‘-’、‘/’、‘.’符号连接，如2018-01-01，2018/01/01，2018.01.01，2018-01，01-01。

每个模板参数都会以类型为前缀，例如第一个数字模板参数为number01.DATA，第二个为number02.DATA，发送模版通知时，通知内容应于模板参数一致，每个模板参数都会以类型为前缀，例如第一个数字模板参数为number01.DATA，第二个为number02.DATA

例如，模板的内容为

姓名: {{name01.DATA}}
金额: {{amount01.DATA}}
行程: {{thing01.DATA}}
日期: {{date01.DATA}}

则对应的json为

{
  "touser": "OPENID",
  "template_id": "TEMPLATE_ID",
  "page": "index",
  "data": {
      "name01": {
          "value": "某某"
      },
      "amount01": {
          "value": "￥100"
      },
      "thing01": {
          "value": "广州至北京"
      },
      "date01": {
          "value": "2018-01-01"
      }
  }
}

如果参数不符合要求，会收到如下提示,并指明不符合要求的字段：

{
    "errcode":47003,
    "errmsg":"thing01.DATA is invalid"
}

# 5. 代码示例

请求示例

  {
           "touser":"OPENID",
           "template_id":"ngqIpbwh8bUfcSsECmogfXcV14J0tQlEpBO27izEYtY",
           "url":"http://weixin.qq.com/download",  
           "miniprogram":{
             "appid":"xiaochengxuappid12345",
             "pagepath":"index?foo=bar"
           },
           "client_msg_id":"MSG_000001",
           "data":{

                   "keyword1":{
                       "value":"巧克力"
                   },
                   "keyword2": {
                       "value":"39.8元"
                   },
                   "keyword3": {
                       "value":"2014年9月22日"
                   }
           }
       }

返回示例

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

# 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 通用错误码

# 7. 适用范围

本接口支持「服务号（仅认证）」账号类型调用。其他账号类型如无特殊说明，均不可调用。