Skip to main content
Use client.chats() to list conversations and apply actions such as archive, mute, pin, and expiration. For instances, see Instances and billing. For session, see Session. Build a GenericInstanceRequest with instanceId and instanceToken. Methods that take a phone argument use the number as the second parameter.

Chats

client.chats().list(request)

var request = GenericInstanceRequest.builder()
    .instanceId("VZ...")
    .instanceToken("instance-token")
    .build();
request.putAdditionalData("page", 1);
request.putAdditionalData("pageSize", 20);
JsonNode chats = client.chats().list(request);
Return: page { page, page_size, total, total_pages, content[] } with chat metadata per item.

client.chats().get(request, phone)

JsonNode chat = client.chats().get(request, "5511999999999");
Return: InstanceChatMetadataphone, jid, name, flags (archived, pinned, muted, etc.) and last message when available.

client.chats().archive(request, phone)

client.chats().archive(request, "5511999999999");
Return: { status: "ok" }.

client.chats().unarchive(request, phone)

client.chats().unarchive(request, "5511999999999");
Return: { status: "ok" }.

client.chats().mute(request, phone)

request.putAdditionalData("durationSeconds", 3600);
client.chats().mute(request, "5511999999999");
Return: { status: "ok" }.

client.chats().unmute(request, phone)

client.chats().unmute(request, "5511999999999");
Return: { status: "ok" }.

client.chats().pin(request, phone) / unpin(request, phone)

client.chats().pin(request, "5511999999999");
client.chats().unpin(request, "5511999999999");
Return: { status: "ok" }.

client.chats().read(request, phone) / unread(request, phone)

client.chats().read(request, "5511999999999");
client.chats().unread(request, "5511999999999");
Return: { status: "ok" }.

client.chats().clear(request, phone) / delete(request, phone)

request.putAdditionalData("deleteMedia", false);
client.chats().clear(request, "5511999999999");
client.chats().delete(request, "5511999999999");
Return: { status: "ok" }.

client.chats().setExpiration(request, phone)

request.putAdditionalData("expiration", "7_DAYS");
client.chats().setExpiration(request, "5511999999999");
Return: { status: "ok" }. Accepted expiration values: 24_HOURS, 7_DAYS, 90_DAYS, OFF.