Получение статуса доставки Viber‑сообщений

Получение статуса доставки Viber-сообщения с помощью API/XML-запроса →

Получение статуса доставки Viber-сообщения с помощью вебхука (webhook) →

Получить статус доставки Viber-сообщения можно двумя способами:

С помощью API/XML-запроса на получение статуса доставки нужного Viber-сообщения, инициируемого с вашей стороны. Т. е. вы отправляете запрос — мы в ответ на него отправляем вам статус доставки Viber-сообщения.

С помощью вебхука (webhook)
Webhook — это механизм оповещения системы о событиях. Используя вебхуки, после отправки Viber-сообщения, вам не нужно самостоятельно дополнительно запрашивать статус доставки Viber-сообщения, отслеживать его изменение, а также учитывать срок жизни Viber-сообщения и контролировать интервалы отправки запросов. Как только мы получим конечный статус доставки Viber-сообщения (или его изменение) от телефонного аппарата абонента, мы отправим этот статус вам.

Получение статуса доставки Viber-соообщения с помощью API/XML–запроса

Статусы доставки Viber-сообщения содержат информацию о текущем состоянии Viber-сообщения. В течение срока жизни Viber-сообщения, до момента получения конечного статуса, статусы регулярно обновляются, и могут быть запрошены пользователем в любое время

Тело запроса


<?xml version="1.0" encoding="utf-8" ?>
<package command="viber_status" login="username" password="password">
<status>
<msg message_id="viber1_id_for_get_status"/>
<msg message_id="viberN_id_for_get_status"/>
</status>
</package>

Описание параметров и тегов в запросе

ваш логин, для доступа в Личный кабинет (ЛК)

password

ваш пароль к API, который генерируется на странице «SMS-рассылка» — «Рассылка по API»

command

тип запроса, всегда viber_status

msg

тег, для которого происходит запрос статуса. Может содержать атрибуты:

message_id

числовой идентификатор Viber-сообщения, который вы получили в момент отправки

Тело ответа


<?xml version="1.0" encoding="utf-8" ?>
<package>
<status>
<msg message_id="viber1_id_for_get_status" message_count="1" operator="3" recipient="+375295363600" sms_resend_id="1103143244">Expired</msg>
<msg message_id="viberN_id_for_get_status" message_count="1" operator="3" recipient="+375293262625" sms_resend_id="0">Sent</msg>
</status>
</package>

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

msg

массив с информацией по отправленным Viber-сообщениям. Элементы могут содержать следующие параметры:

message_id

числовой идентификатор Viber-сообщения, который вы получили в момент отправки

message_count

количество Viber-сообщений

status

статус Viber-сообщений

recipient

номер телефона абонента в международном формате, по которому считываем статус

operator

код мобильного оператора

sms_resend_id

числовой идентификатор SMS-сообщения для каскадной Viber-рассылки (равен 0, если SMS не отправлялось)

Получение статуса доставки Viber-сообщения с помощью вебхука (webhook)

Вы можете получать на ваш адрес (URL) информацию по статусу доставки Viber-сообщения в момент его изменения на нашей платформе. Отправка информации (отчёт о доставке) происходит на URL, который вы передаете в параметре webhook_url API-запроса на отправку Viber-сообщения.
В ответ на отчёт о доставке, наш сервис должен получить от вас HTTP-код 200. В противном случае, отправку отчёта о доставке мы считаем недоставленной и повторяем попытку в течение суток с интервалом в 10 минут.

Тело отчёта о доставке


<?xml version="1.0" encoding="utf-8" ?>
<package>
<status>
<msg message_id="viber1_id_for_get_status" message_count="1" operator="3" recipient="+375295363600">Delivered</msg>
<msg message_id="viberN_id_for_get_status" message_count="1" operator="3" recipient="+375293262625">Sent</msg>
</status>

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

msg

массив с информацией по отправленным Viber-сообщениям. Элементы могут содержать следующие параметры:

message_id

числовой идентификатор Viber-сообщения, который вы получили в момент отправки

message_count

количество Viber-сообщений

status

статус Viber-сообщений

recipient

номер телефона абонента в международном формате, по которому считываем статус

operator