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

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

WhatsApp Cloud API - API сообщений

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

База

URL
https://graph.facebook.com

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


ПОЧТА /{Версия}/{Идентификатор-номера-телефона}/сообщения

Отправить сообщение.

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

ПОЧТА /{Версия}/{Номер-телефона-ID}/сообщения
Попробуйте!
Выберите язык

curl --request POST \ --url 'https://graph.facebook.com/{Version}/{Phone-Number-ID}/messages' \ --header 'Authorization: Bearer<Token> ' \ --header 'Content-Type: application/json' \ --data '{ "audio": { "id": "<AUDIO_OBJECT_ID> " }, "messaging_product": "whatsapp", "recipient_type": "individual", "to": "{{Recipient-Phone-Number}}", "type": "audio" }'
Выберите код состояния

{ "Пример ответа": { "значение": { "контакты": [ { "ввод": "+16505551234", "wa_id": "16505551234" } ], "сообщения": [ { "id": "wamid.HBgLMTY1MDM4Nzk0MzkVAgARGBJCOTY3NDc0NDFDRUI3NTA0Q0UA" } ], "messaging_product": "whatsapp" } }, "Отправить аудиосообщение по URL": { "значение": { "контакты": [ { "ввод": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "сообщения": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить аудио Сообщение по ID: { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить сообщение контакту: { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить сообщение документу по ID: { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить сообщение документа по URL": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить черновик по ID": { "value": { "contacts": [ { "input": "18055555555", "wa_id": "18055555555" } ], "messages": [ { "id": "wamid.HBgL..." } ], "messaging_product": "whatsapp" } }, "Send Draft Flow by Name": { "value": { "contacts": [ { "input": "18055555555", "wa_id": "18055555555" } ], "messages": [ { "id": "wamid.HBgL..." } ], "messaging_product": "whatsapp" } }, "Send Flow Template Message": { "value": { "contacts": [ { "input": "18055555555", "wa_id": "18055555555" } ], "messages": [ { "id": "wamid.HBgL..." } ], "messaging_product": "whatsapp" } }, "Отправить сообщение с изображением по ID": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить сообщение с изображением по URL": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить интерактивный шаблон сообщения": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Send List Message": { "value": { "contacts": [ { "input": "15555551234", "wa_id": "<WHATSAPP_ID> " } ], "messages": [ { "id": "wamid.ID" } ], "messaging_product": "whatsapp" } }, "Send Location Messages": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Send Message Template Media": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить текст шаблона сообщения": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить опубликованный поток по ID": { "value": { "contacts": [ { "input": "18055555555", "wa_id": "18055555555" } ], "messages": [ { "id": "wamid.HBgL..." } ], "messaging_product": "whatsapp" } }, "Отправить опубликованный поток по имени": { "value": { "contacts": [ { "input": "18055555555", "wa_id": "18055555555" } ], "messages": [ { "id": "wamid.HBgL..." } ], "messaging_product": "whatsapp" } }, "Кнопка отправки ответа": { "value": { "contacts": [ { "input": "НОМЕР_ТЕЛЕФОНА", "wa_id": "ИДЕНТИФИКАТОР_WHATSAPP" } ], "messages": [ { "id": "wamid.ID" } ], "messaging_product": "whatsapp" } }, "Отправить ответ на аудиосообщение по ID": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить ответ на аудиосообщение по URL": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить ответ на сообщение контакта": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить ответ на сообщение документа по ID": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить ответ на сообщение документа по URL": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить ответ на сообщение с изображением по ID": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить ответ на сообщение с изображением по URL": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить ответ на сообщение в списке": { "value": { "contacts": [ { "input": "15555551234", "wa_id": "<WHATSAPP_ID> " } ], "messages": [ { "id": "wamid.ID" } ], "messaging_product": "whatsapp" } }, "Отправить ответ на сообщение с указанием местоположения": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить ответ на сообщение со стикером по ID": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить ответ на стикер-сообщение по URL": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить ответ на текстовое сообщение": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить Ответить на видеосообщение по ID: { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить ответ на видеосообщение по URL": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить ответ с реакцией": { "value": { "contacts": [ { "вход": "<PHONE_NUMBER> ", "wa_id": "<WHATSAPP_ID> " } ], "messages": [ { "id": "wamid.HBgLM..." } ], "messaging_product": "whatsapp" } }, "Send Sample Shipping Confirmation Template": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Send Sample Text message": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Send Single Product Message": { "value": { "contacts": [ { "input": "+1-631-555-5555", "wa_id": "16315555555" } ], "messages": [ { "id": "wamid.gBGGFlaCGg0xcvAdgmZ9plHrf2Mh-o" } ], "messaging_product": "whatsapp" } }, "Send Sticker Message By ID": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить стикер-сообщение по URL": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить тестовое сообщение": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить текстовое сообщение": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить видеосообщение по ID": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить видеосообщение по URL": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Send typing indicator and read receipt": { "value": { "success": true } } }

Параметры заголовка
Агент пользователянить
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Авторизациянить·необходимый
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Content-TypeОдин из "application/json", "application/x-www-form-urlencoded", "multipart/form-data"·необходимый
Тип носителя информации в теле запроса
Параметры пути
Версиянить·необходимый
Номер телефона - IDнить·необходимый

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

Схема
Тип
Расположение
Запрос ТелоНеобязательный
Содержание Тип: приложение/json
Схема: Сообщение
Показать дочерние атрибуты

Сообщение

Текстовое сообщение
Показать дочерние атрибуты

messaging_productнить·необходимый

тип_получателяОдин из "индивидуальных", "групповых"·необходимый
Тип получателя.bearerAuth

книть·необходимый
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.

тип"текст"

контекстобъект
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты

message_idнить
Идентификатор сообщения, на которое данное сообщение является ответом.

текстобъект·необходимый
Показывать дочерние атрибуты

телонить
Текст сообщения.

preview_urlлогический

Аудиосообщение
Показать дочерние атрибуты

messaging_productнить·необходимый

тип_получателяОдин из "индивидуальных", "групповых"·необходимый
Тип получателя.

книть·необходимый
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.

тип"аудио"

контекстобъект
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты

message_idнить
Идентификатор сообщения, на которое данное сообщение является ответом.

аудиоДолжно быть одно из следующих значений: неизвестно, неизвестно
Медиаобъект. Либо идентификатор или связь требуется.
Показать дочерние атрибуты

неизвестный
Показать дочерние атрибуты

идентификаторнить·необходимый
Идентификатор медиаобъекта. Требуется, когда связь не используется.

подписьнить
Дополнительная подпись для медиафайлов (по желанию)

неизвестный
Показать дочерние атрибуты

связьстрока (url)·необходимый
Протокол и URL-адрес отправляемых медиафайлов (только HTTP/HTTPS).

подписьнить
Дополнительная подпись для медиафайлов (по желанию)

ДокументСообщение
Показать дочерние атрибуты

messaging_productнить·необходимый

тип_получателяОдин из "индивидуальных", "групповых"·необходимый
Тип получателя.

книть·необходимый
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.

тип"документ"

контекстобъект
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты

message_idнить
Идентификатор сообщения, на которое данное сообщение является ответом.

документДолжно быть одно из следующих значений: неизвестно, неизвестно
Медиаобъект. Либо идентификатор или связь требуется.
Показать дочерние атрибуты

неизвестный
Показать дочерние атрибуты

идентификаторнить·необходимый
Идентификатор медиаобъекта. Требуется, когда связь не используется.

подписьнить
Дополнительная подпись для медиафайлов (по желанию)

неизвестный
Показать дочерние атрибуты

связьстрока (url)·необходимый
Протокол и URL-адрес отправляемых медиафайлов (только HTTP/HTTPS).

подписьнить
Дополнительная подпись для медиафайлов (по желанию)

ImageMessage
Показать дочерние атрибуты

messaging_productнить·необходимый

тип_получателяОдин из "индивидуальных", "групповых"·необходимый
Тип получателя.

книть·необходимый
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.

тип"изображение"

контекстобъект
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты

message_idнить
Идентификатор сообщения, на которое данное сообщение является ответом.

изображениеДолжно быть одно из следующих значений: неизвестно, неизвестно
Медиаобъект. Либо идентификатор или связь требуется.
Показать дочерние атрибуты

неизвестный
Показать дочерние атрибуты

идентификаторнить·необходимый
Идентификатор медиаобъекта. Требуется, когда связь не используется.

подписьнить
Дополнительная подпись для медиафайлов (по желанию)

неизвестный
Показать дочерние атрибуты

связьстрока (url)·необходимый
Протокол и URL-адрес отправляемых медиафайлов (только HTTP/HTTPS).

подписьнить
Дополнительная подпись для медиафайлов (по желанию)

LocationMessage
Показать дочерние атрибуты

messaging_productнить·необходимый

тип_получателяОдин из "индивидуальных", "групповых"·необходимый
Тип получателя.

книть·необходимый
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.

тип"расположение"

контекстобъект
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты

message_idнить
Идентификатор сообщения, на которое данное сообщение является ответом.

расположениеобъект·необходимый
Показать дочерние атрибуты

адреснить
Адрес местоположения.

широтанить
Широта местоположения.

долготанить
Долгота местоположения.

имянить
Название населенного пункта.

Видеосообщение
Показать дочерние атрибуты

messaging_productнить·необходимый

тип_получателяОдин из "индивидуальных", "групповых"·необходимый
Тип получателя.

книть·необходимый
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.

тип"видео"

контекстобъект
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты

message_idнить
Идентификатор сообщения, на которое данное сообщение является ответом.

видеоДолжно быть одно из следующих значений: неизвестно, неизвестно
Медиаобъект. Либо идентификатор или связь требуется.
Показать дочерние атрибуты

неизвестный
Показать дочерние атрибуты

идентификаторнить·необходимый
Идентификатор медиаобъекта. Требуется, когда связь не используется.

подписьнить
Дополнительная подпись для медиафайлов (по желанию)

неизвестный
Показать дочерние атрибуты

связьстрока (url)·необходимый
Протокол и URL-адрес отправляемых медиафайлов (только HTTP/HTTPS).

подписьнить
Дополнительная подпись для медиафайлов (по желанию)

НаклейкаСообщение
Показать дочерние атрибуты

messaging_productнить·необходимый

тип_получателяОдин из "индивидуальных", "групповых"·необходимый
Тип получателя.

книть·необходимый
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.

тип"наклейка"

контекстобъект
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты

message_idнить
Идентификатор сообщения, на которое данное сообщение является ответом.

наклейкаДолжно быть одним из следующих значений: объект, объект·необходимый
Показать дочерние атрибуты

объект
Показать дочерние атрибуты

идентификаторнить·необходимый
Идентификатор наклейки.

объект
Показать дочерние атрибуты

связьнить·необходимый
URL-адрес наклейки.

Реакция
Показать дочерние атрибуты

messaging_productнить·необходимый

тип_получателяОдин из "индивидуальных", "групповых"·необходимый
Тип получателя.

книть·необходимый
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.

тип"реакция"

контекстобъект
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты

message_idнить
Идентификатор сообщения, на которое данное сообщение является ответом.

реакцияобъект·необходимый
Показать дочерние атрибуты

эмодзинить
эмодзи

message_idнить
отреагировал идентификатор сообщения

Интерактивное сообщение
Показать дочерние атрибуты

messaging_productнить·необходимый

тип_получателяОдин из "индивидуальных", "групповых"·необходимый
Тип получателя.

книть·необходимый
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.

тип"интерактивный"

контекстобъект
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты

message_idнить
Идентификатор сообщения, на которое данное сообщение является ответом.

интерактивныйобъект
Объект, содержащий содержимое интерактивного сообщения.
Показать дочерние атрибуты

типОдин из "кнопки", "запроса на разрешение вызова", "сообщения каталога", "списка", "продукта", "списка продуктов", "потока"·необходимый
Тип интерактивного сообщения для отправки.

заголовокобъект
Содержимое заголовка, отображаемое поверх сообщения. Обязательно для типа 'product_list'. Не может быть задано для типа 'product'.
Показать дочерние атрибуты

типОдин из следующих типов данных: "текст", "видео", "изображение", "документ"·необходимый
Тип заголовка.

текстнить
Текст для заголовка. Обязателен, если 'type' имеет значение 'text'. Поддерживаются эмодзи, разметка Markdown не используется.

подтекстнить
Дополнительный подтекст для заголовка (необязательно). Поддерживаются эмодзи, разметка Markdown не используется.

документДолжно быть одно из следующих значений: неизвестно, неизвестно
Медиаобъект. Либо идентификатор или связь требуется.
Показать дочерние атрибуты

неизвестный
Показать дочерние атрибуты

идентификаторнить·необходимый
Идентификатор медиаобъекта. Требуется, когда связь не используется.

подписьнить
Дополнительная подпись для медиафайлов (по желанию)

неизвестный
Показать дочерние атрибуты

связьстрока (url)·необходимый
Протокол и URL-адрес отправляемых медиафайлов (только HTTP/HTTPS).

подписьнить
Дополнительная подпись для медиафайлов (по желанию)

изображениеДолжно быть одно из следующих значений: неизвестно, неизвестно
Медиаобъект. Либо идентификатор или связь требуется.
Показать дочерние атрибуты

неизвестный
Показать дочерние атрибуты

идентификаторнить·необходимый
Идентификатор медиаобъекта. Требуется, когда связь не используется.

подписьнить
Дополнительная подпись для медиафайлов (по желанию)

неизвестный
Показать дочерние атрибуты

связьстрока (url)·необходимый
Протокол и URL-адрес отправляемых медиафайлов (только HTTP/HTTPS).

подписьнить
Дополнительная подпись для медиафайлов (по желанию)

видеоДолжно быть одно из следующих значений: неизвестно, неизвестно
Медиаобъект. Либо идентификатор или связь требуется.
Показать дочерние атрибуты

неизвестный
Показать дочерние атрибуты

идентификаторнить·необходимый
Идентификатор медиаобъекта. Требуется, когда связь не используется.

подписьнить
Дополнительная подпись для медиафайлов (по желанию)

неизвестный
Показать дочерние атрибуты

связьстрока (url)·необходимый
Протокол и URL-адрес отправляемых медиафайлов (только HTTP/HTTPS).

подписьнить
Дополнительная подпись для медиафайлов (по желанию)

телообъект
Объект, содержащий текст сообщения. Необязателен для типа «продукт», обязателен для других типов интерактивных сообщений.
Показать дочерние атрибуты

текстнить·необходимый
Содержимое тела сообщения. Поддерживаются эмодзи и разметка Markdown.

нижний колонтитулобъект
Объект, содержащий нижнюю часть сообщения. Необязательный.
Показать дочерние атрибуты

текстнить·необходимый
Содержимое нижнего колонтитула. Поддерживаются эмодзи, разметка Markdown и ссылки.

действиеДолжно быть одно из следующих значений: неизвестно, неизвестно, неизвестно, неизвестно, неизвестно, неизвестно
Действие, которое вы хотите, чтобы пользователь выполнил после прочтения сообщения. Его структура различается в зависимости от типа интерактивного сообщения.
Показать дочерние атрибуты

неизвестный
Показать дочерние атрибуты

кнопканить·необходимый
Содержимое кнопки для списка сообщений. Не может быть пустым, должно быть уникальным. Поддерживаются эмодзи, разметка Markdown не допускается.

разделымассив SectionObject·необходимый
Массив объектов разделов.
Показать дочерние атрибуты

разделы[]объект
Объект раздела, используемый в сообщениях-списках и сообщениях, содержащих информацию о нескольких товарах.
Показать дочерние атрибуты

заголовокнить
Заголовок раздела. Обязательно, если сообщение содержит более одного раздела. Максимум 24 символа.

товарымассив объектов
Массив объектов продукта.
Показать дочерние атрибуты

товарные_предметы[]объект
Показать дочерние атрибуты

product_retailer_idнить·необходимый
Уникальный идентификатор товара в каталоге.

рядымассив объектов
Содержит список строк.
Показать дочерние атрибуты

строк[]объект
Показать дочерние атрибуты

идентификаторнить·необходимый
Уникальный идентификатор строки.

заголовокнить·необходимый
Заголовок строки.

описаниенить
Необязательное описание строки.

неизвестный
Показать дочерние атрибуты

кнопкимассив объектов·необходимый
Массив объектов-кнопок.
Показать дочерние атрибуты

кнопки[]объект
Показать дочерние атрибуты

тип"отвечать"·необходимый
Для кнопки «Ответ» поддерживается только тип «ответ».

отвечатьобъект·необходимый
Показать дочерние атрибуты

идентификаторнить·необходимый
Уникальный идентификатор для вашей кнопки. Без пробелов в начале и конце.

заголовокнить·необходимый
Заголовок кнопки. Не может быть пустым, должен быть уникальным. Поддерживаются эмодзи, разметка Markdown не допускается.

неизвестный
Показать дочерние атрибуты

catalog_idнить·необходимый
Уникальный идентификатор каталога Facebook, связанного с вашим бизнес-аккаунтом WhatsApp.

product_retailer_idнить
Уникальный идентификатор товара в каталоге. Обязателен для сообщений, содержащих информацию об одном товаре.

разделымассив SectionObject
Массив объектов разделов.
Показать дочерние атрибуты

разделы[]объект
Объект раздела, используемый в сообщениях-списках и сообщениях, содержащих информацию о нескольких товарах.
Показать дочерние атрибуты

заголовокнить
Заголовок раздела. Обязательно, если сообщение содержит более одного раздела. Максимум 24 символа.

товарымассив объектов
Массив объектов продукта.
Показать дочерние атрибуты

товарные_предметы[]объект
Показать дочерние атрибуты

product_retailer_idнить·необходимый
Уникальный идентификатор товара в каталоге.

рядымассив объектов
Содержит список строк.
Показать дочерние атрибуты

строк[]объект
Показать дочерние атрибуты

идентификаторнить·необходимый
Уникальный идентификатор строки.

заголовокнить·необходимый
Заголовок строки.

описаниенить
Необязательное описание строки.

неизвестный
Показать дочерние атрибуты

имя"catalog_message"·необходимый

параметрыобъект·необходимый
Показать дочерние атрибуты

thumbnail_product_retailer_idнить·необходимый
Идентификатор продавца товара для миниатюры.

неизвестный
Показать дочерние атрибуты

имя"поток"·необходимый

параметрыДолжно быть одно из следующих значений: неизвестно, неизвестно·необходимый
Показать дочерние атрибуты

flow_message_version"3"·необходимый
Должно быть "3".

flow_idнить
Уникальный идентификатор потока, предоставляемый WhatsApp. Обязателен, если не задано flow_name. Не может использоваться вместе с flow_name.

flow_nameнить
Название созданного вами потока. Обязательно, если не указан flow_id. Не может использоваться вместе с flow_id.

flow_ctaнить·необходимый
Текст на кнопке призыва к действию (например, «Регистрация»). Рекомендуется не более 30 символов, смайлики не допускаются.

режимОдин из "черновиков", "опубликованных"
Текущий режим работы потока: «черновик» или «опубликованный».

flow_tokenнить
Токен, сгенерированный компанией для использования в качестве идентификатора. По умолчанию — «не используется».

flow_actionОдин из "navigate", "data_exchange"
Для предварительного определения первого экрана используйте команду "navigate", а для более сложных сценариев использования — "data_exchange".
Показать дочерние атрибуты

flow_action_payloadобъект
Необязательно, только если 'flow_action' имеет значение 'navigate'.
Показать дочерние атрибуты

экраннить
Идентификатор ('id') первого экрана потока.

данныеобъект
Входные данные для первого экрана процесса. Должны представлять собой непустой объект.

неизвестный

неизвестный

неизвестный
Показать дочерние атрибуты

имя"call_permission_request"·необходимый

ШаблонСообщение
Показать дочерние атрибуты

messaging_productнить·необходимый

тип_получателяОдин из "индивидуальных", "групповых"·необходимый
Тип получателя.

книть·необходимый
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.

тип"шаблон"

контекстобъект
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты

message_idнить
Идентификатор сообщения, на которое данное сообщение является ответом.

шаблонобъект·необходимый
Показать дочерние атрибуты

имянить·необходимый
Название шаблона.

языкLanguageObject·необходимый
Содержит язык Объект. Указывает язык, на котором может быть отображен шаблон

компонентымассив TemplateComponent
Массив компоненты объекты, содержащие параметры сообщения.
Показать дочерние атрибуты

компоненты[]TemplateComponent

КонтактыСообщение
Показать дочерние атрибуты

messaging_productнить·необходимый

тип_получателяОдин из "индивидуальных", "групповых"·необходимый
Тип получателя.

книть·необходимый
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.

тип"контакты"

контекстобъект
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты

message_idнить
Идентификатор сообщения, на которое данное сообщение является ответом.

контактымассив ContactObject·необходимый
Показать дочерние атрибуты

контакты[]объект
Показать дочерние атрибуты

адресамассив AddressObject
Полный(е) контактный(е) адрес(а)
Показать дочерние атрибуты

адреса[]объект
Показать дочерние атрибуты

городнить
Название города

странанить
Полное название страны
Показать дочерние атрибуты

код странынить
Двухбуквенный код страны ISO

состояниенить
Государственная аббревиатура

улицанить
адрес улицы

типОдин из "ДОМА", "РАБОТЫ"
Тип адреса

зипнить
Почтовый индекс

день рождениястрока (дата)
Дата рождения (в формате ГГГГ-ММ-ДД)

электронные письмамассив объектов Email
Контактный(е) адрес(а) электронной почты
Показать дочерние атрибуты

электронные письма[]объект
Показать дочерние атрибуты

электронная почтастрока (email)·необходимый
Адрес электронной почты

типОдин из "ДОМА", "РАБОТЫ"
Тип электронной почты

имяобъект
Показать дочерние атрибуты

имянить
Имя

форматированное_имянить
Отформатированное полное имя

фамилиянить
Фамилия

второе имянить
Второе имя

префикснить
Префикс имени

суффикснить
Суффикс имени

orgобъект
Показать дочерние атрибуты

компаниянить
Название компании

отделениенить
Название отдела

заголовокнить
Должность

телефонымассив объектов PhoneObject
Контактный(е) номер(а) телефона
Показать дочерние атрибуты

телефоны[]объект
Показать дочерние атрибуты

телефоннить·необходимый
Номер телефона

типОдин из "ДОМА", "РАБОТЫ"
Тип телефона

wa_idнить
Идентификатор WhatsApp

URL-адресамассив UrlObject
Контактные URL-адреса
Показать дочерние атрибуты

urls[]объект
Показать дочерние атрибуты

типОдин из "ДОМА", "РАБОТЫ"
тип URL

urlстрока (uri)·необходимый
URL
Ответы
Отправить сообщение.
200
Отправить тестовое сообщение / Отправить текстовое сообщение / Ответить на текстовое сообщение / Ответить с реакцией / Отправить сообщение с изображением по ID / Ответить на сообщение с изображением по ID / Отправить сообщение с изображением по URL / Ответить на сообщение с изображением по URL / Отправить аудиосообщение по ID / Ответить на аудиосообщение по ID / Отправить аудиосообщение по URL / Ответить на аудиосообщение по URL / Отправить сообщение с документом по ID / Ответить на сообщение с документом по ID / Отправить сообщение с документом по URL / Ответить на сообщение с документом по URL / Отправить сообщение со стикером по ID / Ответить на сообщение со стикером по ID / Ответить на сообщение со стикером по URL / Отправить видеосообщение по ID / Ответить на видеосообщение по ID / Отправить видеосообщение по URL / Ответить на видеосообщение по URL / Отправить сообщение контакта / Ответить на сообщение контакта / Отправить сообщения с местоположением / Ответить на сообщение с местоположением / Отправить шаблон сообщения / Отправить Шаблон сообщения / Отправить интерактивный шаблон сообщения / Отправить сообщение списку / Отправить ответ на сообщение списка / Отправить кнопку ответа / Отправить сообщение об одном товаре / Пример ответа / Пример ответа / Отправить черновик сценария по имени / Отправить черновик сценария по ID / Отправить опубликованный сценарий по имени / Отправить опубликованный сценарий по ID / Отправить шаблон сообщения сценария / Отправить индикатор набора текста и уведомление о прочтении / Отправить образец текстового сообщения / Отправить образец шаблона подтверждения отправки / Отправить образец шаблона решения проблемы
Тип контента: приложение/json
Схема: MessageResponsePayload
Показать дочерние атрибуты

MessageResponsePayload

контактымассив объектов
Показать дочерние атрибуты

контакты[]объект
Показать дочерние атрибуты

входнить

wa_idнить

сообщениямассив объектов
Показать дочерние атрибуты

сообщения[]объект
Показать дочерние атрибуты

идентификаторнить

message_statusОдин из вариантов: "принято", "проверено на качество", "приостановлено"
Статус сообщения WhatsApp:
принялСообщение принято WhatsApp и находится в процессе обработки
проведена_оценка_качестваСообщение отправлено для проверки качества перед доставкой
паузаДоставка сообщений приостановлена

messaging_productнить
Выберите язык

curl --request POST \ --url 'https://graph.facebook.com/{Version}/{Phone-Number-ID}/messages' \ --header 'Authorization: Bearer<Token> ' \ --header 'Content-Type: application/json' \ --data '{ "audio": { "id": "<AUDIO_OBJECT_ID> " }, "messaging_product": "whatsapp", "recipient_type": "individual", "to": "{{Recipient-Phone-Number}}", "type": "audio" }'
Выберите код состояния

{ "Пример ответа": { "значение": { "контакты": [ { "ввод": "+16505551234", "wa_id": "16505551234" } ], "сообщения": [ { "id": "wamid.HBgLMTY1MDM4Nzk0MzkVAgARGBJCOTY3NDc0NDFDRUI3NTA0Q0UA" } ], "messaging_product": "whatsapp" } }, "Отправить аудиосообщение по URL": { "значение": { "контакты": [ { "ввод": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "сообщения": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить аудио Сообщение по ID: { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить сообщение контакту: { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить сообщение документу по ID: { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить сообщение документа по URL": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить черновик по ID": { "value": { "contacts": [ { "input": "18055555555", "wa_id": "18055555555" } ], "messages": [ { "id": "wamid.HBgL..." } ], "messaging_product": "whatsapp" } }, "Send Draft Flow by Name": { "value": { "contacts": [ { "input": "18055555555", "wa_id": "18055555555" } ], "messages": [ { "id": "wamid.HBgL..." } ], "messaging_product": "whatsapp" } }, "Send Flow Template Message": { "value": { "contacts": [ { "input": "18055555555", "wa_id": "18055555555" } ], "messages": [ { "id": "wamid.HBgL..." } ], "messaging_product": "whatsapp" } }, "Отправить сообщение с изображением по ID": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить сообщение с изображением по URL": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить интерактивный шаблон сообщения": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Send List Message": { "value": { "contacts": [ { "input": "15555551234", "wa_id": "<WHATSAPP_ID> " } ], "messages": [ { "id": "wamid.ID" } ], "messaging_product": "whatsapp" } }, "Send Location Messages": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Send Message Template Media": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить текст шаблона сообщения": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить опубликованный поток по ID": { "value": { "contacts": [ { "input": "18055555555", "wa_id": "18055555555" } ], "messages": [ { "id": "wamid.HBgL..." } ], "messaging_product": "whatsapp" } }, "Отправить опубликованный поток по имени": { "value": { "contacts": [ { "input": "18055555555", "wa_id": "18055555555" } ], "messages": [ { "id": "wamid.HBgL..." } ], "messaging_product": "whatsapp" } }, "Кнопка отправки ответа": { "value": { "contacts": [ { "input": "НОМЕР_ТЕЛЕФОНА", "wa_id": "ИДЕНТИФИКАТОР_WHATSAPP" } ], "messages": [ { "id": "wamid.ID" } ], "messaging_product": "whatsapp" } }, "Отправить ответ на аудиосообщение по ID": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить ответ на аудиосообщение по URL": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить ответ на сообщение контакта": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить ответ на сообщение документа по ID": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить ответ на сообщение документа по URL": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить ответ на сообщение с изображением по ID": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить ответ на сообщение с изображением по URL": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить ответ на сообщение в списке": { "value": { "contacts": [ { "input": "15555551234", "wa_id": "<WHATSAPP_ID> " } ], "messages": [ { "id": "wamid.ID" } ], "messaging_product": "whatsapp" } }, "Отправить ответ на сообщение с указанием местоположения": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить ответ на сообщение со стикером по ID": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить ответ на стикер-сообщение по URL": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить ответ на текстовое сообщение": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить Ответить на видеосообщение по ID: { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить ответ на видеосообщение по URL": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить ответ с реакцией": { "value": { "contacts": [ { "вход": "<PHONE_NUMBER> ", "wa_id": "<WHATSAPP_ID> " } ], "messages": [ { "id": "wamid.HBgLM..." } ], "messaging_product": "whatsapp" } }, "Send Sample Shipping Confirmation Template": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Send Sample Text message": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Send Single Product Message": { "value": { "contacts": [ { "input": "+1-631-555-5555", "wa_id": "16315555555" } ], "messages": [ { "id": "wamid.gBGGFlaCGg0xcvAdgmZ9plHrf2Mh-o" } ], "messaging_product": "whatsapp" } }, "Send Sticker Message By ID": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX" } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить стикер-сообщение по URL": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить тестовое сообщение": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить текстовое сообщение": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить видеосообщение по ID": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Отправить видеосообщение по URL": { "value": { "contacts": [ { "input": "48XXXXXXXXX", "wa_id": "48XXXXXXXXX " } ], "messages": [ { "id": "wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww" } ], "messaging_product": "whatsapp" } }, "Send typing indicator and read receipt": { "value": { "success": true } } }

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

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

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

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

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

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