Перейти к основному содержимому

WhatsApp Cloud API - Шаблонный API | Документация для разработчиков

WhatsApp Cloud API - Шаблонный API

Экземпляр для программы магистратуры (LLM)
Версия
Создавайте, получайте, обновляйте и удаляйте шаблоны сообщений.
Управляйте предварительно утвержденными форматами сообщений для инициированных компанией переписок.
Включает в себя отправку шаблонов, локализацию и показатели качества.

Базовый URL

https://graph.facebook.com

Конечные точки

GET /{Version}/{TEMPLATE_ID}

Руководство: Шаблоны сообщений
Справочная информация по конечной точке: Шаблон сообщения WhatsApp

Синтаксис запроса

GET / {Version} / {TEMPLATE_ID}
Попробуйте!
Выберите язык
curl
 --request GET \ --url
 'https://graph.facebook.com/{Version}/{TEMPLATE_ID }' \ --header
 'Authorization: Bearer ' \ --header
 'Content-Type: application/json' \ --data
 '{}'
Выберите код состояния
{
 "Пример ответа"
 : { "значение"
 : { "категория"
 : "МАРКЕТИНГ" , "компоненты"
 : [ {
 "формат"
 : "ТЕКСТ" , "текст"
 : "Осенняя распродажа" , "тип"
 : "ЗАГОЛОВОК" },
 {
 "пример"
 : { "body_text"
 : [ [
 "ОСЕНЬ25"
 ]
 ]
 },
 "текст"
 : "Привет, {{1}}, наша осенняя распродажа началась! Используйте промокод {{2 }} и получите дополнительную скидку 25% на каждый заказ свыше 350 долларов!" , "type"
 : "BODY" },
 {
 "text"
 : "Не интересуетесь нашими акциями? Нажмите "Остановить акции " , "type"
 : "FOOTER" },
 {
 "buttons"
 : [ {
 "text"
 : "Остановить акции" , "type"
 : "QUICK_REPLY" }
 ],
 "type"
 : "BUTTONS" }
 ],
 "id"
 : "920070352646140" , "language"
 : "en_US" , "name"
 : "2023_april_promo" , "status"
 : "APPROVED" }
 }
 }
Параметры заголовка
Строка User-Agent
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Строка авторизации · обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
Строка версии · обязательный
TEMPLATE_ID строка · обязательный
Ответы
Руководство: Шаблоны сообщений
Справочная информация по конечной точке: Шаблон сообщения WhatsApp
200
Пример ответа
Тип содержимого: application/json
Схема: объект
Показать дочерние атрибуты
строка категории
компонентов объекта
Показать дочерние атрибуты
компоненты[] объект
Показать дочерние атрибуты
кнопки массив объектов
Показать дочерние атрибуты
кнопки[] объект
Показать дочерние атрибуты
текстовая строка
тип строка
пример объекта
Показать дочерние атрибуты
body_text массив массивов строк
Показать дочерние атрибуты
body_text[] массив строк
Показать дочерние атрибуты
body_text[][] string
формат строки
текстовая строка
тип строка
строка идентификатора
строка языка
строка имени
строка статуса
Выберите язык
curl
 --request GET \ --url
 'https://graph.facebook.com/{Version}/{TEMPLATE_ID }' \ --header
 'Authorization: Bearer ' \ --header
 'Content-Type: application/json' \ --data
 '{}'
Выберите код состояния
{
 "Пример ответа"
 : { "значение"
 : { "категория"
 : "МАРКЕТИНГ" , "компоненты"
 : [ {
 "формат"
 : "ТЕКСТ" , "текст"
 : "Осенняя распродажа" , "тип"
 : "ЗАГОЛОВОК" },
 {
 "пример"
 : { "body_text"
 : [ [
 "ОСЕНЬ25"
 ]
 ]
 },
 "текст"
 : "Привет, {{1}}, наша осенняя распродажа началась! Используйте промокод {{2 }} и получите дополнительную скидку 25% на каждый заказ свыше 350 долларов!" , "type"
 : "BODY" },
 {
 "text"
 : "Не интересуетесь нашими акциями? Нажмите "Остановить акции " , "type"
 : "FOOTER" },
 {
 "buttons"
 : [ {
 "text"
 : "Остановить акции" , "type"
 : "QUICK_REPLY" }
 ],
 "type"
 : "BUTTONS" }
 ],
 "id"
 : "920070352646140" , "language"
 : "en_US" , "name"
 : "2023_april_promo" , "status"
 : "APPROVED" }
 }
 }

