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"·обязательный
Тип носителя информации в теле запроса
Параметры пути
версииСтрока·обязательный
Phone-Number-IDСтрока·обязательный
Текст запросаНеобязательный
Тип содержимого: application/json
Схема: Сообщение
Показать дочерние атрибуты
Сообщение
Текстовое сообщение
Показать дочерние атрибуты
messaging_productstring·required
recipient_typeОдин из вариантов: "индивидуальный", "групповой"·обязательный
Тип получателя.
встроку·обязательный
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.
тип"текст"
контекстаобъект
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты
message_idstring
Идентификатор сообщения, на которое данное сообщение является ответом.
текстовыйобъект·обязательный
Показать дочерние атрибуты
телоструна
Текст сообщения.
preview_urlлогическое значение
Аудиосообщение
Показать дочерние атрибуты
messaging_productstring·required
recipient_typeОдин из вариантов: "индивидуальный", "групповой"·обязательный
Тип получателя.
встроку·обязательный
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.
тип"аудио"
контекстаобъект
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты
message_idstring
Идентификатор сообщения, на которое данное сообщение является ответом.
аудиоДолжно быть одно из следующих значений: неизвестно, неизвестно
Медиаобъект.
идентификатор , либо ссылка ТребуетсяПоказать дочерние атрибуты
неизвестный
Показать дочерние атрибуты
идентификаторстроковый·обязательный
Идентификатор медиаобъекта. Обязателен, если
ссылка не используется.подписистрока
Дополнительная подпись для медиафайлов (по желанию)
неизвестный
Показать дочерние атрибуты
ссылки(URL)·обязательный
Протокол и URL-адрес отправляемых медиафайлов (только HTTP/HTTPS).
подписистрока
Дополнительная подпись для медиафайлов (по желанию)
ДокументСообщение
Показать дочерние атрибуты
messaging_productstring·required
recipient_typeОдин из вариантов: "индивидуальный", "групповой"·обязательный
Тип получателя.
встроку·обязательный
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.
тип"документ"
контекстаобъект
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты
message_idstring
Идентификатор сообщения, на которое данное сообщение является ответом.
Документдолжен быть одним из следующих: неизвестный, неизвестный
Медиаобъект.
идентификатор , либо ссылка ТребуетсяПоказать дочерние атрибуты
неизвестный
Показать дочерние атрибуты
идентификаторстроковый·обязательный
Идентификатор медиаобъекта. Обязателен, если
ссылка не используется.подписистрока
Дополнительная подпись для медиафайлов (по желанию)
неизвестный
Показать дочерние атрибуты
ссылки(URL)·обязательный
Протокол и URL-адрес отправляемых медиафайлов (только HTTP/HTTPS).
подписистрока
Дополнительная подпись для медиафайлов (по желанию)
ImageMessage
Показать дочерние атрибуты
messaging_productstring·required
recipient_typeОдин из вариантов: "индивидуальный", "групповой"·обязательный
Тип получателя.
встроку·обязательный
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.
тип"изображение"
контекстаобъект
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты
message_idstring
Идентификатор сообщения, на которое данное сообщение является ответом.
Изображениедолжно быть одним из следующих: неизвестно, неизвестно
Медиаобъект.
идентификатор , либо ссылка ТребуетсяПоказать дочерние атрибуты
неизвестный
Показать дочерние атрибуты
идентификаторстроковый·обязательный
Идентификатор медиаобъекта. Обязателен, если
ссылка не используется.подписистрока
Дополнительная подпись для медиафайлов (по желанию)
неизвестный
Показать дочерние атрибуты
ссылки(URL)·обязательный
Протокол и URL-адрес отправляемых медиафайлов (только HTTP/HTTPS).
подписистрока
Дополнительная подпись для медиафайлов (по желанию)
LocationMessage
Показать дочерние атрибуты
messaging_productstring·required
recipient_typeОдин из вариантов: "индивидуальный", "групповой"·обязательный
Тип получателя.
встроку·обязательный
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.
тип"местоположение"
контекстаобъект
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты
message_idstring
Идентификатор сообщения, на которое данное сообщение является ответом.
местоположенияОбъект·обязательный
Показать дочерние атрибуты
адресастрока
Адрес местоположения.
широтыстрока
Широта местоположения.
долготыстрока
Долгота местоположения.
именистрока
Название населенного пункта.
Видеосообщение
Показать дочерние атрибуты
messaging_productstring·required
recipient_typeОдин из вариантов: "индивидуальный", "групповой"·обязательный
Тип получателя.
встроку·обязательный
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.
тип"видео"
контекстаобъект
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты
message_idstring
Идентификатор сообщения, на которое данное сообщение является ответом.
Видеодолжно быть одним из следующих: неизвестно, неизвестно
Медиаобъект.
идентификатор , либо ссылка ТребуетсяПоказать дочерние атрибуты
неизвестный
Показать дочерние атрибуты
идентификаторстроковый·обязательный
Идентификатор медиаобъекта. Обязателен, если
ссылка не используется.подписистрока
Дополнительная подпись для медиафайлов (по желанию)
неизвестный
Показать дочерние атрибуты
ссылки(URL)·обязательный
Протокол и URL-адрес отправляемых медиафайлов (только HTTP/HTTPS).
подписистрока
Дополнительная подпись для медиафайлов (по желанию)
НаклейкаСообщение
Показать дочерние атрибуты
messaging_productstring·required
recipient_typeОдин из вариантов: "индивидуальный", "групповой"·обязательный
Тип получателя.
встроку·обязательный
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.
тип"наклейка"
контекстаобъект
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты
message_idstring
Идентификатор сообщения, на которое данное сообщение является ответом.
Наклейка.Должна быть одной из следующих категорий: объект, объект·обязателен
Показать дочерние атрибуты
объект
Показать дочерние атрибуты
идентификаторстроковый·обязательный
Идентификатор наклейки.
объект
Показать дочерние атрибуты
ссылкистрока·обязательный
URL-адрес наклейки.
Реакция
Показать дочерние атрибуты
messaging_productstring·required
recipient_typeОдин из вариантов: "индивидуальный", "групповой"·обязательный
Тип получателя.
встроку·обязательный
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.
тип"реакция"
контекстаобъект
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты
message_idstring
Идентификатор сообщения, на которое данное сообщение является ответом.
реакцииобъект·требуется
Показать дочерние атрибуты
эмодзистрока
эмодзи
message_idstring
отреагировал идентификатор сообщения
Интерактивное сообщение
Показать дочерние атрибуты
messaging_productstring·required
recipient_typeОдин из вариантов: "индивидуальный", "групповой"·обязательный
Тип получателя.
встроку·обязательный
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.
тип"интерактивный"
контекстаобъект
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты
message_idstring
Идентификатор сообщения, на которое данное сообщение является ответом.
интерактивныйобъект
Объект, содержащий содержимое интерактивного сообщения.
Показать дочерние атрибуты
ШаблонСообщение
Показать дочерние атрибуты
messaging_productstring·required
recipient_typeОдин из вариантов: "индивидуальный", "групповой"·обязательный
Тип получателя.
встроку·обязательный
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.
тип"шаблон"
контекстаобъект
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты
message_idstring
Идентификатор сообщения, на которое данное сообщение является ответом.
шаблонныйобъект·обязательный
Показать дочерние атрибуты
именистрока·обязательный
Название шаблона.
языкLanguageObject·обязательный
Содержит
языковой объект. Указывает язык, на котором может быть отображен шаблон.компонентовTemplateComponent
Массив
-компонентов , содержащих параметры сообщения.Показать дочерние атрибуты
компоненты[]TemplateComponent
КонтактыСообщение
Показать дочерние атрибуты
messaging_productstring·required
recipient_typeОдин из вариантов: "индивидуальный", "групповой"·обязательный
Тип получателя.
встроку·обязательный
Номер телефона получателя для индивидуальных сообщений и идентификатор группы для групповых сообщений.
тип"контакты"
контекстаобъект
Контекстная информация для ответа на сообщение
Показать дочерние атрибуты
message_idstring
Идентификатор сообщения, на которое данное сообщение является ответом.
контактовобъекта ContactObject·обязательно
Показать дочерние атрибуты
контакт[]объект
Показать дочерние атрибуты
адресовAddressObject
Полный(е) контактный(е) адрес(а)
Показать дочерние атрибуты
адреса[]объект
Показать дочерние атрибуты
городскаяструна
Название города
кантриструна
Полное название страны
Показать дочерние атрибуты
country_codeстрока
Двухбуквенный код страны ISO
состояниястрока
Государственная аббревиатура
уличнаяструна
адрес улицы
Типодин из "ДОМ", "РАБОТА"
Тип адреса
зиплайн
Почтовый индекс
дня рождения(дата)
Дата рождения (в формате ГГГГ-ММ-ДД)
электронных писемEmailObject
Контактный(е) адрес(а) электронной почты
Показать дочерние атрибуты
emails[]объект
Показать дочерние атрибуты
email(email)·обязательный
Адрес электронной почты
Типодин из "ДОМ", "РАБОТА"
Тип электронной почты
имяобъекта
Показать дочерние атрибуты
именистрока
Имя
formatted_namestring
Отформатированное полное имя
фамилиистрока
Фамилия
отчествастрока
Второе имя
префикснаястрока
Префикс имени
суффикснаястрока
Суффикс имени
организацииобъект
Показать дочерние атрибуты
компаниистрока
Название компании
отделастрока
Название отдела
заголовкастрока
Должность
телефоновобъекта 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_productstring
Выберите язык
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