HomeGuidesAPI ReferenceChangelog
Guides

You can configure and manage new templates and template groups on the Templates screen. The Templates can be organized into groups for easy access and management.

1914

You will view following template details on the screen:

  • ID: Specifies the Unique ID of the template.
  • Channel: Specifies the message Channel (SMS/Email/Facebook/Twitter/LiveChat/Apple Business Chat/WhatsApp/API) of the agent throughout the chat.
  • Template: Specifies the Customized Message with the variables in tags.
  • Start Template: Specifies the First Message to initiate the chat.
  • Followup Template: Specifies the Standard Message that can be used to follow-up the chat.
  • End Template: Specifies the Last Message of the chat.
  • Action: Specifies the activities that can be performed on the template (i.e.) Edit and Delete.

You can perform following actions on the Templates screen:

  • Create New Template Group
  • Delete Template Group
  • Add New Template
  • Edit Template
  • Delete Template
  • Order Templates

Detailed information on each of the feature is provided in the subsequent sections.

Upload Templates

Upload templates functionality helps to bulk upload templates at once by reducing the time taken to create templates.

To upload templates, follow these steps:

  1. Click Upload Template on the top-right corner of the templates screen.
    The following page appears on the screen.
1581
  1. Click Download sample file here link.
    A sample file is downloaded.
  2. Open the sample file.
814
  1. Enter all the details such as Channel Name, Template Group Name, Template Name, Template Text, Lock Template (Yes/No) in the file, and upload this file to create multiple templates.

📘

Note

  • The upload templates file name must be unique.
  • Enter all the values in the sample file as all fields are mandatory.
  • Upload the file only in .csv format.
  • Compose the template text as per the configured character count for each channel template on the application. Also, the Text Template column supports all the Unicode characters.
  • Use the Pipe symbol (|) as a delimiter to enter multiline text in the Text column.
  • Even If a single template text record in the upload templates file ends with a delimiter-pipe symbol (|), all the records in that file must end with the same delimiter.
  • Delete the help notes before uploading the Upload Templates spreadsheet.
  1. Save the file.
  2. Click Upload File button and upload the file.
1588

📘

Note

If any conflicts exist in the uploaded file, you will view the status on the Upload Templates screen. You can download the file to view the errors and fix them to re-upload.

  1. Click Proceed. The following success message appears on the screen.
648
  1. Click Track Upload Status button on the top-right corner of the Upload Templates screen.
    You will navigate to the following screen.
1593
  1. Select the Show Activity Date Range and click Apply.
  2. Click Search.
    The relevant search results will appear on the screen.
  3. You can further search the table results by directly entering the file name in the search field available under the Show Activity Between search field.
    You can view the status of the uploaded file in the Status column.
  4. If the uploaded file fails the validation or gets uploaded with errors, you will view a report in the Actions column.
381
  1. You can download the report, view the errors, fix the errors, and re-upload the file to create templates.

Create New Template Group

To create a new template group:

  1. Click Add icon adjacent to the Template Groups. The Add Template Group pop-up window appears.
664
  1. Enter Group Name and click Add.
    The success message appears on the screen.

Delete Template Group

  1. Click Delete icon adjacent to the template group name that needs to be deleted.
    A confirmation pop-up window is displayed.
666
  1. Click OK .
    The success message appears on the screen.

Add New Template

This feature enables the team manager to add message template formats for each channel.
To create a new template, follow these steps:

Follow these steps to create templates:

  1. Click Add Template button on the top-right-corner of the templates screen.
    You can create the templates for all channels or any of the following channels:
  • SMS
  • Email
  • Facebook
  • Twitter
  • Livechat
  • API
  • Apple Business Chat
  • WhatsApp
1589

SMS Template

To create an SMS template (or All Channels template), follow these steps:

  1. Click All or SMS tab .
1576
  1. Enter a Unique ID in the Template ID field.

📘

Note

