v1

latestOpenAPI 3.0.02026-07-14181255304.7 KB

Users

Login user with QR-base64

This method returns an image of the type base64. You can render this in a component of the type image that is compatible with the language that you use to program. Just like on WhatsApp Web you will need to read a QR code to connect to Whapi.Cloud. There are two ways that you can do the reading of the QR code. Connect through our dashboard panel or Make this experience available within your own application.

get/users/login

Query parameters

wakeupboolean

If set to false, the channel will not launch

sizenumber

Size of QR-code

widthnumber

Width of result image

heightnumber

Height of result image

color_lightstring

Background color

color_darkstring

Color of code

Response

status'OK' | 'TIMEOUT' | 'WAITING' | 'ERROR' required

Status of the QR code

type'qr' | 'code' | 'webauthn'

Login challenge type. QR means scan rowdata/base64, code means enter code on the phone, webauthn means complete the passkey assertion.

base64string

Base64 encoded login image

rowdatastring

Rowdata for generating the QR code

codestring

Passkey verification code to enter on the phone

request_idstring

Pending passkey request id. Send the WebAuthn response back for the same request.

public_keyobject

PublicKeyCredentialRequestOptions JSON for navigator.credentials.get({ publicKey }).

urlstring

Origin that must be used for the WebAuthn ceremony.

console_scriptstring

Browser console helper that runs navigator.credentials.get on the required origin and prints the response JSON.

expirenumber

Seconds until the login challenge expires

Example response

{
  "url": "https://web.whatsapp.com"
}