Message Templates

A message template is required to open marketing, utility, and authentication conversations. These conversations can be customer care messages or appointment reminders, payment or shipping updates, alerts, and more.

Requirements

• A message template must be approved before it can be used to open a conversation. Learn more.
• To open marketing, utility, and authentication conversations with a customer, the customer must have opted-in to receive messages from your business. Learn more.

Supported Template Categories

See Categories.

Translations

When sending a message template, you need to specify the language using the language field. Your business is responsible for all translations you wish to use.

Supported Languages

Language Packs

Message templates are stored in language packs. A language pack is a bundle of message template elements for a particular language or locale. If a business supports at least one translation for a language or locale, a pack for that language or locale is created.

A message template namespace is a bundle of language packs for a particular business.

Language Policy Options

If a message template is sent with the language: policy field set to deterministic, the default value, WhatsApp delivers the message template in exactly the language and locale asked for. Then, the device queries the server for a language pack of that particular language.

When this message is delivered to the device, the device does the following:

• Policy/Code Check - Given "policy": "deterministic" and "code": "en", is there a cached en pack on the device?
  • If yes, move to Element Check.
  • If not, can the en pack be found on the server?
    • If yes, update local cache and go to Element Check.
    • If not, log the failure, the server returns a structure_unavailable error via a Webhook, and no messages are rendered on the device.

• Element Check - Does the "element": "hello_world" element exist?
  • If yes, unpack the parameters and render the message on the device.
  • If not:
    • If the language pack is from the local cache, download the latest en pack from the server and repeat Element Check.
    • If the language pack was recently downloaded from the server, log the failure, the server returns a structure_unavailable error via a Webhook, and no messages are rendered on the device.

The device language/locale settings are completely ignored.

A problem that can arise when using the deterministic policy is if what you're requesting doesn't exist. Make sure:

• The namespace is correct
• The element name is correct
• The language/locale translation exists for that element
• The number of parameters sent matches what is specified in the message template

Localization

Message templates provide localization support out-of-the-box by localizing the message according to the device locale settings.

Localizable Parameters

Templates have parameters that are dynamically incorporated into the message. For the example used in this document, the message template looks like this:

"You made a purchase for {{1}} using a credit card ending in {{2}}."

For "namespace": "cdb2df51_9816_c754_c5a4_64cdabdcad3e" with "element_name": "purchase_with_credit_card", the first value you list replaces the {{1}} variable in the template message and the second value you list replaces the {{2}} variable.

Some of these parameters (e.g., date_time or currency) are localizable so that they are displayed appropriately based on the customer's language and locale preferences. If the device is unsuccessful in localizing a parameter, it defaults to the fallback_value.

If you need to specify currency and date in addition to the fallback_value, use the currency and date_time objects. This allows the client to optimally localize the data the best way possible, only defaulting to the fallback_value when they cannot localize the data.

The localizable_params options are shown in the table below:

Parameters

The currency Object

The Whatsapp Business API client attempts to format the currency based on the specified localization.

Example

{
    "type": "currency",
    "currency" : {
        "fallback_value": "$230.99",
        "code": "USD",
        "amount_1000": 230990
    }
}  

The date_time Object

The Whatsapp Business API client attempts to format the date/time based on the specified localization. The supported date and time formats include:

• Component Time — The time is assembled from components (i.e., day of the week, month, hour, etc.) The time specified will be the same, regardless of the time zone the client is in.
• Unix Time — The time to be displayed is dependent on the time zone the client is in.

DateTime

DateTimeComponent

Example

{
    "type": "date_time",
    "date_time" : {
        "fallback_value": "October 25, 2020",
        "day_of_week": "Saturday",
        "day_of_month": 25,
        "year": 2020,
        "month": 10,
        "hour": 12,
        "minute": 0
    }
}

DateTimeUnixEpoch

Next Steps

This document contains reference information about message templates. For a guide on how to create and send a template, see Sending Message Templates. For all parameters that can be used in a message template, see Messages, Message Template.

https://developers.facebook.com/docs/whatsapp/message-templates/creation#step-1--create-template-using-the-whatsapp-manager