# 发送一次性订阅消息

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

接口英文名：templateSubscribe

推送订阅模板消息给授权微信用户

# 1. 调用方式

# HTTPS 调用

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

# 云调用

本接口不支持云调用

# 第三方调用

本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为：7
服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看第三方调用说明文档。

# 2. 请求参数

# 查询参数 `Query String parameters`

参数名	类型	必填	示例	说明
access_token	string	是	ACCESS_TOKEN	接口调用凭证，可使用 access_token、authorizer_access_token

# 请求体 `Request Payload`

参数名	类型	必填	示例	说明
touser	string	是	OPENID	接收消息的用户openid
template_id	string	是	TEMPLATE_ID	订阅消息模板ID
url	string	否	https://example.com	点击消息跳转链接(需ICP备案)
miniprogram	object	否	-	跳小程序配置
scene	string	是	1000	订阅场景值
title	string	是	订阅通知	消息标题(15字以内)
data	object	是	-	消息内容

# Body.miniprogram `Object Payload`

跳小程序配置

参数名	类型	必填	示例	说明
appid	string	是	xiaochengxuappid12345	小程序appid
pagepath	string	是	index?foo=bar	小程序页面路径

# Body.data `Object Payload`

消息内容

参数名	类型	必填	说明
content	object	否	内容信息

# Body.data.content `Object Payload`

内容信息

参数名	类型	必填	示例	说明
value	string	否	您好！	消息文本(200字内)
color	string	否	#FF0000	字体颜色

# 3. 返回参数

# 返回体 `Response Payload`

参数名	类型	说明
errcode	number	错误码
errmsg	string	错误信息

# 4. 注意事项

1.url和miniprogram都是非必填字段，若都不传则模板无跳转；若都传会优先跳转至小程序 2.用户已关注公众号时消息下发到公众号会话，未关注时下发到服务通知

# 5. 代码示例

请求示例

{
  "touser": "OPENID",
  "template_id": "TEMPLATE_ID",
  "miniprogram":{
    "appid":"xiaochengxuappid12345",
    "pagepath":"index?foo=bar"    
  },
  "scene": "1000",
  "title": "订阅通知",
  "data": {
    "content": {
      "value": "您好！",
      "color": "#FF0000"
    }
  }
}

返回示例

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

# 6. 错误码

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

错误码	错误描述	解决方案
-1	system error	系统繁忙，此时请开发者稍候再试
0	ok	成功
40001	invalid credential access_token isinvalid or not latest	获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口
40003	invalid openid	不合法的 OpenID ，请开发者确认 OpenID （该用户）是否已关注公众号，或是否是其他公众号的 OpenID
40013	invalid appid	AppID无效
40037	invalid template_id	模板ID无效
40062	invalid title size

# 7. 适用范围

本接口在不同账号类型下的可调用情况：

公众号	服务号	移动应用
仅认证	仅认证	✔

仅认证：表示仅允许企业主体已认证账号调用，未认证或不支持认证的账号无法调用
✔：该账号可调用此接口
其他未明确声明的账号类型，如无特殊说明，均不可调用此接口；

# 发送一次性订阅消息

# 1. 调用方式

# HTTPS 调用

# 云调用

# 第三方调用

# 2. 请求参数

# 查询参数 Query String parameters

# 请求体 Request Payload

# Body.miniprogram Object Payload

# Body.data Object Payload

# Body.data.content Object Payload

# 3. 返回参数

# 返回体 Response Payload

# 4. 注意事项

# 5. 代码示例

# 6. 错误码

# 7. 适用范围

# 查询参数 `Query String parameters`

# 请求体 `Request Payload`

# Body.miniprogram `Object Payload`

# Body.data `Object Payload`

# Body.data.content `Object Payload`

# 返回体 `Response Payload`