Создание шаблона

Статья содержит описание метода API для создания операторского шаблона.

Метод message-matchers

В результате выполнения запроса будет создан операторский шаблон. В случае успешного выполнения запроса клиент получит ответ от сервера с кодом 200. В случае неуспешного выполнения запроса придет сообщение с кодом ошибки.

URL-адрес подключения

Для отправки сообщения выполняется POST-запрос на URL-адрес: https://app.edna.io/api/message-matchers

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

В теле запроса передается JSON-объект с параметрами.

{
    "messageMatcher": {
        "name": "new_matcher",
        "channelType": "WHATSAPP",
        "language": "RU",
        "content": {
            "text": "Здравствуйте! Спасибо, что выбрали нас."
        },
        "category": "ACCOUNT_UPDATE",
        "type": "OPERATOR"
    },
    "subjectIds": [
        2234
    ]
}

Таблица параметров

ПараметрТип данныхОписание
messageMatcherobjectОбъект с данными о шаблоне
namestringНазвание шаблона
channelTypestringТип канала взаимодействия. Возможные значения: WHATSAPP, VIBER, SMS
languagestringЯзык шаблона
contentobjectОбъект с содержимым шаблона
categorystringКатегория шаблона
typestringТип шаблона. Возможные значения:

OPERATOR — операторский шаблон (шаблон, который был зарегистрирован у оператора связи);
USER — пользовательский шаблон (шаблон, который был создан пользователем на основе операторского шаблона)

ВАЖНО! В настоящее время поддерживается только тип OPERATOR.
subjectIdsintegerМассив идентификаторов подписи, для которых создаётся шаблон. Чтобы узнать идентификатор подписи канала, используйте метод получения списка каналов.
smsProviderIdsintegerID SMS-операторов, для которых регистрируется SMS шаблон. Значения:

0 — МТС
1 — Билайн
2 — Мегафон
3 — Теле2

Примеры шаблонов

  • WhatsApp HSM
{
    "messageMatcher": {
        "name": "new_matcher",
        "channelType": "WHATSAPP",
        "language": "RU",
        "content": {
            "text": "Здравствуйте, {{1}}! Спасибо, что выбрали нас.",
            "header": {
                "text": "Ваш чат с edna"
            },
            "footer": {
                "text": "Спасибо за интерес"
            },
            "category": "ACCOUNT_UPDATE",
            "type": "OPERATOR"
        },
        "subjectIds": [
            2234
        ]
    }
}
  • Viber
{
    "messageMatcher": {
        "name": "new_matcher",
        "channelType": "VIBER",
        "language": "RU",
        "content": {
            "text": "Здравствуйте, [\s\w]+! Спасибо, что выбрали нас."
        },
        "category": "ACCOUNT_UPDATE",
        "type": "OPERATOR"
    },
    "subjectIds": [
        2234
    ]
}
  • SMS
{
    "messageMatcher": {
        "name": "new_matcher",
        "channelType": "SMS",
        "language": "RU",
        "content": {
            "text": "Здравствуйте, %w{1,10}! Спасибо, что выбрали нас."
        },
        "category": "ACCOUNT_UPDATE",
        "type": "OPERATOR",
        "createdAt": "2022-05-05T11:34:34.844Z",
        "updatedAt": "2022-05-05T11:34:34.844Z"
    },
    "subjectIds": [
        2234
    ],
    "smsProviderIds": [
        2
    ]
}

{{1}}, [\s\w]+ и %w{1,10} — это элементы автоподстановки, то есть строки символов, вместо которых можно указывать любые значения. У каждого провайдера есть собственные правила использования таких элементов, подробнее читайте в статьях: SMSViberWhatsApp.

Возможные примеры сообщений можно посмoтреть здесь.

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

В ответ на запрос возвращается JSON-объект, содержащий код выполнения запроса.

Коды ответов на запрос

ok — запрос успешно выполнен

Получение информации о каскадах
Cледующая статья Получение статуса регистрации шаблона