Send a Message Template

In this code snippet you learn how to send a Facebook message template using a custom object with the Messages API.

Example

Ensure the following variables are set to your required values using any convenient method:

KeyDescription
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.

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.

LOGO_IMAGE_URL

An optional logo image.

HEADER_IMAGE_URL

An optional header image.

ABOVE_BAR_CODE_IMAGE_URL

An optional image for above the bar code.

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

View full source

Run your code

Save this file to your machine and run it:

bash send-template.sh

Try it out

When you run the code a Facebook message template is sent to the recipient. In this example the message is an airline boarding pass.

Further information