平台差异说明

请求地址

请求参数

属性类型必填说明
access_tokenstring是接口调用凭证，微信小程序参考 ，百度小程序参考verify
idstring是模板标题id
keyword_id_listArray.<number>是开发者自行组合好的模板关键词列表，关键词顺序可以自由搭配（例如[3,5,4]或[4,5,3]），最多支持10个关键词组合

返回值(Object)

属性类型说明平台
errcodenumber错误码
errmsgstring错误信息
template_idstring添加至帐号下的模板id，发送APP模板消息时所需微信小程序
dataObject{template_id}百度小程序

Tips

  • POST 数据格式：JSON。
  • access_token 应写在 url 上。
  • 本接口应在后端服务器调用。请求数据示例
  2.   "id": "xxx",
  3.   "keyword_id_list": [3, 4, 5]
  4. }

返回数据示例

  1. {
  2.     "errcode": 0,
  3.     "errmsg": "ok",
  4.     /* "template_id": "wDYzYZVxobJivW9oMpSCpuvACOfJXQIoKUm0PY397Tc" //微信小程序 */
  5.     "data": { // 百度小程序
  6.         "template_id": "f34178cd598201d9dc8d5c88cd87b44cf7cd0e62NwmP" 
  7.     }
  8. }

deleteTemplate

删除帐号下的某个模板。

平台差异说明

5+AppH5微信小程序支付宝小程序百度小程序头条小程序
xx√x√x

请求地址

  1. /* 微信小程序 */
  2. POST https://api.weixin.qq.com/cgi-bin/wxopen/template/del?access_token=ACCESS_TOKEN
  4. /* 百度小程序 */
  5. POST https://openapi.baidu.com/rest/2.0/smartapp/template/templatedel?access_token=ACCESS_TOKEN

请求参数

属性类型必填说明
access_tokenstring是接口调用凭证，微信小程序参考 getAccessToken，百度小程序参考
template_idstring是要删除的模板id

返回值（Object）

属性类型说明
errcodenumber错误码
errmsgstring错误信息

Tips

  • POST 数据格式：JSON。
  • access_token 应写在 url 上。
  • 本接口应在后端服务器调用。请求数据示例
  1. {
  2.   "template_id": "wDYzYZVxobJivW9oMpSCpuvACOfJXQIoKUm0PY397Tc"
  3. }

返回数据示例

  1. {
  2.   "errcode": 0,
  3.   "errmsg": "ok"
  4. }

获取模板库某个模板标题下关键词库。

平台差异说明

5+AppH5微信小程序支付宝小程序百度小程序头条小程序
xx√x√x

请求地址

  1. /* 微信小程序 */
  2. POST https://api.weixin.qq.com/cgi-bin/wxopen/template/library/get?access_token=ACCESS_TOKEN
  4. /* 百度小程序 */
  5. POST https://openapi.baidu.com/rest/2.0/smartapp/template/libraryget?access_token=ACCESS_TOKEN

请求参数

属性类型必填说明
access_tokenstring是接口调用凭证，微信小程序参考 getAccessToken，百度小程序参考
idstring是模板标题id

返回值(Object)

属性类型说明
keyword_idstring关键词 id，添加模板时需要
namestring关键词内容
examplestring关键词内容对应的示例

Tips

  • POST 数据格式：JSON。
  • access_token 应写在 url 上。
  • 本接口应在后端服务器调用。请求数据示例
  1. {
  2.   "id": "xxx"
  3. }

微信小程序返回数据示例

