Send Contacts Message

Contacts messages allow you to send rich contact information directly to WhatsApp users, such as names, phone numbers, physical addresses, and email addresses. When a WhatsApp user taps the message's profile arrow, it displays the contact's information in a profile view. Each message can include information for up to 257 contacts, although it is recommended to send fewer for usability and negative feedback reasons.

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.

Base URL

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

API Domain and Value

api_domain	Value
IN pod	api.in.kaleyra.io
SG Pod	api.ap.kaleyra.io
EU Pod	api.eu.kaleyra.io

API Request to Send Contacts Message

To send contacts 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 contacts message:

curl -X POST \
  https://api.in.kaleyra.io/v2/HXAP16XXXXXX97IN/whatsapp/+91XXXXXXXXXX/messages \
  -H 'Content-Type: <content_type>' \
  -H 'api-key: <api-key>' \
  -d  '{
    "messaging_object": {
     "messaging_product": "whatsapp", 
        "to": "<phone_number>", 
        "type": "contacts", 
        "contacts": [ 
            { 
                "addresses": [ 
                    { 
                        "street": "street", 
                        "city": "city", 
                        "state": "state", 
                        "zip": "zip", 
                        "country": "country", 
                        "country_code": "country_code", 
                        "type": "home" 
                    }, 
                    { 
                        "street": "street", 
                        "city": "city", 
                        "state": "state", 
                        "zip": "zip", 
                        "country": "country", 
                        "country_code": "country_code", 
                        "type": "work" 
                    } 
                ], 
                "birthday": "birthday", 
                "emails": [ 
                    { 
                        "email": "email", 
                        "type": "work" 
                    }, 
                    { 
                        "email": "email", 
                        "type": "home" 
                    } 
                ], 
                "name": { 
                    "formatted_name": "name", 
                    "first_name": "first_name", 
                    "last_name": "last_name", 
                    "middle_name": "middle_name", 
                    "suffix": "suffix", 
                    "prefix": "prefix" 
                }, 
                "org": { 
                    "company": "company", 
                    "department": "department", 
                    "title": "title" 
                }, 
                "phones": [ 
                    { 
                        "phone": "phone_number", 
                        "type": "home" 
                    }, 
                    { 
                        "phone": "phone_number", 
                        "type": "work", 
                        "wa_id": "phone_or_wa_id" 
                    } 
                ], 
                "urls": [ 
                    { 
                        "url": "url", 
                        "type": "work" 
                    }, 
                    { 
                        "url": "url", 
                        "type": "home" 
                    } 
                ] 
            } 
        ] 
   },
    "extra_info": {
        "ref": "<ref>",
        "ref1": "<ref1>",
        "ref2": "<ref2>",
        "wa_source": "<wa_source>"
    }
}'

Sample Request Format

The following is the sample request format to send contacts message:

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", 
 			 "to": "+16XXXXXX234", 
  			"type": "contacts", 
  			"contacts": [ 
    		{ 
      		"addresses": [ 
        	{ 
          "street": "1 Lucky Shrub Way", 
          "city": "Menlo Park", 
          "state": "CA", 
          "zip": "94XX5", 
          "country": "United States", 
          "country_code": "US", 
          "type": "Office" 
        }, 
        { 
          "street": "1 Hacker Way", 
          "city": "Menlo Park", 
          "state": "CA", 
          "zip": "94XX5", 
          "country": "United States", 
          "country_code": "US", 
          "type": "Pop-Up" 
        } 
      ], 
      "birthday": "1999-01-23", 
      "emails": [ 
        { 
          "email": "[email protected]", 
          "type": "Work" 
        }, 
        { 
          "email": "[email protected]", 
          "type": "Work (old)" 
        } 
      ], 
      "name": { 
        "formatted_name": "Barbara J. Johnson", 
        "first_name": "Barbara", 
        "last_name": "Johnson", 
        "middle_name": "Joana", 
        "suffix": "Esq.", 
        "prefix": "Dr." 
      }, 
      "org": { 
        "company": "Lucky Shrub", 
        "department": "Legal", 
        "title": "Lead Counsel" 
      }, 
      "phones": [ 
        {
          "phone": "+165XXXXXX99", 
          "type": "Landline" 
        }, 
        { 
          "phone": "+191XXXXXX99", 
          "type": "Mobile", 
          "wa_id": "191XXXXX999" 
        } 
      ], 
      "urls": [ 
        { 
          "url": "https://www.luckyshrub.com", 
          "type": "Company" 
        }, 
        { 
          "url": "https://www.facebook.com/luckyshrubplants", 
          "type": "Company (FB)" 
        } 
      ] 
    } 
  ] 
    },
    "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 / Headers	Data Type	Description	Example	Mandatory?
