WhatsApp Cloud API - Упрощенный API для маркетинговых сообщений | Документация для разработчиков
WhatsApp Cloud API - Marketing Messages Lite API
Экземпляр для программы магистратуры (LLM)
Версия
Отправляйте маркетинговые сообщения по шаблону с автоматической оптимизацией доставки.
Доставляет актуальные и своевременные сообщения клиентам, наиболее склонным к взаимодействию
с улучшенной доставляемостью и анализом конверсий на последующих этапах воронки продаж.
База
URL
Конечные точки
POST /{Version}/{Phone-Number-ID}/marketing_messages
Отправляйте маркетинговые сообщения, используя предварительно утвержденные шаблоны. Поддерживаются дополнительные параметры управления политикой продукта и настройки обмена информацией об активности в сообщениях.
Синтаксис запроса
POST / {Version} / {Phone-Number-ID} /marketing_messages
Попробуйте!
Выберите язык
curl --request POST \ --url 'https://graph.facebook.com/{Version}/{Phone-Number-ID}/marketing_messages' \ --header 'Authorization: Bearer<Token> ' \ --header 'Content-Type: application/json' \ --data '{ "messaging_product": "whatsapp", "recipient_type": "individual", "to": "16315552222", "type": "template", "template": { "name": "hello_world", "language": { "code": "en" } } }'
Выберите код состояния
{ "Успешный ответ": { "summary": "Успешный ответ на маркетинговое сообщение", "value": { "contacts": [ { "input": "16315552222", "wa_id": "16315552222" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp", "success": true } } }
Параметры заголовка
Строка User-Agent
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Строка авторизации · обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Content-Type — один из следующих типов данных: "application/json", "application/x-www-form-urlencoded", "multipart/form-data" · required
Тип носителя информации в теле запроса
Параметры пути
Строка версии · обязательный
Версия API WhatsApp (например, v20.0)
Строка идентификатора номера телефона · обязательный
Идентификатор бизнес-телефона WhatsApp
Текст запросаНеобходимый
Тип содержимого: application/json
Схема: MarketingMessageRequestPayload
Показать дочерние атрибуты
MarketingMessageRequestPayload
messaging_product "whatsapp" · required
Используемый мессенджер. Обязательно WhatsApp
recipient_type "individual" · required
Тип получателя. Должен быть "индивидуальный"
в строку · обязательный
Идентификатор WhatsApp или номер телефона получателя сообщения
тип "шаблон" · обязательный
Тип сообщения. Для маркетинговых сообщений должен быть "шаблон"
шаблонный объект · обязательный
Показать дочерние атрибуты
строка имени · обязательный
Название шаблона.
язык LanguageObject · обязательный
Содержит
языковой объект. Указывает язык, на котором может быть отображен шаблон. компонентов TemplateComponent
Массив
-компонентов , содержащих параметры сообщения.Показать дочерние атрибуты
компоненты[] TemplateComponent
product_policy Один из "CLOUD_API_FALLBACK", "STRICT"
Дополнительная настройка политики продукта
message_activity_sharing boolean
Дополнительный флаг для управления обменом сообщениями
Ответы
Отправляйте маркетинговые сообщения, используя предварительно утвержденные шаблоны. Поддерживаются дополнительные параметры управления политикой продукта и настройки обмена информацией об активности в сообщениях.
200
Маркетинговое сообщение успешно отправлено
Тип содержимого: application/json
Схема: MarketingMessageResponsePayload
Показать дочерние атрибуты
Маркетинговое сообщениеОтветПолезная нагрузка
контактов объекта
Показать дочерние атрибуты
контакт[] объект
Показать дочерние атрибуты
входная строка
строка wa_id
сообщений объекта
Показать дочерние атрибуты
сообщения[] объект
Показать дочерние атрибуты
строка идентификатора
message_status Один из вариантов: "accepted", "held_for_quality_assessment", "paused"
Статус сообщения WhatsApp:
Принято : Сообщение принято WhatsApp и находится в обработке.held_for_quality_assessment : Сообщение задерживается для проверки качества перед доставкой.Приостановлено : Доставка сообщения приостановлена.messaging_product string
400
Неверный запрос - Недопустимые параметры запроса
Тип содержимого: application/json
401
Несанкционированный доступ - Недействительный или отсутствующий токен доступа
Тип содержимого: application/json
403
Запрещено — Шаблон не одобрен или имеются недостаточные права доступа
Тип содержимого: application/json
Выберите язык
curl --request POST \ --url 'https://graph.facebook.com/{Version}/{Phone-Number-ID}/marketing_messages' \ --header 'Authorization: Bearer<Token> ' \ --header 'Content-Type: application/json' \ --data '{ "messaging_product": "whatsapp", "recipient_type": "individual", "to": "16315552222", "type": "template", "template": { "name": "hello_world", "language": { "code": "en" } } }'
Выберите код состояния
{ "Успешный ответ": { "summary": "Успешный ответ на маркетинговое сообщение", "value": { "contacts": [ { "input": "16315552222", "wa_id": "16315552222" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp", "success": true } } }
Аутентификация
Схема
Тип
Расположение
bearerAuth
HTTP Bearer
Заголовок:
АвторизацияПримеры использования
bearerAuth:
Включите
Authorization: Bearer your-token-here в заголовки запроса.Глобальные требования к аутентификации
Для работы всех конечных точек требуется:
bearerAuth