Class ActionDataExchangeFlow

Action API object

Hierarchy

Constructors

constructor

Properties

name parameters

Constructors

constructor

  • new ActionDataExchangeFlow(flow_token, flow_id, flow_cta, mode?, flow_message_version?): ActionDataExchangeFlow

  • Builds a data exchange flow component for an Interactive message

    Parameters

    • flow_token: string

      Flow token that is generated by the business to serve as an identifier

    • flow_id: string

      ID of the Flow provided by WhatsApp

    • flow_cta: string

      Text on the CTA button, character limit - 20 characters (no emoji)

    • mode: "published" | "draft" = "published"

      Must be "published" or "draft"

    • flow_message_version: "3" = "3"

      Must be "3"

    Returns ActionDataExchangeFlow

Properties

Readonly name

name: "flow" = "flow"

The name of the component

Readonly parameters

parameters: {
    flow_action: "navigate" | "data_exchange";
    flow_action_payload?: {
        data?: unknown;
        screen: string;
    } & {
        data?: unknown;
        screen: string;
    };
    flow_cta: string;
    flow_id: string;
    flow_message_version: "3";
    flow_token: string;
    mode: "published" | "draft";
}

The Flow parameters

Type declaration

  • flow_action: "navigate" | "data_exchange"

    The Flow type, if set to "navigate", flow_action_payload must be provided

  • Optional flow_action_payload?: {
        data?: unknown;
        screen: string;
    } & {
        data?: unknown;
        screen: string;
    }

    Required if flow_action is "navigate", should be omitted otherwise

  • flow_cta: string

    Text on the CTA button, character limit - 20 characters (no emoji)

  • flow_id: string

    Unique ID of the Flow provided by WhatsApp

  • flow_message_version: "3"

    The Flow version, must be 3

  • flow_token: string

    Flow token that is generated by the business to serve as an identifier

  • mode: "published" | "draft"

    The Flow can be in either draft or published mode

Remarks

TSDoc is unable to document this type properly, so most of the documentation is in the subclasses constructors instead.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc