Send Interactive List Messages

You can send 'interactive list' messages to your customers that help the customers to choose from a list of options for products of interest. An 'Interactive List API' message can have up to ten sections with ten rows in each section and the list also supports an optional header and a footer.

When a customer taps the button, a modal list of options is presented on the customer's phone screen. Then, the customer can choose an option, and this chosen option is sent as a reply back message to the business. The selection of an option triggers a webhook towards the configured customer’s endpoint to send the customer choice to the business as an incoming WhatsApp message.

The messaging_object of the API payload defines the interactive list with all the choices that the customers can choose from. The different options on the list are presented in different sections and rows within each section making it easy for the customers to view the options and select one of them.

Prerequisites

  1. Before you get started, Create an API Key. To view the API Key and the SID, see View API Key and SID.
    A prerequisite for using Kaleyra WhatsApp APIs is to have an active WhatsApp plan on kaleyra platform.
  2. To set up a WhatsApp account on kaleyra.io, see Manual Signup
    and Embedded Signup.
  3. An active WhatsApp for Business API plan that includes:
    • A WhatsApp business number.
    • An associated profile with the business number.
    • A WhatsApp verified and approved profile.

Base URL

https://<api_domain>/v2/<SID>

API Domain and Value

api_domainValue
IN podapi.in.kaleyra.io
SG Podapi.ap.kaleyra.io
EU Podapi.eu.kaleyra.io

API Request to Send Interactive List Messages

To send an interactive list message, use the https://<api_domain>/v2/<sid>/whatsapp/<phone_number>/messages endpoint with the following request method:

Request Format

The following is the request format to send Interactive List Messages.

curl -X POST \
  'https://<api_domain>/v2/<sid>/whatsapp/<phone_number>/messages' \
  -H 'Content-Type: application/json' \
  -H 'api-key: <api-key>' \
  -H 'cache-control: no-cache' \
  -d  '{
    "messaging_object": {
        "messaging_product": "<messaging_product>",
        "recipient_type": "<recipient_type>",
        "to": "<to_phone_number>",
        "type": "<message_type>",
        "interactive": {
            "type": "<type>",
            "header": {
                "type": "<type>",
                "text": "<header_text>"
            },
            "body": {
                "text": "<body_text>"
            },
            "footer": {
                "text": "<footer_text>"
            },
            "action": {
                "button": "<button_text>",
                "sections": [
                    {
                        "title": "<section1_title>",
                        "rows": [
                            {
                                "id": "<section1_row1_id>",
                                "title": "<section1_row1_title>",
                                "description": "<section1_row1_description>"
                            },
                            {
                                "id": "<section1_row2_id>",
                                "title": "<section1_row2_title>",
                                "description": "<section1_row2_description>"
                            }
                        ]
                    },
                    {
                        "title": "<section_2_title>",
                        "rows": [
                            {
                                "id": "<section2_row1_id>",
                                "title": "<section2_row1_title>",
                                "description": "<section2_row1_description>"
                            },
                            {
                                "id": "<section2_row2_id>",
                                "title": "<section2_row2_title>",
                                "description": "<section2_row2_description>"
                            }
                        ]
                    }
                ]
            }
        }
    },
    "extra_info": {
        "ref": "<ref>",
        "ref1": "<ref1>",
        "ref2": "<ref2>",
        "wa_source": "<wa_source>"
    }
}'

Sample Request Format

curl -X POST \ 'https://api.in.kaleyra.io/v2/HXAP16XXXXXX97IN/whatsapp/+91XXXXXXXXXX/messages' \
  -H 'Content-Type: application/json' \
  -H 'api-key: Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx3' \
