All Products
Search
Document Center

Chat App Message Service:Configure the Send a WhatsApp Message node

Last Updated:Nov 18, 2024

This topic describes how to configure the Send WhatsApp Messages component. This component can send WhatsApp messages, and users can use WhatsApp specific functions to reply.

Component Information

Component icon

发送WhatApp消息@1x

Component

Send a WhatsApp Message

Prerequisites

You can use an existing flow or create a new flow to go to the canvas page of the flow.

  • Go to the existing flow canvas page.

    YesChat App Message Service Console > Process Editor > Process Management. Click the name of the flow that you want to edit. The canvas page of the flow appears.

    image

  • Create a new flow to go to the canvas orchestration page. For more information, see Create a flow.

Procedure

  1. Click the Send WhatsApp Message component icon on the canvas to view the component configuration section on the right.

    image

  2. Configure the component data as required. For more information, see configuration items description.

  3. Click Save. In the dialog box that appears, click Save.

    image

Parameters

available variables

By default, commonly used variables are created and displayed in the available variables section. You can use these variables when you orchestrate a chat flow. You can click Insert Variable to add a custom variable. After a custom variable is added, the variable is displayed in the available variables section. For more information about how to use available variables, see Use available variables.

Send Settings

You can select From/To or Reply Back from the Action drop-down list.

From/To

Sender Type

Usage notes

Example

Phone Number

If you select Phone Number for the Sender Type parameter, you must configure the From Channel, From Phone Number, and To (Recipient) parameters. You must select a channel that is approved and a phone number that can receive and send messages as expected. You can enter the phone number of a recipient in the To (Recipient) field, or click Insert Variable to insert a defined variable or add a new variable.

image

Variable

If you select Variable for the Sender Type parameter, you must select a variable that specifies the phone number of the message sender from the From Phone Number drop-down list. You can enter the phone number of a recipient in the To (Recipient) field or click Insert Variable to insert a defined variable or add a new variable.

image

Reply Back

If you select this action, the WABA and number bound to the current process are used to reply to the user's uplink messages. No additional settings are required.

Message Settings

Message settings determine the types of messages to be sent, including text, media, interactive messages, product messages, and template messages.

Text

If you set Message Type to Text, the message is a plain text message. If you select Text from the Message Type drop-down list, you must configure the Content parameter. You can reference variables as the message content.

Media

If you set Message Type to Media, the message is a media message. The following media file types are supported: Image, Audio, Video, File, and Location. If you select Location from the Media Type drop-down list, you must configure the Longitude and Latitude parameters. If you select other values, you must configure the URL parameter.

The following table describes the types of and size limits on media files in a WhatsApp message.

Media

Type

Upper size limit

Audio

ACC, MP4, MPEG, and AMR

16 MB

File

TXT, PDF, PPT, DOC, XLS, DOCX, PPTX, and XLSX

100 MB

Image

JPEG and PNG

5 MB

Video

MP4 and 3GP

  • Only H.264 video codecs and Advanced Audio Coding (AAC) audio codecs are supported.

  • Videos with a single audio stream or no audio stream are supported.

16 MB

Interactive

Interactive messages support two types of messages: Reply and List.

Message Action

Description

Examples

Reply button

  • If you select Reply Buttons for the Message Action parameter, the interactive messages consist of multiple buttons. You can turn on or off Add Header or Add Footer to specify whether to add a message header or message footer for interactive messages.

  • By default, Add Header and Add Footer are turned off. If you turn on the switches, you must configure the message header and footer information. A message header or footer can be up to 60 characters in length.

  • The Body parameter is required. You can insert variables. A message body can be up to 1,024 characters in length.

  • You can click Add Button to add more buttons and specify custom names for buttons. A button name can be up to 20 characters in length. You can add up to three buttons.

image

List

  • You can determine whether to configure the Header and Footer parameters, which are optional. A message header or footer can be up to 60 characters in length.

  • You must configure the Body parameter. A message body can be up to 1,024 characters in length. When you configure this parameter, you can insert variables.

  • You must configure the Button Name parameter. The button name can be up to 20 characters in length. When you configure this parameter, you can insert variables.

  • You can click Add Section to configure sections and items.

    • You can add multiple sections and items based on your business requirements. However, the number of items for all sections cannot exceed 10.

    • If you add a section, the Section Name parameter is required. A section name can be up to 24 characters in length. Each section must have a name.

    • If you add an item for a section, the Item parameter is required. An item name can be up to 24 characters in length. Each item must have a name.

    • The Item Description parameter is optional. An item description can be up to 72 characters in length.

image

Product

Product messages include single-product messages and multi-product messages. Only one product ID can be added to a single-product message. However, you can add multiple product IDs to a multi-product message and group the product IDs.

When you configure the Catalogue ID and Retail ID parameters, you must enter the IDs provided by the Commerce Manager platform of Meta. To obtain the IDs, go to the Commerce Manager platform, and select your account and shop. In the left-side navigation pane, choose Catalog > Items to view the desired IDs.image

Template

If you select Template from the Message Type drop-down list, you must configure the Channel and Template parameters. The WABA associated with the selected message channel and the selected message template must be approved. Click Preview to preview the template content.image

Timeout Settings

You can turn on or off Enable Undelivered Branch and Enable Unread Branch based on your business requirements. After you turn on the switch, you can customize the timeout period, and configure the corresponding components in the branch for undelivered or unread messages. For example, when the timeout period fails to be delivered, the component is used to send messages by SMS.

Interactive Reply Settings

Note

This method is applicable only to interactive messages.

Parameter

Usage notes

Example

Enable branching based on interactive reply

After you turn on Enable branching based on interactive reply, branches are created based on the buttons or items specified in the interactive messages. You can add nodes to configure the branches.

image

Enable branching for interactive reply wait timeout

After you turn on Enable branching for interactive reply wait timeout, the not Replied branch is created to handle timeout issues. You need to configure a custom timeout period by configuring the Wait time for interactive responses parameter. If this switch is turned on and no node is added to the branch, the system continues with subsequent steps after a timeout.

image

Wait time for interactive responses

You can specify a timeout period by second, minute, and hour. After the specified timeout period is reached, the configurations in the not Replied branch will take effect.

-

Custom Output Variable Name

You can specify a custom variable that is used to capture user choices. The custom variable will be displayed in the available variables section and can be referenced at any time in the subsequent steps of the chat flow.

-

Advanced Settings section

Step and parameter

Parameter

Enable Status Report

After you turn on Enable Status Report, you must specify a URL for receiving a status report.

Track ID

The track ID is used to mark and track specific messages.