> ## 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

> List and manage instance conversations

Use `chats` to list conversations and apply actions such as archive, mute, pin, and expiration.

For instances, see [Instances and billing](/en/sdk/php/instances-and-billing). For session, see [Session](/en/sdk/php/session).

## Chats

### `chats()->list($request)`

```php theme={null}
$chats = $vzaps->chats()->list([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
    'page' => 1,
    'pageSize' => 20,
]);
```

**Return:** page `{ page, page_size, total, total_pages, content[] }` with chat metadata per item.

### `chats()->get($request)`

```php theme={null}
$chat = $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)`

```php theme={null}
$vzaps->chats()->archive([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
    'phone' => '5511999999999',
]);
```

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

### `chats()->unarchive($request)`

```php theme={null}
$vzaps->chats()->unarchive([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
    'phone' => '5511999999999',
]);
```

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

### `chats()->mute($request)`

```php theme={null}
$vzaps->chats()->mute([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
    'phone' => '5511999999999',
    'durationSeconds' => 3600,
]);
```

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

### `chats()->unmute($request)`

```php theme={null}
$vzaps->chats()->unmute([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
    'phone' => '5511999999999',
]);
```

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

### `chats()->pin($request)`

```php theme={null}
$vzaps->chats()->pin([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
    'phone' => '5511999999999',
]);
```

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

### `chats()->unpin($request)`

```php theme={null}
$vzaps->chats()->unpin([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
    'phone' => '5511999999999',
]);
```

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

### `chats()->read($request)`

```php theme={null}
$vzaps->chats()->read([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
    'phone' => '5511999999999',
]);
```

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

### `chats()->unread($request)`

```php theme={null}
$vzaps->chats()->unread([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
    'phone' => '5511999999999',
]);
```

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

### `chats()->clear($request)`

```php theme={null}
$vzaps->chats()->clear([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
    'phone' => '5511999999999',
    'deleteMedia' => false,
]);
```

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

### `chats()->delete($request)`

```php theme={null}
$vzaps->chats()->delete([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
    'phone' => '5511999999999',
    'deleteMedia' => false,
]);
```

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

### `chats()->setExpiration($request)`

```php theme={null}
$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`.