Send a Video Message
In this code snippet you learn how to send a video message through Facebook Messenger using the Messages API.
For a step-by-step guide to this topic, you can read our tutorial Sending Facebook Messenger messages with the Messages API.
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. |
FB_SENDER_ID |
Your Page ID. The FB_SENDER_ID is the same as the to.id value you received in the inbound messenger event on your Inbound Message Webhook URL. For sandbox testing this is 107083064136738 . |
VONAGE_FB_SENDER_ID |
Refer to FB_SENDER_ID above |
FROM_ID |
Refer to FB_SENDER_ID above |
FB_RECIPIENT_ID |
The PSID of the user you want to reply to. The FB_RECIPIENT_ID is the PSID of the Facebook User you are messaging. This value is the from.id value you received in the inbound messenger event on your Inbound Message Webhook URL. |
TO_ID |
Refer to FB_RECIPIENT_ID above. |
VIDEO_URL |
The link to the video to send. Messenger supports MP4 (.mp4 ) file format only. |
Prerequisites
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' \
-d $'{
"message_type": "video",
"video": {
"url": "$VIDEO_URL"
},
"to": "$FB_RECIPIENT_ID",
"from": "$FB_SENDER_ID",
"channel": "messenger"
}'
Run your code
Save this file to your machine and run it:
bash send-video.sh
Prerequisites
npm install @vonage/server-sdk
Create a file named send-video.js
and add the following code:
const Vonage = require('@vonage/server-sdk');
const MessengerVideo = require('@vonage/server-sdk/lib/Messages/MessengerVideo');
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,
}
);
Write the code
Add the following to send-video.js
:
vonage.messages.send(
new MessengerVideo({ url: VIDEO_URL }, FB_RECIPIENT_ID, FB_SENDER_ID),
(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
Prerequisites
Add the following to `build.gradle`:
compile 'com.vonage:client:6.2.0'
Create a class named SendMessengerVideo
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();
Write the code
Add the following to the main
method of the SendMessengerVideo
class:
var message = MessengerVideoRequest.builder()
.from(FROM_ID).to(TO_ID)
.url("https://file-examples.com/storage/fee788409562ada83b58ed5/2017/04/file_example_MP4_640_3MG.mp4")
.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;
}
}
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.messenger
with the package containing SendMessengerVideo
:
gradle run -Pmain=com.vonage.quickstart.messages.messenger.SendMessengerVideo
Prerequisites
Install-Package Vonage
Write the code
Add the following to SendMessengerVideo.cs
:
var credentials = Credentials.FromApiKeyAndSecret(
apiKey,
apiSecret
);
var vonageClient = new VonageClient(credentials);
var request = new MessengerVideoRequest
{
To = to,
From = brandName,
Video = new Attachment
{
Url = "https://example.com/video.mp4"
}
};
var response = await vonageClient.MessagesClient.SendAsync(request);
Prerequisites
pip install vonage
Write the code
Add the following to send_video.py
:
client = vonage.Client(
application_id=VONAGE_APPLICATION_ID,
private_key=VONAGE_APPLICATION_PRIVATE_KEY_PATH,
)
client.messages.send_message(
{
"channel": "messenger",
"message_type": "video",
"to": FB_RECIPIENT_ID,
"from": VONAGE_FB_SENDER_ID,
"video": {"url": "https://www.example.com/video.mp4"},
}
)
Run your code
Save this file to your machine and run it:
python3 send_video.py
Prerequisites
gem install vonage
Write the code
Add the following to send-video.rb
:
client = Vonage::Client.new(
application_id: VONAGE_APPLICATION_ID,
private_key: File.read(VONAGE_APPLICATION_PRIVATE_KEY_PATH)
)
message = Vonage::Messaging::Message.messenger(
type: 'video',
message: {
url: "https://example.com/video.mp4"
}
)
client.messaging.send(
from: VONAGE_FB_SENDER_ID,
to: FB_RECIPIENT_ID,
**message
)
Run your code
Save this file to your machine and run it:
ruby send-video.rb
Try it out
When you run the code a video message is sent to the Messenger recipient.