Отправка сообщений по идентификатору шаблона

Обновлено: 9 апреля 2026

Для отправки сообщений в канал Viber по идентификатору шаблона templateId используется метод api/v1/out-messages/viber/template.

подсказка

Метод api/v1/out-messages/viber/template относится к новой версии API.

Канал Viber

Чтобы отправить сообщение в канал Viber по методу api/v1/out-messages/viber/template, отправьте POST-запрос на URL-адрес https://app.edna.by/api/v1/out-messages/viber/template

Формат запроса

{
    "messageId": "string",
    "sender": "string",
    "phone": "string",
    "templateId": integer,
    "textVariables": [
        "string",
        "string",
        "string"
    ],
    "options": {
        "comment": "string",
        "sendDelay": "string",
        "priority": "string"
    }
} 

Пример запроса

Сообщение с текстом:

{
    "sender": "RETAIL_VIBER",
    "phone": "375000000000",
    "templateId": 32,
    "options": {
        "comment": "promotion"
    }
}

Сообщение с отложенной отправкой и с переменными в тексте сообщения:

{
    "messageId": "01987f4a-070e-730e-bf59-cedc1e63350",
    "sender": "RETAIL_VIBER",
    "phone": "375000000000",
    "templateId": 34,
    "textVariables": [
        "Alex",
        "10.05",
        "Happy Birthday"
    ],
    "options": {
        "comment": "2025-08-12T12:17:20.981Z",
        "sendDelay": "PT1H3M4S",
        "priority": "NORMAL"
    }
}

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

Параметр	Тип данных	Характер	Описание
messageId	string	Необязательный	Внутренний идентификатор сообщения.
sender	string	Обязательный	Название подписи. Чтобы узнать название подписи, используйте метод API для получения списка каналов — параметр subject. Получение списка каналов
phone	string	Обязательный	Адрес получателя — номер телефона. Чтобы узнать адрес получателя, используйте метод API для запроса данных получателей — параметр addresses.address. Запрос данных получателей
templateId	integer	Обязательный	Идентификатор шаблона. Чтобы узнать идентификатор шаблона, используйте метод API для получения списка шаблонов — параметр id. Получение списка шаблонов
textVariables	array of strings	Обязательный, если в шаблоне есть переменные	Значения переменных в сообщении по шаблону.
options	object	Необязательный	Используется для дополнительных настроек отправки сообщения.
options.comment	string	Необязательный	Текстовый комментарий к сообщению. Значение параметра отображается в отчёте по сообщениям.
options.sendDelay	string	Необязательный	Временной интервал в формате даты ISO 8601 durations (например, PT10H15M48S), раньше которого сообщение не будет отправлено. Используется при отложенной отправке.
options.priority	string	Необязательный	Используется для обозначения приоритета сообщений. Возможные значения: - LOW — низкий приоритет; - NORMAL — средний приоритет, значение по умолчанию; - HIGH — высокий приоритет; - REALTIME — доставка в режиме реального времени.

Формат ответа

{
    "messageId": "string",
    "phone": "string"
} 

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

{
    "messageId": "01987f4a-070e-730e-bf59-cedc1e63350",
    "phone": "375000000000"
} 

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

Параметр	Тип данных	Описание
messageId	string	Внутренний идентификатор сообщения.
phone	string	Адрес получателя — номер телефона.