# 发送一次性订阅消息

[调试诊断](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_tools)

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：templateSubscribe

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

## 1. 调用方式

### HTTPS 调用

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

### 云调用

- 本接口不支持云调用。

### 第三方调用

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

- 该接口所属的权限集 id 为：7

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "示例": "ACCESS_TOKEN",
    "说明": "接口调用凭证，可使用 [access_token](/doc/subscription/api/base/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "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`

跳小程序配置

```json
[
  {
    "参数名": "appid",
    "类型": "string",
    "必填": "是",
    "示例": "xiaochengxuappid12345",
    "说明": "小程序appid"
  },
  {
    "参数名": "pagepath",
    "类型": "string",
    "必填": "是",
    "示例": "index?foo=bar",
    "说明": "小程序页面路径"
  }
]
```

### Body.data `Object Payload`

消息内容

```json
[
  {
    "参数名": "content",
    "类型": "object",
    "必填": "否",
    "说明": "内容信息"
  }
]
```

### Body.data.content `Object Payload`

内容信息

```json
[
  {
    "参数名": "value",
    "类型": "string",
    "必填": "否",
    "示例": "您好！",
    "说明": "消息文本(200字内)"
  },
  {
    "参数名": "color",
    "类型": "string",
    "必填": "否",
    "示例": "#FF0000",
    "说明": "字体颜色"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  }
]
```

## 4. 注意事项

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

## 5. 代码示例

请求示例

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

返回示例

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

## 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "-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. 适用范围

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

```json
[
  {
    "公众号": "仅认证",
    "服务号": "仅认证",
    "移动应用": "✔"
  }
]
```

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