Send a Location

In this code snippet you learn how to send a location 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 Location 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`	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.
`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-location.sh:

curl -X POST $MESSAGES_API_URL \
     -H 'Authorization: Bearer' $JWT \
     -H 'Content-Type: application/json' \
     -d '{
  "message_type": "custom",
  "to": "$TO_NUMBER",
  "from": "$WHATSAPP_NUMBER",
  "channel": "whatsapp",
  "custom": {
    "type": "location",
    "location": {
      "longitude": -122.425332,
      "latitude": 37.758056,
      "name": "Facebook HQ",
      "address": "1 Hacker Way, Menlo Park, CA 94025"
    }
  }
}'

View full source

Run your code

Save this file to your machine and run it:

bash send-location.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@beta

Write the code

Add the following to send-location.js:

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

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,
    }
);

vonage.channel.send(
    { type: 'whatsapp', number: TO_NUMBER },
    { type: 'whatsapp', number: WHATSAPP_NUMBER },
    {
        content: {
            type: 'custom',
            custom: {
                type: 'location',
                location: {
                    longitude: -122.425332,
                    latitude: 37.758056,
                    name: 'Facebook HQ',
                    address: '1 Hacker Way, Menlo Park, CA 94025',
                },
            },
        },
    },
    (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-location.js

Try it out

When you run the code a WhatsApp location message is sent to the destination number. The location appears as a pin on a map within the WhatsApp message window.

Further information

Improve this page