Получение списка шаблонов HSM (getOutMessageMatchers)

Метод, описанный в этой статье, предназначен только для SME.

Данный метод возвращает список Whatsapp HSM шаблонов, которые были созданы в личном кабинете edna.

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

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

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

В теле запроса передается тип и имя подписи. Поле imType обязательное. Subject необязательное поле. Если его не указать, то будут возвращены все шаблоны по всем подписям.

{
  "imType": "whatsapp",
  "subject": "test" 
}

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

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

{
    "result": [
        {
            "id": 206,
            "name": "206",
            "imType": "whatsapp",
            "language": "AU",
            "content": {
                "header": {},
                "text": "whatsapp text",
                "footer": {
                    "text": "Добавить подпись сообщения"
                },
                "keyboard": {
                    "row": {
                        "buttons": [
                            {
                                "text": "button1",
                                "payload": "button1",
                                "buttonType": "QUICK_REPLY"
                            }
                        ]
                    }
                }
            },
            "category": "ISSUE_UPDATE",
            "status": "PENDING",
            "createdAt": "2020-11-12T11:31:39.000+0000",
            "updatedAt": "2020-11-12T11:31:39.000+0000"
        }
    ],
    "code": "ok"
}

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

Тип заголовка

Заголовок может содержать указание на тип заголовка.

• TEXT: в шаблоне текстовый заголовок.
• IMAGE: в шаблоне в заголовке требуется передавать изображение.
• VIDEO: в шаблоне в заголовке требуется передавать видео.
• DOCUMENT : в шаблоне в заголовке требуется передавать документ. В настоящий момент для шаблонов сообщений с медиафайлами поддерживаются только документы в формате PDF.

Например:

{
    "id": 4214,
    "name": "4214",
    "imType": "whatsapp",
    "headerType": "DOCUMENT",
    "language": "AU",
    "content": {
        "header": {},
        "text": "Это сообщение для тестирования. {{1}}, {{2}}.",
        "footer": {
            "text": "Подпись"
        },
        "keyboard": {
            "row": {
                "buttons": []
            }
        }
    },
    "category": "ACCOUNT_UPDATE",
    "status": "APPROVED",
    "createdAt": "2021-05-25T15:28:57.000+0000",
    "updatedAt": "2021-05-25T15:28:57.000+0000"
}

Если в сообщении нет заголовка, то headerType в ответе не передается.