Viber Bulk Message API

Use the Viber Bulk Message API to upload recipient files and send bulk Viber campaigns with text, image, document, video, template, and fallback channel payloads.

Viber Bulk Message API

Campaign Upload File

Upload a file containing the phone numbers to which the campaign will be sent. The file_code returned in the response is used in subsequent bulk message APIs.

Endpoint details

Field	Value
Endpoint URL	https://apis.rmlconnect.net/viber-file-uploader/v1/upload_file
Method	`POST`
Content-Type	`application/json`
Authentication Required	Yes

Request headers

Header	Value	Description
Content-Type	`application/json`	Specifies the media type of the request body.
Authorization	`Bearer <your-auth-token>`	Replace with your valid token from the login API.

Request parameters

Field	Type	Required	Description
file	file	Yes	CSV file from cloud.

Request body

[
  {
    "key": "file",
    "type": "file",
    "value": [
      "postman-cloud:///1f0f828c-62e9-4fd0-94a5-85a62bfda6fa"
    ]
  }
]

Response

{
  "status": "success",
  "process_type": "sync",
  "process_type_reason": "mime type :text/csv,file size less than 10.0 MB",
  "file_code": "3fZDNAtVUiiyc8FdZ4eAjN",
  "total_records": 2,
  "duplicate_records": 0,
  "valid_records": 2,
  "invalid_records": 0,
  "file_preview": {
    "msisdn": "917021072986",
    "_country_code": 91
  },
  "file_size": "0.000 MB"
}

Text Bulk Message

Send bulk text messages to users through Viber.

Endpoint details

Field	Value
Endpoint URL	https://apis.rmlconnect.net/viber-bulk/api/v3/send_bulk
Method	`POST`
Content-Type	`application/json`
Authentication Required	Yes

Request headers

Header	Value	Description
Content-Type	`application/json`	Specifies the media type of the request body.
Authorization	`Bearer <your-auth-token>`	Replace with your valid token from the login API.

Request parameters

Field	Type	Required	Description
file_code	string	Yes	File code received in the Campaign Upload File response.
campaign_name	string	Yes	Name of the campaign.
personalised	string	Yes	Enter `false`.
payload	object	Yes	Message payload details.
message_type	string	Yes	Type of message. Use `text`.
method	string	Yes	Type of message: Promotional or Transactional.
text	string	Yes	Plain text message content.

Request body

{
  "file_code": "3fZDNAtVUiiyc8FdZ4eAjN",
  "campaign_name": "test",
  "personalised": false,
  "payload": {
    "message_type": "text",
    "method": "transaction",
    "text": "Test Message"
  }
}

Response

{
  "status": "success",
  "message": "campaign with id 731bdc3c-0745-11f1-951b-0242ac110005 is now processing",
  "campaign_id": "731bdc3c-0745-11f1-951b-0242ac110005"
}

Image Bulk

Send bulk image messages to users through Viber.

Endpoint details

Field	Value
Endpoint URL	https://apis.rmlconnect.net/viber-bulk/api/v3/send_bulk
Method	`POST`
Content-Type	`application/json`
Authentication Required	Yes

Request parameters

Field	Type	Required	Description
file_code	string	Yes	File code received in the Campaign Upload File response.
campaign_name	string	Yes	Name of the campaign.
personalised	string	Yes	Enter `false`.
payload	object	Yes	Message payload details.
message_type	string	Yes	Type of message. Use `image`.
method	string	Yes	Type of message: Promotional or Transactional.
image	string	Yes	PNG image URL.

Request body

{
  "file_code": "3fZDNAtVUiiyc8FdZ4eAjN",
  "campaign_name": "test",
  "personalised": false,
  "payload": {
    "message_type": "image",
    "method": "promotion",
    "img": "https://nextgen-vbm.s3.ap-south-1.amazonaws.com/demo_03287b07748a6d2a3fbd31d211ac89e588fa7e888e1e17fbffab84b81dcd79d1.png"
  }
}

Response

{
  "status": "success",
  "message": "campaign with id 731bdc3c-0745-11f1-951b-0242ac110005 is now processing",
  "campaign_id": "731bdc3c-0745-11f1-951b-0242ac110005"
}

Text + Image Message

Send bulk text and image messages to users through Viber.

Endpoint details

Field	Value
Endpoint URL	https://apis.rmlconnect.net/viber-bulk/api/v3/send_bulk
Method	`POST`
Content-Type	`application/json`
Authentication Required	Yes

Request parameters

