MazBot API Documentation

Introduction

The MazBot API enables seamless WhatsApp messaging integration for your applications. Explore endpoints, request/response formats, and examples below.

{
  "paginate": {
    "total": 150,
    "current_page": 1,
    "per_page": 10,
    "last_page": 15,
    "prev_page_url": null,
    "next_page_url": "https://mazbot.net/api/endpoint?page=2",
    "path": "https://mazbot.net/api/endpoint"
  }
}Copy

Team Management API

Manage your team members (staff) with full CRUD operations. Use these endpoints to add, update, and view team members.

Get All Team Members

Returns a list of all team members.

PHP Example

$curl = curl_init();
curl_setopt_array($curl, [
  CURLOPT_URL => 'https://mazbot.net/api/team',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer your_jwt_token'
  ],
]);

$response = curl_exec($curl);
curl_close($curl);
$teamData = json_decode($response, true);Copy

Add Team Member

Request Parameters

PHP Example

$teamData = [
  'first_name' => 'Ahmed',
  'last_name' => 'Mohamed',
  'phone' => '+201234567890',
  'email' => '[email protected]',
  'password' => 'securePassword123',
  'permissions' => ['read:team', 'write:contacts']
];

$curl = curl_init();
curl_setopt_array($curl, [
  CURLOPT_URL => 'https://mazbot.net/api/team-store',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_POST => true,
  CURLOPT_POSTFIELDS => json_encode($teamData),
  CURLOPT_HTTPHEADER => [
    'Content-Type: application/json',
    'Authorization: Bearer your_jwt_token'
  ],
]);

$response = curl_exec($curl);
curl_close($curl);Copy

Update Team Member

Updates an existing team member's information.

WhatsApp API

Manage WhatsApp contacts and contact lists.

Get All Contacts

Returns a list of all WhatsApp contacts.

Add Contact

Request Parameters

PHP Example

$contactData = [
  'name' => 'Ahmed Mohamed',
  'phone' => '+201234567890',
  'country_id' => 1,
  'status' => 1
];

$curl = curl_init();
curl_setopt_array($curl, [
  CURLOPT_URL => 'https://mazbot.net/api/whatsapp-contact-store',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_POST => true,
  CURLOPT_POSTFIELDS => json_encode($contactData),
  CURLOPT_HTTPHEADER => [
    'Content-Type: application/json',
    'Authorization: Bearer your_jwt_token'
  ],
]);

$response = curl_exec($curl);
curl_close($curl);Copy

Get All Contact Lists

Returns a list of all WhatsApp contact lists.

Contact Management API

Manage contacts with full CRUD operations, pagination, and block functionality.

Get All Contacts

Retrieve a paginated list of all contacts.

PHP Example

$curl = curl_init();
curl_setopt_array($curl, [
  CURLOPT_URL => 'https://mazbot.net/api/contacts?page=1',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer your_jwt_token'
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

$data = json_decode($response, true);
print_r($data['data']['contacts']);Copy

JSON Response Example

{
  "status": true,
  "message": "data_retrieved_successfully",
  "data": {
    "contacts": [
      {
        "id": 101,
        "name": "Ahmed Mohamed",
        "phone": "+201234567890",
        "email": "[email protected]",
        "type": "whatsapp",
        "status": 1
      }
    ],
    "paginate": {
      "total": 150,
      "current_page": 1,
      "per_page": 10,
      "last_page": 15,
      "next_page_url": "https://mazbot.net/api/contacts?page=2"
    }
  }
}Copy

Create Contact

Add a new contact to the system.

PHP Example

$contactData = [
  'phone' => '01234567890',
  'country_id' => 1,
  'name' => 'Ahmed Mohamed',
  'email' => '[email protected]'
];

$curl = curl_init();
curl_setopt_array($curl, [
  CURLOPT_URL => 'https://mazbot.net/api/contacts',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_POST => true,
  CURLOPT_POSTFIELDS => json_encode($contactData),
  CURLOPT_HTTPHEADER => [
    'Content-Type: application/json',
    'Authorization: Bearer your_jwt_token'
  ],
]);

$response = curl_exec($curl);
curl_close($curl);Copy

Update Contact

Update an existing contact's information.

Block Contact

Block or unblock a contact to prevent/allow messaging.

Chat Management API

Manage chat rooms and messages.

Get Chat Rooms

Retrieve a list of chat rooms with search and filter options.

PHP Example

$curl = curl_init();
curl_setopt_array($curl, [
  CURLOPT_URL => 'https://mazbot.net/api/chat-rooms?page=1&type=whatsapp',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer your_jwt_token'
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

$data = json_decode($response, true);
print_r($data['data']['chat_rooms']);Copy

JSON Response Example

{
  "status": true,
  "message": "chat_retrieved_successfully",
  "data": {
    "chat_rooms": [
      {
        "id": 1,
        "contact_name": "Ahmed Mohamed",
        "phone": "+201234567890",
        "last_message": "Hello, how can I help you?",
        "unread_count": 3,
        "last_conversation_at": "2025-12-29T10:30:00Z"
      }
    ],
    "total_unread_messages": 12,
    "next_page_url": true
  }
}Copy

Get Messages

Get all messages for a specific contact/chatroom.

PHP Example

$contactId = 123;
$curl = curl_init();
curl_setopt_array($curl, [
  CURLOPT_URL => "https://mazbot.net/api/chatroom-messages/{$contactId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer your_jwt_token'
  ],
]);

$response = curl_exec($curl);
curl_close($curl);Copy

Clear Chat

Delete all messages in a chat room.

Media & Files API

Manage shared files and media in conversations.

Get Shared Files

Delete File

AI Auto-Reply API

Manage AI auto-reply settings for contacts.

Toggle AI Auto-Reply

Enable or disable AI auto-reply for a specific contact.

Request Parameters

PHP Example

$data = [
  'contact_id' => 123,
  'ai_reply_enabled' => true
];

$curl = curl_init();
curl_setopt_array($curl, [
  CURLOPT_URL => 'https://mazbot.net/api/toggle-contact-ai-reply',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_POST => true,
  CURLOPT_POSTFIELDS => json_encode($data),
  CURLOPT_HTTPHEADER => [
    'Content-Type: application/json',
    'Authorization: Bearer your_jwt_token'
  ],
]);

$response = curl_exec($curl);
curl_close($curl);Copy

JSON Response Example

{
  "success": true,
  "message": "AI auto-reply enabled for this contact",
  "ai_reply_enabled": true,
  "contact_id": 123
}Copy

Client & Staff API

Assign staff to contacts and view contact details.

Assign Staff

Assign a staff member to handle a specific contact.

PHP Example

$data = [
  'contact_id' => 101,
  'staff_id' => 5
];

$curl = curl_init();
curl_setopt_array($curl, [
  CURLOPT_URL => 'https://mazbot.net/api/assign-staff',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_POST => true,
  CURLOPT_POSTFIELDS => json_encode($data),
  CURLOPT_HTTPHEADER => [
    'Content-Type: application/json',
    'Authorization: Bearer your_jwt_token'
  ],
]);

$response = curl_exec($curl);
curl_close($curl);Copy

Contact Details

Get detailed information about a specific contact including notes and tags.

Ticket System API

Create and manage support tickets.

Get All Tickets

Create Ticket

Reply to Ticket