Pular para o conteúdo principal
POST
/
chat
/
details
Obter Detalhes Completos
curl --request POST \
  --url https://api.zappfy.io/chat/details \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "number": "5511999999999",
  "preview": false
}
'
{
  "id": "r1a2b3c4d5e6f7",
  "wa_fastid": "admin:5511999999999",
  "wa_chatid": "5511999999999@s.whatsapp.net",
  "wa_name": "João Silva",
  "name": "João Silva",
  "phone": "+55 11 99999-9999",
  "owner": "admin",
  "wa_archived": false,
  "wa_isBlocked": false,
  "wa_isGroup": false,
  "lead_name": "João",
  "lead_fullName": "João Silva",
  "lead_email": "joao@exemplo.com",
  "lead_status": "ativo",
  "wa_contactName": "João Silva",
  "wa_common_groups": "Grupo Família(120363123456789012@g.us),Trabalho(987654321098765432@g.us)",
  "image": "https://pps.whatsapp.net/v/t61.24694-24/12345_image.jpg"
}

Autorizações

​
token
string
header
obrigatório

Corpo

application/json
​
number
string
obrigatório

Número do telefone ou ID do grupo

Exemplo:

"5511999999999"

​
preview
boolean
padrão:false

Controla o tamanho da imagem de perfil retornada:

  • true: Retorna imagem em tamanho preview (menor, otimizada para listagens)
  • false (padrão): Retorna imagem em tamanho full (resolução original, maior qualidade)

Resposta

Informações completas do chat retornadas com sucesso

Representa uma conversa/chamado no sistema

​
id
string

ID único da conversa (r + 7 bytes aleatórios em hex)

​
wa_fastid
string

Identificador rápido do WhatsApp

​
wa_chatid
string

ID completo do chat no WhatsApp

​
wa_archived
boolean
padrão:false

Indica se o chat está arquivado

​
wa_contactName
string
padrão:""

Nome do contato no WhatsApp

​
wa_name
string
padrão:""

Nome do WhatsApp

​
name
string
padrão:""

Nome exibido do chat

​
image
string
padrão:""

URL da imagem de perfil em tamanho full (resolução original) - apenas se preview=false

​
imagePreview
string
padrão:""

URL da imagem de perfil em tamanho preview (menor) - apenas se preview=true

​
wa_ephemeralExpiration
integer<int64>
padrão:0

Tempo de expiração de mensagens efêmeras

​
wa_isBlocked
boolean
padrão:false

Indica se o contato está bloqueado

​
wa_isGroup
boolean
padrão:false

Indica se é um grupo

​
wa_isGroup_admin
boolean
padrão:false

Indica se o usuário é admin do grupo

​
wa_isGroup_announce
boolean
padrão:false

Indica se é um grupo somente anúncios

​
wa_isGroup_community
boolean
padrão:false

Indica se é uma comunidade

​
wa_isGroup_member
boolean
padrão:false

Indica se é membro do grupo

​
wa_isPinned
boolean
padrão:false

Indica se o chat está fixado

​
wa_label
string
padrão:[]

Labels do chat em JSON

​
wa_lastMessageTextVote
string
padrão:""

Texto/voto da última mensagem

​
wa_lastMessageType
string
padrão:""

Tipo da última mensagem

​
wa_lastMsgTimestamp
integer<int64>
padrão:0

Timestamp da última mensagem

​
wa_lastMessageSender
string
padrão:""

Remetente da última mensagem

​
wa_muteEndTime
integer<int64>
padrão:0

Timestamp do fim do silenciamento

​
owner
string
padrão:""

Dono da instância

​
wa_unreadCount
integer<int64>
padrão:0

Contador de mensagens não lidas

​
phone
string
padrão:""

Número de telefone

​
wa_common_groups
string
padrão:""

Grupos em comum separados por vírgula, formato: nome_grupo(id_grupo)

Exemplo:

"Grupo Família(120363123456789012@g.us),Trabalho(987654321098765432@g.us)"

​
lead_name
string
padrão:""

Nome do lead

​
lead_fullName
string
padrão:""

Nome completo do lead

​
lead_email
string
padrão:""

Email do lead

​
lead_personalid
string
padrão:""

Documento de identificação

​
lead_status
string
padrão:""

Status do lead

​
lead_tags
string

Tags do lead em JSON

​
lead_notes
string
padrão:""

Anotações sobre o lead

​
lead_isTicketOpen
boolean
padrão:false

Indica se tem ticket aberto

​
lead_assignedAttendant_id
string
padrão:""

ID do atendente responsável

​
lead_kanbanOrder
integer<int64>
padrão:0

Ordem no kanban

​
lead_field01
string
padrão:""
​
lead_field02
string
padrão:""
​
lead_field03
string
padrão:""
​
lead_field04
string
padrão:""
​
lead_field05
string
padrão:""
​
lead_field06
string
padrão:""
​
lead_field07
string
padrão:""
​
lead_field08
string
padrão:""
​
lead_field09
string
padrão:""
​
lead_field10
string
padrão:""
​
lead_field11
string
padrão:""
​
lead_field12
string
padrão:""
​
lead_field13
string
padrão:""
​
lead_field14
string
padrão:""
​
lead_field15
string
padrão:""
​
lead_field16
string
padrão:""
​
lead_field17
string
padrão:""
​
lead_field18
string
padrão:""
​
lead_field19
string
padrão:""
​
lead_field20
string
padrão:""
​
chatbot_agentResetMemoryAt
integer<int64>
padrão:0

Timestamp do último reset de memória

​
chatbot_lastTrigger_id
string
padrão:""

ID do último gatilho executado

​
chatbot_lastTriggerAt
integer<int64>
padrão:0

Timestamp do último gatilho

​
chatbot_disableUntil
integer<int64>
padrão:0

Timestamp até quando chatbot está desativado

​
created
string
padrão:strftime('%Y-%m-%d %H:%M:%f', 'now')

Data de criação

​
updated
string
padrão:strftime('%Y-%m-%d %H:%M:%f', 'now')

Data da última atualização