Перейти к содержанию

GetTemplates#

Метод предназначен для получения списка всех ранее созданных шаблонов для вашего инстанса.

Запрос#

Для для получения списка всех ранее созданных шаблонов для вашего инстанса требуется выполнить запрос по адресу:

GET {{apiUrl}}/waInstance{{idInstance}}/getTemplates/{{apiTokenInstance}}

Для получения параметров запроса idInstance, apiTokenInstance и apiUrl обратитесь к разделу Перед началом работы.

Ответ#

Поля ответа#

Поле Тип Описание
templates array Массив объектов всех существующих шаблонов

Объект template#

Поле Тип Описание
buttonSupported string Типы кнопок, используемые в шаблоне.
category string Категория шаблона.
containerMeta string Полностью сформированный запрос, отправленный на верификацию в Meta*.
createdOn number Timestamp создания шаблона (в миллисекундах).
data string Поле data из шаблона, текстовое представление шаблона.
elementName string Имя шаблона, заданное в теле запроса CreateTemplate.
languageCode string Язык шаблона, заданный в теле запрсоа CreateTemplate.
languagePolicy string Служебное поле определения языка для Meta*.
meta string Поле, содержащее пример шаблона.
modifiedOn number Timestamp редактирования шаблона (в миллисекундах). Равен createdOn при создании шаблона.
namespace string Идентификатор пространства имён WABA аккаунта
priority number Приоритет шаблону, задаваемый Meta*.
quality string Служебное поле оценивания шаблона со стороны Meta*.
retry number Количество повторной отправки шаблона на верификацию в Meta*.
stage string Служебное поле стадии обработки запроса Meta*.
status string Статус верификации Meta* по шаблону. Может принимать значения: PENDING (на рассмотрении), APPROVED (шаблон верифицирован и может быть отправлен), REJECTED (шаблон не прошел верификацию, Meta считает шаблон подозрительным), FAILED (шаблон не прошел верификацию, ошибка в теле запроса. Причина указана в дополнительном поле reason), PAUSED (работа шаблона приостановлена).
templateType string Тип шаблона
vertical string Краткое описание шаблона для прохождения верификации Meta*.
templateId string ID созданного шаблона для взаимодействия с ним.
elementName string служебные поля Meta*
internalCategory number служебные поля Meta*
internalType number служебные поля Meta*

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

Код успешного состояния: 200 OK. 

{
    "templates": [
        {
            "buttonSupported": "PN,QR,URL",
            "category": "MARKETING",
            "containerMeta": "{\"data\":\"your ticket has been confirmed for {{1}} persons on date {{2}}.\",\"buttons\":[{\"type\":\"PHONE_NUMBER\",\"text\":\"Call Us\",\"phone_number\":\"+919872329959\"},{\"type\":\"URL\",\"text\":\"Book A Demo\",\"url\":\"https://GREEN-API.io/{{1}}\",\"example\":[\"https://GREEN-API.io/abc\"]},{\"type\":\"QUICK_REPLY\",\"text\":\"Demo Button\"}],\"header\":\"This is the header\",\"footer\":\"This is the footer\",\"sampleText\":\"your ticket has been confirmed for 4 persons on date 2020-05-04.\",\"sampleHeader\":\"This is the header\",\"enableSample\":true,\"editTemplate\":false,\"allowTemplateCategoryChange\":true,\"addSecurityRecommendation\":false}",
            "createdOn": 1741089781669,
            "data": "This is the header\nyour ticket has been confirmed for {{1}} persons on date {{2}}.\nThis is the footer | [Call Us,+919872329959] | [Book A Demo,https://GREEN-API.io/{{1}}] | [Demo Button]",
            "elementName": "ticket_check_url_424536",
            "internalCategory": 0,
            "internalType": 0,
            "languageCode": "en_US",
            "languagePolicy": "deterministic",
            "meta": "{\"example\":\"your ticket has been confirmed for 4 persons on date 2020-05-04.\"}",
            "modifiedOn": 1741089798570,
            "namespace": "e******8_4**d_4**1_b***_0d*********6",
            "priority": 1,
            "quality": "UNKNOWN",
            "retry": 0,
            "stage": "NONE",
            "status": "APPROVED",
            "templateType": "TEXT",
            "vertical": "This is a test for creation ticket",
            "templateId": "b*****a-f***-4***-a***-5*********3"
        }
    ]
}

Ошибки GetTemplates#

Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки.

Пример кода на curl#

curl --location '{{apiUrl}}/waInstance{{idInstance}}/getTemplates/{{apiTokenInstance}}'