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

POST

https://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

Body Params application/json

status

enum<string>

required

Allowed values:

pendingapprovedrejected

Example

{
  "status": "approved"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://kazinfoteh.orh/wasender/gettemplate' \
--header 'X-API-KEY: 123' \
--header 'Content-Type: application/json' \
--data-raw '{
    "status": "approved"
}'

Responses

🟢200OK

application/json

Body

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

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

Example

{
  "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": ""
    }
  ]
}

🟠401Unauthorized

🟠400Bad Request

🟠404Record Not Found

Modified at 2024-12-21 17:02:36

Сообщение статичный текст

Авторизационное сообщение