# Use a template

Debugging Tools

Interface should be called on the server side, not in the front end (Weixin Mini Program, web pages, APP, etc.) directly called, specific reference interface call guide

Interface name: addTemplate

This interface is used to get template ID by adding template from category template library or industry template library

# 1. How to call

# HTTPS calls

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

# Cloud Calls

  • This interface does not support cloud calls

# Third party invocation

  • This interface supports Third Party Platform generation business call.

  • This interface belongs to the permission set id: 7,100-101

  • When a service provider is authorized by one of the permissions set, it can call on behalf of the merchant by using authorizer_access_token , which can be viewed in the third-party call documentation.

# 2. Request parameters

# Query parametersQuery String parameters

Parameter NametypeRequired to fill inIntroductions
access_tokenstringyesInterface invocation credentials, using access_token , authorizer_access_token

# Request BodyRequest Payload

Parameter NametypeRequired to fill inExampleIntroductions
template_id_shortstringyes47123Template library template number, there are "TM **" and "OPENTMTM** " and other forms, for category templates, pure digital ID
keyword_name_listarrayyes["Time," Location,"Amount"]The keyword for the selected category template is entered in order. If the keyword is empty or is not in the template library, a 40246 error code will be returned

# 3. Return Parameters

# Response Payload

Parameter NametypeIntroductions
errcodenumberError code
errmsgstringError Description
template_idstringTemplate ID

# 4. Note

There are no special considerations for this interface

# 5. Code examples

Example Requests

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

Return an example

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

# 6. Error code

The following is a list of error codes for this interface, other error codes can refer to General error codes

Error codeError DescriptionSolutions
-1system errorThe system is busy, so the developer is asked to try again in a few minutes.
40001invalid credential  access_token isinvalid or not latestAppSecret error while getting access_token, or access_token is invalid.Developers should check that AppSecret is correct, or that they are calling interfaces for the appropriate Official Account
40037invalid template_idInvalid template_id
40246invalid keyword_name_listNeed to pass in the correct keyword_name_list
40247need new category templatePlease use the Category Template Library ID to add

# 7. Scope of application

This interface supports "Service Account (authentication only)" account type calls.None of the other account types can be invoked without special instructions.