Send an image Message

In this code snippet you will see how to send a Viber image message using the Messages API.

NOTE: It is important that you read this information about Viber accounts and messaging before trying this code snippet.

For a step-by-step guide to this topic, you can read our tutorial Sending Viber Service messages with the Messages API.

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`.
`NEXMO_APPLICATION_ID`	The ID of the application that you created.
`VIBER_SERVICE_MESSAGE_ID`	Your Viber Service Message ID. For sandbox testing this is `16273`.
`TO_NUMBER`	The phone number you are sending the message to.
`IMAGE_URL`	The URL of the image you want to send.

NOTE: Don't use a leading + or 00 when entering a phone number, start with the country code, for example, 447700900000.

Prerequisites

Create an application

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

Copy to Clipboard

curl -X POST $MESSAGES_API_URL \
  -H 'Authorization: Bearer '$JWT\
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d $'{
    "from": { "type": "viber_service_msg", "id": "'$VIBER_SERVICE_MESSAGE_ID'" },
    "to": { "type": "viber_service_msg", "number": "'$TO_NUMBER'" },
    "message": {
       "content": {
          "type": "image",
          "image": {
            "url": "'$IMAGE_URL'"
          }
       }
    }  
}'

View full source

Run your code

Save this file to your machine and run it:

bash send-image.sh

Prerequisites

Create an application

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

Install dependencies

npm install nexmo@beta

Write the code

Add the following to send-image.js:

Copy to Clipboard

const Nexmo = require('nexmo');

const nexmo = new Nexmo(
    {
        apiKey: NEXMO_API_KEY,
        apiSecret: NEXMO_API_SECRET,
        applicationId: NEXMO_APPLICATION_ID,
        privateKey: NEXMO_APPLICATION_PRIVATE_KEY_PATH,
    },
    {
        apiHost: BASE_URL,
    }
);

nexmo.channel.send(
    { type: 'viber_service_msg', number: TO_NUMBER },
    { type: 'viber_service_msg', id: VIBER_SERVICE_MESSAGE_ID },
    {
        content: {
            type: 'image',
            image: {
                url: IMAGE_URL,
            },
        },
    },
    (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-image.js

Try it out

When you run the code a Viber image message is sent to the destination number.