Skip to content

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

GET

/v1/wa/apps/{appId}/templates

Данный эндпоинт API предназначен для получения списка шаблонов.

Авторизация

Для доступа к методу необходим токен системного пользователя. Передайте его в заголовке HTTP-запроса.

Authorization: Bearer <ACCESS_TOKEN>

Параметры

ПараметрРасположениеТипОписание
appIdPathstringУникальный идентификатор приложения.

Пример запроса

bash
curl -X GET \
  https://space.getloo.ru/api/v1/wa/apps/{appId}/templates \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json"

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

json
[
  {
    "id": 1,
    "name": "example_tmplate_1768569111",
    "category": "MARKETING | MARKETING_LITE | UTILITY | SERVICE",
    "type": "TEXT | IMAGE | VIDEO | DOCUMENT",
    "language": "ru",
    "status": "PENDING | APPROVED | REJECTED",
    "quality": "UNKNOWN | GREEN | YELLOW | RED",
    "media_url": null,
    "components": {
      "header": {
        "text": "Welcome back, {{1}}!",
        "sample_text": "Welcome back, John!",
        "placeholders": ["John"]
      },
      "body": {
        "text": "Hello, {{1}}!",
        "sample_text": "Hello, John!",
        "placeholders": ["John"]
      },
      "footer": null,
      "buttons": [
        {
          "type": "URL | QUICK_REPLY",
          "text": "Yes"
        },
        {
          "type": "URL | QUICK_REPLY",
          "text": "My Awesome Site",
          "url": "https://example.com/{{1}}",
          "placeholders": ["about"]
        }
      ]
    },
    "created_at": 1768569113,
    "updated_at": 1768569113
  },
  ...
]

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

ПараметрТипОписание
idintegerУникальный идентификатор шаблона.
namestringНазвание шаблона.
categorystringКатегория шаблона. Возможные значения: MARKETING, MARKETING_LITE, UTILITY, SERVICE. Подробнее о шаблонах в разделе: категории шаблонов
typestringТип шаблона. Возможные значения: TEXT, IMAGE, VIDEO, DOCUMENT.
languagestringЯзык шаблона в формате ISO 639-1.
statusstringСтатус шаблона. Возможные значения:
  • PENDING — на рассмотрении
  • APPROVED — одобрен
  • REJECTED — отклонен
.
qualitystringКачество шаблона. Возможные значения:
  • GREEN — высокое
  • YELLOW — среднее
  • RED — низкое
  • UNKNOWN — оценивается
.
media_urlstringURL медиафайла, если тип шаблона IMAGE, VIDEO или DOCUMENT.
componentsobjectКомпоненты шаблона, включая заголовок, тело, нижний колонтитул и кнопки.
created_atintegerВременная метка создания шаблона в формате UNIX.
updated_atintegerВременная метка последнего обновления шаблона в формате UNIX.

Коды состояния

Код состоянияОписание
200Запрос успешно выполнен
401Неавторизованный запрос
404Не найдено