# 选用模板

调试工具

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

接口英文名:addTemplate

本接口用于从行业模板库添加模板获得模板ID

# 1. 调用方式

# HTTPS 调用

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

# 云调用

  • 本接口不支持云调用

# 第三方调用

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

  • 该接口所属的权限集 id 为:7、100-101

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

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填说明
access_tokenstring接口调用凭证,可使用 access_tokenauthorizer_access_token

# 请求体 Request Payload

参数名类型必填示例说明
template_id_shortstring47123模板库中模板的编号,有“TM**”和“OPENTMTM**”等形式,对于类目模板,为纯数字ID
keyword_name_listarray["时间","地点","金额"]选用的类目模板的关键词,按顺序传入,如果为空,或者关键词不在模板库中,会返回40246错误码

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误描述
template_idstring模板ID

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

请求示例

{
    "template_id_short":"47123",
    "keyword_name_list":["时间","地点","金额"]
}

返回示例

 {
    "errcode":0,
    "errmsg":"ok",
    "template_id":"Doclyl5uP7Aciu-qZ7mJNPtWkbkYnWBWVja26EGbNyk"
  }

# 6. 错误码

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

错误码错误描述解决方案
-1system error系统繁忙,此时请开发者稍候再试
40001invalid credential  access_token isinvalid or not latest获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口
40037invalid template_id不合法的 template_id
40246invalid keyword_name_list需要传入正确的keyword_name_list
40247need new category template请使用类目模板库ID进行添加

# 7. 适用范围

本接口支持「仅认证的服务号」账号类型调用。其他账号类型如无特殊说明,均不可调用。