WhatsApp API

Overview

The WhatsApp API is the core BOOKBEY product: a simple HTTP API to send WhatsApp text, images, documents and approved templates from any application — your website, CRM, billing panel or scripts. You buy a monthly plan with a message quota, connect your WhatsApp number, generate an API key, and send.

Integrate with the ready-made PHP, Node.js or Python SDKs, the REST API, or a panel module like WHMCS, WooCommerce or Magento.

Plans & quota

Each plan has a monthly message limit and a billing cycle. Choose one on the Plans page in your client area.

• Paid plans (e.g. Basic, Advanced) — a set number of messages per month for a monthly price.
• Trial / free — activates instantly with no invoice, so you can test end to end before paying.
• A quota of unlimited is possible on plans configured that way.

Usage counts one message per send. When you reach the monthly limit, sending returns quota_exceeded until the plan renews or you upgrade.

Getting started

1. Choose a plan on the Plans page (or start on trial).
2. Connect your WhatsApp number on the Channels page.
3. Generate an API key under API Keys.
4. Send — via an SDK, the REST API, or a panel module. Your API base URL is https://bookbey.com/public/api.

Connecting your number

On the Channels page you connect the WhatsApp number that will send your messages, and keep it connected. Sends go out from this number; delivery status for each message is recorded in your Logs.

API keys

Generate a key under API Keys and send it on every request (both header forms are accepted):

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

Keys are isolated per account and stored only as hashes. Rotate a key any time; revoking it immediately blocks requests that use it.

Sending messages

PUT https://bookbey.com/public/api/send.php with a JSON body. The type field selects text, image, document (URL or base64) or an approved template:

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!"}'

Full payload shapes and every SDK are in the REST API guide. Check remaining quota any time at GET https://bookbey.com/public/api/status.php.

Templates

Approved Cloud API templates are sent by name with ordered variables. Manage them on the Templates page, then send:

{"to":"9198XXXXXXXX","type":"template","template":"invoice_due","lang":"en_US","params":["John","INV-1001","500"]}

Message logs

The Logs page shows every message sent through your account with its status and the provider message id, so you can audit deliverability and troubleshoot specific sends.

Quota, renewals & suspension

Your plan renews each cycle; a renewal invoice is raised ahead of time. Pay it to keep sending without interruption. If a renewal invoice goes unpaid past the grace period, the plan is suspended and sending stops with plan_suspended — your data, numbers and settings are untouched. Pay the open invoice and sending resumes immediately.

Upgrading to a higher plan takes effect on payment; your old plan is superseded automatically.

Errors

Responses are JSON with ok:false and an error code — e.g. invalid_api_key, no_active_plan, plan_suspended, quota_exceeded, invalid_number, rate_limited. Each SDK/module guide lists the full table and how to handle each.

Troubleshooting

• no_active_plan: choose/activate a plan on the Plans page.
• plan_suspended: a renewal invoice is unpaid — pay it to resume.
• quota_exceeded: monthly limit reached — upgrade or wait for renewal (see status.php).
• invalid_number: use country code + number, digits only, no +.
• Message accepted but not delivered: confirm the number is connected on Channels and the recipient is on WhatsApp; check Logs.

FAQ

Which integration should I use? An SDK for custom apps; a panel module (WHMCS/WooCommerce/Magento) for those platforms; the REST API for anything else. Do templates cost extra? Each send counts as one message against your quota. Is the AI Chatbot part of this? No — the AI Chatbot is a separate product on its own prepaid wallet.