API Documentation

POST

/instances/create

Create WhatsApp Client

Creates a new WhatsApp client container instance. This endpoint initializes a dedicated client session allowing your application to send and receive messages. After creation use the connect endpoint to scan the authentication QR Code. Required before sending any messages.

GET

/instances/connect/{clientId}

Connect WhatsApp Client

Returns the QR Code required to authenticate your WhatsApp client instance. The user must scan the QR Code using WhatsApp to establish a secure connection. Once connected the client status will change to 'connected'.

POST

/messages/text

Send Text Message

Sends a text message to a given WhatsApp number. Messages are queued asynchronously and processed in near real‑time. Make sure the client is connected before attempting to send messages.

POST

/messages/typing

Simulate Typing

Simulates a typing status for a given duration. Improves engagement by displaying a typing indicator before sending messages.