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

Interface WhatsAppTemplateMessageBuilder

All Known Implementing Classes:

WhatsAppTemplateMessageBuilderImpl

public interface WhatsAppTemplateMessageBuilder

Author:

Filip Hrisafov

Method Summary

Modifier and Type	Method and Description
WhatsAppTemplateMessageBuilder	addTemplateTextParameter(String parameter) Add a positional text parameter.
WhatsAppTemplateMessageBuilder	addTemplateTextParameters(Collection<String> parameters) Add positional text parameters.
WhatsAppTemplateMessageBuilder	businessAccountId(String businessAccountId) The id of the business account that should be used when sending out the message.
WhatsAppTemplateMessageBuilder	externalUserId(String externalUserId) The id of the recipient of the message.
WhatsAppTemplateMessageBuilder	language(String language) The language of the template that should be used.
WhatsAppTemplateMessageBuilder	messageId(String messageId) The id of the reference message within the Engage system.
void	send() Perform the send of the template message.
WhatsAppTemplateMessageBuilder	templateId(String templateId) The id of the template that is registered on the WhatsApp side

Method Detail

templateId

WhatsAppTemplateMessageBuilder templateId(String templateId)

The id of the template that is registered on the WhatsApp side

language

WhatsAppTemplateMessageBuilder language(String language)

The language of the template that should be used.

addTemplateTextParameter

WhatsAppTemplateMessageBuilder addTemplateTextParameter(String parameter)

Add a positional text parameter.

Note: The parameter must be added in the correct order according to the template message.

addTemplateTextParameters

WhatsAppTemplateMessageBuilder addTemplateTextParameters(Collection<String> parameters)

Add positional text parameters.

Note: The parameters must be added in the correct order according to the template message.

externalUserId

WhatsAppTemplateMessageBuilder externalUserId(String externalUserId)

The id of the recipient of the message. This is the id of the user within the WhatsApp system.

businessAccountId

WhatsAppTemplateMessageBuilder businessAccountId(String businessAccountId)

The id of the business account that should be used when sending out the message.

messageId

WhatsAppTemplateMessageBuilder messageId(String messageId)

The id of the reference message within the Engage system. It is used in order to correlate the WhatsApp message and the Engage message.

send

void send()

Perform the send of the template message.