Connect your WhatsApp account, generate API keys, and start sending programmatic messages from your ERP, CRM, or custom application in seconds.
Admin LoginInitialize your WhatsApp session. Required before fetching the QR code.
curl -X POST http://your-domain.com/api/v1/start-session \
-H "x-api-key: YOUR_GENERATED_API_KEY"
Fetch connection status. If waiting for QR, it returns the Base64 image.
curl -X GET http://your-domain.com/api/v1/instance-status \
-H "x-api-key: YOUR_GENERATED_API_KEY"
Logout the current WhatsApp session and delete authentication keys.
curl -X POST http://your-domain.com/api/v1/logout \
-H "x-api-key: YOUR_GENERATED_API_KEY"
Send a text message to any WhatsApp number.
curl -X POST http://your-domain.com/api/v1/send-message \
-H "Content-Type: application/json" \
-H "x-api-key: YOUR_GENERATED_API_KEY" \
-d '{
"to": "919876543210",
"message": "Hello from my ERP Software!"
}'
Send an image, document, or video.
curl -X POST http://your-domain.com/api/v1/send-media \
-H "Content-Type: application/json" \
-H "x-api-key: YOUR_GENERATED_API_KEY" \
-d '{
"to": "919876543210",
"type": "document",
"url": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
"fileName": "Invoice_123.pdf",
"mimetype": "application/pdf"
}'
Fetch message history (inbound and outbound) for a specific phone number.
curl -X GET "http://your-domain.com/api/v1/get-messages?phone=919876543210&limit=50" \
-H "x-api-key: YOUR_GENERATED_API_KEY"
Set a webhook URL to receive incoming messages automatically via HTTP POST.
curl -X POST http://your-domain.com/api/v1/webhook/set \
-H "Content-Type: application/json" \
-H "x-api-key: YOUR_GENERATED_API_KEY" \
-d '{
"webhookUrl": "https://your-domain.com/webhook/receive"
}'
Incoming Webhook Payload:
{
"from": "919876543210",
"message": "Hello there!",
"timestamp": "2023-10-05T12:00:00.000Z",
"messageId": "B1C2D3E4F5A6"
}