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_id string whatsapp template id
name string 模板名称,最长为100
language string whatsapp 允许的语言code列表,见下述支持的语言列表
category string 模板类型,支持 MARKETING,UTILITY,模板类别可能发生变更,及时获取变更需要设置模板更新回调
status string whatsapp 审核状态,见下述模板状态,及时获取模板状态变更需要设置模板更新回调
quality string 模板质量评分:UNKNOWN(待定),GREEN(高质量),YELLOW(中等质量),RED(低质量),及时获取模板质量评分变更需要设置模板更新回调
components array 模板组件, 见下述模板组件
created_time int(时间戳) 模板创建时间
updated_time int(时间戳) 模板最后更新时间
status_updated_time int(时间戳) 模板状态最后更新时间
quality_updated_time int(时间戳) 模板质量评分最后更新时间
category_updated_time int(时间戳) 模板类别最后更新时间

支持的语言列表

语言 代码
南非荷兰语 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>"
}