POST /{Version}/{TEMPLATE_ID}

Руководство: Шаблоны сообщений
Справочная информация по конечной точке: Шаблон сообщения WhatsApp

Синтаксис запроса

POST / {Version} / {TEMPLATE_ID}
Попробуйте!
Выберите язык
curl
 --request POST \ --url
 'https://graph.facebook.com/{Version}/{TEMPLATE_ID }' \ --header
 'Authorization: Bearer ' \ --header
 'Content-Type: application/json' \ --data
 '{ "category": "MARKETING",
 "components": [
 {
 "format": "TEXT",
 "text": "Осенняя распродажа",
 "type": "HEADER"
 },
 {
 "example": {
 "body_text": [
 [
 "FALL25"
 ]
 ]
 },
 "text": "Привет, {{1}}, наша осенняя распродажа началась! Используйте
 промокод {{2}} и получите дополнительную скидку 25% на каждый заказ свыше 350 долларов!", "type": "BODY"
 },
 {
 "text": "Не интересуетесь нашими распродажами?
 Нажмите "Остановить акции"", "type": "FOOTER"
 },
 {
 "buttons": [
 {
 "text": "Остановить акции"",
 "type": "QUICK_REPLY"
 }
 ],
 "type": "BUTTONS"
 }
 ],
 "language": "en_US",
 "name": "2023_april_promo"
 }'
Выберите код состояния
{
 "Пример ответа"
 : { "значение"
 : { "успех"
 : true }
 }
 }
Параметры заголовка
Строка User-Agent
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Строка авторизации · обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
Строка версии · обязательный
TEMPLATE_ID строка · обязательный
Текст запросаНеобязательный
Тип содержимого: application/json
Схема: объект
Показать дочерние атрибуты
строка категории
компонентов объекта
Показать дочерние атрибуты
компоненты[] объект
Показать дочерние атрибуты
кнопки массив объектов
Показать дочерние атрибуты
кнопки[] объект
Показать дочерние атрибуты
текстовая строка
тип строка
пример объекта
Показать дочерние атрибуты
body_text массив массивов строк
Показать дочерние атрибуты
body_text[] массив строк
Показать дочерние атрибуты
body_text[][] string
формат строки
текстовая строка
тип строка
строка языка
строка имени
Ответы
Руководство: Шаблоны сообщений
Справочная информация по конечной точке: Шаблон сообщения WhatsApp
200
Пример ответа
Тип содержимого: application/json
Схема: объект
Показать дочерние атрибуты
успех логическое значение
Выберите язык
curl
 --request POST \ --url
 'https://graph.facebook.com/{Version}/{TEMPLATE_ID }' \ --header
 'Authorization: Bearer ' \ --header
 'Content-Type: application/json' \ --data
 '{ "category": "MARKETING",
 "components": [
 {
 "format": "TEXT",
 "text": "Осенняя распродажа",
 "type": "HEADER"
 },
 {
 "example": {
 "body_text": [
 [
 "FALL25"
 ]
 ]
 },
 "text": "Привет, {{1}}, наша осенняя распродажа началась! Используйте
 промокод {{2}} и получите дополнительную скидку 25% на каждый заказ свыше 350 долларов!", "type": "BODY"
 },
 {
 "text": "Не интересуетесь нашими распродажами?
 Нажмите "Остановить акции"", "type": "FOOTER"
 },
 {
 "buttons": [
 {
 "text": "Остановить акции"",
 "type": "QUICK_REPLY"
 }
 ],
 "type": "BUTTONS"
 }
 ],
 "language": "en_US",
 "name": "2023_april_promo"
 }'
Выберите код состояния
{
 "Пример ответа"
 : { "значение"
 : { "успех"
 : true }
 }
 }

GET /{Version}/{WABA-ID}/message_templates

Руководство: Шаблоны сообщений
Справочная информация по конечной точке: Бизнес-аккаунт WhatsApp > Шаблоны сообщений

Синтаксис запроса

GET / {Version} / {WABA-ID} /message_templates
Попробуйте!
Выберите язык
curl
 --request GET \ --url
 'https://graph.facebook.com/{Version}/{WABA-ID}/message_templates ' \ --header
 'Authorization: Bearer' ' \ --header
 'Content-Type: application/json' \ --data
 '{}'
