Раздел содержит описание метода 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" }
Таблица параметров
Параметр | Тип данных | Описание |
subjectId | integer | Идентификатор подписи |
matcherTypes | string (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" } }
Таблица параметров
Параметр | Тип данных | Описание |
id | integer | Идентификатор шаблона |
name | string | Название шаблона |
channelType | string | Тип канала взаимодействия. Возможные значения: WHATSAPP, VIBER, SMS |
language | string | Язык шаблона. Только для типа каналов WHATSAPP, VIBER |
content | object | Поле, определяющее контент шаблона |
attachment | object | Поле, определяющее вложение шаблона |
action | string | Ссылка кнопки. Только для канала VIBER |
caption | string | Название кнопки. Только для канала VIBER |
headerType | string | Тип заголовка. Если в шаблоне нет заголовка, то headerType не передается. Только для канала whatsapp |
header | object | Поле, определяющее заголовок шаблона. Только для канала WHATSAPP |
text | string | Текст шаблона |
footer | object | Поле, определяющее подпись шаблона. Только для канала WHATSAPP |
keyboard | object | Поле, определяющее набор кнопок. Только для каналов WHATSAPP, viber |
row s | object | Поле, определяющее набор кнопок |
buttons | object | Массив объектов в каждом из которых определяется кнопка |
buttonType | string | Тип кнопки |
payload | string | Код кнопки |
category | string | Категория шаблона. Только для каналов Whatsapp и Viber |
status | string | Статус шаблона |
locked | boolean | Признак блокировки шаблона. Возможное значения: • TRUE — шаблон заблокирован;• FALSE — шаблон активен. |
type | string | Тип шаблона. Возможные значения: • OPERATOR — операторский шаблон (шаблон, который был зарегистрирован у оператора связи);• USER — пользовательский шаблон (шаблон, который был создан пользователем на основе операторского шаблона) |
createdAt | string | Время создания шаблона |
updatedAt | string | Время последнего изменения шаблона |
Статусы шаблонов
- APPROVED — активный. Это единственный статус, при котором шаблон возможно использовать для отправки сообщений
- REJECTED — отклонен оператором
- PENDING — на регистрации
- NOT_SENT — черновик
- ARCHIVED — в архиве
- PAUSED — приостановлен
- DISABLED — отключен
Коды ответов на запрос
- ok — запрос успешно выполнен
- error-subject-unknown — указанное имя подписи отсутствует
- error-syntax — неверно указан тип канала