The default Sender ID (short code assigned to the team if SMS is enabled as a Channel) is loaded automatically while creating a template. This feature allows the team manager to easily create and keep track of the templates.

  1. Select the Is End template option to set the template as a closing message of the chat conversation.
    For example: Thank you for your time. The agents will not expect any response to this message from the customer.
  2. Select the Is Start template option to set the template as an opening message to initiate the chat conversation.
    For example: Hello.
  3. Select the Is Followup template option to set the template as follow-up message of the previous chat conversation.
    For example: In line with our earlier chat.
  4. Custom Fields: Enter custom/editable fields in the template body using chevron(<>) brackets. Custom fields are editable fields even in locked templates.
  5. System Parameters: Enter @@ to view the list of system parameters. You can select any of these parameters and compose the te. When any of these parameters are used in the mess the corresponding values are dynamically substituted when an agent uses/selects these templates in a conversation.
1564 1554

📘

Note:

When the relevant values are not available for the configured parameters in the template body, such parameters will be rendered in chevron braces and highlighted in yellow in the chat console.

  1. You can choose to enter the Template Text. Maximum of 800 characters can be entered in the text box.
  2. Select Lock Template option to lock specific templates. When locked, only custom/dynamic fields can be edited by the agents. A lock icon is displayed corresponding to the template. Refer the image below.
1173
  1. Click Save Changes.
    The success message appears on the screen.

Email Template

To create an Email template, follow these steps:

  1. Click Email tab.
    The following screen appears.
1575
  1. Enter a Unique ID.
  2. Select the Is end template option to set the template as a closing message of the chat conversation.
    For example: Thank you for your time. The agents will not expect any response to this message from the customer.
  3. Select the Is start template option to set the template as an opening message to initiate the chat conversation.
    For example: Hello.
    5 Select the Is Followup template option to set the template as follow-up chat message of the previous chat conversation.
    For example: In line with our earlier chat.
  4. Compose the Template Text.
  5. Custom Fields: Enter custom/editable fields in the template body using chevron(<>) brackets. Custom fields are editable fields even in locked templates.
  6. System Parameters: Enter @@ to view the list of system parameters. You can select any of these parameters and compose the template text. When any of these parameters are used in the template text the corresponding values are dynamically substituted when an agent uses/selects these templates in a conversation.
1554 1558

📘

Note:

When the relevant values are not available for the configured parameters in the template body, such parameters will be rendered in chevron braces and highlighted in yellow in the chat console.

  1. You can even choose to enter the customized message in the text box and apply rich formatting styles to the text.
  2. Select Lock Template option to lock specific templates. When locked, only custom/dynamic fields can be edited by the agents. A lock icon is displayed corresponding to the template.
  3. Click Save Changes.
    The success message is displayed on the screen.

Facebook Template

To create a Facebook template, follow these steps:

  1. Click Facebook tab. The following screen appears.
1597

A team manager can create Plain Text, Action, and Multimedia templates.
2. Enter a Unique ID for the template in the Template ID field.
3. Select the Is end template checkbox to set the template as a closing message of the chat conversation.
For example: Thank you for your time. The agents will not expect any response to this message from the customer.
4. Select the Is start template checkbox to set the template as an opening message to initiate the chat conversation.
For example: Hello.
5. Select the Is Followup template checkbox to set the template as follow-up message of the previous chat conversation.
For example: In line with our earlier chat.
6. The Text Template option is selected by default.
7. Custom Fields: Enter custom/editable fields in the template body using chevron(<>) brackets. Custom fields are editable fields even in locked templates.
8. System Parameters: Enter @@ to view the list of system parameters. You can select any of these parameters and compose the template text. When any of these parameters are used in the template text the corresponding values are dynamically substituted when an agent uses/selects these templates in a conversation.

1577 1586

📘

Note:

When the relevant values are not available for the configured parameters in the template body, such parameters will be rendered in chevron braces and highlighted in yellow in the chat console.

  1. You can even choose to enter the template text and click Save Changes.
  2. To create an Action Template, select the Action Template option. This option is used when a quick response is expected from the customer. The message is sent with image and buttons, wherein the customer can respond with a click of a button.
1422
  1. Click Upload Image to browse and select the required image.

📘

Note

The application supports images with an aspect ratio of 1.91:1 only.

  1. Enter Button Names and select Button Type from the drop-down list.
  2. If Button Type as WEB URL is chosen, then enter the Call URL.
  3. Compose the message Template Text.
  4. To create a Multimedia template, select the Multimedia Template button to view the related parameters that need to be set. This option configures Multimedia templates in addition to plain text template. The multimedia types supported are as follows:
  • Image
  • Audio
  • Video
  • File
