Send a flow

🔒 WhatsApp 24-Hour Session Rule

Before sending a free-form message, make sure the WhatsApp session with the user is active.

If the user has not messaged your business within the last 24 hours, WhatsApp requires the first message to be a template message.

After the customer replies, the 24-hour session opens and you may send free-form messages using this API. For sandbox testing, send your join code to the sandbox number to activate your session. Learn more

POST https://gateway.lipachat.com/api/v1/whatsapp/interactive/flows

Header

Name	Value
Content-Type	application/json
apiKey	Get apiKey from app portal settings tab https://app.lipachat.com/app/settings

Body

Name	Type	Description
messageId	string	A unique identifier for the message. This will be used to track the message status and for deduplication purposes.
to	string	PhonReceiver phone number. It should start with a country code.
from	string	Sandbox number [phone] or your own WABA phone number.
text	string
flowId	string	Id of the flow you want to send
flowCta	string	Text to appear on the submit button of the flow
screen	string	First screen of your json request/flow
data.service	string
data.serviceOption	string
data.package	string

Example Request

{
  "messageId": "{{$randomUUID}}",
  "to": "254717746565",
  "from": "{{SANDBOX_NUMBER}}",
  "text": "Thank you share your details and one of our agents will be in touch",
  "flowId": "YOUR_FLOW_ID",
  "flowCta": "Share Details!",
  "screen": "First screen in your JSON request",
  "data": {
    "service": "",
    "serviceOption": "",
    "package": ""
  }
}

Response

200

{
  "timestamp": "2024-03-22T11:42:18.625016916",
  "data": {
    "messageId": "1a85c604-0f08-4182-8011-407ba84598c5",
    "waId": "wamid.HBgMMjU0NzE3NzQ2NTY1FQIAERgSMDUxNjI2OEE5OUUyMzQzMjM4AA==",
    "status": "SENT",
    "statusDesc": "Message sent successfully"
  },
  "status": "success",
  "message": "",
  "errors": null
}

400

{
    "timestamp": "2024-09-15T20:06:38.675567555",
    "data": null,
    "status": "error",
    "message": "Request failed.",
    "errors": null
}

401

{
    "timestamp": "2024-09-15T20:07:23.464199513",
    "data": null,
    "status": "success",
    "message": "Invalid credentials",
    "errors": null
}