Structured Messages

Important

• This page applies only to releases starting from 8.5.301.09.
• As of the 8.5.304.xx release, interactive standard responses are known as structured messages.
• Facebook functionality is not supported in releases prior to 8.5.304.xx.
• Refer to the following documentation for more information on how agents can use these structured messages in customer interactions:
  • Apple Business Chat
  • SANTHOSH TO PROVIDE LINK FOR FB MESSENGER

Structured messages provide enhanced functionality for Apple Business Chat and Facebook interactions. Structured templates contain metadata in the form of JSON strings that specify how to present certain widgets in chat conversations with customers.

Agents can select structured messages from their Standard Response Library and insert them into chat conversations with customers.

In eServices Manager, you can quickly identify structured messages by referring to the Structured column, as shown below:

Creating a structured message

Follow one of the procedures below to create a structured message:

• Creating a structured message for Apple Business Chat
• Creating a structured message for Facebook

Creating a structured message for Apple Business Chat

Important

See the Apple Business Chat documentation for more information on using structured messages with Apple Business Chat.

1. Create a standard response.
2. Go to the Structured Body tab (formerly the HTML tab).
3. Select Structured.



4. In the Rich Media Origin menu, select Apple Business Chat.
5. In the Rich Media Type menu, select one of the following types:
   • Apple Pay—Allow the customer to provide payment information.
   • Custom Extension—Use a Custom Interactive Message that provides functionality from a standalone iMessage app or an iOS app. Click here to view the Apple documentation.
   • List Picker—Allow the customer to select an option in a list.
   • Date Picker—Allow the customer to select a date or time.
