Send WhatsApp Flow Message
Send Interactive WhatsApp Flow message to an existing chat. (Only if the dialogue has an Open Session). Only one destination parameter is needed - chatId, phone, or bsuid. In BSUID-centric routing, chatId can be [email protected], bsuid@lid, [email protected], or username@username. The phone field accepts a phone number or BSUID; bsuid can be passed separately.
Use this method to send a published WhatsApp Flow as a service (interactive) message. If the 24-hour window is closed, send a template with a FLOW button via /sendTemplate.
JWT tokentoken<token>- body
body*stringFlow message body text
header?|Flow header (string or text header object)
footer?stringFooter text
flowId*stringPublished Flow ID
flowToken*stringFlow token generated by the business
flowCta*stringCTA button text
flowAction?stringFlow action type
"navigate""data_exchange"flowActionPayload?Required for flowAction=navigate (screen is required). Ignored for data_exchange. If data is provided, it must be a non-empty object.
flowMessageVersion?stringFlow message version (default "3")
mode?stringFlow mode (draft or published). If omitted, provider default applies
"draft""published"flowActionData?Shortcut for flowActionPayload.data (optional)
flowActionScreen?stringShortcut for flowActionPayload.screen (optional)
quotedMsgId?stringQuoted message ID (Cloud API)
chatId?stringRequired if phone and bsuid are not set
Chat ID from the message list. Examples: [email protected], RU.1504711984690866@lid, username@username, or [email protected] (group). Used instead of the phone parameter.
phone?stringRequired if chatId and bsuid are not set
Recipient identifier. Accepts a phone number starting with the country code, or a BSUID such as RU.1504711984690866.
Use chatId for full chat IDs: [email protected], bsuid@lid, username@username, or [email protected].
bsuid?stringOptional alternative to phone/chatId
Recipient BSUID without the @lid suffix. Example: RU.1504711984690866.
Server response example
application/json- response
sent?booleanid?stringunique message id
message?stringPosting status message
description?stringResult description
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"}