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

API предоставляет интерфейс для автоматизации процесса отправки мгновенных сообщений Viber.

Для авторизации используется ApiKey полученный в личном кабинете для соответствующей компании. Пример заголовка:

Точка подключения:

Отправка сообщения на один номер (POST)

Сервис инициирует отправку Viber-сообщения в соответствии со значениями параметров, передаваемых сервису в POST-запросе следующего формата:

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

Параметр Тип данных Описание Обязательный
phone string Номер получателя Да
viber_sender_name string Имя отправителя Viber Да
text string Текст сообщения Нет
image_url string URL картинки Нет
button string Текст кнопки Нет
button_action string URL-ссылка Нет
can_send_sms boolean Перенаправить как SMS Нет
sms_sender_name string Имя SMS-отправителя Да
local_time boolean Учет часового пояса получателя Нет

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

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

Параметр Тип данных Описание Обязательный
id integer Идентификатор Viber-сообщения Да
campaign_id integer Идентификатор кампании Да
subscriber_id integer Идентификатор получателя Да
status string Статус Viber-сообщения Да
code string Код ответа Да
error string Ошибка Да
created_at string Дата создания сообщения Да

Отправка нескольких сообщений на один номер (POST)

Сервис инициирует отправку Viber-сообщения в соответствии со значениями параметров, передаваемых сервису в POST-запросе следующего формата:

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

Параметр Тип данных Описание Обязательный
phones string Номера получателей Да
viber_sender_name string Имя отправителя Viber Да
text string Текст сообщения Нет
image_url string URL картинки Нет
button string Текст кнопки Нет
button_action string URL-ссылка Нет
can_send_sms boolean Перенаправить как SMS Нет
sms_sender_name string Имя SMS-отправителя Да
local_time boolean Учет часового пояса получателя Нет

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

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

Параметр Тип данных Описание Обязательный
id integer Идентификатор Viber-сообщения Да
campaign_id integer Идентификатор кампании Да
subscriber_id integer Идентификатор получателя Да
status string Статус Viber-сообщения Да
code string Код ответа Да
error string Ошибка Да
created_at string Дата создания сообщения Да

Получение списка Viber-сообщений (GET)

Возвращает список сообщений.

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

Параметр Тип данных Описание Обязательный
page integer Номер страницы Нет
per_page integer Кол-во записей Нет

Запрос статуса Viber-сообщения (GET)

Сервис возвращает статус отправленного Viber-сообщения в соответствии со значениями параметров, передаваемых сервису в GET-запросе следующего формата:

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

Параметр Тип данных Описание Обязательный
id integer Идентификатор Viber-сообщения Да

Запрос статистики за период (GET)

Сервис возвращает входящие sms-сообщения за период в соответствии со значениями параметров, передаваемых сервису в GET-запросе следующего формата:

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

Параметр Тип данных Описание Обязательный
start_date date Дата начала выборки. Формат dd.mm.yyyy Да
end_date date Дата конца выборки. Формат dd.mm.yyyy Да
page integer Номер страницы Нет
per_page integer Кол-во записей Нет

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

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

Параметр Тип данных Описание Обязательный
campaign_id integer Идентификатор Viber-кампании Да
date string Дата Да
enqueued_count integer Сообщений в очереди Да
sent_count integer Сообщений на отправку Да
readed_count integer Прочитано сообщений Да
undelivered_count integer Не доставлено сообщений Да
sent_by_sms_count integer Отправлено сообщений как SMS Да