Viber API

1. Home
2. Integrations
3. API
4. Viber

Create a Viber Campaign

To create a Viber campaign, send a POST request to:

Request parameters:

You can use either address_book, or recipients parameter to specify a list of recipients, one of these parameters is required.

You can send the following types of messages:

• System or promo (text only): message parameter only;
• Promo (text + button + image):  message, button, image parameters;
• Promo (text + button): message, button parameters;
• Promo (image): image parameter.

Please note:  when you send a system message ("message_type": 3), the text in the message parameter is checked. It must match the text of the approved template.  You can add and submit a template for approval in your personal account after registering a sender.

Request example to send a message of the Text+Button+Image format:

{
   "recipients":[ // recipients array
      380931111111,
      380931111112,
      380931111113
   ],
   "address_book":null,
    // there are two options avalable: send either an address book ID, or an array of recipients (1000 recipients maximum)
   "message":"Margaret, you have been approved for a 50% discount on all items in the Cosmetics category",
   "message_type":2,
   "message_live_time":1000, //seconds (60 seconds minimum, maximum 86400 seconds(24 hours),
   "sender_id":1, //id of the active user, the campaign will be sent from
   "send_date":"now", // or date in the following format YYYY-MM-DD HH:ii:ss
   "additional":{
      "button":{
         "text":"Buy all cosmetics",
         "link":"https://sendpulse.com/"
      },
      "image":{
         "link":"https://sendpulse.com/images/image.png"
      },
      "resend_sms":{
         "status":true,
         "sms_text":"Text of the sms message",
         "sms_sender_name":"sendpulse"
      }
   }
}

Request example to send a message containing only text:

{
  "recipients": [
    // array of recipients
    380931111111,
    380931111112,
    380931111113
  ],
  "address_book": null,
  // There are two options: either send the address book ID, or send the recipients array, 1000 recipients maximum
  "message": "Margaret, you have been approved for a 50% discount on all items in the "Cosmetics" category",
  // max lenghth is 1000 symbols
  "message_type": 2,
  "message_live_time": 1000,
  //seconds (min 60seconds, max 86400 seconds(24 hours),
  "sender_id": 1,
  //id of an active sender name
  "send_date": "now", 
  // or date in the following format YYYY-MM-DD HH:ii:ss
  "additional": {
    "resend_sms": {
       //status indicating that re-sending is engaged
        "status" : true,
        // sms text
        "sms_text" : "Text of the sms message",
        // sender name sms
        "sms_sender_name" : "sendpulse"
    }
  }
}

Request example to send a message containing only an image:

{
    "recipients": [
      // array of recipients
      380931111111,
      380931111112,
      380931111113
    ],
    "address_book": null,
    // There are two options: either send the address book ID, or send the recipients array, 1000 recipients maximum
    "message": null,    
    "message_type": 2,
    "message_live_time": 1000,
    //seconds (min 60s, max 86400s (24 hrs)
    "sender_id": 1,
    //ID of an active sender name
    "send_date": "now",
    // or date in the following format YYYY-MM-DD HH:ii:ss
    "additional": {
      // additional data
      "image": {
        // image in the message
        "link": "https://sendpulse.com/images/image.png" 
        //image link
      },
      "resend_sms": {
       //status indicating resend option is turned on
        "status" : true,
        // sms text
        "sms_text" : "Text of the sms",
        // sms sender name
        "sms_sender_name" : "sendpulse"
       }
    }
}

Request example to send a message containing text + button:

{
   "recipients":[
      // array of recipients
      380931111111,
      380931111112,
      380931111113
   ],
   "address_book":null,
   // either send the address book ID, or send the recipients array,
   "message":"Margaret, you have been approved for a 50% discount on all items in the ""Cosmetics"" category",
   // max lenghth is 1000 symbols
   "message_type":2,
   "message_live_time":1000,
   //seconds (min 60 seconds, max 86400 seconda(24 hours),
   "sender_id":1,
   "send_date":"now",
   "additional":{
      "button":{
         "text":"Buy all cosmetics",
         "link":"https://sendpulse.com"
      },
      "resend_sms":{
         "status":true,
         "sms_text":"Text of the sms",
         "sms_sender_name":"sendpulse"
      }
   }
}

Request example to send gradually:

{
   "recipients":[
      380683850429
   ],
   "message":"Test",
   "message_type":2,
   "message_live_time":1000,
   "sender_id":4647,
   "send_date":"now",
   "stretch_time":1
}

If request is successful, you will receive a response:

