Skip to main content
Use client.sessions() for pairing, status checks, and WhatsApp session disconnect. For instances and billing, see Instances and billing. For chats, see Chats.

​
Session

​
client.sessions().status(instanceId, options)

var options = InstanceRequestOptions.builder().instanceToken("instance-token").build();
SessionStatusResponse status = client.sessions().status("VZ...", options);
System.out.println(status.data().connected());
Returns SessionStatusResponse. The data() object uses this field order:
  1. connected() — always first
  2. phone()
  3. whatsappJid()
  4. pushName()
  5. businessName()
  6. businessProfile() — subfields: businessHoursTimezone(), categories(), profileOptions(), address(), email()
  7. profilePictureId()
  8. profilePictureUrl()
  9. profileUrl()
  10. verifiedName() — about, website (when applicable)
When disconnected, data() only has connected() set to false. Empty fields are omitted.

​
client.sessions().qr(instanceId, options)

JsonNode qr = client.sessions().qr("VZ...", options);
Return: envelope { code, success, data }. When not connected yet, data.qr_code (PNG data URL). When already connected, data.status and data.phone.

​
client.sessions().pairCode(instanceId, phone, options)

JsonNode pairCode = client.sessions().pairCode("VZ...", "5511999999999", options);
Return: envelope { code, success, data } with data.linking_code (pairing code).

​
client.sessions().disconnect(instanceId, options)

client.sessions().disconnect("VZ...", options);
Return: InstanceActionResponse — instance_id, status, details.