Field	Type	Required	Description
file_code	string	Yes	File code received in the Campaign Upload File response.
campaign_name	string	Yes	Name of the campaign.
personalised	string	Yes	Enter `false`.
payload	object	Yes	Message payload details.
message_type	string	Yes	Type of message. Use `text_image`.
method	string	Yes	Type of message: Promotional or Transactional.
text	string	Yes	Plain text message content.
img	string	Yes	Image URL.

Request body

{
  "file_code": "3fZDNAtVUiiyc8FdZ4eAjN",
  "campaign_name": "test",
  "personalised": false,
  "payload": {
    "message_type": "text_image",
    "method": "promotion",
    "img": "https://nextgen-vbm.s3.ap-south-1.amazonaws.com/demo_03287b07748a6d2a3fbd31d211ac89e588fa7e888e1e17fbffab84b81dcd79d1.png",
    "text": "hi bulk"
  }
}

Response

{
  "status": "success",
  "message": "campaign with id 731bdc3c-0745-11f1-951b-0242ac110005 is now processing",
  "campaign_id": "731bdc3c-0745-11f1-951b-0242ac110005"
}

Text + Button + Image

Send bulk text, button, and image messages to users through Viber.

Endpoint details

Field	Value
Endpoint URL	https://apis.rmlconnect.net/viber-bulk/api/v3/send_bulk
Method	`POST`
Content-Type	`application/json`
Authentication Required	Yes

Request parameters

Field	Type	Required	Description
file_code	string	Yes	File code received in the Campaign Upload File response.
campaign_name	string	Yes	Name of the campaign.
personalised	string	Yes	Enter `false`.
payload	object	Yes	Message payload details.
message_type	string	Yes	Type of message. Use `template`.
method	string	Yes	Type of message: Promotional or Transactional.
text	string	Yes	Plain text message content.
button_text	string	Yes	Text shown on the button.
button_link	string	Yes	Landing link opened when the button is clicked.
image	string	Yes	PNG image to show in the message.

Request body

{
  "file_code": "3fZDNAtVUiiyc8FdZ4eAjN",
  "campaign_name": "test",
  "personalised": false,
  "payload": {
    "message_type": "template",
    "method": "promotion",
    "button_text": "test",
    "button_link": "https://google.com/",
    "text": "test",
    "img": "https://nextgen-vbm.s3.ap-south-1.amazonaws.com/demo_03287b07748a6d2a3fbd31d211ac89e588fa7e888e1e17fbffab84b81dcd79d1.png"
  }
}

Response

{
  "status": "success",
  "message": "campaign with id 731bdc3c-0745-11f1-951b-0242ac110005 is now processing",
  "campaign_id": "731bdc3c-0745-11f1-951b-0242ac110005"
}

Send Bulk Document

Send a bulk document message to users through Viber.

Endpoint details

Field	Value
Endpoint URL	https://apis.rmlconnect.net/viber-bulk/api/v3/send_bulk
Method	`POST`
Content-Type	`application/json`
Authentication Required	Yes

Request parameters

Field	Type	Required	Description
file_code	string	Yes	File code received in the Campaign Upload File response.
campaign_name	string	Yes	Name of the campaign.
personalised	string	Yes	Enter `false`.
payload	object	Yes	Message payload details.
message_type	string	Yes	Type of message. Use `file`.
method	string	Yes	Type of message: Promotional or Transactional.
file_url	string	Yes	URL of the PDF file.
file_name	string	Yes	File name.

Request body

{
  "file_code": "3fZDNAtVUiiyc8FdZ4eAjN",
  "campaign_name": "test",
  "personalised": false,
  "payload": {
    "message_type": "file",
    "method": "transaction",
    "file_url": "https://nextgen-vbm.s3.ap-south-1.amazonaws.com/demo_e90b6e6e1e584bc3930b77b9d8eaf5541290110539c24366e27319411287ea98.pdf",
    "file_name": "test"
  }
}

Response

{
  "status": "success",
  "message": "campaign with id 731bdc3c-0745-11f1-951b-0242ac110005 is now processing",
  "campaign_id": "731bdc3c-0745-11f1-951b-0242ac110005"
}

Send Bulk Video

Send bulk video messages to users through Viber.

Endpoint details

Field	Value
Endpoint URL	https://apis.rmlconnect.net/viber-bulk/api/v3/send_bulk
Method	`POST`
Content-Type	`application/json`
Authentication Required	Yes

Request parameters

