Отправить WhatsApp Flow сообщение
Отправка интерактивного WhatsApp Flow-сообщения в существующий чат. (Только при открытой сессии диалога). Нужен только один параметр адресата - chatId, phone или bsuid. В BSUID-centric режиме chatId может быть [email protected], bsuid@lid, [email protected] или username@username. Поле phone принимает телефон или BSUID; bsuid можно передать отдельным полем.
Используйте этот метод для отправки опубликованного WhatsApp Flow как сервисного (interactive) сообщения. Если 24-часовое окно закрыто — отправьте шаблон с кнопкой FLOW через /sendTemplate.
JWT tokentoken<token>- body
body*stringТекст сообщения Flow
header?|Заголовок Flow (строка или объект с текстом)
footer?stringТекст подвала
flowId*stringID опубликованного Flow
flowToken*stringFlow token, генерируемый бизнесом
flowCta*stringТекст CTA кнопки
flowAction?stringТип действия Flow
"navigate""data_exchange"flowActionPayload?Обязателен для flowAction=navigate (нужен screen). Для data_exchange игнорируется. Если data передан — он должен быть непустым объектом.
flowMessageVersion?stringВерсия Flow сообщения (по умолчанию "3")
mode?stringРежим Flow (draft или published). Если не передан, используется значение по умолчанию провайдера
"draft""published"flowActionData?Сокращённая форма для flowActionPayload.data (необязательно)
flowActionScreen?stringСокращённая форма для flowActionPayload.screen (необязательно)
quotedMsgId?stringИдентификатор цитируемого сообщения (Cloud API)
chatId?stringОбязателен, если не указаны phone и bsuid
ID чата из списка сообщений. Примеры: [email protected], RU.1504711984690866@lid, username@username или [email protected] (группа). Используется вместо параметра phone.
phone?stringОбязателен, если не указаны chatId и bsuid
Идентификатор получателя. Принимает номер телефона с кодом страны или BSUID, например RU.1504711984690866.
Для chatId используйте полные ID чатов: [email protected], bsuid@lid, username@username или [email protected].
bsuid?stringНеобязательная альтернатива phone/chatId
BSUID получателя без суффикса @lid. Пример: RU.1504711984690866.
Server response example
application/json- response
sent?booleanid?stringУникальный идентификатор сообщения
message?stringУведомление о статусе отправки сообщения
description?stringКомментарий к результату отправки
curl -X POST 'https://api.1msg.io/123/sendFlow' \ -H 'Content-Type: application/json' \ -d '{ "body": "Please complete the flow.", "header": "Feedback", "flowId": "25999010459692480", "flowCta": "Open flow", "flowAction": "navigate", "flowActionPayload": { "screen": "RECOMMEND" }, "phone": "12020721369", "flowToken": "flow_demo_25999010459692480"}'{ "sent": true, "id": "gBGGeRhGZTEfAgkJCh2wAz4ZH-8", "message": "Sent to [email protected]", "description": "Message has been sent to the provider"}