WhatsApp numbers

Connect a WhatsApp number

Start linking a WhatsApp number (Advanced and Enterprise plans). The call only starts it: the QR code (login_method=qr, default) or an 8-character pairing code (login_method=phone) arrives at webhook_url (see the whatsappConnect webhook), followed by connected or not_connected. A request not picked up within 10 minutes expires. The JSON body is served with Content-Type: text/html; parse it as JSON whatever the header says.

post/whatsapp/connect/

Request

  • Base URL: https://wbiztool.com/api/v1
  • URL: https://wbiztool.com/api/v1/whatsapp/connect/
  • Auth: none required

Request body

client_idinteger required

Your API Client ID from Settings → API keys.

api_keystring required

One of your API keys from the same page. Keep it secret.

webhook_urlstring uri

Receives the QR code or phone code and the result (see the whatsappConnect webhook). Without it you cannot get the QR code through the API.

login_method'qr' | 'phone'

qr sends a QR code to the webhook; phone an 8-character pairing code.

whatsapp_numberstring

Required with login_method=phone: full international number, country code first, no leading 0. Ignored for qr.

whatsapp_client_idinteger

Reconnect this existing, disconnected number (keeps its ID). Leave out to add a new number.

Example request

{
  "client_id": 12345,
  "api_key": "YOUR_API_KEY",
  "whatsapp_number": "919876543210"
}

Response

Connection request created (status: 1) or refused (status: 0): Auth Error (also for an invalid JSON body), Higher Subscription Required, WhatsApp Account Limit Reached. Upgrade your account to get more whatsapp limit, Already Connected With Given Number; a non-POST request returns {}.

OR

Changes

No recorded changes to this operation across all 1 revision of this API.