Field	Type	Required	Description
file_code	string	Yes	File code received in the Campaign Upload File response.
campaign_name	string	Yes	Name of the campaign.
personalised	string	Yes	Enter `false`.
payload	object	Yes	Message payload details.
message_type	string	Yes	Type of message. Use `video`.
method	string	Yes	Type of message: Promotional or Transactional.
video	string	Yes	Video URL.
thumbnail_url	string	Yes	PNG image used as the thumbnail.

Request body

{
  "file_code": "3fZDNAtVUiiyc8FdZ4eAjN",
  "campaign_name": "test",
  "personalised": false,
  "payload": {
    "message_type": "video",
    "method": "promotion",
    "video": "https://nextgen-vbm.s3.ap-south-1.amazonaws.com/demo_05bd857af7f70bf51b6aac1144046973bf3325c9101a554bc27dc9607dbbd8f5.mp4",
    "thumbnail_url": "https://nextgen-vbm.s3.ap-south-1.amazonaws.com/path/to/thumbnail.jpg"
  }
}

Response

{
  "status": "success",
  "message": "campaign with id 731bdc3c-0745-11f1-951b-0242ac110005 is now processing",
  "campaign_id": "731bdc3c-0745-11f1-951b-0242ac110005"
}

Send Bulk Text + Video

Send bulk text and video messages to users through Viber.

Endpoint details

Field	Value
Endpoint URL	https://apis.rmlconnect.net/viber-bulk/api/v3/send_bulk
Method	`POST`
Content-Type	`application/json`
Authentication Required	Yes

Request parameters

Field	Type	Required	Description
file_code	string	Yes	File code received in the Campaign Upload File response.
campaign_name	string	Yes	Name of the campaign.
personalised	string	Yes	Enter `false`.
payload	object	Yes	Message payload details.
message_type	string	Yes	Type of message. Use `text_video`.
method	string	Yes	Type of message: Promotional or Transactional.
text	string	Yes	Plain text message content.
video	string	Yes	Video URL.
thumbnail_url	string	Yes	PNG image used as the thumbnail.
schedule_datetime	string	Yes	Date and time of the message in `YYYY-MM-DD HH:mm:ss` format.
timezone	string	Yes	Timezone from where the message was sent.

Request body

{
  "file_code": "3fZDNAtVUiiyc8FdZ4eAjN",
  "campaign_name": "test campaign",
  "personalised": false,
  "payload": {
    "message_type": "text_video",
    "method": "promotion",
    "video": "https://nextgen-vbm.s3.ap-south-1.amazonaws.com/demo_05bd857af7f70bf51b6aac1144046973bf3325c9101a554bc27dc9607dbbd8f5.mp4",
    "text": "test",
    "thumbnail_url": "https://nextgen-vbm.s3.ap-south-1.amazonaws.com/demo_9dc30e900d843592a4d78d6870cf9bd6e78c9a409a50311453af33dee9c6ca25.png"
  },
  "schedule_datetime": "2025-01-21 12:56:00",
  "timezone": "Asia/Kolkata"
}

Response

{
  "status": "success",
  "message": "campaign with id 731bdc3c-0745-11f1-951b-0242ac110005 is now processing",
  "campaign_id": "731bdc3c-0745-11f1-951b-0242ac110005"
}

Send Video + Text + Action

Send bulk video, text, and action button messages to users through Viber.

Endpoint details

Field	Value
Endpoint URL	https://apis.rmlconnect.net/viber-bulk/api/v3/send_bulk
Method	`POST`
Content-Type	`application/json`
Authentication Required	Yes

Request parameters

Field	Type	Required	Description
file_code	string	Yes	File code received in the Campaign Upload File response.
campaign_name	string	Yes	Name of the campaign.
personalised	string	Yes	Enter `false`.
payload	object	Yes	Message payload details.
message_type	string	Yes	Type of message. Use `video_text_action_button`.
method	string	Yes	Type of message: Promotional or Transactional.
text	string	Yes	Plain text message content.
video	string	Yes	Video URL.
thumbnail_url	string	Yes	PNG image used as the thumbnail.
button	object	Yes	Button details.
button_url	string	Yes	Landing URL opened when the button is clicked.
button_text	string	Yes	Text shown on the button.
schedule_datetime	string	Yes	Date and time of the message in `YYYY-MM-DD HH:mm:ss` format.
timezone	string	Yes	Timezone from where the message was sent.

Request body