6. Optionally, you can directly edit the JSON associated with the rich media type. Click Edit JSON to edit the JSON in the provided field, or click Open File to load a JSON file from your local machine.
7. Optionally, add field codes.
Important
You must not use double-quotation marks (") for field codes that are used in structured messages. Use single quotation marks (') instead.
8. Click Create.

Creating a structured message for Facebook

Important

See the Facebook developer documentation for more information on using structured messages with Facebook Messenger.

1. Create a standard response.
2. Go to the Structured Body tab (formerly the HTML tab).
3. Select Structured.



4. In the Rich Media Origin menu, select Facebook.
5. In the Rich Media Type menu, select one of the following types:
   • Button—Send a text message with up to three attached buttons.
   • Generic—Send a simple structured message that includes a title, subtitle, image, and up to three buttons.
   • List—Send a list of two to four structured items with an optional global button rendered at the bottom.
   • Media—Send images, GIFs, and video as a structured message with an optional button.
   • Open Graph—Send a structured message with an Open Graph URL, plus an optional button.
6. Optionally, you can directly edit the JSON associated with the rich media type. Click Edit JSON to edit the JSON in the provided field, or click Open File to load a JSON file from your local machine.
7. Optionally, add field codes.
Important
You must not use double-quotation marks (") for field codes that are used in structured messages. Use single quotation marks (') instead.
8. Click Create.

Rich media types for Apple Business Chat

• Apple Pay
• Custom Extension
• Date Picker
• List Picker

Apple Pay

This option allows the customer to provide payment information using Apple Pay.

You can configure the following options:

Apple Pay tab

• Merchant ID—Enter your Merchant ID (provided by Genesys Hub).
• Merchant Name—Enter your Merchant Name (provided by Genesys Hub).
• Merchant URL—Enter your Merchant URL (provided by Genesys Hub).
• Supported Countries—The list of countries to support, specified by ISO country code.
• Country Code—Your company's two-letter ISO 3166 country code.
• Currency Code—Your company's three-letter ISO 4217 currency code for the payment.

Line Items tab

Click + to add a line item for which the customer can pay. You can configure the following options:

• Label—Enter a description of the line item.
• Amount—Enter the amount of money required to purchase the line item.
• Type
  • final—Select this option if the cost has been finalized and all required information has been gathered from the customer.
  • pending—Select this option if the cost has not been finalized and the customer must provide more information (for example, an address to calculate shipping costs).
• Total Label—The name of the field that shows the total price (for example, Total Price).
• Total Amount—Enter the total amount of money for the line items.
• Total Type
  • final—Select this option if the cost has been finalized and all required information has been gathered from the customer. This option is only available if all line item Type values are set to final.
  • pending—Select this option if the cost has not been finalized and the customer must provide more information.

You can click + to add more top-level items to the list. Or, you can select a line item and click the trashcan icon to remove it from the list.

Shipping Methods tab

Click + to add a shipping method. You can configure the following options for each item:

• Label—Enter text to describe the shipping method (for example, Standard Shipping).
• Identifier—Enter a unique identifier for the shipping method (for example, standard).
• Shipping Detail—Enter additional text about the shipping method (for example, Ships in 24 hours).
• Amount—Enter the shipping cost.
• Type
  • final—Select this option if the cost has been finalized and all required information has been gathered from the customer.
  • pending—Select this option if the cost has not been finalized and the customer must provide more information (for example, an address to calculate shipping costs).
  • not applicable—Select this option if the cost and type are not applicable and must be excluded from the payment.

You can click + to add more shipping methods to the list. Or, you can select a shipping method and click the trashcan icon to remove it from the list.

Other Fields tab

Requested Billing Fields

Select the billing fields that the customer must provide to use Apple Pay. Refer to the Apple Business Chat documentation for more information.

Requested Shipping Fields

Select the shipping fields that the customer must provide to use Apple Pay. Refer to the Apple Business Chat documentation for more information.

Merchant Capabilities

Select the payment capabilities that you support for Apple Pay. Refer to the Apple Business Chat documentation for more information.

Supported Networks

Select the payment networks that you support for Apple Pay. Refer to the Apple Business Chat documentation for more information.

Received Message tab

These options specify how the message appears to the receiving customer.

• Title—Provide a title for the received message.
• Subtitle—(Optional) Provide a subtitle for the received message.
• Style—Select Icon, Small, or Large to specify the size of the image in the received message.
• Image—Click Open to select an image to attach to the received message. Or, if you have previously attached an image, click Remove to remove the attached image.

Important

Refer to the Apple Business Chat documentation for more information on recommended image sizes.

JSON tab

View the JSON associated with this Apple Pay message.

Custom Extension

This option uses a Custom Interactive Message that provides functionality from a standalone iMessage app or an iOS app.

You can configure the following options:

Custom Extension tab

These options refer to values specific to your application. For more information, refer to the Apple Business Chat documentation on the Apple website.

• Application Name—The name of the custom extension.
• Application ID—The App Store identifier of the custom extension.
• Team ID—Provide your Team ID.
• Extension ID—Provide your Extension ID.

Parameters tab

Click + to create a parameter (key-value pair) to be passed to your custom extension.

The number and types of parameters you must create are specific to the design and functionality of your custom extension. Therefore, you must consult with the developer of the custom extension to determine which parameters are needed to support the custom extension.

Refer to the Apple Business Chat documentation for more information.

Received Message tab

These options specify how the message appears to the receiving customer.

• Title—Provide a title for the received message.
• Subtitle—(Optional) Provide a subtitle for the received message.
• Secondary Subtitle—(Optional) Provide a secondary subtitle that is right aligned.
• Tertiary Subtitle—(Optional) Provide a tertiary subtitle that is right aligned.

Tip

Refer to the Apple Business Chat documentation for more information.

JSON tab

View the JSON associated with this custom extension.

Date Picker

This option allows the customer to select a date or time.

You can configure the following options:

Date Picker tab

• Title—Provide a title for the Date Picker.
• Location—(Optional) Describe a location for the Date Picker event.
• Latitude—(Optional) Provide a latitude for the location.
• Longitude—(Optional) Provide a longitude for the location.
• Radius—(Optional) The location radius, in meters. If the latitude and longitude fields are missing or empty, this field is ignored.

Timeslots tab

Click + to add a timeslot for the customer to select.

On the right, specify a Start Date for when you want the timeslot to begin. You can click the Start Date to specify a date and time.

In the Duration section, drag the sliders to specify the duration of the timeslot in hours and/or minutes.

Optionally, you can create additional timeslots by clicking +. Or, you can select a timeslot in the list and click the trash icon to delete it.

Received Message tab

These options specify how the message appears to the receiving customer.

• Title—Provide a title for the received message.
• Subtitle—(Optional) Provide a subtitle for the received message.
• Style—Select Icon, Small, or Large to specify the size of the image in the received message.
• Image—Click Open to select an image to attach to the received message. Or, if you have previously attached an image, click Remove to remove the attached image.

Important

Refer to the Apple Business Chat documentation for more information on recommended image sizes.

Reply Message tab

These options specify the appearance of the customer's response after he or she has made a selection.

• Title—Provide a title for the reply message.
• Subtitle—(Optional) Provide a subtitle for the reply message.
• Style—Select Icon, Small, or Large to specify the size of the image in the reply message.
• Image—Click Open to select an image to attach to the reply message. Or, if you have previously attached an image, click Remove to remove the attached image.

Important

Refer to the Apple Business Chat documentation for more information on recommended image sizes.

JSON tab

View the JSON associated with this Date Picker.

Preview tab

View a preview of this Date Picker.

Important

The Title and Duration fields are only presented to customers when they add the event to their calendar.

List Picker

This option allows the customer to select one or more items from a list.

Important

If you are using images with the List Picker, consult the Apple Business Chat documentation for more information on recommended image sizes.

You can configure the following options:

List Picker tab

A List Picker consists of sections and items. Sections can have one or more items for the customer to select.

For example, a pizzeria might use a List Picker to offer various pizzas for the customer to select. This list might consist of the following:

• Meat Pizzas
  • Pepperoni
  • 3 Meat
• Cheese Pizzas
  • Mozzarella
  • 3 Cheese
• Vegetarian Pizzas
  • Veggie

In eServices Manager, this list is represented as the following:

Your first step is to create a section. Click + to add a section. On the right, specify a Title for the section.

You can click + to add more sections to the list.

Next, you can create items within a section. First, ensure you have selected the section in which you want to create an item. Next, click to create the item.

On the right, specify a Title for the list item. Optionally, add a Subtitle that further describes the list item.

In the Image section, click Open to upload an image to display with this list item. If you have already uploaded an image, you can click Remove to remove the image from this list item.

Once you have multiple sections or items in the list, you can select a section or item and click the arrows to rearrange their order.

To remove a section or item, select it and click the trashcan icon.

Important

If Multiple Selection is checked, the customer can choose more than one item.

Received Message tab

These options specify how the message appears to the receiving customer.

• Title—Provide a title for the received message.
• Subtitle—(Optional) Provide a subtitle for the received message.
• Style—Select Icon, Small, or Large to specify the size of the image in the received message.
• Image—Click Open to select an image to attach to the received message. Or, if you have previously attached an image, click Remove to remove the attached image.

Important

Refer to the Apple Business Chat documentation for more information on recommended image sizes.

Reply Message tab

These options specify the appearance of the customer's response after he or she has made a selection.

• Title—Provide a title for the reply message.
• Subtitle—(Optional) Provide a subtitle for the reply message.
• Style—Select Icon, Small, or Large to specify the size of the image in the reply message.
• Image—Click Open to select an image to attach to the reply message. Or, if you have previously attached an image, click Remove to remove the attached image.

Important

Refer to the Apple Business Chat documentation for more information on recommended image sizes.

JSON tab

View the JSON associated with this List Picker.

Preview tab

View a preview of this List Picker.

Rich media types for Facebook

• Button
• Generic
• List
• Media
• Open Graph

This section describes the rich media types you can use with Facebook Messenger. Each type has the following tabs:

• Media—Configure the type using this tab.
• Preview—View a preview of the type you have created.
• JSON—View the JSON associated with the type you have created.

The following sections describe each type in more detail.

Button

This option allows the customer to select from up to three buttons. For example, the buttons could be options in response to a question. See the Facebook developer documentation for more information.

You can configure the following options:

• Title—In the text box, enter a title that will appear above the button.
• Shareable—If checked, the customer can share this structured message with other users.
• Add Button—Click to add the button. You can select the following options:
  • Call—Provide a name and phone number that the customer can call.
  • Postback—Send an event that can trigger an action on an external website.
  • URL—Provide a link that the customer can click.

Media

This option allows the customer to select from up to three buttons. For example, the buttons could be options in response to a question. See the Facebook developer documentation for more information.

You can configure the following options:

• Shareable—If checked, the customer can share this structured message with other users.
• Media Type—Select whether to attach an image or video above the button.
• Attachment URL—Displays the URL to the media associated with this button. This field is generated automatically after you upload the media.
• Add Media button—Click to open the Edit Attachments window and upload media for this button.
• Remove button—Click to remove the media from this button.
• Add Button—Click to add a button. You can select the following options:
  • Call—Provide a name and phone number that the customer can call.
  • Postback—Send an event that can trigger action on an external website.
  • URL—Provide a link that the customer can click.