百度小程序返回数据示例

  1. {
  2.     "errno": 0,
  3.     "msg": "success",
  4.     "data": {
  5.         "id": "BD0016",
  6.         "title": "取票成功通知",
  7.         "keyword_count": 13,
  8.         "keyword_list": [
  9.             {
  10.                 "keyword_id": 1,
  11.                 "name": "金额",
  12.             },
  13.             {
  14.                 "keyword_id": 2,
  15.                 "name": "订单号",
  16.                 "example": "321254555"
  17.             }
  18.         ]
  20. }

getTemplateLibraryList

获取APP模板库标题列表

平台差异说明

5+AppH5微信小程序支付宝小程序百度小程序头条小程序
xx√x√x

请求地址

  1. /* 微信小程序 */
  2. POST https://api.weixin.qq.com/cgi-bin/wxopen/template/library/list?access_token=ACCESS_TOKEN
  4. /* 百度小程序 */
  5. POST https://openapi.baidu.com/rest/2.0/smartapp/template/librarylist?access_token=ACCESS_TOKEN

请求参数

属性类型必填说明
access_tokenstring是接口调用凭证，微信小程序参考 ，百度小程序参考verify
offsetnumber是用于分页，表示从offset开始。从 0 开始计数。
countnumber是用于分页，表示拉取count条记录。最大为 20。

返回值(Object)

属性类型说明平台
errcodenumber错误码微信小程序
errmsgstring错误信息微信小程序
listArray.<Object>返回模板库标题列表微信小程序
total_countnumber模板库标题总数微信小程序
errnonumber错误码百度小程序
msgstring错误信息百度小程序
dataObject{total_count,list}百度小程序

list结构说明

属性类型说明
idstring模板标题id（获取模板标题下的关键词库时需要）
titlestring模板标题内容

Tips

  • POST 数据格式：JSON。
  • access_token 应写在 url 上。
  • 本接口应在后端服务器调用。请求数据示例
  1. {
  2.   "offset": 0,
  3.   "count": 5
  4. }

微信小程序返回数据示例

  1. {
  2.     "errcode": 0,
  3.     "errmsg": "ok",
  4.     "list": [
  5.         {"id": "AT0002", "title": "购买成功通知"},
  6.         {"id": "AT0003", "title": "交易提醒"}
  7.     ],
  8.     "total_count": 100
  9. }

百度小程序返回数据示例

  1. {
  2.     "errno": 0,
  3.     "msg": "success",
  4.     "data": {
  5.         "total_count": 100,
  6.         "list": [
  7.             {"id": "AT0002", "title": "购买成功通知"},
  8.             {"id": "AT0003", "title": "交易提醒"}
  9.         ]
  10.     }
  11. }

获取帐号下已存在的模板列表。

平台差异说明

5+AppH5微信小程序支付宝小程序百度小程序头条小程序
xx√x√x

请求地址

  1. /* 微信小程序 */
  2. POST https://api.weixin.qq.com/cgi-bin/wxopen/template/list?access_token=ACCESS_TOKEN
  4. /* 百度小程序 */
  5. POST https://openapi.baidu.com/rest/2.0/smartapp/template/templatelist?access_token=ACCESS_TOKEN

请求参数

属性类型必填说明
access_tokenstring是接口调用凭证，微信小程序参考 ，百度小程序参考verify
offsetnumber是用于分页，表示从offset开始。从 0 开始计数。
countnumber是用于分页，表示拉取count条记录。最大为 20。

返回值(Object)

list结构说明

属性类型说明
template_idstring添加至帐号下的模板id，发送APP模板消息时所需
titlestring模板标题
contentstring模板内容
examplestring模板内容示例
  • POST 数据格式：JSON。
  • access_token 应写在 url 上。
  • 本接口应在后端服务器调用。请求数据示例
  1. {
  2.   "offset": 0,
  3.   "count": 1
  4. }

微信小程序返回数据示例

百度小程序返回数据示例

  1. {
  2.     "errno": 0,
  3.     "msg": "success",
  4.     "data": {
  5.         "total_count": 1,
  6.             {
  7.                 "template_id": "e4313219538c4b0262e3a14a0507000e8bd79e9PTPAz",
  8.                 "title": "续费成功通知",
  9.                 "content": "购买时间{{keyword1.DATA}}\n物品名称{{keyword2.DATA}}",
  10.                 "example": "购买时间: 2016年6月6日\n物品名称: 奶茶"
  12.         ]
  13.     }
  14. }

sendTemplateMessage

发送模板消息

平台差异说明

5+AppH5微信小程序支付宝小程序百度小程序头条小程序
xx√x√x

请求地址

  1. /* 微信小程序 */
  2. POST https://api.weixin.qq.com/cgi-bin/message/wxopen/template/send?access_token=ACCESS_TOKEN
  4. /* 百度小程序 */
  5. POST https://openapi.baidu.com/rest/2.0/smartapp/template/templatedel?access_token=ACCESS_TOKEN

请求参数

属性类型必填说明支持平台
access_tokenstring是接口调用凭证，微信小程序参考 getAccessToken，百度小程序参考
touserstring是接收者（用户）的 openid/swan_id
template_idstring是所需下发的模板消息的id
pagestring否点击模板卡片后的跳转页面，仅限本APP内的页面。支持带参数,（示例index?foo=bar）。该字段不填则模板无跳转。
dataObject否模板内容，不填则下发空模板。具体格式请参考示例。
form_idstring是表单提交场景下，为 submit 事件带上的 formId；支付场景下，为本次支付的 微信小程序
emphasis_keywordstring否模板需要放大的关键词，不填则默认无放大微信小程序
touser_openIdstring是接收者open_id百度小程序
scene_idstring是string百度小程序
scene_typenumber是场景type，1：表单；2：百度收银台订单；3:直连订单。百度小程序
extjsonString否'{"xzh_id":111,"category_id":15}'百度小程序

返回值(Object)

属性类型说明平台
errcodenumber错误码微信小程序
errmsgstring错误信息微信小程序
errnonumber错误码百度小程序
msgstring错误信息百度小程序
dataObject{msg_key}百度小程序

errcode 的合法值

值说明
40037template_id不正确
41028form_id不正确，或者过期
41029form_id已被使用
41030page不正确
45009接口调用超过限额（目前默认每个帐号日调用限额为100万）

errno 的合法值

值说明
2002参数错误
4001template_id 不正确
4002消息推送接口调用失败
4003表单无效
4004场景id无效
6001无 push 权限

Tips

  • POST 数据格式：JSON。
  • access_token 应写在 url 上。
  • 本接口应在后端服务器调用。微信小程序请求数据示例
  1. {
  2.     "touser": "OPENID",
  3.     "template_id": "TEMPLATE_ID",
  4.     "page": "/pages/index/index",
  5.     "form_id": "FORMID",
  6.     "data": {
  7.         "keyword1": {
  8.             "value": "339208499"
  9.         },
  10.         "keyword2": {
  11.             "value": "2015年01月05日 12:30"
  12.         }
  13.     },
  14.     "scene_type": 1,
  15.     "emphasis_keyword": "keyword1.DATA"
  16. }

微信小程序返回数据示例

  1. {
  2.     "errcode": 0,
  3.     "errmsg": "ok"
  4. }

百度小程序请求数据示例

  1. {
  2.     "touser": "SWAN_ID",
  3.     "template_id": "TEMPLATE_ID",
  4.     "page": "/pages/index/index",
  5.     "data": {
  6.         "keyword1": {
  7.             "value": "339208499"
  8.         },
  9.         "keyword2": {
  10.             "value": "2015年01月05日 12:30"
  11.         }
  12.     },
  13.     "scene_id": "123456"
  14. }

百度小程序返回数据示例

  1. {
  2.     "errno": 0,
  3.     "msg": "success",
  4.     "data": {
  5.         "msg_key": 158
  6.     }
  7. }

小程序通过 openapi 给用户触达消息，主要为支付后的触达（通过消费id）和用户提交表单后的触达（通过formId）。

平台差异说明

5+AppH5微信小程序支付宝小程序百度小程序头条小程序
xxx√xx

请求地址

    公共请求参数

    发现错误？想参与编辑？在 GitHub 上编辑此页面！