{
    "result": true,
    "data": {
        "address_book_id": null,
        "button_link": null,
        "button_text": null,
        "image_link": null,
        "message":  "Margaret, you have been approved for a 50% discount on all items in the "Cosmetics" category",
        "message_live_time": "1000",
        "message_type": 3,
        "resend_sms": 0,
        "send_date": "2019-03-26 12:40:05",
        "sender_id": 4501,
        "sms_sender_name": null,
        "sms_text": null,
        "task_id": 90241,
        "task_name": "Viber campaign for the personal list on 2019-03-26 12:40"
    }
}

Edit a Viber Campaign

To edit a Viber campaign, send a POST request to:

Request parameters:

{
    "result": true,
    "data": {
        "address_book_id": null,
        "button_link": null,
        "button_text": null,
        "image_link": null,
        "message": "Margaret, you have been approved for a 50% discount on all items in the "Cosmetics" category",
        "message_live_time": "1000",
        "message_type": "3",
        "send_date": "2019-03-26 15:16:00",
        "sender_id": "4495",
        "task_id": 9380939,
        "task_name": "Viber campaign for the personal list on 2019-03-26 15:15"
    }
}

{
    "data": {
        "result": true
    }
}

[
    {
        "id": 9380939,
        "name": "Viber campaign for the personal list on 2019-03-26 15:02",
        "message":  "Jane, you have been approved for a 50% discount on all items in the "Cosmetics" category",
        "button_text": null,
        "button_link": null,
        "image_link": null,
        "address_book": null,
        "sender_name": "YAMAMAY",
        "sender_id": 4495,
        "message_live_time": 1000,
        "send_date": "2019-03-29 10:00:00",
        "status": "moderation",
        "created": "2019-03-26 12:50:02"
    },
    {
        "id": 9380926,
        "name": "Viber campaign for the personal list on 2019-03-26 14:48",
        "message":  "Margaret, you have been approved for a 50% discount on all items in the "Cosmetics" category",
        "button_text": null,
        "button_link": null,
        "image_link": null,
        "address_book": 0,
        "sender_name": "YAMAMAY",
        "sender_id": 4495,
        "message_live_time": 1000,
        "send_date": "2019-03-29 10:00:00",
        "status": null,
        "created": "2019-03-26 12:48:23"
    }
]

{
    "id": 38,
    "name": "Viber_Campaign_38",
    "message": "Viber message text",
    "button_text": "Button",
    "button_link": "https://sendpulse.com",
    "image_link": null,
    "address_book": null,
    "sender_name": "infoservice",
    "send_date": "2017-06-22 09:51:35",
    "status": "send",
    "statistic": {
        "send": 1,
        "delivered": 1,
        "read": 0,
        "redirected": 0,
        "undelivered": 0,
        "errors": 0
    },
    "created": "2017-06-22 09:51:22" 
}

[
   {
      "id": 1,
      "status": "verified",
      "name": "myName",
      "service_type": "Test service",
      "web_site": "https://www.sendpulse.com",
      "description": "We are testing the final variant of the message",
      "country": "UK",
      "traffic_type": "Public information",
      "admin_comment": "Your name has been approved, thank you for choosing our service. Sendpulse team" 
   }
]

{
    "id": 1,
    "status": "verified",
    "name": "infoservice",
    "service_type": "Test service",
    "web_site": "https://www.sendpulse.com",
    "description": "We are testing the final variant of the message",
    "country": "UK",
    "traffic_type": "Public information",
    "admin_comment": "Your name has been approved, thank you for choosing our service. Sendpulse team" 
}

{
    "task_id": 44,
    "recipients": [
        {
           "phone": 380934760182,
           "address_book_id": 850852,
           "status": "send",
           "send_date": "2017-06-23 08:54:01",
           "price": 0.74,
           "currency": "RUR",
           "last_update": "2017-06-23 08:53:38" 
        }
    ]
}

Get a List of Contacts in the Blacklist

To get a list of contacts in the blacklist, send a GET request to:

Request parameter:

If request is successful, you will receive a response: 

{
    "data": {
        "list": [
           {
                "id": 164,
                "user_id": 7046460,
                "phone": 73832370050,
                "description": "",
                "add_date": "2021-11-05 13:34:03"
            },
            {
                "id": 165,
                "user_id": 7046460,
                "phone": 73912050915,
                "description": "",
                "add_date": "2021-11-05 13:34:03"
            }
        ],
        "total": 29
    }
}

Add Phone Number to the Blacklist 

To add a phone number to the blacklist, send a POST request to:

Request parameter:

If request is successful, you will receive a response: 

{
    "result": true,
    "counters": {
        "added": 7,
        "exists": 0
    }
}

Remove a Phone Number from the Blacklist 

To remove a phone number from the blacklist, send a DELETE request to:

Request parameter:

If request is successful, you will receive a response: 

{
    "result": true,
    "deleted": 7
}