`sid`	String	Account SID (Security Identifier).	HXAP16XXXXXX97IN	Yes
`phone_number`	String	Phone number of the end customer you want to send a message to.	+91XXXXXXXXXX	Yes (valid phone numbers only)
`Content-Type`	String	Indicates the format of the content the API will be processing.	The only allowed value is application/json.	Yes
`api-key`	String	API key generated from kaleyra platform account.	Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx3	Yes

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.	Only allowed value is whatsapp	Yes
`recipient_type`	String	Currently, you can only send messages to individuals. Default is individual.	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.	Only allowed value for sending this message is interactive.	No
`contacts`	Array of objects	Contains the contact information to be sent.	See the specific table for details.	Yes

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

Parameter	Data Type	Description	Example	Mandatory?
`addresses`	Array of objects	An array of contacts to be sent.	See the specific table for details.	No
`birthday`	String	Date of birth of the contact in YYYY-MM-DD format.	1999-01-23	No
`emails`	Array of objects	An array of emails associated with the contact.	See the specific table for details.	No
`name`	JSON object	An object containing the contact’s name details.	See the specific table for details.	Yes
`org`	JSON object	An object containing the contact’s organization details.	See the specific table for details.	No
`phones`	Array of objects	An array of phone numbers with their types.	See the specific table for details.	Yes
`urls`	Array of objects	An array of URLs related to the contact.	See the specific table for details.	No

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

Parameter	Data Type	Description	Example	Mandatory?
`street`	String	Street address of the contact.	1 Lucky Shrub Way	No
`city`	String	The city where the contact resides.	Menlo Park	No
`state`	String	Two-letter state code.	CA	No
`zip`	String	Postal or ZIP code.	94XX5	No
`country`	String	Country name.	United States	No
`country_code`	String	ISO two-letter country code.	US	No
`type`	String	Type of address, such as home or work.	Home	No

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

Parameter	Data Type	Description	Example	Mandatory?
`email`	String	Email address of the contact.	[email protected]	No
`type`	String	Type of email, such as personal or work.	Work	No

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

Parameter	Data Type	Description	Example	Mandatory?
`formatted_name`	String	Contact's formatted name. This will appear in the message alongside the profile arrow button.	Barbara J. Johnson	Yes
`first_name`	String	Contact's first name.	Barbara	No
`last_name`	String	Contact's last name.	Johnson	No
`middle_name`	String	Contact's middle name.	Joana	No
`suffix`	String	Suffix for the contact's name, if applicable.	Esq.	No
`prefix`	String	Prefix for the contact's name, such as Mr., Ms., Dr., and so on	Dr.	No

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

Parameter	Data Type	Description	Example	Mandatory?
`company`	String	Name of the company where the contact works.	Lucky Shrub	No
`department`	String	Department within the company.	Legal	No
`title`	String	Contact's job title.	Lead Counsel	No

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

Parameter	Data Type	Description	Example	Mandatory?
`phone`	String	WhatsApp user phone number.	+16XXXXXX999	No
`type`	String	Type of phone number. For example, cell, mobile, main, iPhone, home, work, and so on.	Home	No
`wa_id`	String	WhatsApp user ID. If omitted, the message will display an Invite to WhatsApp button instead of the standard buttons. Note: For more information, see the Button Behaviour section at the end of this document.	191XXXXXX99	No

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

Parameter	Data Type	Description	Example	Mandatory?
`url`	String	Website URL associated with the contact or their company.	https://www.luckyshrub.com	No
`type`	String	Type of website. For example, company, work, personal, Facebook Page, Instagram, and so on.	Company	No

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

Button Behaviour

If you include the contact's WhatsApp ID in the message (using the wa_id property), the message will include a Message and a Save contact button.

If the WhatsApp user taps the Message button, it will open a new message with the contact. If the user taps the Save contact button, they will be given the option to save the contact as a new contact or to update an existing contact.

If you omit the wa_id property, both buttons will be replaced with an Invite to WhatsApp button.

Prerequisites

Base URL

API Domain and Value

API Request to Send Contacts Message

Request Format

Sample Request Format

URL Parameters and Headers

📘Note:

Sample Success Response

Sample Failure Response

Button Behaviour

📘
Note: