Получение списка шаблонов

27 января 2022

Раздел содержит описание метода API для получения списка шаблонов.

Метод message-matchers/get-by-request

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

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

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

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

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

{
    "subjectId": 23,
    "matcherTypes": "OPERATOR"
}

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

ПараметрТип данныхОписание
subjectIdintegerИдентификатор подписи
matcherTypesstring (optional)Тип шаблона. Возможные значения:

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

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

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

{
    "id": 242,
    "name": "QA_message_matcher_WA_1_opr_name_1",
    "channelType": "whatsapp",
    "language": "RU",
    "content": {
    "attachment": null,
    "action": null,
    "caption": null,
    "header": null,
    "text": "QA_message_matcher_WA_1_body_text",
    "footer": null,
                "keyboard": {
                    "rows": [
                        {
                            "buttons": []
                        }
                    ]
                }
            },
            "category": "MARKETING",
            "status": "APPROVED",
            "locked": true,
            "type": "USER",
            "createdAt": "2021-07-15T14:16:54.417024Z",
            "updatedAt": "2021-07-16T13:08:26.275414Z"
        },
{
    "id": 267,
    "channelType": "whatsapp",
    "language": "RU",
    "content": {
            "attachment": null,
            "action": null,
            "caption": null,
            "header": null,
            "text": "QA_message_matcher_WA_1_body_text",
            "footer": null,
            "keyboard": {
                    "rows": [
                        {
                            "buttons": []
                        }
                    ]
                }
            },
            "category": "MARKETING",
            "status": "PENDING",
            "locked": false,
            "type": "USER",
            "createdAt": "2021-07-20T09:21:42.444454Z",
            "updatedAt": "2021-07-20T09:21:42.444454Z"
        }
}

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

ПараметрТип данныхОписание
idintegerИдентификатор шаблона
namestringНазвание шаблона
channelTypestringТип канала взаимодействия. Возможные значения: WHATSAPP, VIBER, SMS
languagestringЯзык шаблона. Только для типа каналов WHATSAPP, VIBER
contentobjectПоле, определяющее контент шаблона
attachmentobjectПоле, определяющее вложение шаблона
actionstringСсылка кнопки. Только для канала VIBER
captionstringНазвание кнопки. Только для канала VIBER
headerTypestringТип заголовка. Если в шаблоне нет заголовка, то headerType не передается. Только для канала whatsapp
headerobjectПоле, определяющее заголовок шаблона. Только для канала WHATSAPP
textstringТекст шаблона
footerobjectПоле, определяющее подпись шаблона. Только для канала WHATSAPP
keyboardobjectПоле, определяющее набор кнопок. Только для каналов WHATSAPP, viber
rowsobjectПоле, определяющее набор кнопок
buttonsobjectМассив объектов в каждом из которых определяется кнопка
buttonTypestringТип кнопки
payloadstringКод кнопки
categorystringКатегория шаблона. Только для каналов Whatsapp и Viber
statusstringСтатус шаблона
lockedbooleanПризнак блокировки шаблона. Возможное значения:

• TRUE — шаблон заблокирован;
• FALSE — шаблон активен.
typestringТип шаблона. Возможные значения:

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

Статусы шаблонов

  • APPROVED — активный. Это единственный статус, при котором шаблон возможно использовать для отправки сообщений
  • REJECTED — отклонен оператором
  • PENDING — на регистрации
  • NOT_SENT — черновик
  • ARCHIVED — в архиве
  • PAUSED — приостановлен
  • DISABLED — отключен

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

  • ok — запрос успешно выполнен
  • error-subject-unknown — указанное имя подписи отсутствует
  • error-syntax — неверно указан тип канала
Получение статуса шаблона
In this article
Разделы статьи