Skip to main content

模板资源说明

资源示例

{
    "template_id": "4166201267033543",
    "name": "test_api_2",
    "language": "en_US",
    "category": "MARKETING",
    "status": "REJECTED",
    "quality": "",
    "components": [
        {
            "type": "BODY",
            "text": "A API test template, first variable: {{1}}, second variable: {{2}}",
            "example": {
                "body_text": [
                    [
                        1,
                        2
                    ]
                ]
            }
        },
        {
            "type": "FOOTER",
            "text": "Good night"
        }
    ],
    "created_time": 1755076187,
    "updated_time": 1755076201,
    "status_updated_time": 0,
    "quality_updated_time": 0,
    "category_updated_time": 0
}

字段说明

字段名类型描述
template_idstringwhatsapp template id
namestring模板名称,最长为100
languagestringwhatsapp 允许的语言code列表,见下述支持的语言列表
categorystring模板类型,支持 MARKETING,UTILITY
statusstringwhatsapp 审核状态,见下述模板状态
qualitystring模板质量评分
componentsarray模板组件, 见下述模板组件

支持的语言列表

语言代码
南非荷兰语af
阿尔巴尼亚语sq
阿拉伯语ar
阿塞拜疆语az
孟加拉语bn
保加利亚语bg
加泰罗尼亚语ca
中文(中国大陆)zh_CN
中文(香港)zh_HK
中文(台湾)zh_TW
克罗地亚语hr
捷克语cs
丹麦语da
荷兰语nl
英语en
英语(英国)en_GB
英语(美国)zh_CN
爱沙尼亚语et
菲律宾语fil
芬兰语fi
法语fr
德语de
希腊语el
古吉拉特语gu
豪萨语ha
希伯来语he
印地语hi
匈牙利语hu
印尼语id
爱尔兰语ga
意大利语it
日语ja
卡纳达语kn
哈萨克语kk
韩语ko
老挝语lo
拉脱维亚语lv
立陶宛语lt
马其顿语mk
马来语ms
马拉雅拉姆语ml
马拉地语mr
挪威语nb
波斯语fa
波兰语pl
葡萄牙语(巴西)pt_BR
葡萄牙语(葡萄牙)pt_PT
旁遮普语pa
罗马尼亚语ro
俄语ru
塞尔维亚语sr
斯洛伐克语sk
斯洛文尼亚语sl
西班牙语es
西班牙语(阿根廷)es_AR
西班牙语(西班牙)es_ES
西班牙语(墨西哥)es_MX
斯瓦希里语sw
瑞典语sv
泰米尔语ta
泰卢固语te
泰语th
土耳其语tr
乌克兰语uk
乌尔都语ur
乌兹别克语uz
越南语vi
祖鲁语zu

模板状态

  • FAILED - 模板创建失败
  • APPROVED — 模板已通过模板审核并获得批准,现在可通过模板消息发送
  • PENDING — 模板已通过类别验证,将进入模板审核流程。
  • REJECTED — 模板未通过类别验证或模板审核。

模板组件

正文(BODY)

正文组件代表消息模板的核心文本内容,它是一个仅包含文本的模板组件。所有模板都必须使用它。

正文组件中的消息文本支持用于编程配置的参数。

位置参数 — 在 example 传入一个与正文文本中数字位置相对应的数字位置参数数组

  • 例如:“Hello {{1}}, your account balance is {{2}}” | [ “John”, “$1,000” ]

所有模板仅限拥有 1 个正文组件。

语法
{ 
    "type": "body", 
    "text": "<BODY_TEXT>", 
    "example": { 
        "body_text": [ 
            [ // You must provide one of the inputs below when the <BODY_TEXT> string contains parameters <POSITIONAL_PARAM_EXAMPLES> <BODY_TEXT_NAMED_PARAMS> 
            ] 
        ] 
    } 
} 

页脚(FOOTER)

页脚是可选的纯文本组件,紧跟正文组件之后出现。一个模板仅限拥有 1 个页脚组件。

语法
{
  "type": "FOOTER",
  "text": "<TEXT>"
}