SMS-ассистент — документация для разработчиков
Отправка одиночных Viber-сообщений. VIBER API PLAIN
Запрос для отправки одиночного Viber‑сообщения
Параметры запроса
чёрный — обязательные параметры
серый — необязательные параметры
серый — необязательные параметры
URL
https://userarea.sms-assistent.by/api/v1.2/send_viber/plain
Пример GET запроса
https://userarea.sms-assistent.by/api/v1.2/send_viber/plain?user=ваш_логин&password=пароль_для_API&sender=отправитель&recipient=ХХХХХХХХХ&message=текст_сообщения
Описание тегов в запросе
user
ваш логин, для доступа в Личный кабинет (ЛК)
password
ваш пароль к API, который генерируется на странице «SMS-рассылка» — «Рассылка по API»
sender
отправитель Viber-сообщений (подпись)
recipient
номер получателя (в возможном формате)
message
текст Viber-сообщения
viber_image
параметр рекламного Viber-сообщения — URL изображения в формате PNG, JPG, JPEG
viber_button_caption
параметр рекламного Viber-сообщения — заголовок кнопки
viber_button_url
параметр рекламного Viber-сообщения — URL с рекламной информацией, на который будет переход после нажатия на кнопку в сообщении
viber_sms_resend
параметр SMS-сообщения — признак необходимости отправки SMS-сообщения, в случае, если приложение Viber не установлено или не активировано у абонента.
viber_sms_text
параметр SMS-сообщения — текст SMS
viber_sms_sender
параметр SMS-сообщения — отправитель SMS (подпись)
webhook_url
адрес (URL) вашего сайта, на который будет отправлен отчёт о доставке Viber-сообщения после того, как статус доставки у этого Viber-сообщения поменяется.
Подробнее по формату отчёта о доставке см. здесь.
Подробнее по формату отчёта о доставке см. здесь.
name
наименование, которое необходимо присвоить рассылке. По наименованию в последующем можно фильтровать рассылки в разделе «Отправленные».
validity_period
срок жизни Viber-сообщения в часах. Максимальный срок жизни составляет 14 суток (336 часов). Рекомендуемое значение в часах = 24. Значения > 336 часов не обрабатываются (в этом случае выставляется значение равное 24).
Происходят следующие проверки:
Происходят следующие проверки:
- значение параметра в диапазоне от 1 до 336 воспринимается как часы;
- значение параметра в диапазоне от 337 до 3599 воспринимается как ошибочное, по умолчанию присваивается 24 ч;
- в диапазоне от 3600 до 1 209 600 воспринимается как передача данных в секундах;
- значение больше, чем 1 209 600, воспринимается как ошибочное и выставляется по умолчанию 24 ч.
date_send
дата отправки Viber-сообщения (передается только в том случае, если необходимо отправить запланированную рассылку).
Формат: ГГГГММДДЧЧММ. Например, передаем значение 202112250159 для того, чтобы запланировать рассылку на 25 декабря 2021 г. на 1ч 59 м.
Дата запланированной рассылки должна быть не меньше, чем текущая дата +10 минут
Формат: ГГГГММДДЧЧММ. Например, передаем значение 202112250159 для того, чтобы запланировать рассылку на 25 декабря 2021 г. на 1ч 59 м.
Дата запланированной рассылки должна быть не меньше, чем текущая дата +10 минут
Ответ в случае успешной обработки запроса
возвращается код результата выполнения операции