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

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

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

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

Базовый URL

https://graph.facebook.com

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

POST /{Version}/{Phone-Number-ID}/messages

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

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

POST / {Version} / {Phone-Number-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 } } }
Параметры заголовка
Строка User-Agent
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Строка авторизации · обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Content-Type — один из следующих типов данных: "application/json", "application/x-www-form-urlencoded", "multipart/form-data" · required
Тип носителя информации в теле запроса
Параметры пути
Строка версии · обязательный
Строка идентификатора номера телефона · обязательный
Текст запросаНеобязательный
Тип содержимого: application/json
Схема: Сообщение
Показать дочерние атрибуты
Сообщение
Текстовое сообщение
Показать дочерние атрибуты
messaging_product string · required
recipient_type Один из вариантов: "индивидуальный", "групповой" · обязательный
Тип получателя.
в строку · обязательный
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.
тип "текст"
объект контекста
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты
message_id string
Идентификатор сообщения, на которое данное сообщение является ответом.
текстовый объект · обязательный
Показать дочерние атрибуты
тело струна
Текст сообщения.
preview_url логическое значение
Аудиосообщение
Показать дочерние атрибуты
messaging_product string · required
recipient_type Один из вариантов: "индивидуальный", "групповой" · обязательный
Тип получателя.
в строку · обязательный
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.
тип "аудио"
объект контекста
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты
message_id string
Идентификатор сообщения, на которое данное сообщение является ответом.
аудио Должно быть одно из следующих значений: неизвестно, неизвестно
Медиаобъект. Требуется идентификатор , либо ссылка
Показать дочерние атрибуты
неизвестный
Показать дочерние атрибуты
строковый идентификатор · обязательный
Идентификатор медиаобъекта. Обязателен, если ссылка не используется.
строка подписи
Дополнительная подпись для медиафайлов (по желанию)
неизвестный
Показать дочерние атрибуты
ссылки (URL) · обязательный
Протокол и URL-адрес отправляемых медиафайлов (только HTTP/HTTPS).
строка подписи
Дополнительная подпись для медиафайлов (по желанию)
ДокументСообщение
Показать дочерние атрибуты
messaging_product string · required
recipient_type Один из вариантов: "индивидуальный", "групповой" · обязательный
Тип получателя.
в строку · обязательный
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.
тип "документ"
объект контекста
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты
message_id string
Идентификатор сообщения, на которое данное сообщение является ответом.
Документ должен быть одним из следующих: неизвестный, неизвестный
Медиаобъект. Требуется идентификатор , либо ссылка
Показать дочерние атрибуты
неизвестный
Показать дочерние атрибуты
строковый идентификатор · обязательный
Идентификатор медиаобъекта. Обязателен, если ссылка не используется.
строка подписи
Дополнительная подпись для медиафайлов (по желанию)
неизвестный
Показать дочерние атрибуты
ссылки (URL) · обязательный
Протокол и URL-адрес отправляемых медиафайлов (только HTTP/HTTPS).
строка подписи
Дополнительная подпись для медиафайлов (по желанию)
ImageMessage
Показать дочерние атрибуты
messaging_product string · required
recipient_type Один из вариантов: "индивидуальный", "групповой" · обязательный
Тип получателя.
в строку · обязательный
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.
тип "изображение"
объект контекста
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты
message_id string
Идентификатор сообщения, на которое данное сообщение является ответом.
Изображение должно быть одним из следующих: неизвестно, неизвестно
Медиаобъект. Требуется идентификатор , либо ссылка
Показать дочерние атрибуты
неизвестный
Показать дочерние атрибуты
строковый идентификатор · обязательный
Идентификатор медиаобъекта. Обязателен, если ссылка не используется.
строка подписи
Дополнительная подпись для медиафайлов (по желанию)
неизвестный
Показать дочерние атрибуты
ссылки (URL) · обязательный
Протокол и URL-адрес отправляемых медиафайлов (только HTTP/HTTPS).
строка подписи
Дополнительная подпись для медиафайлов (по желанию)
LocationMessage
Показать дочерние атрибуты
messaging_product string · required
recipient_type Один из вариантов: "индивидуальный", "групповой" · обязательный
Тип получателя.
в строку · обязательный
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.
тип "местоположение"
объект контекста
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты
message_id string
Идентификатор сообщения, на которое данное сообщение является ответом.
Объект местоположения · обязательный
Показать дочерние атрибуты
строка адреса
Адрес местоположения.
строка широты
Широта местоположения.
строка долготы
Долгота местоположения.
строка имени
Название населенного пункта.
Видеосообщение
Показать дочерние атрибуты
messaging_product string · required
recipient_type Один из вариантов: "индивидуальный", "групповой" · обязательный
Тип получателя.
в строку · обязательный
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.
тип "видео"
объект контекста
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты
message_id string
Идентификатор сообщения, на которое данное сообщение является ответом.
Видео должно быть одним из следующих: неизвестно, неизвестно
Медиаобъект. Требуется идентификатор , либо ссылка
Показать дочерние атрибуты
неизвестный
Показать дочерние атрибуты
строковый идентификатор · обязательный
Идентификатор медиаобъекта. Обязателен, если ссылка не используется.
строка подписи
Дополнительная подпись для медиафайлов (по желанию)
неизвестный
Показать дочерние атрибуты
ссылки (URL) · обязательный
Протокол и URL-адрес отправляемых медиафайлов (только HTTP/HTTPS).
строка подписи
Дополнительная подпись для медиафайлов (по желанию)
НаклейкаСообщение
Показать дочерние атрибуты
messaging_product string · required
recipient_type Один из вариантов: "индивидуальный", "групповой" · обязательный
Тип получателя.
в строку · обязательный
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.
тип "наклейка"
объект контекста
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты
message_id string
Идентификатор сообщения, на которое данное сообщение является ответом.
Наклейка. Должна быть одной из следующих категорий: объект, объект · обязателен
Показать дочерние атрибуты
объект
Показать дочерние атрибуты
строковый идентификатор · обязательный
Идентификатор наклейки.
объект
Показать дочерние атрибуты
строка ссылки · обязательный
URL-адрес наклейки.
Реакция
Показать дочерние атрибуты
messaging_product string · required
recipient_type Один из вариантов: "индивидуальный", "групповой" · обязательный
Тип получателя.
в строку · обязательный
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.
тип "реакция"
объект контекста
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты
message_id string
Идентификатор сообщения, на которое данное сообщение является ответом.
объект реакции · требуется
Показать дочерние атрибуты
строка эмодзи
эмодзи
message_id string
отреагировал идентификатор сообщения
Интерактивное сообщение
Показать дочерние атрибуты
messaging_product string · required
recipient_type Один из вариантов: "индивидуальный", "групповой" · обязательный
Тип получателя.
в строку · обязательный
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.
тип "интерактивный"
объект контекста
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты
message_id string
Идентификатор сообщения, на которое данное сообщение является ответом.
интерактивный объект
Объект, содержащий содержимое интерактивного сообщения.
Показать дочерние атрибуты
Тип: Один из "кнопки", "запроса разрешения на вызов", "сообщения каталога", "списка", "продукта", "списка продуктов", "потока" · обязательный
Тип интерактивного сообщения для отправки.
объект заголовка
Содержимое заголовка, отображаемое поверх сообщения. Обязательно для типа '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_items
Массив объектов продукта.
Показать дочерние атрибуты
объект product_items[]
Показать дочерние атрибуты
product_retailer_id строка · обязательный
Уникальный идентификатор товара в каталоге.
массив строк объекта
Содержит список строк.
Показать дочерние атрибуты
rows[] объект
Показать дочерние атрибуты
строковый идентификатор · обязательный
Уникальный идентификатор строки.
заголовок строка · обязательный
Заголовок строки.
строка описания
Необязательное описание строки.
неизвестный
Показать дочерние атрибуты
массив объектов buttons · required
Массив объектов-кнопок.
Показать дочерние атрибуты
кнопки[] объект
Показать дочерние атрибуты
введите "ответ" · обязательно
Для кнопки «Ответ» поддерживается только тип «ответ».
объект ответа · обязательный
Показать дочерние атрибуты
строковый идентификатор · обязательный
Уникальный идентификатор для вашей кнопки. Без пробелов в начале и конце.
заголовок строка · обязательный
Заголовок кнопки. Не может быть пустым, должен быть уникальным. Поддерживаются эмодзи, разметка Markdown не допускается.
неизвестный
Показать дочерние атрибуты
catalog_id строка · обязательный
Уникальный идентификатор каталога Facebook, связанного с вашим бизнес-аккаунтом WhatsApp.
product_retailer_id string
Уникальный идентификатор товара в каталоге. Обязателен для сообщений, содержащих информацию об одном товаре.
разделов объекта SectionObject
Массив объектов разделов.
Показать дочерние атрибуты
разделы[] объект
Объект раздела, используемый в сообщениях-списках и сообщениях, содержащих информацию о нескольких товарах.
Показать дочерние атрибуты
строка заголовка
Заголовок раздела. Обязательно, если сообщение содержит более одного раздела. Максимум 24 символа.
массив объектов product_items
Массив объектов продукта.
Показать дочерние атрибуты
объект product_items[]
Показать дочерние атрибуты
product_retailer_id строка · обязательный
Уникальный идентификатор товара в каталоге.
массив строк объекта
Содержит список строк.
Показать дочерние атрибуты
rows[] объект
Показать дочерние атрибуты
строковый идентификатор · обязательный
Уникальный идентификатор строки.
заголовок строка · обязательный
Заголовок строки.
строка описания
Необязательное описание строки.
неизвестный
Показать дочерние атрибуты
имя "catalog_message" · обязательно
объект параметров · обязательный
Показать дочерние атрибуты
thumbnail_product_retailer_id строка · обязательный
Идентификатор продавца товара для миниатюры.
неизвестный
Показать дочерние атрибуты
имя "поток" · обязательно
Параметры. Должен быть одним из следующих: unknown, unknown · required
Показать дочерние атрибуты
flow_message_version "3" · required
Должно быть "3".
flow_id строка
Уникальный идентификатор потока, предоставляемый WhatsApp. Обязателен, если не задано flow_name. Не может использоваться вместе с flow_name.
flow_name string
Название созданного вами потока. Обязательно, если не указан 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 string · required
recipient_type Один из вариантов: "индивидуальный", "групповой" · обязательный
Тип получателя.
в строку · обязательный
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.
тип "шаблон"
объект контекста
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты
message_id string
Идентификатор сообщения, на которое данное сообщение является ответом.
шаблонный объект · обязательный
Показать дочерние атрибуты
строка имени · обязательный
Название шаблона.
язык LanguageObject · обязательный
Содержит языковой объект. Указывает язык, на котором может быть отображен шаблон.
компонентов TemplateComponent
Массив -компонентов , содержащих параметры сообщения.
Показать дочерние атрибуты
компоненты[] TemplateComponent
КонтактыСообщение
Показать дочерние атрибуты
messaging_product string · required
recipient_type Один из вариантов: "индивидуальный", "групповой" · обязательный
Тип получателя.
в строку · обязательный
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.
тип "контакты"
объект контекста
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты
message_id string
Идентификатор сообщения, на которое данное сообщение является ответом.
контактов объекта ContactObject · обязательно
Показать дочерние атрибуты
контакт[] объект
Показать дочерние атрибуты
адресов AddressObject
Полный(е) контактный(е) адрес(а)
Показать дочерние атрибуты
адреса[] объект
Показать дочерние атрибуты
городская струна
Название города
кантри струна
Полное название страны
Показать дочерние атрибуты
строка country_code
Двухбуквенный код страны ISO
строка состояния
Государственная аббревиатура
уличная струна
адрес улицы
Тип один из "ДОМ", "РАБОТА"
Тип адреса
зиплайн​
Почтовый индекс
дня рождения (дата)
Дата рождения (в формате ГГГГ-ММ-ДД)
электронных писем EmailObject
Контактный(е) адрес(а) электронной почты
Показать дочерние атрибуты
emails[] объект
Показать дочерние атрибуты
email (email) · обязательный
Адрес электронной почты
Тип один из "ДОМ", "РАБОТА"
Тип электронной почты
имя объекта
Показать дочерние атрибуты
строка имени
Имя
formatted_name string
Отформатированное полное имя
строка фамилии
Фамилия
строка отчества
Второе имя
префиксная строка
Префикс имени
суффиксная строка
Суффикс имени
объект организации
Показать дочерние атрибуты
строка компании
Название компании
строка отдела
Название отдела
строка заголовка
Должность
телефонов объекта PhoneObject
Контактный(е) номер(а) телефона
Показать дочерние атрибуты
телефоны[] объект
Показать дочерние атрибуты
строка телефона · обязательно
Номер телефона
Тип один из "ДОМ", "РАБОТА"
Тип телефона
строка wa_id
Идентификатор WhatsApp
urls объектов 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 / Отправить шаблон сообщения сценария / Отправить индикатор набора текста и уведомление о прочтении / Отправить образец текстового сообщения / Отправить образец шаблона подтверждения отправки / Отправить образец шаблона решения проблемы
Тип содержимого: application/json
Схема: MessageResponsePayload
Показать дочерние атрибуты
MessageResponsePayload
контактов объекта
Показать дочерние атрибуты
контакт[] объект
Показать дочерние атрибуты
входная строка
строка wa_id
сообщений объекта
Показать дочерние атрибуты
сообщения[] объект
Показать дочерние атрибуты
строка идентификатора
message_status Один из вариантов: "accepted", "held_for_quality_assessment", "paused"
Статус сообщения WhatsApp:
Принято : Сообщение принято WhatsApp и находится в обработке.
held_for_quality_assessment : Сообщение задерживается для проверки качества перед доставкой.
Приостановлено : Доставка сообщения приостановлена.
messaging_product string
Выберите язык
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
Вернуться наверх