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)`

$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)`

$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)`

$vzaps->chats()->archive([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
    'phone' => '5511999999999',
]);

Return: { status: "ok" }.

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

$vzaps->chats()->unarchive([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
    'phone' => '5511999999999',
]);

Return: { status: "ok" }.

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

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

Return: { status: "ok" }.

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

$vzaps->chats()->unmute([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
    'phone' => '5511999999999',
]);

Return: { status: "ok" }.

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

$vzaps->chats()->pin([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
    'phone' => '5511999999999',
]);

Return: { status: "ok" }.

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

$vzaps->chats()->unpin([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
    'phone' => '5511999999999',
]);

Return: { status: "ok" }.

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

$vzaps->chats()->read([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
    'phone' => '5511999999999',
]);

Return: { status: "ok" }.

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

$vzaps->chats()->unread([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
    'phone' => '5511999999999',
]);

Return: { status: "ok" }.

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

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

Return: { status: "ok" }.

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

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

Return: { status: "ok" }.

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

$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