{
  "file_code": "3fZDNAtVUiiyc8FdZ4eAjN",
  "campaign_name": "test campaign",
  "personalised": true,
  "payload": {
    "message_type": "video_text_action_button",
    "method": "promotion",
    "video": "https://nextgen-vbm.s3.ap-south-1.amazonaws.com/demo_05bd857af7f70bf51b6aac1144046973bf3325c9101a554bc27dc9607dbbd8f5.mp4",
    "text": "Test",
    "thumbnail_url": "https://nextgen-vbm.s3.ap-south-1.amazonaws.com/demo_9dc30e900d843592a4d78d6870cf9bd6e78c9a409a50311453af33dee9c6ca25.png",
    "button": {
      "button_url": "https://routemobile.com/",
      "button_text": "Hi"
    }
  },
  "schedule_datetime": "2025-01-21 12:56:00",
  "timezone": "Asia/Kolkata"
}

Response

{
  "status": "success",
  "message": "campaign with id 731bdc3c-0745-11f1-951b-0242ac110005 is now processing",
  "campaign_id": "731bdc3c-0745-11f1-951b-0242ac110005"
}

Text Template (Transactional) Message

Send bulk transactional text template messages to users through Viber.

Endpoint details

Field	Value
Endpoint URL	https://apis.rmlconnect.net/viber-bulk/api/v3/send_bulk
Method	`POST`
Content-Type	`application/json`
Authentication Required	Yes

Request parameters

Field	Type	Required	Description
file_code	string	Yes	File code received in the Campaign Upload File response.
campaign_name	string	Yes	Name of the campaign.
personalised	string	Yes	Enter `false`.
payload	object	Yes	Message payload details.
message_type	string	Yes	Type of message. Use `text_template`.
method	string	Yes	Type of message: Promotional or Transactional.
text	string	Yes	Plain text message content.
tracking_data	string	Yes	Tracking data for the request.

Request body

{
  "file_code": "QaQkBy39AGHbVus6GPy4wg",
  "campaign_name": "test campaign",
  "personalised": false,
  "payload": {
    "message_type": "text_template",
    "method": "promotion",
    "text": "test",
    "tracking_data": "test"
  }
}

Response

{
  "status": "success",
  "message": "campaign with id 731bdc3c-0745-11f1-951b-0242ac110005 is now processing",
  "campaign_id": "731bdc3c-0745-11f1-951b-0242ac110005"
}

Fallback Channels — Bulk Message API

Use fallback channels to route a Viber bulk campaign through another channel when fallback is required.

Fallback to SMS (Bulk)

Request body

{
  "file_code": "3fZDNAtVUiiyc8FdZ4eAjN",
  "campaign_name": "test",
  "personalised": false,
  "payload": {
    "message_type": "image",
    "method": "promotion",
    "img": "https://nextgen-vbm.s3.ap-south-1.amazonaws.com/demo_03287b07748a6d2a3fbd31d211ac89e588fa7e888e1e17fbffab84b81dcd79d1.png",
    "fallback_channel": "sms",
    "fallback_sms": {
      "fallback_sender": "ALOTSL",
      "fallback_username": "AlotPromo",
      "fallback_text": "We'\\''re providing WhatsApp Marketing Solutions is the easy marketing strategy for your business Call 8080888131 alotsolutions.com",
      "template_id": "507167343822070952",
      "tm_id": "1702160915855670817",
      "pe_id": "1201159179954058607"
    }
  }
}

Response

{
  "status": "success",
  "message": "campaign with id c9e3b44e-33e7-11f1-951b-0242ac110005 is now processing",
  "campaign_id": "c9e3b44e-33e7-11f1-951b-0242ac110005"
}

Fallback to WhatsApp (Bulk)

Request body

{
  "file_code": "3fZDNAtVUiiyc8FdZ4eAjN",
  "campaign_name": "test",
  "personalised": false,
  "payload": {
    "message_type": "image",
    "method": "promotion",
    "img": "https://nextgen-vbm.s3.ap-south-1.amazonaws.com/demo_03287b07748a6d2a3fbd31d211ac89e588fa7e888e1e17fbffab84b81dcd79d1.png",
    "fallback_channel": "whatsapp",
    "fallback_whatsapp": {
      "fallback_sender": "ALOTSL",
      "fallback_username": "AlotPromo",
      "fallback_text": "We'\\''re providing WhatsApp Marketing Solutions is the easy marketing strategy for your business Call 8080888131 alotsolutions.com",
      "template_id": "507167343822070952",
      "tm_id": "1702160915855670817",
      "pe_id": "1201159179954058607"
    }
  }
}

Response

{
  "status": "success",
  "message": "campaign with id c3240cb2-33e7-11f1-951b-0242ac110005 is now processing",
  "campaign_id": "c3240cb2-33e7-11f1-951b-0242ac110005"
}