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

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

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

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

База

URL
https://graph.facebook.com

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


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

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

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

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

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нить·необходимый

тип_получателяOne of "individual", "group"·необходимый
Тип получателя.bearerAuth

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

тип"текст"

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

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

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

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

preview_urlлогический

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

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

тип_получателяOne of "individual", "group"·необходимый
Тип получателя.

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

тип"аудио"

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

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

аудиоMust be one of: unknown, unknown
A media object. Either идентификатор или связь is required.
Показать дочерние атрибуты

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

идентификаторнить·необходимый
The media object ID. Required when связь is not used.

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

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

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

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

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

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

тип_получателяOne of "individual", "group"·необходимый
Тип получателя.

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

тип"document"

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

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

документMust be one of: unknown, unknown
A media object. Either идентификатор или связь is required.
Показать дочерние атрибуты

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

идентификаторнить·необходимый
The media object ID. Required when связь is not used.

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

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

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

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

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

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

тип_получателяOne of "individual", "group"·необходимый
Тип получателя.

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

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

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

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

изображениеMust be one of: unknown, unknown
A media object. Either идентификатор или связь is required.
Показать дочерние атрибуты

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

идентификаторнить·необходимый
The media object ID. Required when связь is not used.

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

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

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

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

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

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

тип_получателяOne of "individual", "group"·необходимый
Тип получателя.

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

тип"location"

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

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

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

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

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

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

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

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

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

тип_получателяOne of "individual", "group"·необходимый
Тип получателя.

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

тип"video"

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

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

видеоMust be one of: unknown, unknown
A media object. Either идентификатор или связь is required.
Показать дочерние атрибуты

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

идентификаторнить·необходимый
The media object ID. Required when связь is not used.

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

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

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

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

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

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

тип_получателяOne of "individual", "group"·необходимый
Тип получателя.

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

тип"sticker"

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

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

stickerMust be one of: object, object·необходимый
Показать дочерние атрибуты

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

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

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

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

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

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

тип_получателяOne of "individual", "group"·необходимый
Тип получателя.

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

тип"reaction"

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

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

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

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

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

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

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

тип_получателяOne of "individual", "group"·необходимый
Тип получателя.

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

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

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

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

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

типOne of "button", "call_permission_request", "catalog_message", "list", "product", "product_list", "flow"·необходимый
Тип интерактивного сообщения для отправки.

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

типOne of "text", "video", "image", "document"·необходимый
Тип заголовка.

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

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

документMust be one of: unknown, unknown
A media object. Either идентификатор или связь is required.
Показать дочерние атрибуты

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

идентификаторнить·необходимый
The media object ID. Required when связь is not used.

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

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

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

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

изображениеMust be one of: unknown, unknown
A media object. Either идентификатор или связь is required.
Показать дочерние атрибуты

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

идентификаторнить·необходимый
The media object ID. Required when связь is not used.

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

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

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

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

видеоMust be one of: unknown, unknown
A media object. Either идентификатор или связь is required.
Показать дочерние атрибуты

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

идентификаторнить·необходимый
The media object ID. Required when связь is not used.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

параметрыMust be one of: unknown, unknown·необходимый
Показать дочерние атрибуты

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

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

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

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

режимOne of "draft", "published"
Текущий режим работы потока: «черновик» или «опубликованный».

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

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

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

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

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

неизвестный

неизвестный

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

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

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

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

тип_получателяOne of "individual", "group"·необходимый
Тип получателя.

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

тип"шаблон"

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

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

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

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

языкLanguageObject·необходимый
Contains a язык object. Specifies the language the template may be rendered in

компонентыarray of TemplateComponent
Array of компоненты objects containing the parameters of the message.
Показать дочерние атрибуты

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

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

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

тип_получателяOne of "individual", "group"·необходимый
Тип получателя.

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

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

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

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

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

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

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

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

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

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

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

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

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

типOne of "HOME", "WORK"
Тип адреса

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

birthdaystring (date)
Дата рождения (в формате ГГГГ-ММ-ДД)

emailsarray of EmailObject
Контактный(е) адрес(а) электронной почты
Показать дочерние атрибуты

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

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

типOne of "HOME", "WORK"
Тип электронной почты

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

first_nameнить
Имя

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

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

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

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

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

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

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

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

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

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

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

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

типOne of "HOME", "WORK"
Тип телефона

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

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

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

типOne of "HOME", "WORK"
тип URL

urlstring (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

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

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

входнить

wa_idнить

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

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

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

message_statusOne of "accepted", "held_for_quality_assessment", "paused"
Статус сообщения WhatsApp:
принял: The message has been accepted by WhatsApp and is being processed
held_for_quality_assessment: The message is being held for quality assessment before delivery
paused: The message delivery has been paused

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