Consultar detalles de un chat

curl --request POST \
  --url https://api.wppfy.com/chat/details \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "number": "5511999999999",
  "preview": false
}
'

import requests

url = "https://api.wppfy.com/chat/details"

payload = {
    "number": "5511999999999",
    "preview": False
}
headers = {
    "token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({number: '5511999999999', preview: false})
};

fetch('https://api.wppfy.com/chat/details', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.wppfy.com/chat/details",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'number' => '5511999999999',
    'preview' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.wppfy.com/chat/details"

	payload := strings.NewReader("{\n  \"number\": \"5511999999999\",\n  \"preview\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.wppfy.com/chat/details")
  .header("token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"number\": \"5511999999999\",\n  \"preview\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.wppfy.com/chat/details")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"number\": \"5511999999999\",\n  \"preview\": false\n}"

response = http.request(request)
puts response.read_body

{
  "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",
  "is_business": false,
  "business_name": "",
  "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"
}

Contactos

Consultar detalles de un chat

Devuelve los datos disponibles para presentar o editar una conversación: identificación, nombres conocidos, teléfono, foto, estado del chat, datos de lead e información de grupo cuando corresponda.

Úselo después de elegir un chat en POST /chat/find. Para obtener solo la imagen, prefiera POST /chat/avatar, más liviano, principalmente en listas con muchos chats. El campo preview permite elegir una imagen más pequeña para interfaces de listado o la imagen completa.

Cada instancia procesa hasta 4 consultas de esta ruta al mismo tiempo. La siguiente espera hasta 2 segundos por un espacio; si no lo hay, recibe 429 con el header Retry-After. La ruta también cuenta en el límite de llamadas de la instancia.

Para contactos individuales, is_business indica si hay un nombre comercial conocido. business_name trae ese nombre cuando está disponible.

POST

chat

details

Consultar detalles de un chat

curl --request POST \
  --url https://api.wppfy.com/chat/details \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "number": "5511999999999",
  "preview": false
}
'

import requests

url = "https://api.wppfy.com/chat/details"

payload = {
    "number": "5511999999999",
    "preview": False
}
headers = {
    "token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({number: '5511999999999', preview: false})
};

