the-box/box-whatsapp

The WhatsApp Box is part of the TheBox family — a lightweight PHP package that allows you to send WhatsApp messages easily

dev-main 2025-11-12 02:42 UTC

Requires

• php: >=7.4
• ext-curl: *

MIT

README

The WhatsApp Box is part of the TheBox family — a lightweight PHP package that allows you to send WhatsApp messages easily.
It can be extremely useful in real-world scenarios such as user registration forms, where you can send a verification code or confirmation message directly via WhatsApp once an account is created.

🚀 Requirements

Before using this package, make sure you have the following:

• PHP 8.0+
• Composer installed
• cURL extension enabled
• A Unipile account, with an API key and DNS endpoint → https://www.unipile.com/

⚙️ Installation

Install the package via Composer:

composer require the-box/whatsapp-box

💡 Usage Example

<?php

use BoxWhatsapp\BoxWhatsapp;

$whatsapp = new BoxWhatsapp();

// Configure your Unipile API key and DNS (base URL of your Unipile instance)
$whatsapp->setKey('ENTER_YOUR_API_KEY');
$whatsapp->setDns('https://your-unipile-host/api');

// Optional: Set a default recipient number
$whatsapp->setDest('[phone]');

// 1️⃣ Simple message (uses the default number)
$result = $whatsapp->sendMessage('Hello there');

// 2️⃣ Direct message with a specific number
$result2 = $whatsapp->sendMessage('Hi again!', '[phone]');

// 3️⃣ Send to multiple recipients
$result3 = $whatsapp->sendMessageGroup('Hello everyone!', ['[phone]', '[phone]']);

// 4️⃣ (Optional) Send to a WhatsApp group using JID
// Example JID: [e-mail]
// $result4 = $whatsapp->sendMessageToGroup('[e-mail]', 'Hello Group!');

🧠 Notes

• The package automatically retrieves your account_id via the /accounts endpoint.
  If needed, you can manually set it with $whatsapp->setAccountId('YOUR_ACCOUNT_ID');.
• Sending requests uses multipart/form-data on the /chats endpoint with attendees_ids and text fields.
• Numbers are automatically converted to the WhatsApp JID format:
  +243... → [e-mail].

🧩 Part of TheBox

This package is designed to integrate seamlessly with the TheBox ecosystem.
For more modules and utilities, check out other TheBox projects.

You can Donate Me

✨ Author

Developed with ❤️ by Exauce Stan Malka - Exauce Malumba
GitHub • Website