Viber-рассылки

Создать Viber рассылку

Для отправки Viber рассылки отправляется POST запрос по ссылке

https://mailer-api.i.bizml.ru/viber

Параметры ответа:

task_id ID записи (int)
task_name имя кампании
message текст сообщения
button_text текст на кнопке, если не указан, вернет NULL
button_link ссылка для перехода, если не указано, вернет NULL
image_link адрес картинки если не указано, вернет NULL
address_book адресная книга, если использовался ручной ввод, вернет NULL
sender_id ID отправителя который был при отправки
message_live_time время жизни сообщения(секунд)
send_date время отправки

Пример запроса на отправку сообщения формата текст + кнопка + картинка

{

"recipients": [

// массив получателей

380931111111,

380931111112,

380931111113

],

"address_book": null,

// два варианта или же отправляем ID адресной книги, или же список получателей массивом, максимум 1000 получателей

"message": "Ирина, вы получили скидку 50% на все товары в категории "Косметика" до 14.07.2017",

// длина максимум 1000 символов

"message_live_time": 1000,

//секунд (минимум 60с, максимум 86400 секунд(24 часа),

"sender_id": 1,

//id активного имени отправителя от которого пойдет отправка

"send_date": "now",

// или время в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС

"additional": {

// дополнительные данные

"button": {

//кнопка в сообщении

"text": "Купить всю косметику",

//текст на кнопке

"link": "https://annbakery.ru/"

// ссылка для перехода при клике

},

"image": {

// картинка в сообщении

"link": "https://annbakery.ru/images/image.png"

//ссылка на картинку

},

"resend_sms": {

//статус того, что переотправка включена

"status" : true,

// текст sms сообщения

"sms_text" : "Текст sms сообщения",

// имя отправителя smsс

"sms_sender_name" : "sendbox"

}

}

}

Пример запроса на отправку сообщения только с текстом

{

"recipients": [

// массив получателей

380931111111,

380931111112,

380931111113

],

"address_book": null,

// два варианта или же отправляем ID адресной книги, или же список получателей массивом, максимум 1000 получателей

"message": "Ирина, вы получили скидку 50% на все товары в категории "Косметика" до 14.07.2017",

// длина максимум 1000 символов

"message_live_time": 1000,

//секунд (минимум 60с, максимум 86400 секунд(24 часа),

"sender_id": 1,

//id активного имени отправителя от которого пойдет отправка

"send_date": "now",

// или время в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС

"additional": {

"resend_sms": {

//статус того, что переотправка включена

"status" : true,

// текст sms сообщения

"sms_text" : "Текст sms сообщения",

// имя отправителя sms

"sms_sender_name" : "sendbox"

}

}

}

Пример запроса на отправку сообщения только с картинкой

{

"recipients": [

// массив получаетелей

380931111111,

380931111112,

380931111113

],

"address_book": null,

// два варианта или же отправляем ID адресной книги, или же список получателей массивом, максимум 1000 получателей

"message": null,

// длина максимум 1000 символов

"message_live_time": 1000,

//секунд (минимум 60с, максимум 86400 секунд(24 часа),

"sender_id": 1,

//id активного имени отправителя от которого пойдет отправка

"send_date": "now",

// или время в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС

"additional": {

// дополнительные данные

"image": {

// картинка в сообщении

"link": "https://annbakery.ru/images/image.png"

//ссылка на картинку

},

"resend_sms": {

//статус того, что переотправка включена

"status" : true,

// текст sms сообщения

"sms_text" : "Текст sms сообщения",

// имя отправителя sms

"sms_sender_name" : "sendbox"

}

}

}

Пример запроса на отправку сообщения формата текст + кнопка

{

"recipients": [

// массив получаетелей

380931111111,

380931111112,

380931111113

],

"address_book": null,

// два варианта или же отправляем ID адресной книги, или же список получателей массивом, максимум 1000 получателей

"message": "Ирина, вы получили скидку 50% на все товары в категории "Косметика" до 14.07.2017",

// длина максимум 1000 символов

"message_live_time": 1000,

//секунд (минимум 60с, максимум 86400 секунд(24 часа),

"sender_id": 1,

//id активного имени отправителя от которого пойдет отправка

"send_date": "now",

// или время в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС

"additional": {

// дополнительные данные

"button": {

//кнопка в сообщении

"text": "Купить всю косметику",

//текст на кнопке

"link": "https://annbakery.ru"

// ссылка для перехода при клике

},

"resend_sms": {

//статус того что переотправка включена

"status" : true,

// текст sms сообщения

"sms_text" : "Текст sms сообщения",

// имя отправителя sms

"sms_sender_name" : "sendbox"

}

}

}


Пример ответа:

[

'result' => true,

'data' => [

'task_id' => 12345,

'task_name' => "Моя вайбер рассылка",

'message' => "Первая вайбер рассылка",

'button_text' => "Кнопка",

'button_link' => "https://annbakery.ru",

'image_link' => "https://annbakery.ru/images/image.png",

'address_book_id' => 1234456,

'sender_id' => 123,

'message_live_time' => 450,

'send_date' => 2017-07-25 14:54:25,

]

];

Получить список рассылок

Чтобы получить список рассылок, отправляется GET запрос по ссылке

https://mailer-api.i.bizml.ru/viber/task

