> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zixflow.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction to WhatsApp Messaging

> WhatsApp Business API messaging

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: go to **Developers** under Admin settings at [Zixflow Platform](https://app.zixflow.com/settings/workspace/developer), and assign the respective permissions for the channel (all channels recommended for future flexibility)
4. Use the appropriate endpoint for your message type

### Template-Based Messaging

For template-based messages, use **Get WhatsApp Variables** to understand the template structure—including variable names and value types required for delivery. The API returns a JSON response with template variable details; if no variables are required, you can send the message without them.

The **Send WhatsApp Template** API delivers messages using approved templates. Provide valid variables that match the template requirements and format; incorrect or missing variables will prevent the message from being sent. Always ensure variable data is accurate and adheres to the template structure.

<Note>
  WhatsApp messages can only be sent using approved templates from WhatsApp's official template library. Use the appropriate template and ensure it complies with WhatsApp's guidelines for successful delivery.
</Note>

### 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