Send a Contact

In this code snippet you learn how to send a contact to WhatsApp using the Messages API. This uses Vonage's Custom object feature. Further information on the specific message format can be found in the WhatsApp developers Contacts message documentation.

Example

Find the description for all variables used in each code snippet below:

Key	Description
`VONAGE_APPLICATION_ID`	The Vonage Application ID.
`VONAGE_APPLICATION_PRIVATE_KEY_PATH`	Private key path.
`VONAGE_PRIVATE_KEY_PATH`	Private key path.
`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`	There are two versions of the API, each with their own endpoints. For production the previous Messages API endpoint was `https://api.nexmo.com/v0.1/messages`, the new one is `https://api.nexmo.com/v1/messages`. For sandbox testing the Messages API endpoint is `https://messages-sandbox.nexmo.com/v0.1/messages` or `https://messages-sandbox.nexmo.com/v1/messages`, depending on which version you have set in the sandbox dashboard.
`WHATSAPP_NUMBER`	The WhatsApp number that has been allocated to you by Vonage. For sandbox testing the number is 14157386102.
`VONAGE_WHATSAPP_NUMBER`	Refer to `WHATSAPP_NUMBER` above.
`VONAGE_NUMBER`	Refer to `WHATSAPP_NUMBER` above.
`TO_NUMBER`	Replace with the number you are sending to. E.g. `447700900001`

NOTE: Don't use a leading + or 00 when entering a phone number, start with the country code, for example, 447700900000.

Prerequisites

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' \
  -H 'Accept: application/json' \
  -d $'{
    "to": "'${MESSAGES_TO_NUMBER}'",
    "from": "'${WHATSAPP_SENDER_ID}'",
    "channel": "whatsapp",
    "message_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"
            }
          ]
        }
      ]
    }
  }'

View full source

Run your code

Save this file to your machine and run it:

bash send-contact.sh

Prerequisites

If you do not have an application you can create one. Make sure you also configure your webhooks.

npm install @vonage/server-sdk @vonage/messages

Create a file named send-contact.js and add the following code:

const { Vonage } = require('@vonage/server-sdk');
const { Channels } = require('@vonage/messages');

/**
 * It is best to send messages using JWT instead of basic auth. If you leave out
 * apiKey and apiSecret, the messages SDK will send requests using JWT tokens
 *
 * @link https://developer.vonage.com/en/messages/technical-details#authentication
 */
const vonage = new Vonage(
  {
    applicationId: VONAGE_APPLICATION_ID,
    privateKey: VONAGE_PRIVATE_KEY,
  },
  {
    ...(MESSAGES_API_URL ? {apiHost: MESSAGES_API_URL} : {}),
  },
);

View full source

Write the code

Add the following to send-contact.js:

vonage.messages.send({
  to: MESSAGES_TO_NUMBER,
  from: WHATSAPP_SENDER_ID,
  channel: Channels.WHATSAPP,
  messageType: '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',
          },
        ],
      },
    ],
  },
})
  .then(({ messageUUID }) => console.log(messageUUID))
  .catch((error) => console.error(error));

View full source

Run your code

Save this file to your machine and run it:

node send-contact.js

Prerequisites

If you do not have an application you can create one. Make sure you also configure your webhooks.

Add the following to build.gradle:

implementation 'com.vonage:server-sdk-kotlin:2.1.1'

Create a class named SendWhatsappContact and add the following code to the main method:

val client = Vonage {
    applicationId(VONAGE_APPLICATION_ID)
    privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
}

View full source

Write the code

Add the following to the main method of the SendWhatsappContact class:

val messageId = client.messages.send(
    whatsappCustom {
        to(MESSAGES_TO_NUMBER)
        from(WHATSAPP_SENDER_ID)
        custom(mapOf(
            "type" to "contacts",
            "contacts" to listOf(
                mapOf(
                    "addresses" to listOf(
                        mapOf(
                            "city" to "Menlo Park",
                            "country" to "United States",
                            "state" to "CA",
                            "country_code" to "us",
                            "street" to "1 Hacker Way",
                            "type" to "HOME",
                            "zip" to "94025"
                        ),
                        mapOf(
                            "city" to "Menlo Park",
                            "country" to "United States",
                            "state" to "CA",
                            "country_code" to "us",
                            "street" to "200 Jefferson Dr",
                            "type" to "WORK",
                            "zip" to "94025"
                        )
                    ),
                    "birthday" to "2012-08-18",
                    "emails" to listOf(
                        mapOf(
                            "email" to "test@fb.com",
                            "type" to "WORK"
                        ),
                        mapOf(
                            "email" to "test@whatsapp.com",
                            "type" to "WORK"
                        )
                    ),
                    "name" to mapOf(
                        "first_name" to "Jayden",
                        "last_name" to "Smith",
                        "formatted_name" to "J. Smith"
                    ),
                    "org" to mapOf(
                        "company" to "WhatsApp",
                        "department" to "Design",
                        "title" to "Manager"
                    ),
                    "phones" to listOf(
                        mapOf(
                            "phone" to "+1 (940) 555-1234",
                            "type" to "HOME"
                        ),
                        mapOf(
                            "phone" to "+1 (650) 555-1234",
                            "type" to "WORK",
                            "wa_id" to "16505551234"
                        )
                    ),
                    "urls" to listOf(
                        mapOf(
                            "url" to "https://www.facebook.com",
                            "type" to "WORK"
                        )
                    )
                )
            )
        ))
    }
)

View full source

Run your code

We can use the application plugin for Gradle to simplify the running of our application. Update your build.gradle with the following:

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

