KiT Docs Portal

Получить имена всех шаблонов - gettemplate

POSThttps://kazinfoteh.orh/wasender/gettemplate

Используйте метод gettemplate для получения всех шаблонов. Имена шаблонов используются в отправке шаблонных сообщений и являются обязательным параметром при отправке.

Если запрос успешный, сервер возвращает ответ с кодом 200, содержащий JSON-объект с массивом шаблонов.

:::info
| Адрес |
| https://kazinfoteh.org/wasender/gettemplate |
:::

:::info
Для отправки запросов Вам потребуется X-API-KEY выданный Вашим менеджером.
:::

:::check
Варианты параметра status в запросе

pending - вернет только шаблоны на рассмотрении
approved - вернет только одобренные шаблоны
rejected - вернет только отклоненные шаблоны
:::

Request

Header Params

X-API-KEY

string

required

Example:

123

status

enum<string>

required

Allowed values:

pendingapprovedrejected

{
  "status": "approved"
}

Request samples

Responses

OK(200)

Unauthorized(401)

Bad Request(400)

Record Not Found(404)

HTTP Code: 200

Content Type : JSONapplication/json

content

array [object {7}]

required

name

string

required

Имя шаблона для отправки сообщений

type

string

required

Тип шаблона

marketing - маркетинговый шаблон
utility - служебный шаблон
auth - авторизационный шаблон

status

string

required

pending - шаблон на рассмотрении
approved - одобренный шаблоны
rejected - отклоненный шаблоны

headerTyp

string

required

Тип заголовка в шаблоне. См. "Типы заголовков в шаблонных сообщениях". Если есть

headerContent

string

required

Текст или URL заголовка. См. "Типы заголовков в шаблонных сообщениях". Если есть

bodyText

string

required

Текст тело сообщения.

footerText

string

required

Текст подписи сообщения. Если есть

{
  "content": [
    {
      "name": "test_txt",
      "type": "marketing",
      "status": "approved",
      "headerTyp": "text",
      "headerContent": "Привет {{1}}",
      "bodyText": "Это пример шаблона",
      "footerText": "Спасибо"
    },
    {
      "name": "test_img",
      "type": "marketing",
      "status": "approved",
      "headerTyp": "image",
      "headerContent": "https://kazinfoteh.kz/img/display.png",
      "bodyText": "Скидки весь июль",
      "footerText": ""
    }
  ]
}

Last modified: 2 months ago