curl --request POST \
--url https://api.wppfy.com/instance/connect \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"browser": "auto",
"systemName": "Minha Empresa",
"proxy_managed_country": "br",
"proxy_managed_state": "sp",
"proxy_managed_city": "campinas"
}
'{
"response": "Connecting",
"request_id": "5f0c2a8e-6d1b-4c3a-9e7f-1a2b3c4d5e6f",
"status": {
"connected": false,
"loggedIn": false,
"jid": null
}
}Conectar instancia a WhatsApp
Inicia la conexión de la instancia con WhatsApp.
- Sin
phone, devuelve un QR Code para escanear con el celular. - Con
phone, devuelve un código de emparejamiento para ese número.
La instancia permanece en connecting hasta que se confirme el emparejamiento o
expire el plazo. Siga la evolución en GET /instance/status; no repita la
llamada mientras el proceso esté en curso.
Tras la conexión, el historial disponible empieza a llegar mediante el evento
history y puede consultarse en POST /message/find y POST /chat/find.
La respuesta puede incluir request_id en el nivel superior, incluso antes de escanear el QR code
o usar el código de emparejamiento. Guarde ese id para correlacionar el intento con
los lotes history del emparejamiento, incluido el status de finalización, y con
GET /instance/history-sync/status. Permanece igual durante el mismo
intento y cambia con cada nuevo emparejamiento. Puede estar ausente cuando no hay
emparejamiento ni seguimiento disponible.
En un emparejamiento nuevo, history_days elige cuántos días de historial envía el
celular. Sin el campo, con un valor fuera de 0–365 o de 1 a 90 días, la
solicitud es el historial normal (90 días, cuando no hay un valor válido). De 91
a 365 días, o con 0 (el máximo, 365 días), la solicitud es el historial
completo, más grande y más lento. Una instancia ya emparejada se reconecta sin
solicitar historial.
Para elegir una región de conexión, consulte primero
GET /proxy-managed/countries y GET /proxy-managed/cities y reutilice los
valores devueltos en los campos proxy_managed_*.
curl --request POST \
--url https://api.wppfy.com/instance/connect \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"browser": "auto",
"systemName": "Minha Empresa",
"proxy_managed_country": "br",
"proxy_managed_state": "sp",
"proxy_managed_city": "campinas"
}
'{
"response": "Connecting",
"request_id": "5f0c2a8e-6d1b-4c3a-9e7f-1a2b3c4d5e6f",
"status": {
"connected": false,
"loggedIn": false,
"jid": null
}
}Autorizaciones
Cuerpo
Número de teléfono en formato internacional (ej.: 5511999999999). Si se informa, genera un código de emparejamiento. Si se omite, genera un código QR.
^\d{10,15}$"5511999999999"
Navegador usado en el ciclo de autenticación/conexión. auto conserva un perfil válido ya guardado o elige Safari, Firefox o Edge para nuevas conexiones.
auto, safari, firefox, edge, chrome "auto"
Sistema/nombre mostrado en el celular en dispositivos vinculados. Ayuda a identificar la instancia en WhatsApp; para mayor estabilidad, recomendamos dejarlo en blanco y usar el valor predeterminado del navegador elegido.
"Mi Empresa"
País deseado para el proxy regional, en ISO alpha-2 en minúsculas. Use el valor devuelto por GET /proxy-managed/countries.
^[a-z]{2}$"br"
Estado/subdivisión de la ciudad elegida. Cuando el país/ciudad requiera desambiguación, use el campo state devuelto por GET /proxy-managed/cities?country=br.
"sp"
Ciudad elegida para el proxy regional. Use siempre el campo value devuelto por GET /proxy-managed/cities.
"campinas"
Días de historial solicitados al celular en la vinculación.
- Ausente: 90 días, mediante el historial normal.
- De
1a90: los últimos N días, mediante el historial normal. - De
91a365: los últimos N días, mediante el historial completo. 0: el máximo, 365 días mediante el historial completo.- Fuera de 0–365: se ignora; aplican los 90 días.
Solo aplica en una vinculación nueva. Una instancia ya vinculada se reconecta sin solicitar historial, y un código QR o código ya generado mantiene lo que se solicitó. El celular decide qué envía: los días son un límite solicitado, no una garantía.
0 <= x <= 36590
Respuesta
Éxito
Estado actual de la conexión
false
Estado del inicio de sesión
false
ID de WhatsApp (cuando hay sesión iniciada)
null
Detalles completos de la instancia
Show child attributes
Show child attributes
{
"id": "i91011ijkl",
"token": "abc123xyz",
"status": "connected",
"paircode": "1234-5678",
"qrcode": "data:image/png;base64,iVBORw0KGg...",
"name": "Instância Principal",
"profileName": "Loja ABC",
"profilePicUrl": "https://example.com/profile.jpg",
"isBusiness": true,
"plataform": "Android",
"systemName": "WppFy",
"owner": "user@example.com",
"lastDisconnect": "2025-01-24T14:00:00Z",
"lastDisconnectReason": "Network error",
"adminField01": "custom_data",
"openai_apikey": "sk-...xyz",
"chatbot_enabled": true,
"chatbot_ignoreGroups": true,
"chatbot_stopConversation": "parar",
"chatbot_stopMinutes": 60,
"created": "2025-01-24T14:00:00Z",
"updated": "2025-01-24T14:30:00Z",
"currentPresence": "available"
}
Identificador del intento de emparejamiento y de su historial inicial. Opcional; es el mismo informado en los eventos history y en GET /instance/history-sync/status.
"5f0c2a8e-6d1b-4c3a-9e7f-1a2b3c4d5e6f"