Создать Viber рассылку
Для отправки Viber рассылки отправляется POST запрос по ссылке
https://api.sendpulse.com/viber |
Параметры запроса:
task_name | имя кампании | ||
message_type* | тип сообщения: тип 2 — рекламное, тип 3 — системное |
||
sender_id | id активного имени отправителя от которого пойдет отправка; метод получения sender_id описан тут тут, для этого у пользователя должно быть зарегистрировано имя отправителя в настройках сервиса |
||
message_live_time | время жизни сообщения(секунд), минимум 60с, максимум 86400 секунд (24 часа) | ||
sent_date | время отправки. now если необходимо отправить сразу, или указать время в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС если нужно запланировать |
||
address_book* | идентификатор адресной книги | ||
recipients* | массив телефонов в json формате [380931111111,380931111112, 380931111113] |
||
message* | текст сообщения, длина максимум 1000 символов | ||
additional | дополнительные параметры | ||
button* | параметры кнопки | ||
text | текст на кнопке | ||
link | ссылка на кнопке | ||
image* | параметры картинки | ||
link | ссылка на загруженную картинку | ||
resend_sms | функция переотправки сообщения через смс сервис | ||
status | true если включен, false если выключен |
||
sms_text | текст смс сообщения | ||
sms_sender_name | имя отправителя смс |
Примечание: можно использовать параметр address_book
или recipients
для указания списка получателей, один из двух параметров обязательный
Существуют такие типы сообщений:
- Системное или рекламное (только текст): только параметр
message
; - Рекламное (текст + кнопка + картинка): параметры:
message
,button
,image
; - Рекламное (текст + кнопка): параметры:
message
,button
; - Рекламное (картинка): параметры:
image
.
Обратите внимание, что при отправке системного сообщения ("message_type":3
) проверяется текст в параметре message
. Он должен совпадать с текстом одобренного шаблона. Подать шаблон на регистрацию вы можете в личном кабинете после регистрации отправителя.
Пример запроса на отправку сообщения формата текст + кнопка + картинка:
{
"recipients": [380931111111,380931111112, 380931111113],
//два варианта или же отправляем ID адресной книги,
или же список получателей массивом, сейчас выбрали массив получателей
"message":"Ирина, вы получили скидку 50% на все товары в категории " Косметика" до 14.07.2017",
// длина максимум 1000 символов
"message_type":2,
"message_live_time":1000, //секунд (минимум 60с, максимум 86400 секунд(24 часа),
"sender_id":1, //id активного имени отправителя от которого пойдет отправка
"send_date":"now", // или время в формате ГГГГ-ММ-ДД ЧЧ: ММ: СС
"additional": { // дополнительные данные
"button":{ //кнопка в сообщении
"text":"Купить всю косметику", //текст на кнопке
"link":"https://sendpulse.com/" // ссылка для перехода при клике
},
"image":{ // картинка в сообщении
"link":"https://sendpulse.com/images/image.png" //ссылка на картинку
},
"resend_sms":{ //статус того, что переотправка включена
"status":true,
"sms_text":"Текст sms сообщения", // текст sms сообщения
"sms_sender_name":"sendpulse" // имя отправителя sms
}
}
}
Пример запроса на отправку сообщения только с текстом:
{
"recipients": [380931111111,380931111112, 380931111113],
//два варианта или же отправляем ID адресной книги,
или же список получателей массивом, сейчас выбрали массив получателей
"message":"Ирина, вы получили скидку 50% на все товары в категории " Косметика" до 14.07.2017",
// длина максимум 1000 символов",
"message_type": 2,
"message_live_time":1000, //секунд (минимум 60с, максимум 86400 секунд(24 часа),
"sender_id":2222, // id активного имени отправителя от которого пойдет отправка
"send_date":"now" // или время в формате ГГГГ-ММ-ДД ЧЧ: ММ: СС
}
Пример запроса на отправку сообщения только с картинкой:
{
"recipients": [380931111111,380931111112, 380931111113],
//два варианта или же отправляем ID адресной книги,
или же список получателей массивом, сейчас выбрали массив получателей
"message":null
"message_type":2,
"message_live_time":1000, //секунд (минимум 60с, максимум 86400 секунд(24 часа),
"sender_id":1, //id активного имени отправителя от которого пойдет отправка
"send_date":"now", // или время в формате ГГГГ-ММ-ДД ЧЧ: ММ: СС
"additional":{ // дополнительные данные
"image":{ // картинка в сообщении
"link":"https://sendpulse.com/images/image.png" //ссылка на картинку
},
"resend_sms":{ //статус того, что переотправка включена
"status":true,
"sms_text":"Текст sms сообщения", // текст sms сообщения
"sms_sender_name":"sendpulse" // имя отправителя sms
}
}
}
Пример запроса на отправку сообщения формата текст + кнопка:
{
"recipients": [380931111111,380931111112, 380931111113],
//два варианта или же отправляем ID адресной книги,
или же список получателей массивом, сейчас выбрали массив получателей
"message":"Ирина, вы получили скидку 50% на все товары в категории " Косметика" до 14.07.2018",
// длина максимум 1000 символов
"message_type": 2,
"message_live_time":1000, //секунд (минимум 60с, максимум 86400 секунд(24 часа),
"sender_id":2222, // id активного имени отправителя от которого пойдет отправка
"send_date":"now", // или время в формате ГГГГ-ММ-ДД ЧЧ: ММ: СС
"additional":{ // дополнительные данные
"button":{ //кнопка в сообщении
"text":"Купить всю косметику", //текст на кнопке
"link":"https://sendpulse.com" // ссылка для перехода при клике
},
"resend_sms":{ //статус того, что переотправка включена
"status":true,
"sms_text":"Текст sms сообщения", // текст sms сообщения
"sms_sender_name":"sendpulse" // имя отправителя sms
}
}
}
Пример ответа:
{
"result": true,
"data": {
"address_book_id": null,
"button_link": null,
"button_text": null,
"image_link": null,
"message": "Ciao! Вас вітає офіційний viber-канал бренду Yamamay та нагадує, що Ви - найчарівніша.",
"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"
}
}
Редактировать запланированную VIber рассылку
Чтобы редактировать Viber рассылку, отправляется POST запрос по ссылке
https://api.sendpulse.com/viber/update |
Параметры запроса:
main_task_id | ID записи (int) |
task_name | имя кампании |
message | текст сообщения |
message_type | тип сообщения: тип 2 — рекламное, тип 3 — системное *обязательный параметр |
button_text | текст на кнопке, если не указан, вернет NULL |
button_link | ссылка для перехода, если не указано, вернет NULL |
image_link | адрес картинки, если не указано, вернет NULL |
address_book | адресная книга, если использовался ручной ввод, вернет NULL |
sender_id | ID отправителя, который был при отправке *обязательный параметр метод получения sender_id описан тут для этого у пользователя должно быть зарегистрировано имя отправителя в настройках сервиса |
message_live_time | время жизни сообщения(секунд) |
sent_date | время отправки |
Пример ответа:
{
"result": true,
"data": {
"address_book_id": null,
"button_link": null,
"button_text": null,
"image_link": null,
"message": "Ciao! Ciao Ciao Ciao Ciao Вас вітає офіційний viber-канал бренду Yamamay та нагадує, що Ви - найчарівніша.",
"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"
}
}
Получить список рассылок
Чтобы получить список рассылок, отправляется GET запрос по ссылке
https://api.sendpulse.com/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 | время жизни сообщения(секунд) |
sent_date | время отправки |
status | статус задания |
created | дата создания |
Пример ответа:
[
{
"id": 9380939,
"name": "Viber campaign for the personal list on 2019-03-26 15:02",
"message": "Ciao! Ciao Ciao Ciao Ciao Вас вітає офіційний viber-канал бренду Yamamay та нагадує, що Ви - найчарівніша.",
"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": "Ciao! Вас вітає офіційний viber-канал бренду Yamamay та нагадує, що Ви - найчарівніша.",
"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"
}
]
Получить статистику по рассылке
Для получения статистики по рассылке отправляется GET запрос по ссылке
https://api.sendpulse.com/viber/task/{id} |
Параметры ответа:
id | идентификатор кампании | |
name |
название кампании
|
|
message | текст сообщения | |
button_text | текст на кнопке, если не указан, вернет null | |
button_link | ссылка для перехода, если не указано, вернет null | |
image_link |
адрес картинки если не указано, вернет null
|
|
address_book_id |
адресная книга, если использовался ручной ввод, вернет null
|
|
sender_name |
имя отправителя, которое использовали при отправке
|
|
sent_date |
время отправки
|
|
status |
статус отправки кампании
|
|
statistic | статистика отправленной кампании | |
sent | количество отправленных | |
delivered | количество доставленных | |
read | количество открытых | |
redirected | количество переход по ссылке | |
undelivered | количество недоставленных | |
errors | количество ошибок (абонент не является пользователем вайбера) | |
created | дата создания |
Пример ответа:
{
"id": 38,
"name": "Viber_Campaign_38",
"message": "Это текст для вайбер сообщения",
"button_text": "Кнопка",
"button_link": "https://sendpulse.com",
"image_link": null,
"address_book": null,
"sender_name": "infoservice",
"sent_date": "2017-06-22 09:51:35",
"status": "send",
"statistic": {
"sent": 1,
"delivered": 1,
"read": 0,
"redirected": 0,
"undelivered": 0,
"errors": 0
},
"created": "2017-06-22 09:51:22"
}
Получить список имен отправителя
Для получения статистики по рассылке отправляется GET запрос по ссылке
https://api.sendpulse.com/viber/senders |
Параметры ответа:
id | номер записи |
status | текущий статус имени |
name | имя, от которого будут приходить сообщения |
service_type | тип сервиса |
web_site | веб сайт |
description | описание сервиса |
country | страна для отправки |
traffic_type | тип трафика |
admin_comment | комментарий администратора, если комментарий существует придет текст, иначе NULL |
Пример ответа:
[
{
"id": 2222,
"status": "verified",
"name": "Foxkids",
"service_type": "Магазин iграшок",
"web_site": "www.foxkids.com",
"description": "Магазин Foxkids –«Королівство іграшок» де знайдете багато речей, необхідних для комфорту і розвитку вашого малюка",
"countries": [
"UA"
],
"traffic_type": "Рекламные сообщения",
"admin_comment": null,
"owner": "you"
}
]
Получить одно имя отправителя
Для получения одного имени отправителя отправляется GET запрос по ссылке
https://api.sendpulse.com/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.sendpulse.com",
"description": "Мы тестируем финальную отправку сообщений",
"country": "UA",
"traffic_type": "Публичная информация",
"admin_comment": "Ваше имя одобрено, спасибо что выбрали наш сервис для отправки вайбер сообщений. Команда Sendpulse"
}
Получить список получателей в Viber рассылке
Для получения одного имени отправителя отправляется GET запрос по ссылке
https://api.sendpulse.com/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"
}
]
}
Регистрация через соцсети
Войти через Facebook Войти через Google