798
  1. Select the type of media in Media Type field and enter the respective downloadable URL in Enter Media URL field.
  2. Select Lock Template option to lock specific templates. When locked, only custom/dynamic fields can be edited by the agents. A lock icon is displayed corresponding to the template.
  3. Click Save Changes to create the template. The success message appears on the screen.
    The newly added templates will be displayed under the selected template group.

Twitter Template

To create a Twitter template, follow these steps:

  1. Click the Twitter tab on the add template page.
    The following screen appears.
1583
  1. Enter a Unique ID for the template in the Template ID field.
  2. Select the Is end template option to set the template as a closing message of the chat conversation.
    For example: Thank you for your time. The agents will not expect any response to this message from the customer.
  3. Select the Is start template option to set the template as an opening message to initiate the chat conversation.
    For example: Hello.
  4. Select the Is Followup template option to set the template as follow-up message of the previous chat conversation.
    For example: In line with our earlier chat.
  5. Custom Fields: Enter custom/editable fields in the template body using chevron(<>) brackets. Custom fields are editable fields even in locked templates.
  6. System Parameters: Enter @@ to view the list of system parameters. You can select any of these parameters and compose the template text. When any of these parameters are used in the template text the corresponding values are dynamically substituted when an agent uses/selects these templates in a conversation.
1553 1552

📘

Note:

When the relevant values are not available for the configured parameters in the template body, such parameters will be rendered in chevron braces and highlighted in yellow in the chat console.

  1. You can even choose to enter the Template Text.
  2. Select Lock Template option to lock specific templates. When locked, only custom/dynamic fields can be edited by the agents. A lock icon is displayed corresponding to the template.
  3. Click Save Changes to create the template.
    The success message appears on the screen.

Livechat Template

To create a Livechat template, follow these steps:

  1. Click the Livechat tab on the Add Template page.
    The following screen appears.
1573
  1. Enter a Unique ID for the template in the Template ID field.
  2. Select the Is end template option to set the template as a closing message of the chat conversation.
    For example: Thank you for your time. The agents will not expect any response to this message from the customer.
  3. Select the Is start template option to set the template as an opening message to initiate the chat conversation.
    For example: Hello.
  4. Select the Is Followup template option to set the template as follow-up message of the previous chat conversation.
    For example: In line with our earlier chat.
  5. Custom Fields: Enter custom/editable fields in the template body using chevron(<>) brackets. Custom fields are editable fields even in locked templates.
  6. System Parameters: Enter @@ to view the list of system parameters. You can select any of these parameters and compose the template text. When any of these parameters are used in the template text the corresponding values are dynamically substituted when an agent uses/selects these templates in a conversation.
1558
  1. You can even choose to enter the Template Text.
1558

📘

Note:

When the relevant values are not available for the configured parameters in the template body, such parameters will be rendered in chevron braces and highlighted in yellow in the chat console.

  1. Select Lock Template option to lock specific templates. When locked, only custom/dynamic fields can be edited by the agents. A lock icon is displayed corresponding to the template.
  2. Click Save Changes to create the template.
    The success message appears on the screen.

API Template

To create an API template, follow these steps:

  1. Click API tab on the Add Template page.
    The following screen appears.
1588
  1. Enter a Unique ID for the template in the Template ID field.
  2. Select the Is end template option to set the template as a closing message of the chat conversation.
    For example: Thank you for your time. The agents will not expect any response to this message from the customer.
  3. Select the Is start template option to set the template as an opening message to initiate the chat conversation.
    For example: Hello.
  4. Select the Is Followup template option to set the template as follow-up chat message of the previous chat conversation.
    For example: In line with our earlier chat.
  5. Custom Fields: Enter custom/editable fields in the template body using chevron(<>) brackets. Custom fields are editable fields even in locked templates.
  6. System Parameters: Enter @@ to view the list of system parameters. You can select any of these parameters and compose the template text. When any of these parameters are used in the template text the corresponding values are dynamically substituted when an agent uses/selects these templates in a conversation.
1557 1544

📘

Note:

