Send an Interactive Reply Button Message

POST Method

The Interactive Reply Button messages enable you to send up to three predefined reply to options for the users. The message includes a header, body, footer, and reply to buttons. Users can select one of these buttons to reply, triggering an incoming message with the selected option to the Brand.

This document explains how to send an Interactive Reply Button Message.

Prerequisites

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.
To set up a WhatsApp account on kaleyra.io, see Manual Signup
and Embedded Signup.
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.
- A WABA ID onboarded on Kaleyra WhatsApp API V2.

Base URL

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

API Domain and Value

api_domain	Value
IN pod	api.in.kaleyra.io
SG Pod	api.kaleyra.io
EU Pod	api.eu.kaleyra.io
NA pod	api.na.kaleyra.ai

API Request to Send Interactive Reply Button Messages

To send Interactive Reply Button Messages 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 Reply Button Messages:

curl -X POST \
  https://<api_domain>/v2/<sid>/whatsapp/<phone_number>/messages \
  -H 'Content-Type: <content_type>' \
  -H 'api-key: <api-key>' \
  -d  '{
    "messaging_object": {
        "messaging_product": "<messaging product>",
    "recipient_type": "<recipient type>",
    "to": "<phone_number>",
    "type": "<type>",
    "interactive": {
      "type": "button",
      "header": "<message_header>",
      "body": {
        "text": "<button_text>"
      },
      "footer": {
        "text": "<footer_text>"
      },
      "action": {
        "buttons": [
          {
            "type": "reply",
            "reply": {
              "id": "<unique_button_id>",
              "title": "<button_title_1>"
            }
          }
        ]
      }
    }   
   },
    "extra_info": {
        "ref": "<ref>",
        "ref1": "<ref1>",
        "ref2": "<ref2>",
        "wa_source": "<wa_source>"
    }
}'

Sample Request Format

The following is the sample request format to send Interactive Reply Button Messages:

curl -X POST \
  https://api.in.kaleyra.io/v2/HXAP16XXXXXX97IN/whatsapp/+91XXXXXXXXXX/messages \
  -H 'Content-Type: application/json' \
  -H 'api-key: Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx3' \
  -d  '{
    "messaging_object": {
          "messaging_product": "whatsapp",
    "recipient_type": "individual",
    "to": "+91XXXXXXXXXX",
    "type": "interactive",
    "interactive": {
      "type": "button",
      "header": { 
        "type":"text",
        "text": "Appointment Reminder"
        }
      "body": {
        "text": "Hi John! Your car service is scheduled for 9 am tomorrow. Use the buttons if you need to reschedule. Thank you!"
      },
      "footer": {
        "text": "CarCareSystems: One stop for all car needs!"
      },
      "action": {
        "buttons": [
          {
            "type": "reply",
            "reply": {
              "id": "change-button",
              "title": "Change"
            }
          },
          {
            "type": "reply",
            "reply": {
              "id": "cancel-button",
              "title": "Cancel"
            }
          }
        ]
      }
    },
    "extra_info": {
        "ref": "customer1",
        "ref1": "marketing",
        "ref2": "dictionary",
        "wa_source": "api"
    }
}'

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

Parameter	Data Type	Description	Example	Mandatory?
`messaging_object`	JSON object	Payload 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_info`	JSON object	This 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 JSON object:

Parameter	Data Type	Description	Example	Mandatory?
`messaging_product`	String	Messaging service used for the request.	The only allowed value is whatsapp.	Yes
`recipient_type`	String	Currently, you can only send messages to individuals. The default is individual.	The only allowed value is individual.	No
`to`	String	WhatsApp end-user phone number. It should include country code prefix following E.164 format.	+16XXXXXX234	Yes
`type`	String	The type of message you want to send. If omitted, defaults to text.	The only allowed value for the Reply Button message is interactive.	No
`interactive`	JSON object	Nested inside the message_object, the interactive object contains the interactive message details.	See the specific table for details.	Yes

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

Parameter	Data Type	Description	Example	Mandatory?
`type`	String	The type of interactive element.	button	Yes
`header`	JSON object	Header content. Supports the following types: • document • image • text • video Media assets can be sent using their uploaded media ID (recommended) or URL link (not recommended).	See the specific table for details.	No
`body`	String	Message body text. Emojis, markdowns, and links are supported. Maximum 1024 characters.	"Hi John! Your car service is scheduled for 9 am tomorrow. Use the buttons if you need to reschedule. Thank you!"	Yes
`footer`	String	Message footer text. Emojis, markdowns, and links are supported. Maximum 60 characters.	"CarCareSystems: One stop for all car needs!"	No
`action`	JSON object	Defines the action buttons.	See the specific table for details.	Yes

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

Parameter	Data Type	Description	Example	Mandatory?
`buttons`	Array of objects	Contains the buttons for the interactive message.	See the specific table for details.	Yes

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

Parameter	Data Type	Description	Example	Mandatory?
`type`	String	The type of button interaction.	reply	Yes
`reply`	JSON object	Contains details about each button.	See the specific table for details.	Yes

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

Parameter	Data Type	Description	Example	Mandatory?
`id`	String	A unique identifier for each button. Supports up to 3 buttons. Maximum 256 characters.	change-button	Yes
`title`	String	Button label text. Maximum 20 characters.	Change	Yes

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

Parameter	Data Type	Description	Example	Mandatory?
`ref`	String	Include 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.	customer1	No
`ref1`	String	Include 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.	marketing	No
`ref2`	String	Include 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.	dictionary	No
`wa_source`	String	Indicates 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".	api	No

📘
Note:
In the case of ref, ref1, and ref2, if the length of the string exceeds 255 characters, it will be truncated.

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."
    }
}

Updated 8 days ago