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' \
     -d '{
  "message_type": "custom",
  "to": "447700900000",
  "from": "447700900001",
  "channel": "whatsapp",
  "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

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

const Vonage = require('@vonage/server-sdk');
const WhatsAppCustom = require('@vonage/server-sdk/lib/Messages/WhatsAppCustom');

const vonage = new Vonage(
    {
        apiKey: VONAGE_API_KEY,
        apiSecret: VONAGE_API_SECRET,
        applicationId: VONAGE_APPLICATION_ID,
        privateKey: VONAGE_APPLICATION_PRIVATE_KEY_PATH,
    },
    {
        apiHost: BASE_URL,
    }
);

View full source

Write the code

Add the following to send-contact.js:

vonage.messages.send(
    new WhatsAppCustom(
        {
            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',
                        },
                    ],
                },
            ],
        },
        TO_NUMBER,
        WHATSAPP_NUMBER,
    ),
    (err, data) => {
        if (err) {
            console.error(err);
        } else {
            console.log(data.message_uuid);
        }
    }
);

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`:

compile 'com.vonage:client:6.2.0'

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();

MessagesClient messagesClient = client.getMessagesClient();

View full source

Write the code

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

var message = WhatsappCustomRequest.builder()
        .from(VONAGE_WHATSAPP_NUMBER).to(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();

try {
    MessageResponse response = messagesClient.sendMessage(message);
    System.out.println("Message sent successfully. ID: "+response.getMessageUuid());
}
catch (MessageResponseException mrx) {
    switch (mrx.getStatusCode()) {
        default: throw mrx;
        case 401: // Bad credentials
            throw new IllegalStateException(mrx.getTitle(), mrx);
        case 422: // Invalid
            throw new IllegalStateException(mrx.getDetail(), mrx);
        case 402: // Low balance
            client.getAccountClient().topUp("transactionID");
            break;
        case 429: // Rate limit
            Thread.sleep(12_000);
            break;
    }
}

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.

pip install vonage

Write the code

Add the following to send_contact.py:

CONTACTS = {
    "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"}],
        }
    ],
}

import vonage

client = vonage.Client(
    application_id=VONAGE_APPLICATION_ID,
    private_key=VONAGE_APPLICATION_PRIVATE_KEY_PATH,
)


client.messages.send_message(
    {
        "channel": "whatsapp",
        "message_type": "custom",
        "to": TO_NUMBER,
        "from": FROM_NUMBER,
        "custom": CONTACTS,
    }
)

View full source

Run your code

Save this file to your machine and run it:

python3 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

Write the code

Add the following to send-contact.rb:

client = Vonage::Client.new(
  application_id: VONAGE_APPLICATION_ID,
  private_key: File.read(VONAGE_APPLICATION_PRIVATE_KEY_PATH)
)

message = Vonage::Messaging::Message.whatsapp(
  type: 'custom',
  message: {
    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"
          }
        ]
      }
    ]
  }
)

client.messaging.send(
  from: VONAGE_WHATSAPP_NUMBER,
  to: TO_NUMBER,
  **message
)

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.

Further information