When the relevant values are not available for the configured parameters in the template body, such parameters will be rendered in chevron braces and highlighted in yellow in the chat console.

  1. You can even choose to enter the Template Text.
  2. Select Lock Template option to lock specific templates. When locked, only custom/dynamic fields can be edited by the agents. A lock icon is displayed corresponding to the template.
  3. Click Save Changes to create the template.
    The success message appears on the screen.

Apple Business Chat Template

To create an Apple Business Chat template, follow these steps

  1. Click Apple Business Chat tab on the Add Template page.
    The following screen appears.
1586
  1. Enter Unique Template ID.
  2. Select template type - the template type can be Text, Text with Attachment, Time Picker, List Picker, and Rich Link.
  3. If template type as text is chosen, compose the Template Text. Maximum of 10000 characters can be entered in this filed.
  4. Select the Is end template option to set the template as a closing message of the chat conversation.
    For example: Thank you for your time. The agents will not expect any response to this message from the customer.
  5. Select the Is start template option to set the template as an opening message to initiate the chat conversation.
    For example: Hello.
  6. Select the Is Followup template option to set the template as follow-up chat message of the previous chat conversation.
    For example: In line with our earlier chat.
  7. If Text with Attachment template type is chosen, the following options appear.
1577
  1. Custom Fields: Enter custom/editable fields in the template body using chevron(<>) brackets. Custom fields are editable fields even in locked templates.
  2. System Parameters: Enter @@ to view the list of system parameters. You can select any of these parameters and compose the template text. When any of these parameters are used in the template text the corresponding values are dynamically substituted when an agent uses/selects these templates in a conversation.
1562 1539

📘

Note:

When the relevant values are not available for the configured parameters in the template body, such parameters will be rendered in chevron braces and highlighted in yellow in the chat console

  1. You can also choose to enter the Template Text.
  2. Click Choose File/ Drop Files Here to upload an attachment. The maximum upload file limit is ≤ 5 MB.
  3. Select Lock Template option to lock specific templates. When locked, only custom/dynamic fields can be edited by the agents. A lock icon is displayed corresponding to the template.
  4. If Time Picker template type is chosen, the following options appear.
1057

Received Message: In this section, an admin can configure received messages.
15. Enter Title, Subtitle, and Click Choose File/ Drop files here to upload an attachment. The maximum upload file limit is ≤ 5 MB.
16. Here, admin can configure the uploaded image and view it in icon, small, and large sizes.

1025
  1. Event Details: Toggle this field to pre-fill the details (manual agent intervention). When this field is enabled, the following options appear.
1017
  1. Enter the Event Title,Location Details, and Show on Map details.
  2. Time Slots: Select the date, time, and duration from respective fields.
1028
  1. Click Add icon to add more time slots.

📘

Note:

The team manager can create maximum of Ten slots.

663
  1. Click - icon to delete a time slot.
    Reply Message: In this section, a reply message can be configured.
  2. Enter Title, Subtitle, and Click Choose File/ Drop Files Here to upload an attachment. The maximum upload file limit is ≤ 5 MB.
1032

Here, admin can configure the uploaded image in icon, small, and large sizes.
23. If List Picker template type is chosen, the following options will appear.

932
  1. Received Message: In this section, received messages can be configured.
  2. Enter Title, Subtitle, and Click Choose File/ Drop files here to upload an attachment. The maximum upload file limit is ≤ 5 MB.
  3. Here, team manager can configure the uploaded image in icon, small, and large sizes.
  4. List Details: Enter Section Title.
  5. To have multiple sections for a section, check Allow Multiple Sections for Section option.
  6. Enter Item Name and Item Subtitle.
  7. To upload an image, click Drop Files Here to Upload option.
  8. To further add items to the list, click Add icon.
  9. To further add section, click Add Section.
638
  1. To delete a section or a list item, click - icon next to it.
    Reply Message: In this section, reply messages can be configured.
  2. Enter Title, Subtitle, and Click Choose File/ Drop files here to upload an attachment. The maximum upload file limit is ≤ 5 MB.
    Here, admin can configure the uploaded image in icon, small, and large sizes.
  3. If Rich Link template type is chosen, the following options appear.
933
  1. Enter Title and URL.
  2. Select the file type (Image / Video) from the drop-down list. Click Choose File and upload Image/ Video.

📘

Note:

The maximum upload file limit is ≤ 5 MB. Video file must be in MP4 format.

  1. Click Save changes.
    The success message appears on the screen. This template is listed in the chosen group.

WhatsApp Template

To create a WhatsApp template, follow these steps

  1. Click WhatsApp tab on the Add Template page.
    The following screen appears.
1621
  1. Enter Unique Template ID.
  2. Select the Is End Template option to set the template as a closing message of the chat conversation.
    For example: Thank you for your time. The Agents will not expect any response to this message from the customer.
  3. Select the Is Start Template option to set the template as an opening message to initiate the chat conversation.
    For example: Hello.
  4. Select the Is Followup Template option to set the template as follow-up chat message of the previous chat conversation.
    For example: In line with our earlier chat.
  5. Custom Fields: Enter custom/editable fields in the template body using chevron(<>) brackets. Custom fields are editable fields even in locked templates.
  6. System Parameters: Enter @@ to view the list of system parameters. You can select any of these parameters and compose the template text. When any of these parameters are used in the template text the corresponding values are dynamically substituted when an agent uses/selects these templates in a conversation.
1589 1584

📘

Note:

When the relevant values are not available for the configured parameters in the template body, such parameters will be rendered in chevron braces and highlighted in yellow in the chat console.

  1. To create a text template, select the Text radio button and enter the template text in the Template Text field. The maximum character limit allowed in the Template Text field is 4096 characters.
  2. To create an attachment template, select the Attachment radio button.
424
  1. Click Choose File/ Drop Files Here to upload an attachment. The maximum upload file limit is 64 MB.

📘

Note:

To initiate a conversation with a customer, WhatsApp requires you to use a pre-approved WhatsApp Business (WAB) registered message templates.

  1. To create WAB registered message, select the WAB registered message radio button. The following options appear on the screen:
1586
  1. Select a category from the Category drop-down list.
  2. Select a language from the Language drop-down list.
  3. Select the WABA name from the WABA Name(ID) drop-down list. These WABA names are configured at asset level.
  4. To include a header for a template, select the Text header type from the Header drop-down list. The maximum character limit for the header text field is 60 characters.
807
  1. To add a custom variable in the header text, click Add Variable above the Header Text field a custom variable is added in the Header field. Enter the required custom variable.
1062
  1. Enter the template text in the Message Body field. The maximum allowable character limit in this field is 1024 characters. You can apply following rich formatting styles to the Message Body text:
  • Bold
  • Italics
  • Underline
  • Strikethrough
    You can enter both system and custom parameters in the Message Body field.
  1. Click Add Variable, to add a custom variable.
  2. Enter @@ in the Message Body field to view a list of system variables. Select a required variable.

📘

Note:

When you include any of these parameters in the template text, the dynamic substitution of values occurs when an agent uses these templates in a conversation.

  1. The footer is a text field. To add a footer to the template, enter the footer text in the Footer field. The maximum allowable character limit for footer is 60 characters.
1370
  1. Click Save Changes.

To view the approved templates on the chat console, follow these steps:

  1. Navigate to the Templates (Client Admin Console>Assets) tab.
  2. Navigate to the required group and click the Edit icon in the Actions column of a template.
774

The template is approved if you observe a green checkmark beside the template name on the Edit template screen. You can even mouse hover on the green checkmark to view the status. You can view only the approved WAB templates on the chat console.

1909

📘

Note:

  • You can create a message template in one language at a time. WAB registered templates do not support multi-language templates. So, to create templates in multiple languages, you need to create a separate template for each language.
  • You can delete a message template, but WhatsApp does not allow you to create a template with the same name for four weeks.

For more information on how to Add and Configure Mobile Numbers in Facebook WhatsApp Manager, click on the below link
https://developers.facebook.com/docs/whatsapp/getting-started

Edit Template

To edit a template follow these steps:

  1. Click Edit icon adjacent to the template name.
1629

The following screen appears.

1618
  1. Make the required changes to the template, and click Save Changes.
    The success message appears on the screen.

Delete Template

To delete a template follow these steps:

  1. Click Delete icon corresponding to the template name.
    A confirmation popup window appears.
581
  1. Make the required changes to the template, and click Save Changes.
    The success message appears on the screen.