Перейти к основному содержимому

WabaTemplateRead

Шаблон сообщения WhatsApp Business API, зарегистрированный для канала компании. WABA требует предварительно одобренные шаблоны для инициации переписки вне 24-часового окна. Шаблон строится на основе подготовленного сообщения и имеет статус одобрения.

idIdrequired

Уникальный числовой идентификатор записи.

company_idCompany Idrequired

Идентификатор компании-владельца (аккаунт верхнего уровня — арендатор).

prepared_msg_idPrepared Msg Idrequired

Идентификатор подготовленного сообщения, на котором основан шаблон.

channel_idChannel Idrequired

Идентификатор канала, к которому относится запись.

ext_idExt Idrequired

Идентификатор шаблона у провайдера WABA.

nameNamerequired

Имя шаблона, зарегистрированное у провайдера.

variables object[]required

Упорядоченные переменные, подставляемые в шаблон; каждая берётся из поля лида или контакта.

  • Array [
    • sourceSource

    Откуда берётся значение — из лида или из контакта.

    Possible values: [lead, contact]

    Default value: lead
    keyKeyrequired

    Ключ поля, из которого читается значение.

  • ]
    • statusStatusrequired

    Статус одобрения у провайдера — pending, approved, rejected, failed или paused.

    Possible values: [pending, approved, rejected, failed, paused]

    categoryCategoryrequired

    Категория WABA-шаблона — marketing, utility или authentication.

    Possible values: [marketing, utility, authentication]

    typeTyperequired

    Тип медиа шаблона — text, video, image или document.

    Possible values: [text, video, image, document]

    example objectrequired

    Пример наполнения тела шаблона.

    anyOf
    string
    vertical objectrequired

    Необязательная бизнес-вертикаль, заявленная для шаблона.

    anyOf
    string
    langLangrequired

    Язык шаблона (ru или en_US).

    Possible values: [ru, en_US]

    header objectrequired

    Необязательный текст заголовка шаблона.

    anyOf
    string
    example_header objectrequired

    Необязательное примерное значение для заголовка.

    anyOf
    string
    footer objectrequired

    Необязательный текст подвала шаблона.

    anyOf
    string
    buttonsundefined[]required

    Необязательные кнопки шаблона.

    created_atdate-timerequired

    Время создания (UTC, ISO 8601).

    WabaTemplateRead
    {
      "id": 0,
      "company_id": 0,
      "prepared_msg_id": 0,
      "channel_id": 0,
      "ext_id": "string",
      "name": "string",
      "variables": [
        {
          "source": "lead",
          "key": "string"
        }
      ],
      "status": "pending",
      "category": "marketing",
      "type": "text",
      "example": "string",
      "vertical": "string",
      "lang": "ru",
      "header": "string",
      "example_header": "string",
      "footer": "string",
      "buttons": [
        null
      ],
      "created_at": "2024-07-29T15:51:28.071Z"
    }