Выберите код состояния
{
 "Пример ответа"
 : { "значение"
 : { "данные"
 : [ {
 "категория"
 : "МАРКЕТИНГ" , "компоненты"
 : [ {
 "формат"
 : "ТЕКСТ" , "текст"
 : "Привет, мир" , "тип"
 : "ЗАГОЛОВОК" },
 {
 "текст"
 : "Добро пожаловать и поздравляем!! Это сообщение демонстрирует вашу способность отправлять уведомления из облачного API платформы WhatsApp Business . Спасибо, что уделили время для тестирования с нами." , "type"
 : "BODY" },
 {
 "text"
 : "WhatsApp Business API Team" , "type"
 : "FOOTER" }
 ],
 "id"
 : "1192339204654487" , "language"
 : "en_US" , "name
  : "hello_world" , "previous_category"
 : "ACCOUNT_UPDATE" , "status"
 : "APPROVED" },
 {
 "category"
 : "MARKETING" , "components"
 : [ {
 "format"
 : "TEXT" , "text"
 : "Fall Sale" , "type"
 : "HEADER" },
 {
 "example"
 : { "body_text"
 : [ [
 "FALL25"
 ]
 ]
 },
 "text"
 : "Привет, {{1}}, наша осенняя распродажа началась! Используйте Промокод {{2 }} Получите дополнительную скидку 25% на каждый заказ свыше 350 долларов! , "type"
 : "BODY" },
 {
 "text"
 : "Не интересуетесь нашими распродажами? Нажмите "Остановить акции " , "type"
 : "FOOTER" },
 {
 "buttons"
 : [ {
 "text"
 : "Остановить акции" , "type"
 : "QUICK_REPLY" }
 ],
 "type"
 : "BUTTONS" }
 ],
 "id"
 : "920070352646140" , "language"
 : "en_US" , "name"
 : "2023_april_promo" , "status"
 : "APPROVED" }
 ],
 "paging"
 : { "cursors"
 : { "after"
 : "MjQZD" , "before"
 : "MAZDZD" }
 }
 }
 }
 }
Параметры заголовка
Строка User-Agent
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Строка авторизации · обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
Строка версии · обязательный
Строка WABA-ID · обязательный
Параметры запроса
строка имени
Ответы
Руководство: Шаблоны сообщений
Справочная информация по конечной точке: Бизнес-аккаунт WhatsApp > Шаблоны сообщений
200
Пример ответа / Пример ответа
Тип содержимого: application/json
Схема: объект
Показать дочерние атрибуты
данных объекта
Показать дочерние атрибуты
объект данных[]
Показать дочерние атрибуты
строка категории
компонентов объекта
Показать дочерние атрибуты
компоненты[] объект
Показать дочерние атрибуты
кнопки массив объектов
Показать дочерние атрибуты
кнопки[] объект
Показать дочерние атрибуты
текстовая строка
тип строка
пример объекта
Показать дочерние атрибуты
body_text массив массивов строк
Показать дочерние атрибуты
body_text[] массив строк
Показать дочерние атрибуты
body_text[][] string
формат строки
текстовая строка
тип строка
строка идентификатора
строка языка
строка имени
строка статуса
объект постраничной навигации
Показать дочерние атрибуты
объект курсоров
Показать дочерние атрибуты
после строки
перед строкой
Выберите язык
curl
 --request GET \ --url
 'https://graph.facebook.com/{Version}/{WABA-ID}/message_templates ' \ --header
 'Authorization: Bearer' ' \ --header
 'Content-Type: application/json' \ --data
 '{}'
