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

GetTemplateById#

Используйте этот метод, чтобы получить ранее созданный шаблон по его идентификатору.

Запрос#

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

POST {{apiUrl}}/waInstance{{idInstance}}/getTemplateById/{{apiTokenInstance}}

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

Параметры запроса#

Параметр Тип Обязательный Описание
templateId string Да Идентификатор ранее созданного, существующего шаблона

Пример тела запроса#

{
    "templateId": "2522g44c-c2e4-4416-b506-4bghdd456e5g"
}

Ответ#

Поля ответа#

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

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

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

{
  "template": {
      "appId": "3cb92fbd-0bac-41d7-818e-4e4326d90335",
      "buttonSupported": "PN,URL",
      "category": "MARKETING",
      "containerMeta": "{\"data\":\"Exclusive deals on car and train bookings. Book now..!! flejpaiqah9z\",\"buttons\":[{\"type\":\"PHONE_NUMBER\",\"text\":\"Contact\",\"phone_number\":\"+919139472766\"},{\"type\":\"URL\",\"text\":\"Greenwaba\",\"url\":\"https://www.google.com/\"}],\"header\":\"Dear {{1}}\",\"footer\":\"Thank you\",\"sampleText\":\"Exclusive deals on car and train bookings. Book now..!! flejpaiqah9z\",\"sampleHeader\":\"Dear [user]\",\"enableSample\":true,\"editTemplate\":false,\"allowTemplateCategoryChange\":false,\"addSecurityRecommendation\":false,\"correctCategory\":\"UTILITY\"}",
      "createdOn": 1717510871793,
      "data": "Dear {{1}}\nExclusive deals on car and train bookings. Book now..!! flejpaiqah9z\nThank you | [Contact,+919139472766] | [Greenwaba,https://www.google.com/]",
      "elementName": "qa_automation_qa_automation_112907flejpaiqah9z",
      "externalId": "<metaTemplateId>",
      "id": "51eddb1e-8e36-44df-a9e5-2815e4f8463b",
      "internalCategory": 0,
      "internalType": 0,
      "languageCode": "en",
      "languagePolicy": "deterministic",
      "meta": "{\"example\":\"Exclusive deals on car and train bookings. Book now..!! flejpaiqah9z\"}",
      "modifiedOn": 1717511304250,
      "namespace": "<namespace>",
      "oldCategory": "UTILITY",
      "priority": 1,
      "quality": "UNKNOWN",
      "retry": 0,
      "stage": "NONE",
      "status": "APPROVED",
      "templateType": "TEXT",
      "wabaId": "106579118720596"
    }
}

Ошибки GetTemplateById#

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

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

curl --location '{{apiUrl}}/waInstance{{idInstance}}/getTemplateById/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "templateId": "2522g44c-c2e4-4416-b506-4bghdd456e5g"
}'