Run the following gradle command to execute your application, replacing com.vonage.quickstart.kt.messages.whatsapp with the package containing SendWhatsappContact:

gradle run -Pmain=com.vonage.quickstart.kt.messages.whatsapp.SendWhatsappContact

Prerequisites

If you do not have an application you can create one. Make sure you also configure your webhooks.

Add the following to build.gradle:

implementation 'com.vonage:server-sdk:9.3.1'

Create a class named SendWhatsappContact and add the following code to the main method:

VonageClient client = VonageClient.builder()
		.applicationId(VONAGE_APPLICATION_ID)
		.privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
		.build();

View full source

Write the code

Add the following to the main method of the SendWhatsappContact class:

var response = client.getMessagesClient().sendMessage(
		WhatsappCustomRequest.builder()
			.from(WHATSAPP_SENDER_ID).to(MESSAGES_TO_NUMBER)
			.custom(Map.of(
				"type", "contacts",
				"contacts", List.of(Map.of(
					"addresses", List.of(
						Map.of(
							"city", "Menlo Park",
							"country", "United States",
							"state", "CA",
							"country_code", "us",
							"street", "1 Hacker Way",
							"type", "HOME",
							"zip", "94025"
						),
						Map.of(
							"city", "Menlo Park",
							"country", "United States",
							"state", "CA",
							"country_code", "us",
							"street", "200 Jefferson Dr",
							"type", "WORK",
							"zip", "94025"
						)
					),
					"birthday", "2012-08-18",
					"emails", List.of(
						Map.of(
							"email", "test@fb.com",
							"type", "WORK"
						),
						Map.of(
							"email", "test@whatsapp.com",
							"type", "WORK"
						)
					),
					Map.of("name", Map.of(
						"first_name", "Jayden",
						"last_name", "Smith",
						"formatted_name", "J. Smith"
					)),
					Map.of("org", Map.of(
						"company", "WhatsApp",
						"department", "Design",
						"title", "Manager"
					)),
					Map.of("phones", List.of(
						Map.of(
							"phone", "+1 (940) 555-1234",
							"type", "HOME"
						),
						Map.of(
							"phone", "+1 (650) 555-1234",
							"type", "WORK",
							"wa_id", "16505551234"
						)
					)),
					Map.of("urls", List.of(
						Map.of(
							"url", "https://www.facebook.com",
							"type", "WORK"
						)
					))
				))
			))
			.build()
);
System.out.println("Message sent successfully. ID: "+response.getMessageUuid());

View full source

Run your code

We can use the application plugin for Gradle to simplify the running of our application. Update your build.gradle with the following:

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

Run the following gradle command to execute your application, replacing com.vonage.quickstart.messages.whatsapp with the package containing SendWhatsappContact:

gradle run -Pmain=com.vonage.quickstart.messages.whatsapp.SendWhatsappContact

Prerequisites

If you do not have an application you can create one. Make sure you also configure your webhooks.

Install-Package Vonage

Write the code

Add the following to SendWhatsAppContact.cs:

var credentials = Credentials.FromAppIdAndPrivateKeyPath(VONAGE_APPLICATION_ID, VONAGE_PRIVATE_KEY_PATH);
var vonageClient = new VonageClient(credentials);
var request = new WhatsAppCustomRequest
{
    To = MESSAGES_TO_NUMBER,
    From = WHATSAPP_SENDER_ID,
    Custom = new
    {
        type = "contacts",
        contacts = new []
        {
            new
            {
               name = new {
                first_name = "John",
                formatted_name = "John Smith",
                last_name = "Smith",
               },
               birthday = "2012-08-18",
               emails = new []
               {
                   new
                   {
                       email = "test@fb.com",
                       type = "WORK",
                   },
                   new
                   {
                       email = "test@whatsapp.com",
                       type = "WORK",
                   }
               },
               addresses = new []
               {
                    new
                    {
                         city = "Menlo Park",
                         country = "United States",
                         country_code = "US",
                         state = "CA",
                         street = "1 Hacker Way",
                         type = "WORK",
                         zip = "94025",
                    }
               },
               org = new
               {
                   company = "WhatsApp",
                   department = "Design",
                   title = "Manager",
               },
               urls = new
               {
                   url = "https://www.facebook.com",
                   type = "WORK",
               }
            }
        }
    }
};
var response = await vonageClient.MessagesClient.SendAsync(request);

View full source

Prerequisites

If you do not have an application you can create one. Make sure you also configure your webhooks.

composer require vonage/client

Create a file named send-contact.php and add the following code:

View full source

Write the code

Add the following to send-contact.php:

View full source

Run your code

Save this file to your machine and run it:

php send-contact.php

Prerequisites

If you do not have an application you can create one. Make sure you also configure your webhooks.

pip install vonage python-dotenv

Write the code

Add the following to send-contact.py:

from vonage import Auth, Vonage
from vonage_messages import WhatsappCustom

client = Vonage(
    Auth(
        application_id=VONAGE_APPLICATION_ID,
        private_key=VONAGE_PRIVATE_KEY,
    )
)

message = WhatsappCustom(
    to=MESSAGES_TO_NUMBER,
    from_=WHATSAPP_SENDER_ID,
    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"}],
            }
        ],
    },
)

response = client.messages.send(message)
print(response)

View full source

Run your code

Save this file to your machine and run it:

python messages/whatsapp/send-contact.py

Prerequisites

If you do not have an application you can create one. Make sure you also configure your webhooks.

gem install vonage

Create a file named send-contact.rb and add the following code:

View full source

Write the code

Add the following to send-contact.rb:

View full source

Run your code

Save this file to your machine and run it:

ruby send-contact.rb

Try 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.