Chats - VZaps Docs

Use chats para listar conversas e aplicar ações como arquivar, silenciar, fixar e expiração. Para instâncias, veja Instâncias e billing. Para sessão, veja Sessão.

Chats

`client.chats.list(...)`

chats = client.chats.list(
    instance_id="VZ...",
    instance_token="instance-token",
    page=1,
    page_size=20,
)

Retorno: pagina { page, page_size, total, total_pages, content[] } com metadados de cada chat.

`client.chats.get(...)`

chat = client.chats.get(
    instance_id="VZ...",
    instance_token="instance-token",
    phone="5511999999999",
)

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

`client.chats.archive(...)`

client.chats.archive(
    instance_id="VZ...",
    instance_token="instance-token",
    phone="5511999999999",
)

Retorno: { status: "ok" }.

`client.chats.unarchive(...)`

client.chats.unarchive(
    instance_id="VZ...",
    instance_token="instance-token",
    phone="5511999999999",
)

Retorno: { status: "ok" }.

`client.chats.mute(...)`

client.chats.mute(
    instance_id="VZ...",
    instance_token="instance-token",
    phone="5511999999999",
    duration_seconds=3600,
)

Retorno: { status: "ok" }.

`client.chats.unmute(...)`

client.chats.unmute(
    instance_id="VZ...",
    instance_token="instance-token",
    phone="5511999999999",
)

Retorno: { status: "ok" }.

`client.chats.pin(...)`

client.chats.pin(
    instance_id="VZ...",
    instance_token="instance-token",
    phone="5511999999999",
)

Retorno: { status: "ok" }.

`client.chats.unpin(...)`

client.chats.unpin(
    instance_id="VZ...",
    instance_token="instance-token",
    phone="5511999999999",
)

Retorno: { status: "ok" }.

`client.chats.read(...)`

client.chats.read(
    instance_id="VZ...",
    instance_token="instance-token",
    phone="5511999999999",
)

Retorno: { status: "ok" }.

`client.chats.unread(...)`

client.chats.unread(
    instance_id="VZ...",
    instance_token="instance-token",
    phone="5511999999999",
)

Retorno: { status: "ok" }.

`client.chats.clear(...)`

client.chats.clear(
    instance_id="VZ...",
    instance_token="instance-token",
    phone="5511999999999",
    delete_media=False,
)

Retorno: { status: "ok" }.

`client.chats.delete(...)`

client.chats.delete(
    instance_id="VZ...",
    instance_token="instance-token",
    phone="5511999999999",
    delete_media=False,
)

Retorno: { status: "ok" }.

`client.chats.set_expiration(...)`

client.chats.set_expiration(
    instance_id="VZ...",
    instance_token="instance-token",
    phone="5511999999999",
    expiration="7_DAYS",
)

Retorno: { status: "ok" }. Valores aceitos em expiration: 24_HOURS, 7_DAYS, 90_DAYS, OFF.

Sessão Mensagens