List Message
Send a custom interactive list menu through WhatsApp.
Basic Usage
Parameters
Everything inside platforms.meta_whatsapp should be considered parameters for this notification. There are top level
parameters that describe the message type and other general message behaviours, and then there are nested parameters
dependent on the message type.
Only nested parameters for message_type: list is explained here, for all top level parameters, see the top level
Whatsapp documentation
message_type required string
Indicates the type of message that is going to be sent. This also will determine what the contents of the params object should be.
Available message types are:
params required object
Contains the parameters for the message and will depend on the message_type setting.
See the message_type specific documentation above for the message type specific parameters.
Show child attributes
list required object
Object is required if the message_type is list. This object should change to match what message_type is set to.
Show child attributes
header optional object
Optional header that appears at the top of the list message.
Show child attributes
type required string
The header type. Currently only "text" is supported.
text required string
The header text that appears at the top of the list message.
body required object
The body content that will be displayed in the list message.
Show child attributes
text required string
The text content of the body that will be displayed in the list message.
action required object
Defines the interactive elements of the list message.
Show child attributes
button required string
The text displayed on the button that opens the list menu. Maximum length is 20 characters.
sections required array
Array of section objects that will be displayed in the list menu. You can include up to 10 sections.
Show child attributes
title required string
The title of the section. Maximum length is 24 characters.
rows required array
Array of row objects that represent menu items within a section. You can include up to 10 rows across all sections.
::summary
id required string
The unique identifier for the row. This value will be available in the data when the user selects this option.
The id needs to be a string and can be up to 200 characters long.
title required string
The title text displayed for the row. Maximum length is 24 characters.
description optional string
Additional description text displayed below the title. Maximum length is 72 characters.
::
Row object example:
Result
When a user selects an option from the list, they will receive a confirmation message and the selected id will be available in the response data.