Параметры запроса:

limit целое число больше 0 (необязательный параметр)
offset целое число больше или равно 0 (необязательный параметр)

Параметры ответа:

id номер записи
name имя кампании
message текст сообщения
button_text текст на кнопке, если не указан, вернет NULL
button_link ссылка для перехода, если не указано, вернет NULL
image_link адрес картинки если не указано, вернет NULL
address_book_id адресная книга, если использовался ручной ввод, вернет NULL
sender_name имя отправителя которое использовали при отправке
sender_id ID отправителя который был при отправки
message_live_time время жизни сообщения(секунд)
send_date время отправки
status статус задания
created дата создания

Пример ответа:

[

'id' => 123,

'name' => "Моя компания",

'message' => "Первое сообщение",

'button_text' => "Кнопка",

'button_link' => "https://annbakery.ru",

'image_link' => "https://annbakery.ru/images/image.png",

'address_book' => 12313,

'sender_name' => "sendbox",

'sender_id' => 12

'send_date' => 2017-08-25 14:55:05,

'status' => "sent",

'created' => "2017-06-25 12:14:55"

]

Получить статистику по рассылке

Для получения статистики по рассылке отправляется GET запрос по ссылке

https://mailer-api.i.bizml.ru/viber/task/{id}

Параметры ответа:

  номер записи
name имя кампании
message текст сообщения
button_text текст на кнопке, если не указан, вернет NULL
button_link ссылка для перехода, если не указано, вернет NULL
image_link адрес картинки если не указано, вернет NULL
address_book_id адресная книга, если использовался ручной ввод, вернет NULL
sender_name имя отправителя которое использовали при отправке
sender_id ID отправителя который был при отправки
message_live_time время жизни сообщения(секунд)
send_date время отправки
status статус задания
sent отправлено
delivered доставлено
read прочитано
redirected выполнено переходов по кнопке
undelivered не доставлено
errors ошибок
created дата создания

Пример ответа, если рассылка существует:

{

"id": 38,

"name": "Viber_Campaign_38",

"message": "Это текст для вайбер сообщения",

"button_text": "Кнопка",

"button_link": "https://annbakery.ru",

"image_link": null,

"address_book": null,

"sender_name": "infoservice",

"send_date": "2017-06-22 09:51:35",

"status": "sent",

"statistic": {

"sent": 1,

"delivered": 1,

"read": 0,

"redirected": 0,

"undelivered": 0,

"errors": 0

},

"created": "2017-06-22 09:51:22"

}

Получить список имен отправителя

Для получения статистики по рассылке отправляется GET запрос по ссылке

https://mailer-api.i.bizml.ru/viber/senders

Параметры ответа:

id номер записи
status текущий статус имени
name имя, от которого будут приходить сообщения
service_type тип сервиса
web_site веб сайт
description описание сервиса
country страна для отправки
traffic_type тип трафика
admin_comment комментарий администратора, если комментарий существует придет текст, иначе NULL

Пример ответа:

[

{

"id": 1,

"status": "verified",

"name": "myName",

"service_type": "Тестовый сервис",

"web_site": "https://www.annbakery.ru",

"description": "Мы тестируем финульную отправку сообщений",

"country": "UA",

"traffic_type": "Публичная информация",

"admin_comment": "Ваши имя одобрено, спасибо что выбрали наш сервис для отправки вайбер сообщений. Команда Sendbox"

}

]

Получить одно имя отправителя

Для получения одного имени отправителя отправляется GET запрос по ссылке

https://mailer-api.i.bizml.ru/viber/senders/{id}

Параметры ответа:

id номер записи
status текущий статус имени
name имя, от которого будут приходить сообщения
service_type тип сервиса
web_site веб сайт
description описание сервиса
country страна для отправки
traffic_type тип трафика
admin_comment комментарий администратора, если комментарий существует придет текст, иначе NULL

Пример ответа:

{

"id": 1,

"status": "verified",

"name": "infoservice",

"service_type": "Тестовый сервис",

"web_site": "https://www.annbakery.ru",

"description": "Мы тестируем финульную отправку сообщений",

"country": "UA",

"traffic_type": "Публичная информация",

"admin_comment": "Ваши имя одобрено, спасибо что выбрали наш сервис для отправки вайбер сообщений. Команда Sendbox" 

}

Получить список получателей в Viber рассылке

Для получения одного имени отправителя отправляется GET запрос по ссылке

https://mailer-api.i.bizml.ru/viber/task/{id}/recipients

Параметры ответа:

task_id ID кампании
recipients массив получателей
phone номер телефона получателя
address_book_id ID адресной книги в которой был номер телефона, если же ручной ввод вернет NULL
status статус сообщения на этот номер (отправлено, доставлено, доставлено и прочитано, доставлено и прочитано и был переход, не доставлено, ошибка)
sent_date время отправки
price цена за данное сообщения
currency текущая валюта пользователя и стоимость сообщения указана в этой валюте
last_update последнее обновление статистики

Пример ответа:

{

"task_id": 44,

"recipients": [

{

"phone": 380934760182,

"address_book_id": 850852,

"status": "send",

"sent_date": "2017-06-23 08:54:01",

"price": 0.74,

"currency": "RUR",

"last_update": "2017-06-23 08:53:38"

}

]

}