База знань

У Messaggio створення та надсилання повідомлень здійснюється за допомогою зареєстрованих шаблонів Viber. Для цього перейдіть до розділу «Шаблони», виберіть канал Viber та тип шаблону «Транзакційний».

Вимоги до шаблонів

Транзакційний шаблон може містити:

• до 1000 символів;
• до 8 змінних;
• кожне значення змінної — до 125 символів.

Змінні задаються у подвійних фігурних дужках:

{{name}}
{{account}}
{{debt}}

Обмеження:

• одну й ту саму змінну можна використовувати кілька разів в одному шаблоні;
• транзакційний шаблон не може починатися або закінчуватися змінною;
• при цьому між першою або останньою змінною та текстом має бути щонайменше один пробіл;
• між двома змінними обов’язково має бути текст;
• для кожної змінної необхідно вказати приклад значення;
• OTP-шаблон не може починатися зі змінної;
• OTP-шаблон обов’язково повинен містити змінну {{pin}}.

Приклад шаблону:

Вітаємо, {{name}}.
Ваш борг за рахунком {{account}} становить {{debt}}.
Будь ласка, погасіть заборгованість у поточному розрахунковому періоді.

Створення шаблону

Для створення шаблону:

1. Перейдіть до розділу «Шаблони».
2. Виберіть канал Viber.
3. Виберіть тип шаблону «Транзакційний».
4. Введіть текст шаблону.
5. Додайте змінні вручну (наприклад, {{name}}) або скористайтеся кнопкою додавання змінної.
6. Для кожної змінної вкажіть приклад значення.
7. Збережіть шаблон.
8. Надішліть шаблон на модерацію.

Після створення шаблону в його картці будуть доступні:

• ідентифікатор шаблону (Template ID);
• імена всіх змінних;
• приклади їхніх значень.

Ці дані використовуються під час надсилання повідомлень через API.

Надсилання повідомлень за шаблоном

Для надсилання повідомлення необхідно вказати:

• ідентифікатор зареєстрованого шаблону Viber;
• значення всіх використаних змінних.

Приклад тіла запиту:

{
    "recipients": [
        {
            "phone": "123456789"
        }
    ],
    "channels": [
        "viber"
    ],
    "viber": {
        "from": "ViberName",
        "label": "transaction",
        "content": [
            {
                "type": "template",
                "template": {
                    "template_id": "b9gff5f38b6c0961",
                    "parameters": {
                        "name": "Алекс",
                        "account": "19888-2",
                        "debt": "80 eur"
                    }
                }
            }
        ]
    }
}

Якщо шаблон не містить змінних, необхідно передати лише ідентифікатор шаблону. Об’єкт parameters у такому разі передавати не потрібно.

Використання змінних

Змінні передаються окремо від тексту шаблону.

Шаблон:

Вітаємо, {{name}}! Ваше замовлення прибуло.

Параметри:

{
    "name": "Алекс"
}

Одержувач побачить:

Вітаємо, Алекс! Ваше замовлення прибуло.

Обмеження щодо використання посилань

У значеннях змінних не можна передавати посилання або повні доменні імена. Такі повідомлення можуть бути відхилені Viber.

Некоректний приклад

Шаблон:

Сайт: {{site}}

Параметри:

{
    "site": "messaggio.com"
}

У цьому випадку все посилання передається через змінну, що є неприпустимим.

Коректний приклад

Шаблон:

Сайт: {{site}}.com

Параметри:

{
    "site": "messaggio"
}

Одержувач побачить:

Сайт: messaggio.com

У цьому випадку змінна містить лише частину тексту, а закінчення доменного імені є частиною самого шаблону, тому повідомлення проходить перевірку.