logo
logo
System Status: Operational (v2.4.0 API Ready)

MarkuzAI Documentation & API

Complete system architecture guides, integration tutorials, interactive API endpoint references, and code samples in cURL, Node.js, Python, and PHP.

System Architecture & Platform Overview

MarkuzAI System Documentation

MarkuzAI is an enterprise-grade multi-organization bulk messaging and communication platform built on Laravel, MySQL, Meta WhatsApp Business API Cloud Framework, and SMTPS relay modules.

System Infrastructure Layers

v2.4 High Available
Front-end Client Layer

Responsive Blade views, Tailwind styling, AJAX API Controllers, Dynamic Live Chat & Interactive Dashboards.

Application Logic Layer

Laravel 11 Multi-Guard Auth, Role-Based Access (Org Admin & Staff), TTS Generator, Queue Dispatcher.

Integration Gateways

Meta WhatsApp Graph API (v19.0), Razorpay UPI Payment Gateways, SMTPS Relay & Webhook Dispatcher.

Multi-Tenant Organization Isolation

Data for each company or organization is fully segregated. Super Admins manage global plans, rate cards, and billing, while Org Admins manage their own team, contacts, and WhatsApp credentials.

AI Voice Synthesis Engine

Integrated TTS studio with fundamental frequency pitch shifts, multi-lingual audio synthesis, and WhatsApp voice note format compatibility (.ogg opus).

Onboarding Steps

Quick Start Integration Guide

1

Obtain API Bearer Token

Navigate to your Dashboard → Developer Settings to copy your organization's Secret Bearer Token (`mk_live_...`). Keep this key private and stored securely in environment variables.

2

Connect Meta WhatsApp Business Account

Go to WhatsApp Configuration in the sidebar. Click "Connect Meta Account" or manually input your Meta Business Account ID, Access Token, and Phone Number ID.

3

Dispatch Test Message or API Request

Use the REST API endpoint below or the Campaign Studio UI to send your first message to any recipient number.

Security Header

API Authentication

All requests to MarkuzAI API endpoints must include standard HTTP Bearer token authentication headers:

# Pass header in HTTP requests
Authorization: Bearer YOUR_MARKUZAI_API_TOKEN
Content-Type: application/json
Accept: application/json
Email Service API

Send Bulk & Transactional Email

POST /api/v1/emails/send

Programmatically send custom HTML emails or template-driven messages with attachment support and open-tracking pixels.

curl -X POST https://markuzai.com/api/v1/emails/send \
  -H "Authorization: Bearer YOUR_MARKUZAI_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "client@example.com",
    "subject": "Order Confirmation #9802",
    "html": "

Thank you for your order

Your items are being prepared.

", "sender_name": "MarkuzAI Support" }'

Request Parameters

Field Type Required Description
to string Required Recipient email address.
subject string Required Email subject line.
html string Required HTML body content.
sender_name string Optional Custom sender title displayed in inbox.
WhatsApp Cloud API

Send Meta WhatsApp Messages

POST /api/v1/whatsapp/send

Send official Meta WhatsApp template notifications or direct interactive messages to customer numbers in international format.

curl -X POST https://markuzai.com/api/v1/whatsapp/send \
  -H "Authorization: Bearer YOUR_MARKUZAI_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+919876543210",
    "template_name": "order_update_notification",
    "language": "en",
    "variables": ["Alex", "Shipped", "TRK-49021"]
  }'
HTTP 200 OK Response
{
  "success": true,
  "whatsapp_message_id": "wamid.HBgLMTkxOTg3NjU0MzIxMBUAERgSQjEwQzg0MEY5...",
  "recipient": "+919876543210",
  "status": "sent",
  "timestamp": 1780449120
}
AI Voice Studio API

Synthesize AI Voice Note

POST /api/v1/voice/synthesize

Convert custom script text into human-like WhatsApp voice audio (.ogg format) with custom fundamental pitch shift and language parameters.

curl -X POST https://markuzai.com/api/v1/voice/synthesize \
  -H "Authorization: Bearer YOUR_MARKUZAI_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Hello, your hotel booking at Grand Palace is confirmed for tomorrow!",
    "voice_id": "custom_modi_v2",
    "pitch_shift_hz": -30,
    "speed_rate": 1.0,
    "format": "ogg"
  }'
WhatsApp Bot Automation

Automated Bot & Broadcast API

REST Endpoints
GET /api/v1/bot/analytics

Retrieve Bot Stats

Fetch total conversations, active automated workflows, resolved FAQs, and agent handoff metrics.

POST /api/v1/bot/broadcast

Trigger Targeted Broadcast

Send segment-filtered bulk broadcasts to specific contact groups with interactive menu buttons.

Real-time Webhooks

Webhooks & Event Streams

POST Handlers

Configure your server URL in Dashboard → Webhooks to receive HTTP POST event notifications whenever messages are delivered, read, or replied to.

# Payload posted to your Webhook Endpoint
{
  "event": "whatsapp.message_received",
  "timestamp": 1780449300,
  "data": {
    "from": "+919876543210",
    "message": "Can I book a deluxe suite for tomorrow?",
    "message_id": "wamid.HBgLMTkx...",
    "type": "text"
  }
}
Limits & Status Codes

Rate Limits & HTTP Response Codes

Rate Limits by Plan

  • Starter Tier: 60 requests / minute
  • Professional Tier: 300 requests / minute
  • Enterprise Tier: Unlimited dedicated throughput

HTTP Status Codes

  • 200 / 201: Request successful
  • 400: Missing parameter or malformed JSON
  • 401: Invalid API Bearer Token
  • 429: Rate limit exceeded (Retry after 60s)

Need Custom API Integration Support?

Our developer advocates are available to assist with custom webhook listeners, SDK integration, and high-volume dispatch.

Book a Live Demo

Personalized 15-minute product walkthrough