Skip to main content
Welcome to Zixflow AI API documentation. This service provides unified APIs for sending messages across multiple channels including Email, SMS, WhatsApp, RCS, and managing Transflow automations.

​
Base URL

All API endpoints are available at: 
https://api-ai.zixflow.com

​
Supported Channels

The Zixflow AI supports the following communication channels:

​
SMS

  • Send SMS Message: Send direct SMS messages with support for flash SMS and DLT compliance (India)
  • Send SMS Template: Send SMS using predefined templates with variable substitution

​
WhatsApp

  • Send WhatsApp Template: Send approved WhatsApp Business templates
  • Direct Messages: Send text, image, video, audio, document, sticker, location, contact, and reaction messages
  • Interactive Messages: Send interactive messages with reply buttons, list buttons, URL buttons, address requests, location requests, media carousels, and product carousels
  • Data APIs: Get WhatsApp accounts, templates, and template variables

​
RCS (Rich Communication Services)

  • Send RCS Template: Send RCS templates with variable substitution
  • Direct Messages: Send text, image, video, audio, and document messages
  • Data APIs: Get RCS template variables

​
Email

  • Send Email Message: Send direct email messages with attachments, open/click tracking, and custom sender information
  • Send Email Template: Send emails using predefined templates with variable substitution

​
Transflow

  • Trigger Transflow: Trigger automation workflows with recipient information and custom variables
  • Stop Transflow: Stop running workflow executions
  • Get Delivery Report: Retrieve delivery status for Transflow executions

​
Additional Features

  • Postback Notifications: Receive webhook notifications for message delivery status updates across all channels. See Postback Notifications for details.
  • Delivery Reports: Query delivery status for messages sent through any channel using the request ID

​
Authentication

The API uses header-based authentication. Include the following headers in all requests: 
x-api-key: <your-api-key>
x-workspace-id: <your-workspace-id>
For detailed information on how to obtain your API key and workspace ID, see the Authentication documentation.

​
Document and API Usage Guidelines

  • Our APIs use the basic HTTP request codes: POST, GET, PATCH, DELETE.
  • Note: Any requests made using the valid API credentials will affect the real-time data in your zixflow account.
  • All the APIs are provided with their appropriate example requests and responses for successful and failed calls.

​
Rate Limits

  • Our API has a rate limit of 150 requests per second.
  • If you exceed this limit, you will receive a “Too many requests, try again later!” error response.
  • When you encounter this error, please wait and try again later to avoid further rate limiting.

​
Getting Started

  1. Set up authentication: Obtain your API key and workspace ID from the Zixflow dashboard. See Authentication for step-by-step instructions.
  2. Include headers: Add both x-api-key and x-workspace-id headers to all API requests
  3. Choose your channel: Select the appropriate endpoint for your communication channel (SMS, WhatsApp, RCS, Email, or Transflow)
  4. Format phone numbers: For SMS, WhatsApp, and RCS, use international format without the + sign (e.g., 919876543210 for India)
  5. Handle responses: All send endpoints return a request_id that you can use to track delivery status
  6. Set up webhooks (optional): Configure post_back_url to receive real-time delivery notifications

​
Support

  • All the required information on integration is in this document. Please read it thoroughly.
  • For any integration and API-related support, you can feel free to drop us an email at support@zixflow.com.
  • The zixflow terms of service are listed here: Terms Of Service