> For the complete documentation index, see [llms.txt](https://docs.innopaas.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.innopaas.com/api-reference/whatsapp-business-api/whatsapp-business-api/mu-ban-yi-bu-template.md).

# 模板(异步)Template

## 创建模板

**请求接口地址**

```
POST    https://api.innopaas.com/api/whatsapp/v3/template/submit
```

####  **请求参数**

<table data-header-hidden><thead><tr><th width="243.87109375"></th><th width="111.06640625"></th><th width="70.15234375"></th><th width="342.91796875"></th></tr></thead><tbody><tr><td>字段</td><td>数据类型</td><td>是否必填</td><td>描述</td></tr><tr><td>wabaId</td><td>String</td><td>是</td><td>WhatsApp商业账户唯一标识</td></tr><tr><td>name</td><td>String</td><td>是</td><td>模板名称：(eg:limited_time_offer_tuscan_getaway_2023)由小写字母、数字、下划线组合,字段限制为512个字符.</td></tr><tr><td>category</td><td>String</td><td>是</td><td>模板类型：1-MARKETING,2-AUTHENTICATION,3-UTILITY</td></tr><tr><td>messageLanguage</td><td>String</td><td>是</td><td>模板支持的语言，(<strong>需要传语言缩写编码</strong>)请参考附录1</td></tr><tr><td>headerType</td><td>Integer</td><td>是</td><td>是否支持多媒体,默认1,1:None,2:Text,3:Image,4:Video,5:Document</td></tr><tr><td>caption</td><td>String</td><td>否</td><td><strong>页眉内容:</strong>字段限制为字符(多媒体模板时，该字段为空),动参格式{{1}}</td></tr><tr><td>messageBody</td><td>String</td><td>否</td><td><strong>正文内容:</strong>字段限制为1024个字符.动参格式{{1}}{{2}},前后按序插入</td></tr><tr><td>footer</td><td>String</td><td>否</td><td><strong>页脚内容:</strong>字段限制为60字符(AUTHENTICATION模板时,该字段表示过期时间,非必填,过期时间限制90分钟内)</td></tr><tr><td>safetyAdvice</td><td>Integer</td><td>否</td><td>AUTHENTICATION模板是否添加安全建议(0:不添加 1:添加)选填,未添加显示：*{{1}}* 是你的验证码。添加后显示：*{{1}}* 是你的验证码。为安全起见，请不要分享这组验证码。</td></tr><tr><td>buttons</td><td>Object[]</td><td>否</td><td>按钮总数不超过10个</td></tr><tr><td>├─actionType<br></td><td>String</td><td><br></td><td>按钮类型 1-quick reply,2-visit website,3-call phone number,4-copy code(category为2时),5-auto fill (category为2时)</td></tr><tr><td>├─label</td><td>String</td><td><br></td><td>按钮文本</td></tr><tr><td>├─ phoneArea</td><td>String</td><td><br></td><td>号码区号(eg:86)</td></tr><tr><td>├─ phone</td><td>String</td><td><br></td><td>号码(eg:18877776666)</td></tr><tr><td>├─packageName</td><td>String</td><td><br></td><td><strong>应用包名</strong><br>模板类型为:AUTHENTICATION,<br><mark style="color:$danger;">actionType=5</mark> 时必填</td></tr><tr><td>├─sigNatureHash</td><td>String</td><td><br></td><td><strong>应用哈希散列</strong><br>模板类型为:AUTHENTICATION,<br><mark style="color:$danger;">actionType=5</mark>时必填</td></tr><tr><td>├─ autoFill</td><td>String</td><td><br></td><td><strong>自动填充</strong><br>模板类型为:AUTHENTICATION,<br><mark style="color:$danger;">actionType=5</mark>时必填</td></tr><tr><td>├─ zeroTapTermsAccepted</td><td>boolean</td><td></td><td><strong>接受填充条款</strong><br>模板类型为:AUTHENTICATION,<br><mark style="color:$danger;">actionType=5</mark>时必填且为<code>true</code></td></tr><tr><td>├─ targetUrl</td><td>String</td><td><br></td><td>网址访问(eg："<a href="https://www.chuanglan.com/">https://www.chuanglan.com/</a>{{1}}") 只支持一个动参，格式{{1}}</td></tr><tr><td>├─buttonExample</td><td>Array</td><td><br></td><td>按钮变量示例(eg："buttonExample": ["<a href="https://www.chuanglan.com/whatsApp">https://www.chuanglan.com/whatsApp</a>"])网址访问含有变量时必填,变量内容为完整网址</td></tr><tr><td>headerExample</td><td>Objec</td><td>否</td><td><br></td></tr><tr><td>├─ header_handle</td><td>Array</td><td><br></td><td>多媒体模板变量(eg："header_handle": ["4::axxxx"])多媒体模板时，填写文件上传返回时句柄内容</td></tr><tr><td>├─ header_link</td><td>String</td><td></td><td>资源地址URL，需要外网能够访问，<mark style="color:$danger;">header_link和header_handle 二选一， 当 header_link 不为空时，header_handle会被替换</mark></td></tr><tr><td>├─ header_text</td><td>Array</td><td><br></td><td>纯文本模板变量(eg："header_text": ["创蓝云智"])文本动参模板变量,动参个数限制1</td></tr><tr><td>bodyExample</td><td>Object</td><td>否</td><td><br></td></tr><tr><td>├─ body_text</td><td>Array</td><td><br></td><td>body变量(eg: "body_text":[["variable1","variable2"]]) 变量示例与变量按序对应，变量{{1}}对应variable1，以此类推</td></tr></tbody></table>

#### **请求示例**

```json
{
    "name": "transland_marketing_promotion_6",
    "category": "1",
    "messageLanguage": "zh_CN",
    "headerType":2,
    "caption": "Transland API Account {{1}} Opened",
    "messageBody": "Dear customer {{1}}，your SMS API account {{2}} is avaliable, please rember the secret of this account. The secret is sent via email.",
    "footer": "Have a nice sms experience.",
    "buttonType":2,
    "headerExample": {
        "header_text": [
            "II2024089"
        ]
    },
    "bodyExample": {
        "body_text": [
            [
                "Tom",
                "II2024089"
            ]
        ]
    },
    "wabaId": "121009624329108",
    "buttons": [
        {
            "actionType": 1,
            "label": "Call Us",
            "phone": "+8615121041046"
        },
        {
            "actionType": 2,
            "label": "Websit",
            "targetUrl": "https://www.chuanglan.com/{{1}}",
            "buttonExample": [
                "https://www.chuanglan.com/document"
            ]
        }
    ]
}
```

#### **响应示例**

```json

{
    "code": "0",
    "message": "Success",
    "data": "1399631517488334"
}
```

## 修改模板

#### **请求接口地址**

```
POST     https://api.innopaas.com/api/whatsapp/v3/template/update
```

#### **请求参数**

<table data-header-hidden><thead><tr><th width="167.71484375"></th><th width="118.70703125"></th><th width="91.27734375"></th><th></th></tr></thead><tbody><tr><td>字段</td><td>数据类型</td><td>是否必填</td><td>描述</td></tr><tr><td>templateId</td><td>String</td><td>是</td><td>模板id</td></tr><tr><td>wabaId</td><td>String</td><td><del>是</del></td><td>WhatsApp商业账户唯一标识</td></tr><tr><td>name</td><td>String</td><td>是</td><td>模板名称：(eg:limited_time_offer_tuscan_getaway_2023)由小写字母、数字、下划线组合,字段限制为512个字符.</td></tr><tr><td>category</td><td>String</td><td>是</td><td>模板类型：1-MARKETING,2-AUTHENTICATION,3-UTILITY</td></tr><tr><td>messageLanguage</td><td>String</td><td>是</td><td>模板支持的语言:(<strong>需要传语言缩写简码</strong>)请参考附录1</td></tr><tr><td>headerType</td><td>Integer</td><td>是</td><td>是否支持多媒体,默认1,1:None,2:Text,3:Image,4:Video,5:Document</td></tr><tr><td>caption</td><td>String</td><td>否</td><td><strong>页眉内容:</strong>字段限制为字符(多媒体模板时，该字段为空),动参格式{{1}}</td></tr><tr><td>messageBody</td><td>String</td><td>否</td><td><strong>正文内容:</strong>字段限制为1024个字符.动参格式{{1}}{{2}},前后按序插入</td></tr><tr><td>footer</td><td>String</td><td>否</td><td><strong>页脚内容:</strong>字段限制为60字符(AUTHENTICATION模板时,该字段表示过期时间,非必填,过期时间限制90分钟内)</td></tr><tr><td>safetyAdvice</td><td>Integer</td><td>否</td><td>AUTHENTICATION模板是否添加安全建议(0:不添加 1:添加)选填,未添加显示：*{{1}}* 是你的验证码。添加后显示：*{{1}}* 是你的验证码。为安全起见，请不要分享这组验证码。</td></tr><tr><td>buttons</td><td>Object[]</td><td>否</td><td>按钮总数不超过10个</td></tr><tr><td>├─actionType</td><td>String</td><td><br></td><td>按钮类型 1-quick reply,2-visit website,3-call phone number,4-copy code(category为2时),5-auto fill (category为2时)</td></tr><tr><td>├─label</td><td>String</td><td><br></td><td>按钮文本</td></tr><tr><td>├─ phoneArea</td><td>String</td><td><br></td><td>号码区号(eg:86)</td></tr><tr><td>├─ phone</td><td>String</td><td><br></td><td>号码(eg:18877776666)</td></tr><tr><td>├─packageName</td><td>String</td><td><br></td><td><strong>应用包名,</strong>模板类型为AUTHENTICATION,选填</td></tr><tr><td>├─signatureHash</td><td>String</td><td><br></td><td><strong>应用哈希散列,</strong>模板类型为AUTHENTICATION,选填</td></tr><tr><td>├─ autoFill</td><td>String</td><td><br></td><td><strong>自动填充,</strong>模板类型为AUTHENTICATION,选填</td></tr><tr><td>├─ targetUrl</td><td>String</td><td><br></td><td>网址访问(eg："<a href="https://www.chuanglan.com/">https://www.chuanglan.com/</a>{{1}}") 只支持一个动参，格式{{1}}</td></tr><tr><td>├─buttonExample</td><td>Array</td><td><br></td><td>按钮变量示例(eg："buttonExample": ["<a href="https://www.chuanglan.com/whatsApp">https://www.chuanglan.com/whatsApp</a>"])网址访问含有变量时必填,变量内容为完整网址</td></tr><tr><td>headerExample</td><td>Object[]</td><td>否</td><td><br></td></tr><tr><td>├─ header_handle</td><td>Array</td><td><br></td><td>多媒体模板变量(eg："header_handle": ["4::axxxx"])多媒体模板时，填写文件上传返回时句柄内容</td></tr><tr><td>├─ header_link</td><td>String</td><td></td><td>资源地址URL，需要外网能够访问，<mark style="color:$danger;">header_link和header_handle 二选一， 当 header_link 不为空时，header_handle会被替换</mark></td></tr><tr><td>├─ header_text</td><td>Array</td><td><br></td><td>纯文本模板变量(eg："header_text": ["创蓝云智"])文本动参模板变量,动参个数限制1</td></tr><tr><td>bodyExample</td><td>Object[]</td><td>否</td><td><br></td></tr><tr><td>├─ body_text</td><td>Array</td><td><br></td><td>body变量(eg: "body_text":[["variable1","variable2"]]) 变量示例与变量按序对应，变量{{1}}对应variable1，以此类推</td></tr></tbody></table>

#### **请求示例**

```json

{   "templateId":"123123123123213",
    "name": "transland_marketing_promotion_6",
    "category": "1",
    "messageLanguage": "zh_CN",
    "headerType":2,
    "caption": "Transland API Account {{1}} Opened",
    "messageBody": "Dear customer {{1}}，your SMS API account {{2}} is avaliable, please rember the secret of this account. The secret is sent via email.",
    "footer": "Have a nice sms experience.",
    "buttonType":2,
    "headerExample": {
        "header_text": [
            "II2024089"
        ]
    },
    "bodyExample": {
        "body_text": [
            [
                "Tom",
                "II2024089"
            ]
        ]
    },
    "wabaId": "121009624329108",
    "buttons": [
        {
            "actionType": 1,
            "label": "Call Us",
            "phone": "+8615121041046"
        },
        {
            "actionType": 2,
            "label": "Websit",
            "targetUrl": "https://www.chuanglan.com/{{1}}",
            "buttonExample": [
                "https://www.chuanglan.com/document"
            ]
        }
    ]
}
```

#### **响应示例**

```json

{
    "code": "0",
    "message": "Success",
    "data": "1399631517488334"
}
```

## 模版列表

#### **请求接口地址**

```
POST    https://api.innopaas.com/api/whatsapp/v3/template/list
```

#### 请求参数

| 字段              | 数据类型    | 是否必填 | 描述                                                                                |
| --------------- | ------- | ---- | --------------------------------------------------------------------------------- |
| page            | Integer | 是    | 页码                                                                                |
| size            | Integer | 是    | 每页返回条数                                                                            |
| wabaId          | String  | 是    | WhatsApp商业账户唯一标识                                                                  |
| name            | String  | 否    | 模板名称                                                                              |
| templateId      | String  | 否    | 模板id                                                                              |
| category        | list    | 否    | 模板类型 1-MARKETING,2-AUTHENTICATION,3-UTILITY                                       |
| messageLanguage | list    | 否    | 模板语言(eg:en)                                                                       |
| auditStatus     | list    | 否    | 模板状态 1:待定(Pending), 2: 通过（Approved） 3: 拒绝（Rejected） 4: 暂停（Paused） 5: 禁用（Disabled） |

#### 请求示例代码

```json
{
    "page":1,
    "size":100
    "name": "transland_marketing_promotion_01"
    "wabaId": "100853739759190"
}

```

#### 响应示例

```json

{
    "code": "0",
    "message": "成功",
    "data": {
        "total": 1,
        "pages": 1,
        "list": [
            {
                "updateDate": "2023-10-16 19:09:45",
                "bodyExample": {
                    "body_text": [
                        [
                            "Tom",
                            "II2024089"
                        ]
                    ]
                },
                "buttons": [
                    {
                        "actionType": 3,
                        "phone": "15121041046",
                        "phoneArea": "86",
                        "label": "Call Us"
                    },
                    {
                        "actionType": 2,
                        "buttonExample": [
                            "\"https://www.chuanglan.com/document\""
                        ],
                        "label": "Websit",
                        "targetUrl": "https://www.chuanglan.com/{{1}}"
                    }
                ],
                "messageBody": "Dear customer {{1}}，your SMS API account {{2}} is avaliable, please rember the secret of this account. The secret is sent via email.",
                "footer": "Have a nice sms experience.",
                "messageLanguage": "zh_CN",
                "caption": "Transland API Account {{1}} Opened",
                "updateUser": "",
                "source": 1,
                "delFlag": 0,
                "templateId": "FCFD7669C142497684F090203F88AE98",
                "customerName": "CXQ测试20230426",
                "sid": "634562468792622",
                "headerExample": {
                    "header_text": [
                        "II2024089"
                    ]
                },
                "wabaId": "wabaId",
                "name": "transland_marketing_promotion_01",
                "auditStatus": 2,
                "headerType": 2,
                "createUser": "",
                "id": 194,
                "category": 1,
                "createDate": "2023-10-16 19:09:45",
                "safetyAdvice": 0
            }
        ]
    }
}

```

## 模板删除

**请求接口地址**

```
POST https://api.innopaas.com/api/whatsapp/v3/template/delete
```

**接口描述：**

请求参数

<table><thead><tr><th width="111">名称</th><th width="104">类型</th><th width="80">是否必须</th><th>备注</th><th>其他信息</th></tr></thead><tbody><tr><td>wabaId</td><td>string</td><td>必须</td><td>WhatsApp商业账户唯一标识</td><td></td></tr><tr><td>id</td><td>integer</td><td></td><td>模板主键id</td><td>id/templateId 至少传其一</td></tr><tr><td>templateId</td><td>string</td><td></td><td>模板id</td><td>id/templateId 至少传其一</td></tr></tbody></table>

返回参数

<table><thead><tr><th>名称</th><th>类型</th><th>是否必须</th><th>默认值</th><th width="98">备注</th><th>其他信息</th></tr></thead><tbody><tr><td>code</td><td>integer</td><td>必须</td><td></td><td></td><td>0：成功<br>其他：失败</td></tr><tr><td>data</td><td>object</td><td>必须</td><td></td><td></td><td></td></tr><tr><td>message</td><td>string</td><td>必须</td><td></td><td></td><td></td></tr></tbody></table>

<br>