All Products
Search
Document Center

Chat App Message Service:Use Chat Flow

Last Updated:Jan 15, 2025

This topic describes how to use Chat Flow to create a flow, orchestrate the flow on the canvas, and publish the flow.

Overview

You can use Chat Flow to perform the following operations:

  1. Create a flow: Create a flow or upload a JSON file that is exported from another flow.

  2. Orchestrate the flow on the canvas: Drag the required components to the canvas and configure parameters for the components based on your business requirements.

  3. Publish the flow: Publish the orchestrated flow.

  4. (Optional) Modify the flow: After the flow is saved or published, you can modify the flow. For example, you can modify the basic information.

  5. (Optional) Delete the flow: You can delete the flow if it is no longer needed.

Prerequisites

The WhatsApp, Viber, Messenger, and Instagram services may be used in the components of Chat Flow. Before you use Chat Flow, make sure that the following requirements are met:

Procedure

Step 1: Create a flow

You can create a flow by using different methods based on your business requirements. This section describes how to create a flow.

  1. Log on to the Chat App Message Service console. In the left-side navigation pane, click Chat Flow. On the Flow Management tab of the Chat Flow page, click Create Flow.image

  2. In the Create New Flow dialog box, select one of the following creation methods based on your business requirements: Create on Blank Canvas, Import Flow, and Create Based on Template.image

    Create on Blank Canvas

    Create a flow on a blank canvas.

    Trigger type

    Description

    Manual

    The flow is triggered by API operations or marketing campaigns.

    WhatsApp

    The flow is triggered by WhatsApp messages.

    Instagram

    The flow is triggered by Instagram messages.

    Viber

    The flow is triggered by Viber messages.

    Messenger

    The flow is triggered by Messenger messages.

    Import Flow

    Upload a JSON file that is exported from another flow to quickly create a flow that is the same as the source flow.

    Create Based on Template

    In the Add dialog box, select a template from the View Template drop-down list and click OK.

    Note

    You can also perform the following operations to create a flow based on a template: On the Chat Flow page, click the View Template tab. On the View Template tab, click the template that you want to use and modify the components of the template based on your business requirements. Then, click Create Flow in the upper-right corner to create a flow based on the template.

  3. If you select Create on Blank Canvas or Import Flow in the Create New Flow dialog box, configure the required parameters and click OK to create the flow.

    image

    Note

Step 2: Orchestrate the flow on the canvas

This section describes how to design and orchestrate the flow on the canvas.

  1. In the left-side navigation pane of the Chat App Message Service console, click Chat Flow. On the Flow Management tab of the Chat Flow page, click the name of the flow that you want to orchestrate.image

  2. On the Flow Editing tab, click the Component Library icon on the left of the canvas. Drag components to the canvas based on your business requirements. Components must be placed between the Start and End nodes. You can also click the image icon between the Start and End nodes to add a component.

    image

  3. Configure parameters for the components. For more information, see Chat Flow nodes.

    image

  4. After the flow is orchestrated, click Save in the upper-right corner.

    image

    Note

    We recommend that you click Save to save data at the earliest opportunity during the orchestration of the flow to prevent data loss.

Step 3: Publish the flow

This describes how to publish the flow that is orchestrated. A flow that is triggered by the replies of users must be published and associated with a marketing campaign. For more information, see Manage marketing campaigns.

  1. In the left-side navigation pane of the Chat App Message Service console, click Chat Flow. On the Flow Management tab of the Chat Flow page, click the name of the flow that you want to publish.image

  2. On the Flow Editing tab, click Publish in the upper-right corner to publish the flow. In the message that appears, click Publish. To unpublish a flow, find the flow on the Flow Management tab of the Chat Flow page and click Unpublish in the Actions column. In the message that appears, click OK.

    image

  3. In the left side navigation pane of the Chat App Message Service console, click Chat Flow. On the Flow Management tab of the Chat Flow page, check whether the flow is published based on the value in the Status column.image

Step 4: (Optional) Modify the flow

You can modify the basic information, account information, and logging configurations of the flow after it is published or saved. This section describes how to modify the flow.

  1. In the left-side navigation pane of the Chat App Message Service console, click Chat Flow. On the Flow Management tab of the Chat Flow page, find the flow that you want to modify and click Edit in the Actions column.7F409FFF-1DD0-4941-9A4B-89C29D7B02F0

  2. On the Basic Information tab of the Edit Flow dialog box, modify the Flow Name and Remarks parameters based on your business requirements.AC4D68BC-7DB0-49e1-AA3F-5F34E3276823

  3. On the tab of the account information, modify the information about the associated account.

    image

    Note

    The tab of the account information is available only when the trigger type of the flow is set to WhatsApp, Viber, or Instagram. You can modify the account information only for an unpublished flow.

  4. On the Log tab, enable or disable the logging feature. After the logging feature is enabled, Simple Log Service (SLS) collects the logs when the flow is triggered and runs. You can use these logs to debug code, analyze failures, and analyze data. To use the logging feature, you must activate SLS. For more information, see Getting Started.image

  5. After the flow is modified, click OK in the Edit Flow dialog box.

Step 5: (Optional) Delete the flow

You can delete the flow if it is no longer needed. Only an unpublished flow can be deleted. In the left-side navigation pane of the Chat App Message Service console, click Chat Flow. On the Flow Management tab of the Chat Flow page, find the flow that you want to delete and click Delete in the Actions column. In the message that appears, click OK.

Important

The flow cannot be restored and can no longer be used after it is deleted. Exercise caution when you delete a flow.

image

References

For more information about the canvas and component configurations in Chat Flow, see the following topics: