SMS-ассистент — документация для разработчиков

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

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

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

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

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

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

чёрный — обязательные параметры
серый — необязательные параметры

Тело запроса


{
    "login": "username",
    "password": "password",
    "command": "viber_send",
    "name": "send_name",
    "date_send": "date_send_message",
    "webhook_url": "http://callback.yourdomain.by/",
    "viber_image": "viber_image",
    "viber_button_caption": "viber_button_caption",
    "viber_button_url": "viber_button_url",
    "viber_sms_resend": "viber_sms_resend",
    "viber_sms_text": "viber_sms_text",
    "viber_sms_sender": "viber_sms_sender",
    "message": {
        "default": {
            "sender": "SMS-assist",
            "validity_period": 24,
            "viber_text": "viber_text",
            "viber_sms_text": "viber_sms_text"
        },
        "msg": [
            {
                "recepient": "295363600",
                "sender": "SMS-assist",
                "validity_period": 24,
                "viber_text": "текст сообщения 1"
            },
            {
                "recipient": "295363600",
                "template_id": 29,
                "tags_replace": {
                    "{TAG1}": "замена 1",
                    "{TAG2}": "замена 2"
                }
            },
            {
                "recipient": "293262625",
                "sender": "TEST-assist",
                "viber_text": "текст сообщения 2",
                "viber_sms_text": "текст SMS-сообщения"
            }
        ]
    }
}

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

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

password

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

command

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

date_send

дата отправки Viber-сообщения (передается только в том случае, если необходимо отправить запланированную рассылку).
Формат: ГГГГММДДЧЧММ. Например, передаем значение 202112250159 для того, чтобы запланировать рассылку на 25 декабря 2021 г. на 1#nbspч 59 м.
Дата запланированной рассылки должна быть не меньше, чем текущая дата +10 минут

name

наименование, которое необходимо присвоить рассылке. По наименованию в последующем можно фильтровать рассылки в разделе «Отправленные»

webhook_url

адрес (URL) вашего сайта, на который будет отправлен отчёт о доставке Viber-сообщения после того, как статус доставки у этого Viber-сообщения поменяется.
Подробнее по формату отчёта о доставке см. здесь

viber_image

параметр рекламного Viber-сообщения — URL изображения в формате PNG, JPG, JPEG

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 (подпись)

default

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

msg

тег-массив с получателями Viber-сообщений. Можно указывать персональные параметры для каждого абонента:

recipient

номер получателя (в возможном формате)

sender

отправитель Viber-сообщения (подпись)

validity_period

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

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

значение параметра в диапазоне от 1 до 336 воспринимается как часы;
значение параметра в диапазоне от 337 до 3599 воспринимается как ошибочное, по умолчанию присваивается 24 ч;
в диапазоне от 3600 до 1 209 600 воспринимается как передача данных в секундах;
значение больше, чем 1 209 600, воспринимается как ошибочное и выставляется по умолчанию 24 ч.

viber_text

текст Viber-сообщения. Параметр необязательный только в том случае, если передаётся template_id

template_id

код шаблона текста Viber-сообщения, который создается в ЛК. В шаблоне текста Viber-сообщения можно использовать собственные теги. Тогда, при отправке Viber-сообщения по API, вместо тегов можно передать параметры на подстановку. Это позволит вам в ЛК менять текст Viber-сообщения без изменения программного кода выполнения запросов по API. Получить код шаблона можно по json запросу get_templates или по запросу в службу технической поддержки.

tags_replace

параметр, в котором передаются значения на замену пользовательских метатегов. Работает только при использовании template_id.

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

Тело ответа


{
    "message": {
        "msg": [
            {
                "message_id": 12345678,
                "message_count": 1,
                "operator": 2,
                "error_code": 0,
                "recipient": "+375295363600"
            },
            {
                "message_id": 0,
                "message_count": 1,
                "operator": 0,
                "error_code": -5,
                "recipient": "+375293262625"
            }
        ]
    }
}

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

msg

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

message_id

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

message_count

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

error_code

код ошибки. В случае успешного ответа значение 0

recipient

номер получателя в международном формате

operator