InteractiveMessage

Reply buttons or a list menu. Requires an active chat window.

View as Markdown

Fields

wabaNumberstringrequired
Your WhatsApp API number to send from, with country code.

Example: "919705182126"
recipientobjectrequired
3 properties
- phoneNumberstringrequired
  The contact's phone number, with country code.
  
  Example: "919999999999"
- nameoptionalstring
  Optional display name, saved to the contact if it is new.
  
  Example: "Raj S"
- emailoptionalstring
  Optional email, saved to the contact if it is new.
  
  format: email
typeunknownrequired
interactiveInteractiveButtonsorInteractiveListrequired
2 variants
One of the following:
InteractiveButtonsbutton
View InteractiveButtons schema →
3 properties
typestringrequired
bodyobjectrequired
1 properties
textstringrequired
Example: "Please select an option"
actionobjectrequired
1 properties
buttonsarray ofobjectrequired
Up to three reply buttons.

2 properties
typestringrequired
replyobjectrequired
2 properties
idstringrequired
Returned to you when the contact taps the button.

Example: "btn_1"
titlestringrequired
Example: "Option 1"
InteractiveListlist
View InteractiveList schema →
3 properties
typestringrequired
bodyobjectrequired
1 properties
textstringrequired
Example: "Please choose from our menu"
actionobjectrequired
2 properties
buttonstringrequired
Label of the button that opens the list.

Example: "View Menu"
sectionsarray ofobjectrequired
2 properties
titlestringrequired
Example: "Main Dishes"
rowsarray ofobjectrequired
3 properties
idstringrequired
Returned to you when the contact picks the row.

Example: "item_1"
titlestringrequired
Example: "Pasta"
descriptionoptionalstring
Example: "Italian pasta with tomato sauce"