Jump to: navigation, search

WhatsApp structured messages

This page explains how to create a structured message for WhatsApp.

Structured messages for WhatsApp (also known as highly structured messages) use specific message formats that your company can use to notify customers about things such as an upcoming bill, service outage, or any other notification-type message. You can use eServices Manager to create and format the structured message for WhatsApp.

Before continuing, you must upload the message to WhatsApp for approval before you can finish creating the structured message in eServices Manager. See the WhatsApp documentation for more information.

Creating a structured message for WhatsApp

  1. Create a standard response.
  2. Go to the Structured Body tab.
  3. Select Structured.
    ESMgr900 CreateHSM.png
  4. In the Media Origin menu, select Genesys JSON.
  5. In the Type menu, select Notification.
  6. Click Edit JSON to configure the structured message. See the Configuring the structured message section below for more information.
  7. Optionally, you can directly edit the JSON associated with the media type in the provided field, or click Open File to load a JSON file from your local machine.
  8. Optionally, add field codes.
    You must not use double-quotation marks (") for field codes that are used in structured messages. Use single quotation marks (') instead.
  9. Click Create.

Configuring the structured message

Starting with version, you can edit a Media Notification template of the standard response that was previously created and saved in UCS. In addition, starting with version, you can view a JSON structure.

A short video on how to configure a Media Notification template:

Media Notification template: Body section

After you click Edit JSON, an editor appears that allows you to edit the mandatory Body section of the structured message.

In the ID field, enter the namespace@element_name ID for the structured message (provided in WhatsApp Manager after WhatsApp has approved the message).

In the Content area, compose the content of your message. For example, let's say you want to create a message to let customers know when their account balance is $0. Enter the following message: Hello Customer. Your account balance is now $0. Contact us at 1-800-555-5555 to add more funds.

Example of the general body message

You can use field codes to introduce parameters for known data. For example, instead of Customer, you can use <$Contact.FirstName$>. In the Content area, remove Customer and then click ESMgr900 CreateHSM2.png to add parameters. Notice how a variable has been added to the Content area (as this is the first variable, it's {{1}}). In the Parameters section, you can define the {{1}} variable as such:

  • Name—Enter the name of the variable. For example, Customer.
  • Value—Enter the field code to use. For ease of use, you can:
    1. Enter a temporary value in the Value field.
    2. Click Save to save the message template and return to the New/Edit Standard Response window.
    3. In the JSON Part section, find the temporary parameter value you used earlier (for example, "value": "Sample_Value") and select the sample value.
    4. Click Insert Field Code.
    5. Select a field code and click OK to insert it, together with its required delimiters (<$ $>), into the standard response.
      Only use field codes in parameter values.

The Content area now looks like this:

Example of the customized body message

As you edit the Content area, a live preview appears on the right to show you how the message will appear to the customer. Field codes are rendered when the message is inserted into a WhatsApp interaction by an agent in Workspace. However, when eServices Manager detects a field code in the message, you can click Render (located above the live preview area) to render the field code with its default value.

Optionally, you can use the toolbar in the Content area to use bold (B), italics (I), strikethroughs (S), and highlights (<>).

When you are done, click Save.

Example of the live preview area with the rendered field code

Media Notification template: optional sections

Starting with version, the Media Notification template adds the following optional sections:

  • Header
  • Footer
  • Buttons


In the Header section, you can configure content that is displayed at the top of the Body section of a WhatsApp notification-type message:

  • Text—A header containing the text content with one parameter or without parameters. The parameter value can contain field codes.
  • Media—A header containing the media content of the following types: file, image, or video.
Example of the text header
Example of the image header

Media content can be used for:

  • Sending personalized content—A media file, image, or video is added from the header when an agent sends a message to a particular customer. Note that the header contains only definition of the media content type but not a media file itself. The media file can be customized and inserted into a WhatsApp interaction by an agent in Workspace.
  • Sending common content—A media file, image, or video is uploaded to the header through a corresponding Upload button and then automatically attached to a message when it sends out.
Any new downloaded media file in the Header section replaces the existing media file in a standard response. The previous files remain in the environment. Genesys recommends deleting the files that are not in use manually, using the Edit Attachments window.


In the Footer section, you can configure the static text content that is displayed below the Body section of a WhatsApp message, by selecting Text and entering the footer content.

Example of the footer


In the Buttons section, you can configure predefined button sections that are displayed at the bottom of a WhatsApp message. The following Button options are available:

  • QuickReply—Enables adding up to three quick replies buttons and contains the following items:
    • Button Text—Populates with a value from the WhatsApp template. The button text is returned along with the Button Postback text to the webhook when a user clicks the button.
    • Button Postback—Populates with the Postback text (Optional).
  • CallToAction—Enables adding up to two call-to-action buttons and contains the following items, depending on the action type:
    • Call Phone Number:
      • Button Text—Populates with the button text from the WhatsApp template.
      • Action Type—Call Phone Number.
      • Phone Number—Populates with the phone number from the WhatsApp template.
    • Visit Website:
      • Button Text—Populates with the button text from the WhatsApp template.
      • Action Type—Visit Website.
      • URL—Populates with the URL from the WhatsApp template. The URL can contain one parameter. The parameter value is used at the end of the URL.
Example of the QuickReply button
Example of the CallToAction button

Dark mode

Optionally, you can select Dark to use dark mode. Below is a comparison:

  • Dark off:
  • Dark on:

Language and country in Notification template

After a Notification is created for Genesys JSON, the JSON Part field contains the key-value pair (KVP), language, with values from the language and country options of the Language business attribute values. You can configure the values for the language and country options under the Language business attribute values using instructions provided in the Configuring language and country for WhatsApp structured messages section.

  • This feature is only available starting with the version and later.
  • Values of the language KVP are not updated in Genesys JSON under standard response if you cut, copy, paste, or import a standard response with Genesys JSON.
  • Values of the language KVP are not updated in Genesys JSON under standard response if you modify the values for the language and country options under the Language business attribute values.
  • Genesys recommends that you delete the language KVP in Genesys JSON under standard response, click Edit JSON, and click Save to change the values of the language KVP. The JSON Part field gets updated with the correct values for the language KVP.

For more information, refer to the How to Configure Languages section of the Chat Server Administration guide.

This page was last edited on August 12, 2020, at 11:17.
blog comments powered by Disqus