# 获取已有模板列表

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

接口英文名：getwxapubnewtemplate

该接口用于获取当前帐号下的已有的模板列表。

# 1. 调用方式

# HTTPS 调用

GET https://api.weixin.qq.com/wxaapi/newtmpl/gettemplate?access_token=ACCESS_TOKEN

# 云调用

调用方法：subscribeMessage.getTemplateList
出入参和 HTTPS 调用相同，调用方式可查看云调用说明文档

# 第三方调用

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

# 2. 请求参数

# 查询参数 `Query String parameters`

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

# 请求体 `Request Payload`

无

# 3. 返回参数

# 返回体 `Response Payload`

参数名	类型	说明
errcode	number	错误码
errmsg	string	错误信息
data	objarray	模板列表

# Res.data(Array) `Object Payload`

模板列表

参数名	类型	说明
priTmplId	string	添加至帐号下的模板 id，发送小程序订阅消息时所需
title	string	模版标题
content	string	模版内容
example	string	模板内容示例
type	number	模版类型，2 为一次性订阅，3 为长期订阅
keywordEnumValueList	objarray	枚举参数值范围

# Res.data(Array).keywordEnumValueList`Object Payload`

枚举参数值范围

参数名	类型	说明
keywordCode	string	枚举参数的 key
enumValueList	array	枚举参数值范围列表

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

# 5.1 HTTPS请求示例

请求示例

GET https://api.weixin.qq.com/wxaapi/newtmpl/gettemplate?access_token=ACCESS_TOKEN

返回示例

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "priTmplId": "9Aw5ZV1j9xdWTFEkqCpZ7mIBbSC34khK55OtzUPl0rU",
      "title": "报名结果通知",
      "content": "会议时间:{{date2.DATA}}\n会议地点:{{thing1.DATA}}\n",
      "example": "会议时间:2016年8月8日\n会议地点:TIT会议室\n",
      "type": 2
    },
    {
      "priTmplId": "cy_DfOZL7lypxHh3ja3DyAUbn1GYQRGwezuy5LBTFME",
      "title": "洗衣机故障提醒",
      "content": "完成时间:{{time1.DATA}}\n所在位置:{{enum_string2.DATA}}\n提示说明:{{enum_string3.DATA}}\n",
      "example": "完成时间:2021年10月21日 12:00:00\n所在位置:客厅\n提示说明:设备发生故障，导致工作异常，请及时查看\n",
      "keywordEnumValueList": [
        {
          "enumValueList": [
            "客厅",
            "餐厅",
            "厨房",
            "卧室",
            "主卧",
            "次卧",
            "客卧",
            "父母房",
            "儿童房",
            "男孩房",
            "女孩房",
            "卫生间",
            "主卧卫生间",
            "公共卫生间",
            "衣帽间",
            "书房",
            "游戏室",
            "阳台",
            "地下室",
            "储物间",
            "车库",
            "保姆房",
            "其他房间"
          ],
          "keywordCode": "enum_string2.DATA"
        },
        {
          "enumValueList": [
            "设备发生故障，导致工作异常，请及时查看"
          ],
          "keywordCode": "enum_string3.DATA"
        }
      ],
      "type": 3
    }
  ]
}

# 5.2 云函数调用示例

请求示例

const cloud = require('wx-server-sdk')
cloud.init({
  env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.subscribeMessage.getTemplateList({})
    return result
  } catch (err) {
    return err
  }
}

返回示例

{
  "errCode": 0,
  "errMsg": "openapi.subscribeMessage.getTemplateList:ok",
  "data": [
    {
      "priTmplId": "9Aw5ZV1j9xdWTFEkqCpZ7mIBbSC34khK55OtzUPl0rU",
      "title": "报名结果通知",
      "content": "会议时间:{{date2.DATA}}\n会议地点:{{thing1.DATA}}\n",
      "example": "会议时间:2016年8月8日\n会议地点:TIT会议室\n",
      "type": 2
    },
    {
      "priTmplId": "cy_DfOZL7lypxHh3ja3DyAUbn1GYQRGwezuy5LBTFME",
      "title": "洗衣机故障提醒",
      "content": "完成时间:{{time1.DATA}}\n所在位置:{{enum_string2.DATA}}\n提示说明:{{enum_string3.DATA}}\n",
      "example": "完成时间:2021年10月21日 12:00:00\n所在位置:客厅\n提示说明:设备发生故障，导致工作异常，请及时查看\n",
      "keywordEnumValueList": [
        {
          "enumValueList": [
            "客厅",
            "餐厅",
            "厨房",
            "卧室",
            "主卧",
            "次卧",
            "客卧",
            "父母房",
            "儿童房",
            "男孩房",
            "女孩房",
            "卫生间",
            "主卧卫生间",
            "公共卫生间",
            "衣帽间",
            "书房",
            "游戏室",
            "阳台",
            "地下室",
            "储物间",
            "车库",
            "保姆房",
            "其他房间"
          ],
          "keywordCode": "enum_string2.DATA"
        },
        {
          "enumValueList": [
            "设备发生故障，导致工作异常，请及时查看"
          ],
          "keywordCode": "enum_string3.DATA"
        }
      ],
      "type": 3
    }
  ]
}

# 6. 错误码

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

错误码	错误描述	解决方案
-1	system error	系统繁忙，此时请开发者稍候再试
404	404 not found	请检查调用方法是否有误[get\|post]
40001	invalid credential access_token isinvalid or not latest	获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口
200100	账号类型不合法	请使用小程序账号调用

# 7. 适用范围

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

小程序	公众号	服务号	小游戏
✔	仅认证	仅认证	✔

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

# 获取已有模板列表

# 1. 调用方式

# HTTPS 调用

# 云调用

# 第三方调用

# 2. 请求参数

# 查询参数 Query String parameters

# 请求体 Request Payload

# 3. 返回参数

# 返回体 Response Payload

# Res.data(Array) Object Payload

# Res.data(Array).keywordEnumValueListObject Payload

# 4. 注意事项

# 5. 代码示例

# 5.1 HTTPS请求示例

# 5.2 云函数调用示例

# 6. 错误码

# 7. 适用范围

# 查询参数 `Query String parameters`

# 请求体 `Request Payload`

# 返回体 `Response Payload`

# Res.data(Array) `Object Payload`

# Res.data(Array).keywordEnumValueList`Object Payload`