> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vzaps.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Chats

> Listar e gerenciar conversas de uma instância

Use `chats` para listar conversas e aplicar ações como arquivar, silenciar, fixar e expiração.

Para instâncias, veja [Instâncias e billing](/pt-BR/sdk/typescript/instances-and-billing). Para sessão, veja [Sessão](/pt-BR/sdk/typescript/session).

## Chats

### `chats.list(request)`

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

**Retorno:** pagina `{ page, pageSize, total, totalPages, content[] }` com metadados de cada chat.

### `chats.get(request)`

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

**Retorno:** `InstanceChatMetadata` — `phone`, `jid`, `name`, flags (`archived`, `pinned`, `muted`, etc.) e ultima mensagem quando disponivel.

### `chats.archive(request)`

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

**Retorno:** `{ status: "ok" }`.

### `chats.unarchive(request)`

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

**Retorno:** `{ status: "ok" }`.

### `chats.mute(request)`

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

**Retorno:** `{ status: "ok" }`.

### `chats.unmute(request)`

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

**Retorno:** `{ status: "ok" }`.

### `chats.pin(request)`

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

**Retorno:** `{ status: "ok" }`.

### `chats.unpin(request)`

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

**Retorno:** `{ status: "ok" }`.

### `chats.read(request)`

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

**Retorno:** `{ status: "ok" }`.

### `chats.unread(request)`

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

**Retorno:** `{ status: "ok" }`.

### `chats.clear(request)`

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

**Retorno:** `{ status: "ok" }`.

### `chats.delete(request)`

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

**Retorno:** `{ status: "ok" }`.

### `chats.setExpiration(request)`

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

**Retorno:** `{ status: "ok" }`.

Valores aceitos em `expiration`: `24_HOURS`, `7_DAYS`, `90_DAYS`, `OFF`.