Send a Video Message
In this code snippet you learn how to send a video message through WhatsApp using the Messages API. For WhatsApp the maximum outbound media size is 64MB.
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 Vonage. For sandbox testing the number is 14157386170. |
TO_NUMBER |
Replace with the number you are sending to. E.g. 447700900001
|
VIDEO_URL |
The link to the video to send. WhatsApp supports .mp4 and .3gpp . Note, only H.264 video codec and AAC audio codecs are supported. |
VIDEO_CAPTION |
The text describing the video being sent. |
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-video.sh
:
curl -X POST $MESSAGES_API_URL \
-H 'Authorization: Bearer '$JWT \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d $'{
"from": { "type": "whatsapp", "number": "'$WHATSAPP_NUMBER'" },
"to": { "type": "whatsapp", "number": "'$TO_NUMBER'" },
"message": {
"content": {
"type": "video",
"video": {
"url": "'$VIDEO_URL'",
"caption": "'$VIDEO_CAPTION'"
}
}
}
}'
Run your code
Save this file to your machine and run it:
bash send-video.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-video.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: 'video',
video: {
url: VIDEO_URL,
},
},
},
(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-video.js
Try it out
When you run the code a video message is sent to the WhatsApp recipient.