Chats - VZaps Docs

Use chats to list conversations and apply actions such as archive, mute, pin, and expiration. For instances, see Instances and billing. For session, see Session.

Chats

`chats.list(request)`

const chats = await vzaps.chats.list({
  instanceId: 'VZ...',
  instanceToken: 'instance-token',
  page: 1,
  pageSize: 20,
});

Return: page { page, pageSize, total, totalPages, content[] } with chat metadata per item.

`chats.get(request)`

const chat = await vzaps.chats.get({
  instanceId: 'VZ...',
  instanceToken: 'instance-token',
  phone: '5511999999999',
});

Return: InstanceChatMetadata — phone, jid, name, flags (archived, pinned, muted, etc.) and last message when available.

`chats.archive(request)`

await vzaps.chats.archive({
  instanceId: 'VZ...',
  instanceToken: 'instance-token',
  phone: '5511999999999',
});

Return: { status: "ok" }.

`chats.unarchive(request)`

await vzaps.chats.unarchive({
  instanceId: 'VZ...',
  instanceToken: 'instance-token',
  phone: '5511999999999',
});

Return: { status: "ok" }.

`chats.mute(request)`

await vzaps.chats.mute({
  instanceId: 'VZ...',
  instanceToken: 'instance-token',
  phone: '5511999999999',
  durationSeconds: 3600,
});

Return: { status: "ok" }.

`chats.unmute(request)`

await vzaps.chats.unmute({
  instanceId: 'VZ...',
  instanceToken: 'instance-token',
  phone: '5511999999999',
});

Return: { status: "ok" }.

`chats.pin(request)`

await vzaps.chats.pin({
  instanceId: 'VZ...',
  instanceToken: 'instance-token',
  phone: '5511999999999',
});

Return: { status: "ok" }.

`chats.unpin(request)`

await vzaps.chats.unpin({
  instanceId: 'VZ...',
  instanceToken: 'instance-token',
  phone: '5511999999999',
});

Return: { status: "ok" }.

`chats.read(request)`

await vzaps.chats.read({
  instanceId: 'VZ...',
  instanceToken: 'instance-token',
  phone: '5511999999999',
});

Return: { status: "ok" }.

`chats.unread(request)`

await vzaps.chats.unread({
  instanceId: 'VZ...',
  instanceToken: 'instance-token',
  phone: '5511999999999',
});

Return: { status: "ok" }.

`chats.clear(request)`

await vzaps.chats.clear({
  instanceId: 'VZ...',
  instanceToken: 'instance-token',
  phone: '5511999999999',
  deleteMedia: false,
});

Return: { status: "ok" }.

`chats.delete(request)`

await vzaps.chats.delete({
  instanceId: 'VZ...',
  instanceToken: 'instance-token',
  phone: '5511999999999',
  deleteMedia: false,
});

Return: { status: "ok" }.

`chats.setExpiration(request)`

await vzaps.chats.setExpiration({
  instanceId: 'VZ...',
  instanceToken: 'instance-token',
  phone: '5511999999999',
  expiration: '7_DAYS',
});

Return: { status: "ok" }. Accepted values for expiration: 24_HOURS, 7_DAYS, 90_DAYS, OFF.

Session Messages