Send a WhatsApp Media Message Template

In this code snippet you learn how to send a WhatsApp Media Message Template using the Messages API.

To send the Media Message Template you need to use the Messages custom object. The custom object takes a partial section of the original WhatsApp API request and sends it directly through to WhatsApp.

IMPORTANT: If a customer messages you, you have 24 hours to respond to the customer with a free form message. After this period you must use a template message (MTM). If a customer has not messaged you first, then the first time you send a message to a user, WhatsApp requires that the message contains a template. This is explained in more detail in the Understanding WhatsApp topic.

Message format and length restrictions

WhatsApp Media Message Templates consist of a Header, Body and Footer structure. The Header contains the media, which can be text, location, video, image or file. The Body contains the text message. This is currently limited to 1024 characters when displayed to the end user, so as to avoid the need for scrolling. The Footer is optional and contains static text only.

NOTE: The Header and Footer lengths are currently limited to 60 characters each and the Message body length is limited to 1024 characters.

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.
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
WHATSAPP_TEMPLATE_NAMESPACE The namespace ID found in your WhatsApp Business Account. Only templates created in your own namespace will work. Using an template with a namespace outside of your own results in an error code 1022 being returned. For sandbox testing the supported namespace is 9b6b4fcb_da19_4a26_8fe8_78074a91b584.
WHATSAPP_TEMPLATE_NAME The name of the template created in your WhatsApp Business Account. For sandbox testing the verify template is currently available. Refer to this table for new templates as they become available.

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-media-mtm.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": "template",
    "template": {
      "namespace": "$WHATSAPP_TEMPLATE_NAMESPACE",
      "name": "$WHATSAPP_TEMPLATE_NAME",
      "language": {
        "policy": "deterministic",
        "code": "en"
      },
      "components": [
        {
          "type": "header",
          "parameters": [
            {
              "type": "location",
              "location": {
                "longitude": -122.425332,
                "latitude": 37.758056,
                "name": "Facebook HQ",
                "address": "1 Hacker Way, Menlo Park, CA 94025"
              }
            }
          ]
        },
        {
          "type": "body",
          "parameters": [
            {
              "type": "text",
              "text": "Value 1"
            },
            {
              "type": "text",
              "text": "Value 2"
            },
            {
              "type": "text",
              "text": "Value 3"
            }
          ]
        }
      ]
    }
  }
}'

View full source

Run your code

Save this file to your machine and run it:

bash send-media-mtm.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-media-template.js and add the following code:

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

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-media-template.js:

vonage.messages.send(
    new WhatsAppTemplate(
        {
            name: `${WHATSAPP_TEMPLATE_NAMESPACE}:${WHATSAPP_TEMPLATE_NAME}`,
            components: [
                {
                    type: 'header',
                    parameters: [
                        {
                            type: 'location',
                            location: {
                                longitude: -122.425332,
                                latitude: 37.758056,
                                name: 'Facebook HQ',
                                address: '1 Hacker Way, Menlo Park, CA 94025',
                            },
                        },
                    ],
                },
                {
                    type: 'body',
                    parameters: [
                        {
                            type: 'text',
                            text: 'Value 1',
                        },
                        {
                            type: 'text',
                            text: 'Value 2',
                        },
                        {
                            type: 'text',
                            text: 'Value 3',
                        },
                    ],
                },
            ],
        },
        {
            policy: 'deterministic',
            locale: 'en',
        },
        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-media-template.js

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_media_template.py:

MEDIA_TEMPLATE = {
    "type": "template",
    "template": {
        "namespace": WHATSAPP_TEMPLATE_NAMESPACE,
        "name": WHATSAPP_TEMPLATE_NAME,
        "language": {"policy": "deterministic", "code": "en"},
        "components": [
            {
                "type": "header",
                "parameters": [
                    {
                        "type": "location",
                        "location": {
                            "longitude": -122.425332,
                            "latitude": 37.758056,
                            "name": "Facebook HQ",
                            "address": "1 Hacker Way, Menlo Park, CA 94025",
                        },
                    }
                ],
            },
            {
                "type": "body",
                "parameters": [
                    {"type": "text", "text": "Value 1"},
                    {"type": "text", "text": "Value 2"},
                    {"type": "text", "text": "Value 3"},
                ],
            },
        ],
    },
}

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": MEDIA_TEMPLATE,
    }
)

View full source

Run your code

Save this file to your machine and run it:

python3 send_media_template.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-media-mtm.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: "template",
    template: {
      namespace: WHATSAPP_TEMPLATE_NAMESPACE,
      name: WHATSAPP_TEMPLATE_NAME,
      language: {
        policy: "deterministic",
        code: "en"
      },
      components: [
        {
          type: "header",
          parameters: [
            {
              type: "location",
              location: {
                longitude: -122.425332,
                latitude: 37.758056,
                name: "Facebook HQ",
                address: "1 Hacker Way, Menlo Park, CA 94025"
              }
            }
          ]
        },
        {
          type: "body",
          parameters: [
            {
              type: "text",
              text: "Value 1"
            },
            {
              type: "text",
              text: "Value 2"
            },
            {
              type: "text",
              text: "Value 3"
            }
          ]
        }
      ]
    }
  }
)

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-media-mtm.rb

Try it out

When you run the code a WhatsApp Media Message Template is sent to the destination number.

Further information