小程序
取消
开发
中文
EN
取消
  • 指南

    • # 选用模板

    调试诊断

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

    接口英文名：addwxanewtemplate

    从公共模板库中选用模板到私有模板库

    # 1. 调用方式

    # HTTPS 调用

    POST https://api.weixin.qq.com/wxaapi/newtmpl/addtemplate?access_token=ACCESS_TOKEN

    # 云调用

    • 调用方法：subscribeMessage.addTemplate

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

    # 第三方调用

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

    • 该接口所属的权限集 id 为：18、89

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

    # 2. 请求参数

    # 查询参数 Query String parameters

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

    # 请求体 Request Payload

    参数名类型必填说明
    tidstring是模板标题 id，可通过接口获取，也可登录小程序后台查看获取
    kidListnumarray是开发者自行组合好的模板关键词列表，关键词顺序可以自由搭配（例如 [3,5,4] 或 [4,5,3]），最多支持5个，最少2个关键词组合
    sceneDescstring是服务场景描述，15个字以内

    # 3. 返回参数

    # 返回体 Response Payload

    参数名类型说明
    errcodenumber错误码
    errmsgstring错误信息
    priTmplIdstring添加至帐号下的模板id，发送小程序订阅消息时所需

    # 4. 注意事项

    1.模板标题 id可通过接口获取或后台查看 2.关键词组合需2-5个 3.服务场景描述限制15字

    # 5. 代码示例

    # 5.1 选用模板

    请求示例

    {
  "tid": "401",
  "kidList": [
    1,
    2
  ],
  "sceneDesc": "测试数据"
}

    返回示例

    {
  "errmsg": "ok",
  "errcode": 0,
  "priTmplId": "9Aw5ZV1j9xdWTFEkqCpZ7jWySL7aGN6rQom4gXINfJs"
}

    # 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({ convertCase: false }).subscribeMessage.addTemplate({
        "tid": '401',
        "kidList": [
          1,
          2
        ],
        "sceneDesc": '测试数据'
      })
    return result
  } catch (err) {
    return err
  }
}

    返回示例

    {
  "errMsg": "openapi.subscribeMessage.addTemplate:ok",
  "errCode": 0,
  "priTmplId": "9Aw5ZV1j9xdWTFEkqCpZ7jWySL7aGN6rQom4gXINfJs"
}

    # 6. 错误码

    以下是本接口的错误码列表，其他错误码可参考 通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具 辅助定位和分析问题。

    错误码错误描述解决方案
    -1system error系统繁忙，此时请开发者稍候再试
    40001invalid credential  access_token isinvalid or not latest获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口
    40400HTTP报文不符合规范（HTTP Bad Request）开发者修复
    200001系统错误请稍后再试
    200011此账号已被封禁前往公众平台查看站内信了解封禁原因并按照站内信通知进行处理
    200012私有模板数已达上限删除已有的私有模版后可添加
    200013此模版已被封禁前往公众平台查看站内信了解封禁原因并按照站内信通知进行处理
    200014模版 tid 参数错误请检查tid是否为空值以及该tid是否存在
    200020关键词列表 kidList 参数错误kidList中的关键词不存在，请使用已有的关键词或者申请新的关键词
    200021场景描述 sceneDesc 参数错误请检查sceneDesc是否为空值以及格式是否合法
    200022想通标题和关键字的模板已存在更换标题和关键字重试
    200100账号类型不合法请使用小程序账号调用

    # 7. 适用范围

    本接口在不同账号类型下的可调用情况：
    小程序公众号服务号小游戏
    ✔ 仅认证 仅认证 ✔
    • ✔：该账号可调用此接口
    • 仅认证：表示仅允许企业主体已认证账号调用，未认证或不支持认证的账号无法调用
    • 其他未明确声明的账号类型，如无特殊说明，均不可调用此接口；