Выберите код состояния
{
 "Пример ответа"
 : { "значение"
 : { "данные"
 : [ {
 "категория"
 : "МАРКЕТИНГ" , "компоненты"
 : [ {
 "формат"
 : "ТЕКСТ" , "текст"
 : "Привет, мир" , "тип"
 : "ЗАГОЛОВОК" },
 {
 "текст"
 : "Добро пожаловать и поздравляем!! Это сообщение демонстрирует вашу способность отправлять уведомления из облачного API платформы WhatsApp Business . Спасибо, что уделили время для тестирования с нами." , "type"
 : "BODY" },
 {
 "text"
 : "WhatsApp Business API Team" , "type"
 : "FOOTER" }
 ],
 "id"
 : "1192339204654487" , "language"
 : "en_US" , "name
  : "hello_world" , "previous_category"
 : "ACCOUNT_UPDATE" , "status"
 : "APPROVED" },
 {
 "category"
 : "MARKETING" , "components"
 : [ {
 "format"
 : "TEXT" , "text"
 : "Fall Sale" , "type"
 : "HEADER" },
 {
 "example"
 : { "body_text"
 : [ [
 "FALL25"
 ]
 ]
 },
 "text"
 : "Привет, {{1}}, наша осенняя распродажа началась! Используйте Промокод {{2 }} Получите дополнительную скидку 25% на каждый заказ свыше 350 долларов! , "type"
 : "BODY" },
 {
 "text"
 : "Не интересуетесь нашими распродажами? Нажмите "Остановить акции " , "type"
 : "FOOTER" },
 {
 "buttons"
 : [ {
 "text"
 : "Остановить акции" , "type"
 : "QUICK_REPLY" }
 ],
 "type"
 : "BUTTONS" }
 ],
 "id"
 : "920070352646140" , "language"
 : "en_US" , "name"
 : "2023_april_promo" , "status"
 : "APPROVED" }
 ],
 "paging"
 : { "cursors"
 : { "after"
 : "MjQZD" , "before"
 : "MAZDZD" }
 }
 }
 }
 }

POST /{Version}/{WABA-ID}/message_templates

Синтаксис запроса

POST / {Version} / {WABA-ID} /message_templates
Попробуйте!
Выберите язык
curl
 --request POST \ --url
 'https://graph.facebook.com/{Version}/{WABA-ID}/message_templates ' \ --header
 'Authorization: Bearer' ' \ --header
 'Content-Type: application/json' \ --data
 '{ "category": "MARKETING",
 "components": [
 {
 "text": "Ознакомьтесь с этим новым предложением",
 "type": "body"
 },
 {
 "buttons": [
 {
 "flow_action": "navigate",
 "flow_json": "{\"version\":\"5.0\",\"scr
 eens\":[{\"id\":\"WELCOME_SCREEN\",\"layout\":{\" type\":\"SingleColumnLayout\",\"children\":[{\"type \":\"TextHeading\",\"text\":\"Hello World\"},{\" type\":\"Footer\",\"label\":\"Complete\",\"on-click- action\":{\"name\":\"complete\",\"payload\":{}}}]} ,\"title\":\"Добро пожаловать\",\"терминал\":true,\"успех \":true,\"данные\":{}}]}", "экран навигации": "Экран приветствия",
 "текст": "Ознакомьтесь с этим предложением!",
 "тип": "ПОТОК"
 }
 ],
 "тип": "КНОПКИ"
 }
 ],
 "язык": "en_US",
 "имя": " "
 }'
Выберите код состояния
{
 "Создать шаблон сообщения потока по JSON потока"
 : { "value"
 : { "category"
 : "MARKETING" , "id"
 : "template-1" , "status"
 : "PENDING" }
 },
 "Создать шаблон сообщения потока по ID"
 : { "value"
 : { "category"
 : "MARKETING" , "id"
 : "template-1" , "status"
 : "PENDING" }
 },
 "Создать шаблон сообщения потока по имени"
 : { "value"
 : { "category"
 : "MARKETING" , "id"
 : "template-1" , "status"
 : "PENDING" }
 },
 "Пример ответа"
 : { "value"
 : { "category"
 : "UTILITY" , "id"
 : "1689556908129832" , "статус"
 : "ОЖИДАЕТСЯ" }
 }
 }
