Pular para o conteúdo principal
GET
/
instances
/
{id}
/
chats
/
{phone}
Obter metadados de um chat
curl --request GET \
  --url https://api.vzaps.com/instances/{id}/chats/{phone} \
  --header 'Authorization: Bearer <token>'
{
  "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
}

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

id
string
obrigatório

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

Exemplo:

"VZ9K2M4N8P1Q3R5S7T0WABCD01EF"

phone
string
obrigatório

Numero do contato (ex.: 5511999999999), ID de grupo ou JID completo.

Exemplo:

"5511999999999"

Resposta

Metadados do chat

phone
string

Telefone ou identificador do chat (contato ou grupo).

Exemplo:

"5511999999999"

jid
string
Exemplo:

"5511999999999@s.whatsapp.net"

name
string

Nome do chat (contato salvo, titulo do grupo ou equivalente).

last_message_user_name
string

Nome de quem enviou a ultima mensagem no chat.

last_message_user_phone
string

Telefone ou identificador de quem enviou a ultima mensagem.

community_name
string

Nome da comunidade quando o chat e um subgrupo. Vazio fora desse caso.

community_jid
string

JID da comunidade pai quando o chat e um subgrupo.

archived
boolean
pinned
boolean
unread
string

Contagem de nao lidas como string.

messages_unread
integer
marked_as_unread
boolean
is_muted
enum<string>
Opções disponíveis:
0,
1
is_marked_spam
boolean
is_group
boolean
is_group_announcement
boolean
last_message_time
string

Timestamp Unix em segundos (string).

last_message_timestamp_ms
integer<int64>
mute_end_time
integer<int64>

Presente quando o chat esta silenciado com prazo definido.