Documentation

Everything you need to integrate BOOKBEY. Your API base URL is https://bookbey.com/public/api. Get an API key from your client area.

Quick start

1) Sign up and choose a plan. 2) Connect your WhatsApp number. 3) Generate an API key. 4) Download the PHP SDK or WHMCS module and start sending.

Authentication

Send your key as a Bearer token, or as an X-API-Key header. Both are accepted; keys are isolated per client and stored only as hashes.

Authorization: Bearer YOUR_API_KEY
# or
X-API-Key: YOUR_API_KEY

Send a message

PUT https://bookbey.com/public/api/send.php with a JSON body.

curl -X PUT https://bookbey.com/public/api/send.php \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to":"9198XXXXXXXX","type":"text","text":"Hello from BOOKBEY!"}'

Supported types

text, image, document (by URL or base64), and Cloud API template.

Status & quota

curl https://bookbey.com/public/api/status.php -H "X-API-Key: YOUR_API_KEY"
=> {"ok":true,"plan":"Basic","limit":2000,"used":3,"remaining":1997}

PHP SDK

Download from your client area (PHP 7.4-8.3 universal build). Then:

require 'BookbeyWhatsApp.php';
$wa = new BookbeyWhatsApp('YOUR_API_KEY', 'https://bookbey.com/public/api');
$wa->sendText('9198XXXXXXXX', 'Hello!');
$wa->sendDocument('9198XXXXXXXX', 'https://you.com/invoice.pdf', 'invoice.pdf', 'Your invoice');

WHMCS module

Download bookbeywa from your client area and copy it to <whmcs>/modules/addons/. Then in WHMCS:

1) Setup → Addon Modules → activate BOOKBEY WhatsApp Notifications.
2) Set API Base URL = https://bookbey.com/public/api and your API Key.
3) Open the module → Templates to edit messages, Send test to verify.

The module adds a WhatsApp Number field to signup, fires notifications on invoices, payments, services, tickets and orders, and keeps full delivery logs. Use the universal (PHP 7.4-8.3) build for any server.

Website chatbot

After purchasing the one-time chatbot, open Web Chatbot in your client area, set your Q&A and appearance, then paste the embed snippet before </body>:

<script src="https://bookbey.com/public/chatbot/embed.js?k=YOUR_PUBLIC_KEY" async></script>

The widget answers from your Q&A, captures leads into your dashboard, and offers a WhatsApp handoff to your connected number.

Errors

Responses are JSON with ok:false and an error code, e.g. invalid_api_key, account_suspended, no_active_plan, quota_exceeded, rate_limited. HTTP status reflects the error class.