Share Contact Information
POST and GET Methods
Description
The end user can share any contact information to single person or a group of people from your WhatsApp using this API.
Base URL
To share contact information on WhatsApp, follow the below steps:
1. Sign in to Kaleyra.io and create your API key.
Refer to the Create an API Key and Security Identifier page for steps to create your API key.
Note:
After you sign up, your account will be on the trial version. You need to complete the KYC to access all the features of Kalyera Cloud.
2. API command to share contact information
Request Format
To send your first SMS, use the /messages endpoints.
curl -X POST "https://https://api.kaleyra.io/v1/<SID>/messages" \
-H "api-key: <API_KEY>" \
-H "Content-Type: <CONTENT_TYPE>" \
-d "channel=<CHANNEL_NAME>" \
-d "to=<TO_NUMBER>" \
-d "from=<FROM_NUMBER>" \
-d "type=<MESSAGE_TYPE>" \
-d 'param_contacts={"name": { "first_name": "<FIRST_NAME>","formatted_name":" <FORMATTED_NAME>", "last_name": "<LAST_NAME>" },"phones": [ { "phone": "<PHONE_NUMBER>", "type": "<NUMBER_TYPE>"}]}' \
-d "callback_url=<CALLBACK_URL>"
Note:
Ensure to replace the parameter values with the proper inputs in the above code.
Parameters and Variables
The below table displays the parameters and variables used:
Parameter | Variable | Description | Example | Mandatory |
|---|---|---|---|---|
SID | String | Account SID (Security Identifier) | HXXXXXXX071US | True |
CONTENT_TYPE | String | The format in which the data is sent. | application/x-www-form-urlencoded | True |
API_KEY | String | API Key generated by Kaleyra.io. | Ac4XXXXX21f | True |
TO_NUMBER | Integer | A valid WhatsApp number of the recipient. Ensure that the country code is prefixed to the number. (E164 format). Note: You can add multiple recipients separated by the comma. | +1202XXXXXXX | True |
MESSAGE_TYPE | String | Format of the message. | contacts | True |
CHANNEL_NAME | String | Channel on which the message should be sent. | True | |
FROM_NUMBER | Integer | The WhatsApp business number registered with Kaleyra.io from which the message is to be sent. Ensure the number is prefixed with the country code. (E164 format). | +1202XXXXXXX | True |
FIRST_NAME | String | First name of the recipient | John | False |
FORMATTED_NAME | String | First and last name of the recipient | John Doe | False |
LAST_NAME | String | Last name of the recipient | Doe | False |
PHONE_NUMBER | Integer | Phone number of the recipient | +1202XXXXXXX | True |
NUMBER_TYPE | String | Phone number type | Home | False |
CALLBACK_URL | String | The URL that Kalyera.io should send information to when your number receives a response. This URL can be accessed publicly. | False |
3. Response Format
This section provides you the successful JSON response format.
Success Response
{
"id": "8xxxxxxx-fxxx-4xxx-axxx-exxxxxxxxxxx",
"type": "contacts",
"body": null,
"createdDateTime": "2020-12-10 10:16:13+00:00",
"totalCount": 1,
"data": [
{
"message_id": "8xxxxxxx-fxxx-4xxx-axxx-exxxxxxxxxxx:x",
"recipient": "91xxxxxxxxxx"
}
],
"error": {}
}
Note:
In case of error, ensure that the above replaceable values are correct. See Standard Error Codes
Sample Request
curl -X POST "https://https://api.kaleyra.io/v1/HXXXXXXX071US/messages" \
-H "api-key: Ac4XXXXX21f" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "channel=whatsapp" \
-d "to=+1XXXXXXXXXX" \
-d "from=+1202XXXXXXX" \
-d "type=contacts" \
-d 'param_contacts={"name": { "first_name": "John","formatted_name":"John Doe", "last_name": "Doe" },"phones": [ { "phone": "+1202XXXXXXX", "type": "Home"}]}' \
-d "callback_url=https://webhook.site/89b43b12-b889-4f66-8ebf-3379b4b3345c"
Updated 6 months ago