Documentation

Interactive

Suggest Edits

Interactive templates can only be used for replies. They cannot be the first message that is sent. The first message should always be a template message.

Sub Types

There are different types of interactive templates you can create based on your use case.

  1. Common
  2. Request Location
  3. Address
  4. Flow
  5. Order Status
  6. Order Details

1. Common:

Message Type

  1. Text: Add text content in this space.
  2. Image: Insert an image you would like to send in the template. The URL of the image should be public. Supported file types are jpeg and png. Please note that images with transparent backgrounds are not supported. You can also upload an image directly from your device.Maximum size limit is 5 MB.
  3. Video: Insert the video file. The URL of the video should be public. Supported file types are mp4 and _3gpp_Maximum size limit is 16MB.
  4. File: Attach a document you want to send in the template. The URL of the document should be public. Any valid MIME type of document is supported.Maximum size limit is 100MB.

Title

  1. Title - This is a mandatory field. You can give any title to this interactive message.
  2. Preview URL - If you enable this URL, it will show the thumbnail of the URL added.

Body

This is a mandatory field. You need to add the body of the message here. You can also add any no of placeholders.

Footer

This is an optional field. You can add any footer elements here. You can also add any placeholders.

Action

Allows you to add interactive buttons, only when the "Interactive" option is selected from the Type drop-down.

  1. Button - This is the CTA user will see as part of the interactive message.
  2. Button Id - This is optional. If you want to use a unique Id to identify this button or want to send any payload as part of this button, you can use it.
  3. Menu: Provide options from a menu within your WhatsApp messages for your customers to choose from.

2. Request Location:

This message sub-type has a default CTA - 'Send Location'.

Body

This is a mandatory field. You need to add the body of the message here. You can also add any no of placeholders.

3. Address:

This message sub-type has a default CTA - 'Provide Address'.

Body

This is a mandatory field. You need to add the body of the message here. You can also add any no of placeholders.

4. Flow:

Message Type

  1. Text: Add text content in this space.
  2. Image: Insert an image you would like to send in the template. The URL of the image should be public. Supported file types are jpeg and png. Please note that images with transparent backgrounds are not supported. You can also upload an image directly from your device.Maximum size limit is 5 MB.
  3. Video: Insert the video file. The URL of the video should be public. Supported file types are mp4 and _3gpp_Maximum size limit is 16MB.
  4. File: Attach a document you want to send in the template. The URL of the document should be public. Any valid MIME type of document is supported.Maximum size limit is 100MB.

Title

This is a mandatory field. You can give any title to this interactive message.

Body

This is a mandatory field. You need to add the body of the message here. You can also add any no of placeholders.

Footer

This is an optional field. You can add any footer elements here. You can also add any placeholders.

Flow Settings

  1. Type - Navigate or Data Exchange

  2. Flow Id - A unique id generated by Meta for every flow created.

  3. Flow Token (Optional) - You can add a unique Id for your flow or use 'unused'.

  4. Button - Add the button title which the user will see on the interactive Whatsapp message

  5. Initial Screen - This is the initial screen of the flow.

  6. Additional Data (Optional) - If your flow needs any data payload, you can use additional data as json payload

Order Status

Body

This is a mandatory field. You need to add the body of the message here. You can also add any no of placeholders.

Footer

This is an optional field. You can add any footer elements here. You can also add any placeholders.

Order details

  1. Order Id - Provide the order id for which you are sending this message.
  2. Status
    1. Processing
    2. Partially Shipped
    3. Shipped
    4. Completed
    5. Cancelled

6. Order Details:

Message Type

  1. Text: Add text content in this space.
  2. Image: Insert an image you would like to send in the template. The URL of the image should be public. Supported file types are jpeg and png. Please note that images with transparent backgrounds are not supported. You can also upload an image directly from your device.Maximum size limit is 5 MB.

Title

This is a mandatory field. You can give any title to this interactive message.

Body

This is a mandatory field. You need to add the body of the message here. You can also add any no of placeholders.

Footer

This is an optional field. You can add any footer elements here. You can also add any placeholders.

List Settings

  1. List Type
    1. Static - If you know the no of items in your order, use static list
    2. Dynamic - If you don't know exactly the no of items in your order, then use dynamic list.
  2. Item Type
    1. Physical
    2. Digital
  3. Billing Details - Its an optional field.
    1. Name
    2. Address Line 1
    3. Address Line 2
    4. Country
    5. State
    6. City
    7. Postal Code
  4. Item Details - You can add any no of items by clicking '+' if you are using static list. If you are using dynamic list, you just need to provide the details of the first item in your array.
    1. Name
    2. Image (Optional)
    3. Price
    4. Quantity
    5. Sale Price (Optional)
    6. ID
  5. Retailer Details

Payment Settings

  1. Gateway
    1. UPI
    2. Razorpay
    3. PayU
  2. Configuration Name
  3. Shipping Cost
  4. Tax
  5. Discount

Placeholders

Placeholders: Below the "Channels" section on the left, you can find placeholders. Placeholders are denoted by {{}} or Handlebars. You may define the parameters of Placeholders by clicking on it, which opens up a pop-up window where you can define them. Check out this comprehensive guide on how to use "Handlebars"

❗️

You cannot use only numeric values as placeholder keys!

🚧

WhatsApp URL Redirection will not work!

When providing the URLs for files in the WhatsApp templates, redirected links (with multiple hops) will not work as per Facebook Policies.


Preview

Review your content and take a look at what your message would look like in the Preview section on the right. If you have configured a Non-Synced template, you won't be seeing any preview.

Save & Go live:

Save and create different versions of the templates by hitting Save which will be Test versions. Use Go Live when you are ready to move your template into the "Live" version.

Updated 16 days ago