Шаблоны WhatsApp Business API

База знаний

РУ

База знаний

Регистрация

Вход

РУ

База знаний

Шаблоны WhatsApp Business API

С помощью шаблонов WABA начинают переписку с клиентами с каналов WhatsApp Buisness API.

👉 Что такое шаблон WABA, из чего он состоит и как его создать в личном кабинете Wazzup

Чтобы получить список шаблонов WABA, которые добавлены для работы в Wazzup, вызовите:

Метод GET https://api.wazzup24.com/v3/templates/whatsapp

Структура запроса

GET /v3/templates/whatsapp
├── limit
└── offset

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

Название	Тип	Описание
limit	number	Лимит возвращаемых записей. По умолчанию: 100
offset	number	Сдвиг выборки. Пригодится, если вы уже получали список шаблонов, но после этого пользователь уже создал новые. По умолчанию: 0

Пример запроса

curl --location --request GET 'https://api.wazzup24.com/v3/templates/whatsapp' \
--header 'Authorization: Bearer f6633fb8f4c648fasssf0e9f43a334c1b' \
--data-raw ''

Параметры ответа

Параметр	Тип	Описание
templateGuid	string	Идентификатор шаблона
accountId	number	Идентификатор аккаунта
title	string	Название шаблона в Wazzup. Нужно, чтобы пользователь смог быстрее найти шаблон в списке
name	string	Имя шаблона, которое отправляется в Facebook*
waba	`object waba`	Объект с информацией о бизнес-аккаунте Facebook*
channels	array	Список каналов, к которым привязан шаблон
category	string	Категория шаблона
language	string	Язык шаблона
status	string	Статус модерации шаблона
rejected_reason	string	Причина отклонения, если статус rejected (отклонен)
namespace	string	Неймспейс Facebook*
components	`array of objects components`	Список компонентов шаблона

waba (объект)

Параметр	Тип	Описание
wabaId	string	ID бизнес-аккаунта Facebook*
wabaName	string	Название бизнес-аккаунта

components (объект)

Параметр	Тип	Описание
type	string	Тип компонента шаблона: HEADER — заголовок шаблона, FOOTER — подпись шаблона, BUTTONS — кнопки, BODY — основной текст шаблона.
format	string	Формат. Только для component.HEADER: IMAGE, DOCUMENT, VIDEO, TEXT
text	string	Текст компонента, если есть
example	String (Array)	Примеры переменных для соответствующего компонента шаблона
buttons	`array of objects buttons`	Список кнопок, если они есть в шаблоне

buttons (объект)

Параметр	Тип	Описание
type	string	Тип кнопки: URL — ссылка, QUICK_REPLY — быстрый ответ, PHONE_NUMBER — номер телефона.
text	string	Текст на кнопке
url	string	Для кнопок типа URL. Ссылка, по которой перейдет человек, когда нажмет на кнопку

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

HTTP/1.1 200 OK
[
 {
  "templateGuid": "8d255e5d-aefd-44dc-8131-c3ad6c3ab28c",
  "accountId": 70789196,
  "title": "Название шаблона",
  "channels": ["e9a268e4-44af-41cd-9b63-2524a4ad653e"],
  "order": 0,
  "category": "MARKETING",
  "language": "ru",
  "components": [
    {
     "text": "Привет, !",
     "type": "HEADER",
     "format": "TEXT",
     "example": {
     "header_text": ["header-example-1"]
      }
    },
    {
     "text": "Обновление сервиса.",
     "type": "BODY",
     "example": {
      "body_text": [["body-example-1"]]
     }
 }
 ],
  "waba": {
   "wabaId": "194388939529290",
   "wabaName": "Wazzup LLC"
 },
 "name": "Имя шаблона, которое отправляется в Facebook*",
 "namespace": "c8ae5f90_307a_ca4c_b8f6_d1e2a2573574",
 "publishedAt": null,
 "isTrickyTemplate": false,
 "trickyTemplatesPriority": null,
 "createdAt": "2023-12-31T23:55:42.504Z",
 "updatedAt": "2023-12-31T23:55:08.857Z",
 "componentsDefaults": {},
 "tags": null,
 "templateCode": "@template: fe03cddf-dec1-4c19-aede-e16190abca46 { [[headerVar1]]; [[bodyVar1]] }"
}

*Запрещены и признаны экстремистскими на территории РФ