Send a File Message

In this code snippet you learn how to send a file 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.
`FILE_URL`	The link to the file to send. Can be ZIP, CSV, PDF or any other type supported by Messenger.

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-file.sh:

curl -X POST $MESSAGES_API_URL \
     -H 'Authorization: Bearer '$JWT \
     -H 'Content-Type: application/json' \
     -d $'{
  "message_type": "file",
  "file": {
    "url": "'$FILE_URL'"
  },
  "to": "'$FB_RECIPIENT_ID'",
  "from": "'$FB_SENDER_ID'",
  "channel": "messenger"
}'

View full source

Run your code

Save this file to your machine and run it:

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

const { Vonage } = require('@vonage/server-sdk');
const { MessengerFile } = require('@vonage/messages');

const vonage = new Vonage({
  applicationId: VONAGE_APPLICATION_ID,
  privateKey: VONAGE_PRIVATE_KEY,
});

View full source

Write the code

Add the following to send-file.js:

vonage.messages.send(
  new MessengerFile({
    file: {
      url: FILE_URL,
    },
    to: FB_RECIPIENT_ID,
    from: FB_SENDER_ID,
  }),
)
  .then(({ messageUUID}) => console.log(messageUUID))
  .catch((error) => console.error(error));

View full source

Run your code

Save this file to your machine and run it:

node send-file.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:

implementation 'com.vonage:server-sdk-kotlin:1.1.2'

Create a file named SendMessengerFile and add the following code to the main method:

val client = Vonage {
    applicationId(VONAGE_APPLICATION_ID)
    privateKeyPath(VONAGE_APPLICATION_PRIVATE_KEY_PATH)
}

View full source

Write the code

Add the following to the main method of the SendMessengerFile file:

val messageId = client.messages.send(
    messengerFile {
        to(FB_RECIPIENT_ID)
        from(VONAGE_FB_SENDER_ID)
        url(FILE_URL)
    }
)

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.kt.messages.messenger with the package containing SendMessengerFile:

gradle run -Pmain=com.vonage.quickstart.kt.messages.messenger.SendMessengerFile

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:

implementation 'com.vonage:server-sdk:8.15.1'

Create a file named SendMessengerFile and add the following code to the main method:

VonageClient client = VonageClient.builder()
		.applicationId(VONAGE_APPLICATION_ID)
		.privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
		.build();

View full source

Write the code

Add the following to the main method of the SendMessengerFile file:

var response = client.getMessagesClient().sendMessage(
		MessengerFileRequest.builder()
			.from(VONAGE_FB_SENDER_ID)
			.to(FB_RECIPIENT_ID)
			.url(FILE_URL)
			.build()
);
System.out.println("Message sent successfully. ID: "+response.getMessageUuid());

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.messenger with the package containing SendMessengerFile:

gradle run -Pmain=com.vonage.quickstart.messages.messenger.SendMessengerFile

Prerequisites

If you do not have an application you can create one. Make sure you also configure your webhooks.

Install-Package Vonage

Write the code

Add the following to SendMessengerFile.cs:

var credentials = Credentials.FromAppIdAndPrivateKeyPath(appId, privateKeyPath);

var vonageClient = new VonageClient(credentials);

var request = new MessengerFileRequest
{
    To = to,
    From = brandName,
    File = new Attachment
    {
        Url = "https://examples.com/file.pdf"
    }
};

var response = await vonageClient.MessagesClient.SendAsync(request);

View full source

Prerequisites

If you do not have an application you can create one. Make sure you also configure your webhooks.

composer require vonage/client

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

$keypair = new \Vonage\Client\Credentials\Keypair(
    file_get_contents(VONAGE_APPLICATION_PRIVATE_KEY_PATH),
    VONAGE_APPLICATION_ID
);

$client = new \Vonage\Client($keypair);

View full source

Write the code

Add the following to send-file.php:

$fileObject = new \Vonage\Messages\MessageObjects\FileObject(
    'https://example.com/file.pdf',
);

$message = new \Vonage\Messages\Channel\Messenger\MessengerFile(
    TO_NUMBER,
    FROM_NUMBER,
    $fileObject
);

$client->messages()->send($message);

View full source

Run your code

Save this file to your machine and run it:

php send-file.php

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

from vonage import Auth, Vonage
from vonage_messages.models import MessengerFile, MessengerResource

client = Vonage(
    Auth(
        application_id=VONAGE_APPLICATION_ID,
        private_key=VONAGE_APPLICATION_PRIVATE_KEY_PATH,
    )
)

message = MessengerFile(
    to=FB_RECIPIENT_ID,
    from_=VONAGE_FB_SENDER_ID,
    file=MessengerResource(url=FILE_URL),
)

response = client.messages.send(message)
print(response)

View full source

Run your code

Save this file to your machine and run it:

python send-file.py

Prerequisites

If you do not have an application you can create one. Make sure you also configure your webhooks.

gem install vonage

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

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

View full source

Write the code

Add the following to send-file.rb:

message = Vonage::Messaging::Message.messenger(
  type: 'file',
  message: {
    url: "https://example.com/file.pdf"
  }
)

client.messaging.send(
  from: VONAGE_FB_SENDER_ID,
  to: FB_RECIPIENT_ID,
  **message
)

View full source

Run your code

Save this file to your machine and run it:

ruby send-file.rb

Try it out

When you run the code a file message is sent to the Messenger recipient.