WhatsApp Cloud API Reference

WhatsApp Cloud API Integration #

Complete API reference for integrating with WhatsApp Cloud API through Flowmatix. Send and receive WhatsApp messages programmatically.

Base URL #

https://api.flowmatix.com/v1/whatsapp

Authentication #

Use your Flowmatix API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Send Text Message #

POST /messages

{
  "to": "+1234567890",
  "type": "text",
  "text": {
    "body": "Hello from Flowmatix!"
  }
}

Send Template Message #

POST /messages

{
  "to": "+1234567890",
  "type": "template",
  "template": {
    "name": "welcome_message",
    "language": {
      "code": "en"
    },
    "components": [
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "John"
          }
        ]
      }
    ]
  }
}

Send Media Message #

POST /messages

{
  "to": "+1234567890",
  "type": "image",
  "image": {
    "link": "https://example.com/image.jpg",
    "caption": "Check this out!"
  }
}

Send Interactive Message #

POST /messages

{
  "to": "+1234567890",
  "type": "interactive",
  "interactive": {
    "type": "button",
    "body": {
      "text": "Choose an option:"
    },
    "action": {
      "buttons": [
        {
          "type": "reply",
          "reply": {
            "id": "option_1",
            "title": "Option 1"
          }
        }
      ]
    }
  }
}

Message Status #

GET /messages/{message_id}/status

Check delivery status of sent messages:

• sent – Message sent to WhatsApp
• delivered – Message delivered to recipient
• read – Message read by recipient
• failed – Message delivery failed

Webhook Events #

Configure webhook URL to receive real-time events:

• messages – Incoming messages
• message_status – Delivery status updates
• account_alerts – Account notifications

Message Types Supported #

• Text – Plain text messages
• Image – JPEG, PNG images
• Video – MP4, 3GPP videos
• Audio – AAC, MP3, OGG audio
• Document – PDF, DOC, XLS files
• Location – GPS coordinates
• Contact – vCard contact info

Rate Limits #

WhatsApp Cloud API rate limits:

• 1000 messages per second
• 80 requests per second per phone number
• Daily message limits based on phone number tier