Skip to main content
Welcome to the WhatsApp API documentation. This guide provides developers with comprehensive information on sending various types of WhatsApp messages through the Zixflow AI Ingestion Service.

Getting Started with WhatsApp

To send WhatsApp messages, you need to:
  1. Set up a WhatsApp Business Account through Zixflow
  2. Obtain your Phone ID from the Zixflow WhatsApp Settings page
  3. Generate an API key with WhatsApp permissions
  4. Use the appropriate endpoint for your message type

Supported Message Types

The WhatsApp API supports the following message types:
  • Text Messages: Send plain text messages with optional preview URLs
  • Media Messages: Send images, videos, audio files, and documents
  • Location Messages: Send location information
  • Contact Messages: Send contact cards (vCards)
  • Sticker Messages: Send stickers
  • Reaction Messages: Send message reactions
  • Interactive Messages: Send interactive messages with buttons, lists, carousels, and more
  • Templates: Send pre-approved WhatsApp templates with variables

Features

  • Rich media support (images, videos, audio, documents)
  • Interactive elements (buttons, lists, carousels)
  • Template-based messaging for compliance
  • Post-back URLs for delivery status tracking
  • Support for all WhatsApp Business API features