Пакетная (массовая) отправка Viber-сообщений. viber XML API

Запрос для отправки пакета Viber-сообщений


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

чёрный — обязательные параметры
серый — необязательные параметры
Тело запроса
<?xml version="1.0" encoding="UTF-8"?>
<package command="viber_send" login="username" password="password" name="Название рассылки" webhook_url="http://callback.yourdomain.by/" date_send="Дата отправки" viber_image="Изображение" viber_button_caption="Заголовок кнопки" viber_button_url="Ссылка на кнопке" viber_sms_resend="1" viber_sms_sender="Имя отправителя">
<message>
<default sender="TEST-assist" validity_period="24" recipient="+375293262625" sms_text="Текст SMS по умолчанию"/>
<msg recipient="295363600" sender="notdefault" validity_period="24">Текст Viber-сообщения</msg>
<msg recipient="8(029)326-26-25" template_id="1" tags_replace="{TAG1}::подстановка1;;{TAG2}" />
<msg recipient="8(029)536-36-00" sender="notdefault" sms_text="Текст SMS индивидуальный">Текст Viber-сообщения</msg>
</message>
</package>
В случае отправки запросов с количеством Viber-сообщений больше 3000, в запрос необходимо вставлять строчку: <!DOCTYPE package SYSTEM «send_sms.dtd»>
Описание тегов в запросе
package
тег, в котором указываются основные параметры запроса:
command
тип запроса, всегда viber_send
login
ваш логин, для доступа в Личный кабинет (ЛК)
password
ваш пароль к API, который генерируется на странице «SMS-рассылка» — «Рассылка по API»
name
наименование, которое необходимо присвоить рассылке. По наименованию в последующем можно фильтровать рассылки в разделе «Отправленные». Параметр необязательный.
webhook_url
адрес (URL) вашего сайта, на который будет отправлен отчёт о доставке Viber-сообщения после того, как статус доставки у этого Viber-сообщения поменяется. Подробнее про формат отчёта о доставке см. здесь
date_send
дата отправки Viber-сообщения (передается только в том случае, если необходимо отправить запланированную рассылку).
Формат: ГГГГММДДЧЧММ. Например, передаем значение 202112250159 для того, чтобы запланировать рассылку на 25 декабря 2021 г. на 1ч 59м.
Дата запланированной рассылки должна быть не меньше, чем текущая дата +10 минут
viber_image
параметр рекламного Viber-сообщения — URL изображения в формате PNG, JPG, JPEG
viber_button_caption
параметры рекламного Viber-сообщения — заголовок кнопки
viber_button_url
параметр рекламного Viber-сообщения — URL с рекламной информацией, на который будет переход после нажатия на кнопку в сообщении
viber_sms_resend
параметр SMS-сообщения — признак необходимости отправки SMS-сообщения, в случае, если у абонента не установлено или не активировано приложение Viber
viber_sms_sender
параметр SMS-сообщения — отправитель SMS (подпись)

default
параметры по умолчанию для всех отправляемых Viber-сообщений. Применяется только в том случае, если параметры опущены из тега msg для конкретных сообщений. Можно указывать параметры: sender, validity_period, recipient, sms_text (значение параметров ниже в описании тега msg)

msg
тег-массив с получателями Viber-сообщений. Может содержать атрибуты:
recipient
номер получателя (в возможном формате)
validity_period
срок жизни Viber-сообщения в часах. Максимальный срок жизни составляет 14 суток (336 часов). Рекомендуемое значение в часах = 24. Значения > 336 часов не обрабатываются (в этом случае выставляется значение равное 24).

Происходят следующие проверки:

  • значение параметра в диапазоне от 1 до 336 воспринимается как часы;
  • значение параметра в диапазоне от 337 до 3599 воспринимается как ошибочное, по умолчанию присваивается 24 ч;
  • в диапазоне от 3600 до 1 209 600 воспринимается как передача данных в секундах;
  • значение больше, чем 1 209 600, воспринимается как ошибочное и выставляется по умолчанию 24 ч.
template_id
код шаблона текста Viber-сообщения, который создается в ЛК. В шаблоне текста Viber-сообщения можно использовать собственные теги. Тогда, при отправке Viber-сообщения по API, вместо тегов можно передать параметры на подстановку. Это позволит вам в ЛК менять текст Viber-сообщения без изменения программного кода выполнения запросов по API. Получить код шаблона можно по json запросу get_templates или по запросу в службу технической поддержки.
tags_replace
параметр, в котором передаются значения на замену пользовательских метатегов. Работает только при использовании template_id. Формат: ПАРАМЕТР1:ЗНАЧЕНИЕ_ПАРАМЕТРА1;;ПАРАМЕТР2:ЗНАЧЕНИЕ_ПАРАМЕТРА2
sms_text
параметры SMS-сообщения — текст SMS

Ответ после отправки Viber-сообщений


Тело ответа

<?xml version="1.0" encoding="utf-8" ?>
<package>
<message>
<msg message_id="12345678" message_count="1" operator="2" recipient="+375295363600" />
<msg message_id="0" message_count="0" operator="0" recipient="+375293262625">-4</msg>
</message>
</package>

Описание тегов в ответе

msg
тег Viber-сообщения, в качестве параметра возвращается код ошибки (если не удалось обработать сообщение), может содержать атрибуты:
message_id
числовой идентификатор Viber-сообщения, который вы получили в момент отправки
message_count
фактическое количество Viber-сообщений к отправке
recipient
номер получателя в международном формате
operator
код мобильного оператора
Ещё в этом разделе