com.flowable.engage.external.system.whatsapp.api

Interface WhatsAppInteractiveMessageBuilder

All Known Implementing Classes:

WhatsAppInteractiveMessageBuilderImpl

public interface WhatsAppInteractiveMessageBuilder

In order to understand this API better you need to be familiar with the WhatsApp Sending Interactive Messages.

Author:

Filip Hrisafov

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	WhatsAppInteractiveMessageBuilder.ButtonMessageBuilder Builder for finishing building the Button message details and sending the message.
static interface	WhatsAppInteractiveMessageBuilder.ListMessageBuilder Builder for finishing building the List message details and sending the message.
static interface	WhatsAppInteractiveMessageBuilder.SectionBuilder Builder for building a list message section.
static interface	WhatsAppInteractiveMessageBuilder.SectionRowBuilder Builder for building a row in a section for list interactive messages.

Method Summary

Modifier and Type	Method and Description
WhatsAppInteractiveMessageBuilder	body(String bodyText) The main content of the interactive message body
WhatsAppInteractiveMessageBuilder	businessAccountId(String businessAccountId) The ID of the business account for the external user
WhatsAppInteractiveMessageBuilder.ButtonMessageBuilder	button() Create a button message.
WhatsAppInteractiveMessageBuilder	externalUserId(String externalUserId) The ID of the external user to which the message should be sent to
WhatsAppInteractiveMessageBuilder	footer(String footerText) The footer text that would be visible to the user
WhatsAppInteractiveMessageBuilder.ListMessageBuilder	list(String actionContent) Create a List message with the action content visible to the user.
WhatsAppInteractiveMessageBuilder	mediaHeader(String mediaId) The content item ID for the media header.
WhatsAppInteractiveMessageBuilder	messageId(String messageId) The ID of the message being sent (can be used for logging purposes)
WhatsAppInteractiveMessageBuilder	textHeader(String headerText) The header text that would be visible to the user.

Method Detail

externalUserId

WhatsAppInteractiveMessageBuilder externalUserId(String externalUserId)

The ID of the external user to which the message should be sent to

Parameters:

externalUserId - the external user ID

businessAccountId

WhatsAppInteractiveMessageBuilder businessAccountId(String businessAccountId)

The ID of the business account for the external user

Parameters:

businessAccountId - the business account ID

messageId

WhatsAppInteractiveMessageBuilder messageId(String messageId)

The ID of the message being sent (can be used for logging purposes)

Parameters:

messageId - the message ID

textHeader

WhatsAppInteractiveMessageBuilder textHeader(String headerText)

The header text that would be visible to the user.

Parameters:

headerText - the header text

mediaHeader

WhatsAppInteractiveMessageBuilder mediaHeader(String mediaId)

The content item ID for the media header.

Parameters:

mediaId - the media header

body

WhatsAppInteractiveMessageBuilder body(String bodyText)

The main content of the interactive message body

Parameters:

bodyText - the main content

footer

WhatsAppInteractiveMessageBuilder footer(String footerText)

The footer text that would be visible to the user

Parameters:

footerText - the footer content

button

WhatsAppInteractiveMessageBuilder.ButtonMessageBuilder button()

Create a button message. Use WhatsAppInteractiveMessageBuilder.ButtonMessageBuilder.send() to actually send the message.

list

WhatsAppInteractiveMessageBuilder.ListMessageBuilder list(String actionContent)

Create a List message with the action content visible to the user. Use WhatsAppInteractiveMessageBuilder.ListMessageBuilder.send() to actually send the message.

Parameters:

actionContent - the content of the button visible ot the user