Send Interactive Call-to-Action URL Button Messages

POST Method

The Send Interactive Call-to-Action URL Button Messages API allows you to send an interactive Call-to-Action URL button messages to WhatsApp users. You can map any URL to a button, so you do not have to include the raw URL in the body of the message.

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 Call-to-Action URL Button Messages:

To send Interactive Call-to-Action URL 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 Call-to-Action URL Button Messages:

curl -X POST \
  https://<api_domain>/v2/<sid>/whatsapp/<phone_number>/messages \
  -H 'Content-Type: <content_type>' \
  -H 'api-key: <api-key>' \
  -H 'cache-control: no-cache' \
  -d  '{
    "messaging_object": {
        "messaging_product": "<messaging_product>",
        "recipient_type": "<recipient_type>",
        "to": "<to_number>",
        "type": "<type>",
        "interactive": {
            "type": "<type>",
                "header": {
                "type": "<header_type>",
                "text": "<header_text>"
            },
                "body": {
                "text": "<body_text>"
            },
                "footer": {
                "text": "<footer_text>"
            },
            "action": {
                "name": "<button_name>",
                "parameters": {
                    "display_text": "<button_text>",
                    "url": "<button_url>"
                }
            }
        }
    },
    "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 Call-to-Action URL Button Messages:

curl -X POST \
  https://api.in.kaleyra.io/v2/HXAP16XXXXXX97IN/whatsapp/+91XXXXXXXXXX/messages \
  -H 'Content-Type: application/json' \
  -H 'api-key: Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx3' \
  -H 'cache-control: no-cache' \
  -d  '{
    "messaging_object": {
        "messaging_product": "whatsapp",
        "recipient_type": "individual",
        "to": "+91XXXXXXXXX ",
        "type": "interactive",
        "interactive": {
            "type": "cta_url",
                "header": {
                "type": "text",
                "text": "Available Dates"
            },
                "body": {
                "text": "Tap the button below to see available dates."
            },
                "footer": {
                "text": "Dates subject to change."
            },
            "action": {
                "name": "cta_url",
                "parameters": {
                    "display_text": "See Dates",
                    "url": "https://www.luckyshrub.com?clickID=kqDGWd24Q5TRwoEQTICY7W1JKoXvaZOXWAS7h1P76s0R7Paec4"
                }
            }
        }
    },
    "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.The only allowed value is whatsappYes
recipient_typeStringCurrently, you can only send messages to individuals. Default is individual.The only allowed value is individualNo
to_numberStringWhatsApp end-user phone number. It should include country code prefix following E.164 format.+91XXXXXXXXXYes
typeStringThe type of message you want to send. If omitted, it defaults to text.The only allowed value is interactiveNo
interactiveJSON objectInteractive object contains interactive message details.See the specific table for detailsYes

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

ParameterData TypeDescriptionExampleMandatory?
typeStringThe type of interactive elementThe only allowed value to send the CTA URL button message is cta_urlYes
header
(Optional)
JSON objectHeader content. Supports document, image, text, and video header types.See the specific table for detailsNo
body
(Optional)
StringBody content.See the specific table for detailsNo
footer
(Optional)
StringFooter content.See the specific table for detailsNo
actionJSON objectDefines the action buttons.See the specific table for detailsYes

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

ParameterData TypeDescriptionExampleMandatory?
header_typeStringThe type of header element.The only allowed value is textYes
header_textStringHeader text.Available DatesNo

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

ParameterData TypeDescriptionExampleMandatory?
body_textStringMessage body text.Tap the button below to see available datesNo

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

ParameterData TypeDescriptionExampleMandatory?
footer_textStringMessage footer text.Dates subject to changeNo

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

ParameterData TypeDescriptionExampleMandatory?
button_nameStringSpecifies the name of the button.cta_urlYes
parametersStringIndicates the type of parameter for the button.See the specific table for detailsYes

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

ParameterData TypeDescriptionExampleMandatory?
button_textStringButton text.See DatesYes
button_urlStringURL to load in the device's default web browser when tapped by the WhatsApp user.https://www.luckyshrub.com?clickID=kqDGWd24Q5TRwoEQTICY7W1JKoXvaZOXWAS7h1P76s0R7Paec4Yes

The following table describes the different attributes used for the extra_info 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

📘

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