Get chat metadata - VZaps Docs

{ "phone": "5511999999999", "jid": "5511999999999@s.whatsapp.net", "name": "<string>", "last_message_user_name": "<string>", "last_message_user_phone": "<string>", "community_name": "<string>", "community_jid": "<string>", "archived": true, "pinned": true, "unread": "<string>", "messages_unread": 123, "marked_as_unread": true, "is_marked_spam": true, "is_group": true, "is_group_announcement": true, "last_message_time": "<string>", "last_message_timestamp_ms": 123, "mute_end_time": 123 }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Identificador publico da instancia no formato gerado pela plataforma: prefixo VZ seguido de caracteres alfanumericos.

Example:

"VZ9K2M4N8P1Q3R5S7T0WABCD01EF"

phone

string

required

Contact number (e.g. 5511999999999), group id, or full JID.

Example:

"5511999999999"

Response

Chat metadata

phone

string

Chat phone or identifier (contact or group).

Example:

"5511999999999"

jid

string

Example:

"5511999999999@s.whatsapp.net"

name

string

Chat name (saved contact, group title, or equivalent).

last_message_user_name

string

Name of the user who sent the last message in the chat.

last_message_user_phone

string

Phone or identifier of the user who sent the last message.

community_name

string

Community name when the chat is a subgroup. Empty otherwise.

community_jid

string

Parent community JID when the chat is a subgroup.

archived

boolean

pinned

boolean

unread

string

Unread count as string.

messages_unread

integer

marked_as_unread

boolean

is_muted

enum<string>

Available options:

0,

1

is_marked_spam

boolean

is_group

boolean

is_group_announcement

boolean

last_message_time

string

Unix timestamp in seconds (string).

last_message_timestamp_ms

integer<int64>

mute_end_time

integer<int64>

Present when the chat is muted with a defined end time.