Send a Contact
In this code snippet you learn how to send a contact to WhatsApp using the Messages API. This uses Nexmo's Custom object feature. Further information on the specific message format can be found in the WhatsApp developers Contacts message documentation.
Example
Ensure the following variables are set to your required values using any convenient method:
| Key | Description |
|---|---|
BASE_URL |
For production use the base URL is https://api.nexmo.com/. For sandbox testing the base URL is https://messages-sandbox.nexmo.com/. |
MESSAGES_API_URL |
For production use the Messages API endpoint is https://api.nexmo.com/v0.1/messages. For sandbox testing the Messages API endpoint is https://messages-sandbox.nexmo.com/v0.1/messages. |
WHATSAPP_NUMBER |
The WhatsApp number that has been allocated to you by Nexmo. For sandbox testing the number is 14157386170. |
TO_NUMBER |
The phone number you are sending the message to. |
NOTE: Don't use a leading + or 00 when entering a phone number, start with the country code, for example, 447700900000.
Prerequisites
Create an application
If you do not have an application you can create one. Make sure you also configure your webhooks.
Write the code
Add the following to send-contact.sh:
curl -X POST $MESSAGES_API_URL \
-H 'Authorization: Bearer' $JWT \
-H 'Content-Type: application/json' \
-d '{
"from": {
"type": "whatsapp",
"number": "'$WHATSAPP_NUMBER'"
},
"to": {
"type": "whatsapp",
"number": "'$TO_NUMBER'"
},
"message": {
"content": {
"type": "custom",
"custom": {
"type": "contacts",
"contacts": [
{
"addresses": [
{
"city": "Menlo Park",
"country": "United States",
"country_code": "us",
"state": "CA",
"street": "1 Hacker Way",
"type": "HOME",
"zip": "94025"
},
{
"city": "Menlo Park",
"country": "United States",
"country_code": "us",
"state": "CA",
"street": "200 Jefferson Dr",
"type": "WORK",
"zip": "94025"
}
],
"birthday": "2012-08-18",
"emails": [
{
"email": "test@fb.com",
"type": "WORK"
},
{
"email": "test@whatsapp.com",
"type": "WORK"
}
],
"name": {
"first_name": "John",
"formatted_name": "John Smith",
"last_name": "Smith"
},
"org": {
"company": "WhatsApp",
"department": "Design",
"title": "Manager"
},
"phones": [
{
"phone": "+1 (940) 555-1234",
"type": "HOME"
},
{
"phone": "+1 (650) 555-1234",
"type": "WORK",
"wa_id": "16505551234"
}
],
"urls": [
{
"url": "https://www.facebook.com",
"type": "WORK"
}
]
}
]
}
}
}
}'
Run your code
Save this file to your machine and run it:
bash send-contact.shPrerequisites
Create an application
If you do not have an application you can create one. Make sure you also configure your webhooks.
Install dependencies
npm install nexmo@betaWrite the code
Add the following to send-contact.js:
const Nexmo = require('nexmo');
const nexmo = new Nexmo(
{
apiKey: NEXMO_API_KEY,
apiSecret: NEXMO_API_SECRET,
applicationId: NEXMO_APPLICATION_ID,
privateKey: NEXMO_APPLICATION_PRIVATE_KEY_PATH,
},
{
apiHost: BASE_URL,
}
);
nexmo.channel.send(
{ type: 'whatsapp', number: TO_NUMBER },
{ type: 'whatsapp', number: WHATSAPP_NUMBER },
{
content: {
type: 'custom',
custom: {
type: 'contacts',
contacts: [
{
addresses: [
{
city: 'Menlo Park',
country: 'United States',
country_code: 'us',
state: 'CA',
street: '1 Hacker Way',
type: 'HOME',
zip: '94025',
},
{
city: 'Menlo Park',
country: 'United States',
country_code: 'us',
state: 'CA',
street: '200 Jefferson Dr',
type: 'WORK',
zip: '94025',
},
],
birthday: '2012-08-18',
emails: [
{
email: 'test@fb.com',
type: 'WORK',
},
{
email: 'test@whatsapp.com',
type: 'WORK',
},
],
name: {
first_name: 'John',
formatted_name: 'John Smith',
last_name: 'Smith',
},
org: {
company: 'WhatsApp',
department: 'Design',
title: 'Manager',
},
phones: [
{
phone: '+1 (940) 555-1234',
type: 'HOME',
},
{
phone: '+1 (650) 555-1234',
type: 'WORK',
wa_id: '16505551234',
},
],
urls: [
{
url: 'https://www.facebook.com',
type: 'WORK',
},
],
},
],
},
},
},
(err, data) => {
if (err) {
console.error(err);
} else {
console.log(data.message_uuid);
}
}
);
Run your code
Save this file to your machine and run it:
node send-contact.jsTry it out
When you run the code a WhatsApp contact message is sent to the destination number. In WhatsApp you can view the contact details and add to address book if required.