Параметры заголовка
Строка User-Agent
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Строка авторизации · обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
Строка версии · обязательный
Строка WABA-ID · обязательный
Текст запросаНеобязательный
Тип содержимого: application/json
Схема: объект
Показать дочерние атрибуты
строка категории
компонентов объекта
Показать дочерние атрибуты
компоненты[] объект
Показать дочерние атрибуты
кнопки массив объектов
Показать дочерние атрибуты
кнопки[] объект
Показать дочерние атрибуты
строка flow_action
flow_id строка
строка navigate_screen
текстовая строка
тип строка
текстовая строка
тип строка
строка языка
строка имени
Ответы
200
Пример ответа / Пример ответа / Пример ответа / Пример ответа / Пример ответа / Пример ответа / Пример ответа / Пример ответа / Создать сообщение шаблона потока по имени / Создать сообщение шаблона потока по JSON потока / Создать сообщение шаблона потока по ID
Тип содержимого: application/json
Схема: объект
Показать дочерние атрибуты
строка категории
строка идентификатора
строка статуса
Выберите язык
curl
 --request POST \ --url
 'https://graph.facebook.com/{Version}/{WABA-ID}/message_templates ' \ --header
 'Authorization: Bearer' ' \ --header
 'Content-Type: application/json' \ --data
 '{ "category": "MARKETING",
 "components": [
 {
 "text": "Ознакомьтесь с этим новым предложением",
 "type": "body"
 },
 {
 "buttons": [
 {
 "flow_action": "navigate",
 "flow_json": "{\"version\":\"5.0\",\"scr
 eens\":[{\"id\":\"WELCOME_SCREEN\",\"layout\":{\" type\":\"SingleColumnLayout\",\"children\":[{\"type \":\"TextHeading\",\"text\":\"Hello World\"},{\" type\":\"Footer\",\"label\":\"Complete\",\"on-click- action\":{\"name\":\"complete\",\"payload\":{}}}]} ,\"title\":\"Добро пожаловать\",\"терминал\":true,\"успех \":true,\"данные\":{}}]}", "экран навигации": "Экран приветствия",
 "текст": "Ознакомьтесь с этим предложением!",
 "тип": "ПОТОК"
 }
 ],
 "тип": "КНОПКИ"
 }
 ],
 "язык": "en_US",
 "имя": " "
 }'
Выберите код состояния
{
 "Создать шаблон сообщения потока по JSON потока"
 : { "value"
 : { "category"
 : "MARKETING" , "id"
 : "template-1" , "status"
 : "PENDING" }
 },
 "Создать шаблон сообщения потока по ID"
 : { "value"
 : { "category"
 : "MARKETING" , "id"
 : "template-1" , "status"
 : "PENDING" }
 },
 "Создать шаблон сообщения потока по имени"
 : { "value"
 : { "category"
 : "MARKETING" , "id"
 : "template-1" , "status"
 : "PENDING" }
 },
 "Пример ответа"
 : { "value"
 : { "category"
 : "UTILITY" , "id"
 : "1689556908129832" , "статус"
 : "ОЖИДАЕТСЯ" }
 }
 }

Удалить /{Версия}/{WABA-ID}/message_templates

Руководство: Шаблоны сообщений
Справочная информация по конечной точке: Бизнес-аккаунт WhatsApp > Шаблоны сообщений

Синтаксис запроса

DELETE / {Version} / {WABA-ID} /message_templates
Попробуйте!
Выберите язык
curl
 --request DELETE \ --url
 'https://graph.facebook.com/{Version}/{WABA-ID}/message_templates ' \ --header
 'Authorization: Bearer' ' \ --header
 'Content-Type: application/json' \ --data
 '{}'
Выберите код состояния
{
 "Пример ответа"
 : { "значение"
 : { "успех"
 : true }
 }
 }
Параметры заголовка
Строка User-Agent
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Строка авторизации · обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
Строка версии · обязательный
Строка WABA-ID · обязательный
Параметры запроса
строка имени
строка hsm_id
Идентификатор шаблона
Ответы
Руководство: Шаблоны сообщений
Справочная информация по конечной точке: Бизнес-аккаунт WhatsApp > Шаблоны сообщений
200
Пример ответа / Пример ответа
Тип содержимого: application/json
Схема: объект
Показать дочерние атрибуты
успех логическое значение
Выберите язык
curl
 --request DELETE \ --url
 'https://graph.facebook.com/{Version}/{WABA-ID}/message_templates ' \ --header
 'Authorization: Bearer' ' \ --header
 'Content-Type: application/json' \ --data
 '{}'
Выберите код состояния
{
 "Пример ответа"
 : { "значение"
 : { "успех"
 : true }
 }
 }

Аутентификация

Схема
Тип
Расположение
bearerAuth
HTTP Bearer
Заголовок: Авторизация

Примеры использования

bearerAuth:
Включите Authorization: Bearer your-token-here в заголовки запроса.

Глобальные требования к аутентификации

Для работы всех конечных точек требуется:
bearerAuth
Вернуться наверх