Send a flow

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 +254110090747 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

{
  "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
}

Last updated