fetch('https://api.wppfy.com/chat/details', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.wppfy.com/chat/details",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'number' => '5511999999999',
    'preview' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.wppfy.com/chat/details"

	payload := strings.NewReader("{\n  \"number\": \"5511999999999\",\n  \"preview\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.wppfy.com/chat/details")
  .header("token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"number\": \"5511999999999\",\n  \"preview\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.wppfy.com/chat/details")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"number\": \"5511999999999\",\n  \"preview\": false\n}"

response = http.request(request)
puts response.read_body

{
  "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",
  "is_business": false,
  "business_name": "",
  "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"
}

Autorizaciones

token

string

header

requerido

Cuerpo

application/json

number

string

requerido

Número de teléfono o ID del grupo

Ejemplo:

"5511999999999"

preview

boolean

predeterminado:false

Controla el tamaño de la imagen de perfil devuelta:

true: Devuelve la imagen en tamaño preview (más pequeña, optimizada para listados)
false (predeterminado): Devuelve la imagen en tamaño full (resolución original, mayor calidad)

Respuesta

Información completa del chat devuelta con éxito

Representa una conversación/ticket en el sistema

string

ID único de la conversación (r + 7 bytes aleatorios en hex)

wa_fastid

string

Identificador rápido de WhatsApp

wa_chatid

string

ID completo del chat en WhatsApp

wa_chatlid

string

LID del chat en WhatsApp (cuando esté disponible)

wa_archived

boolean

predeterminado:false

Indica si el chat está archivado

wa_contactName

string

predeterminado:""

Nombre guardado en la agenda del teléfono para este número (vacío: no está guardado). La conversación se crea con él (por LID, mediante el número vinculado) y cambia cuando el contacto se guarda o se elimina en el teléfono.

wa_name

string

predeterminado:""

Nombre definido por el usuario en el perfil de WhatsApp ("push name"). Proviene del perfil del contacto y puede no estar disponible según el contexto o el origen de los datos.

name

string

predeterminado:""

Nombre resuelto por el sistema como fallback. Normalmente consolida el mejor valor disponible entre datos internos, el nombre proveniente de WhatsApp y el nombre guardado en los contactos. Por eso, suele tener mayor probabilidad de venir completado.

image

string

predeterminado:""

URL de la foto de perfil en tamaño original; vacía si no hay.

imagePreview

string

predeterminado:""

URL de la foto de perfil en tamaño reducido; vacía si no hay.

parent_community

object

Comunidad principal del chat cuando representa un subgrupo

Show child attributes

wa_ephemeralExpiration

integer<int64>

predeterminado:0

Tiempo de expiración de mensajes efímeros

wa_isBlocked

boolean

predeterminado:false

Indica si el contacto está bloqueado

wa_isGroup

boolean

predeterminado:false

Indica si es un grupo

wa_isGroup_admin

boolean

predeterminado:false

Indica si el usuario es admin del grupo

wa_isGroup_announce

boolean

predeterminado:false

Indica si es un grupo solo de anuncios

wa_isGroup_community

boolean

predeterminado:false

Indica si es una comunidad

wa_isGroup_member

boolean

predeterminado:false

Indica si es miembro del grupo

wa_isPinned

boolean

predeterminado:false

Indica si el chat está fijado

wa_label

string[]

Etiquetas del chat

wa_notes

string

predeterminado:""

Notas internas del chat sincronizadas mediante app state

wa_lastMessageTextVote

string

predeterminado:""

Texto/voto del último mensaje

wa_lastMessageType

string

predeterminado:""

Tipo del último mensaje

wa_lastMsgTimestamp

integer<int64>

predeterminado:0

Timestamp del último mensaje

wa_lastMessageSender

string

predeterminado:""

Remitente del último mensaje

lead_awaitingReply

boolean

read-only

true cuando el contacto espera respuesta: el último mensaje es suyo y nadie concluyó la conversación (POST /lead/resolve). El mensaje del contacto lo activa; el nuestro (usted, la IA, un flujo o una integración) lo desactiva. En las conversaciones anteriores a este campo, la api decide según el remitente (el número o el LID de la instancia). Solo en conversaciones con personas: ausente en grupos y canales, que no entran en ninguno de los dos filtros, y cuando la conversación no tiene un último mensaje conocido (solo la fecha). Filtrable en /chat/find.

wa_muteEndTime

integer<int64>

predeterminado:0

Timestamp del fin del silenciamiento

owner

string

predeterminado:""

Propietario de la instancia

wa_unreadCount

integer<int64>

predeterminado:0

Contador de mensajes no leídos

phone

string

predeterminado:""

Número de teléfono

common_groups

string

predeterminado:""

Grupos en común separados por coma, formato: (nombre_grupo)id_grupo

Ejemplo:

"Grupo Familia(120363123456789012@g.us),Trabajo(987654321098765432@g.us)"

lead_name

string

predeterminado:""

Nombre del lead

lead_fullName

string

predeterminado:""

Nombre completo del lead

lead_email

string

predeterminado:""

Email del lead

lead_personalid

string

predeterminado:""

Documento de identificación

lead_status

string

predeterminado:""

Estado libre del lead

lead_tags

string[]

Etiquetas del lead. Las etiquetas configuradas con kanban=true también determinan las columnas en las que aparece la tarjeta en el Kanban.

lead_notes

string

predeterminado:""

Notas sobre el lead

lead_isTicketOpen

boolean

predeterminado:false

Indica si tiene un ticket abierto

lead_assignedAttendant_id

string

predeterminado:""

ID del agente responsable

lead_kanbanOrder

integer<int64>

predeterminado:0

Orden en el kanban

lead_field01

string

predeterminado:""

lead_field02

string

predeterminado:""

lead_field03

string

predeterminado:""

lead_field04

string

predeterminado:""

lead_field05

string

predeterminado:""

lead_field06

string

predeterminado:""

lead_field07

string

predeterminado:""

lead_field08

string

predeterminado:""

lead_field09

string

predeterminado:""

lead_field10

string

predeterminado:""

lead_field11

string

predeterminado:""

lead_field12

string

predeterminado:""

lead_field13

string

predeterminado:""

lead_field14

string

predeterminado:""

lead_field15

string

predeterminado:""

lead_field16

string

predeterminado:""

lead_field17

string

predeterminado:""

lead_field18

string

predeterminado:""

lead_field19

string

predeterminado:""

lead_field20

string

predeterminado:""

chatbot_agentResetMemoryAt

integer<int64>

predeterminado:0

Inicio de la memoria de la IA (ms): el agente solo lee los mensajes de la conversación a partir de aquí. 0: sin corte (se aplica la ventana del agente). Se guarda mediante /chat/editLead.

chatbot_lastTrigger_id

string

predeterminado:""

ID del último disparador ejecutado

chatbot_lastTriggerAt

integer<int64>

predeterminado:0

Timestamp del último disparador

chatbot_disableUntil

integer<int64>

predeterminado:0

Automatización (IA, disparadores y flujos) pausada en esta conversación hasta este horario, en milisegundos. -1: hasta que alguien la vuelva a activar; 0: activada.

chatbot_summary

string

predeterminado:""

Motivo de la pausa realizada por la automatización: solicitud de humano (IA o flujo; pausa hasta que alguien la reactive) o límite de respuestas de la IA (pausa de 1 hora). Vacío cuando no hay pausa o después de que termina. Reactivar (chatbot_disableUntil: 0 en /chat/editLead) o concluir (POST /lead/resolve) lo limpia.

is_business

boolean

Existe un nombre comercial conocido para este contacto.

business_name

string

Nombre comercial conocido, o string vacío.

wa_common_groups

string

Grupos en común separados por coma, formato: nombre_grupo(id_grupo)

Ejemplo:

"Grupo Familia(120363123456789012@g.us),Trabajo(987654321098765432@g.us)"

Instancia

CRM

Proxy

Perfil

Enviar Mensaje

Mensaje Async

Acciones en el mensaje y Búsqueda

Grupos y Comunidades

Newsletters y Canales

Server-Sent Events (SSE)

Bloqueos

Etiquetas

Chats

Contactos

Llamadas

Integración con Chatwoot

Business

Respuestas Rápidas

Consultar detalles de un chat

Autorizaciones

Cuerpo

Respuesta