-d '
{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "+91xxxxxxxxxx",
  "type": "interactive",
  "interactive": {
    "type": "list",
    "header": {
      "type": "text",
      "text": "Shipping Options"
           },
    "body": {
      "text": "Choose your shipping option"
            },
    "footer": {
      "text": "Trendy apparel: your ultimate style choices"
             },
    "action": {
      "button": "Shipping Options",
      "sections": [
        {
          "title": "I want it pretty quick!",
          "rows": [
            {
              "id": "priority_express",
              "title": "Quick Mail Express",
              "description": "Next 2 days"
            },
            {
              "id": "priority_mail",
              "title": "Priority Mail",
              "description": "2–3 Days"
            }
          ]
        },
        {
          "title": "I am not in a hurry",
          "rows": [
            {
              "id": "ups_ground_advantage",
              "title": "ups ground advantage",
              "description": "4–5 Days"
            },
            {
              "id": "media_mail",
              "title": "Media Mail",
              "description": "4–8 Days"
            }
          ]
        }
      ]
    }
  }
},
"extra_info": {
        "ref": "customer1",
        "ref1": "marketing",
        "ref2": "dictionary",
        "wa_source": "api"
    }'

URL Parameters and Headers

Following is the list of parameters and headers to send the outgoing message request:

Parameter / HeadersData TypeDescriptionExampleMandatory?
sidStringAccount SID (Security Identifier).HXAP16XXXXXX97INYes
phone_numberStringPhone number of the end customer you want to send a message to.+91XXXXXXXXXXYes
(valid phone numbers only)
Content-TypeStringIndicates the format of the content the API will be processing.The only allowed value is application/json.Yes
api-keyStringAPI key generated from kaleyra platform account.Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx3Yes

Following is the list of attributes to be used in the payload to send the outgoing message:

ParameterData TypeDescriptionExampleMandatory?
messaging_objectJSON objectPayload is supported only in JSON format. The messaging_object is the payload which contains the message object as defined by Meta which is used to send the WhatsApp message.See the specific table for details.Yes
extra_infoJSON objectThis object will contain additional details that a user can send for certain functionalities.See the specific table for details.No

The following table describes the different attributes used for the messaging_object object:

ParameterData TypeDescriptionExampleMandatory?
messaging_productStringMessaging service used for the request.Only allowed value is 'whatsapp'.Yes
recipient_typeStringCurrently, you can only send messages to individuals. Default is individual.Only allowed value is 'individual'.No
toStringWhatsApp end-user phone number. It should include country code prefix following E.164 format.+91xxxxxxxxxxYes
typeStringThe type of message you want to send.interactiveYes
interactiveJSON ObjectThe interactive object details.See the specific table for descriptionYes

The following table describes the different attributes used for the 'interactive` object.

ParameterData TypeDescriptionExampleMandatory?
typeStringThe type of list message.listYes
headerJSON ObjectThe header object details.See the specific table for description.No
bodyJSON ObjectThe body object details.See the specific table for description.Yes
footerJSON ObjectThe footer object details.See the specific table for description.Yes
actionJSON ObjectThe action object details.See the specific table for description.Yes

The following table describes the different attributes used for the 'header' object.

ParameterData TypeDescriptionExampleMandatory?
typeStringThe type of list message.textYes
textStringThe header object details.Shipping optionsYes

The following table describes the different attributes used for the 'body' object.

ParameterData TypeDescriptionExampleMandatory?
textStringThe body text of the message.Choose your shipping optionYes

The following table describes the different attributes used for the 'footer' object.

ParameterData TypeDescriptionExampleMandatory?
textStringThe footer text of the message.Trendy suits: your ultimate style choices.Yes

The following table describes the different attributes used for the 'action' object.

ParameterData TypeDescriptionExampleMandatory?
buttonStringThe text displayed on the button.Shipping OptionsYes
sectionsArrayThe section array details.See the specific table for details.Yes

The following table describes the different attributes used for the 'section' array.

ParameterData TypeDescriptionExampleMandatory?
titleStringThe section title text.I want it pretty quick!Yes
rowsArrayThe section array details.See the specific table for details.Yes

The following table describes the different attributes used for the 'rows' array.

ParameterData TypeDescriptionExampleMandatory?
idStringThe row id.priority_expressYes
titleStringThe row title text.Quick Mail ExpressYes
descriptionStringThe row description.Next 2 daysYes

The following table describes the different attributes used for the extra_info JSON object:

ParameterData TypeDescriptionExampleMandatory?
ref StringInclude any contextual information in this parameter you want to associate with the request. For Example, Name, Customer ID, and many more.
Limit: The variable can be 255 characters long only. This parameter will be available in report and callback.
customer1No
ref1 StringInclude the contextual information in this parameter you want to associate with the request. For Example, Name, Customer ID, and many more.
Limit: The variable can be 255 characters long only. This parameter will be available in report and callback.
marketingNo
ref2 StringInclude the contextual information in this parameter you want to associate with the request. For Example, Name, Customer ID, and many more.
Limit: The variable can be 255 characters long only. This parameter will be available in report and callback.
dictionaryNo
wa_sourceStringIndicates the source from where the API has been triggered. Supported values for wa_source are "api", "clevertap", "zoho", "webengage", "shopify", "leadsquared", "responsys", "braze", "hubspot", "salesforce", "zapier", "eloqua", and "moengage".
Note: If the customer passes any other value other than above-specified values, then the system will override that as the "API".
apiNo

Sample Success Response

The following success message appears with the status 202 Accepted:

202 Accepted 
{
"code":"WA202"
"message":"Request Accepted",
"data":{
  "message_id":"AXXXXXXXXXXXXXXXXXXX"
}
"error":{}
}

Sample Failure Response

The following are the failure responses:

401 Unauthorized
{
    "code": "RBC001",
    "message": "Incorrect SID or API key.",
    "data": [],
    "error": {
        "error": "Incorrect SID or API key."
    }
}
401 Unauthorized phone number
{
    "code": "WA401",
    "message": "Phone number is not present or does not belong to the account.",
    "data": {},
    "error": {
        "phone_number": "Phone number is not present or does not belong to the account."
    }
}
400 Incorrect payload
{
    "code": "WA400",
    "message": "Refer to correct payload format",
    "data": {},
    "error": {
        "payload": "Incorrect payload format"
    }
}
500 Internal Server Error
{
    "code": "WA500",
    "message": "Please try again later",
    "data": {},
    "error": {
        "error": "Internal server error"
    }
}
400 Low balance
{
    "code": "E110",
    "message": "Please check your balance, You have a low balance!",
    "data": {},
    "error": {
        "balance": "Please check your balance, You have a low balance!"
    }
}
401 Unauthorised Account type
{
    "code": "WA-401",
    "message": "API is not available for given customer.Please contact support for more info",
    "data": {},
    "error": {
        "account": "API is not available for given customer.Please contact support for more info"
    }
}
401 Unauthorized phone number version
{
    "code": "WA-401",
    "message": "The phone number you're using is associated with different Version of our WA API. Please use the appropriate endpoint.",
    "data": {},
    "error": {
        "phone_number": "The phone number you're using is associated with different Version of our WA API. Please use the appropriate endpoint."
    }
}

Webhook for Interactive List Message

The following is an example webhook that is triggered when a customer selects an option from an interactive list message. The webhook helps you to know the customer phone number, name, and the customer choice made from the interactive list message.

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "102290129340398",
      "changes": [
        {
          "value": {
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "15550783881",
              "phone_number_id": "106540352242922"
            },
            "contacts": [
              {
                "profile": {
                  "name": "James Paul"
                },
                "wa_id": "16505551234"
              }
            ],
            "messages": [
              {
                "context": {
                  "from": "15550783881",
                  "id": "wamid.HBgLMTY0NjcwNDM1OTUVAgARGBIwMjg0RkMxOEMyMkNEQUFFRDgA"
                },
                "from": "16505551234",
                "id": "wamid.HBgLMTY0NjcwNDM1OTUVAgASGBQzQTZDMzFGRUFBQjlDMzIzMzlEQwA=",
                "timestamp": "1712595443",
                "type": "interactive",
                "interactive": {
                  "type": "list_reply",
                  "list_reply": {
                    "id": "priority_express",
                    "title": "Priority Mail Express",
                    "description": "Next Day to 2 Days"
                  }
                }
              }
            ]
          },
          "field": "messages"
        }
      ]
    }
  ]
}