WhatsApp — Syncro API

Lista los números de WhatsApp conectados y las plantillas oficiales aprobadas. El envío de mensajes se realiza mediante los endpoints de Leads.

Base URLhttps://app.syncro.chat/api/v1AuthX-API-Key: crm_SUA_CHAVE_AQUI

Lista los números de WhatsApp conectados y las plantillas oficiales aprobadas. El envío de mensajes se realiza mediante los endpoints de Leads (enlaces al final de la página).

Listar números conectados

GET/whatsapp/instances

Permiso: whatsapp:read

Lista los números de WhatsApp conectados. Sin parámetros.

Campos de la respuesta

providerstringopcional

waha (no oficial) o cloud_api (API Oficial de Meta)

supports_templatesbooleanopcional

true si acepta plantillas HSM (solo API Oficial)

has_window_restrictionbooleanopcional

true si respeta la ventana de 24h (solo API Oficial)

idintegeropcional

Úsalo como instance_id al enviar mensajes

Solicitud

curl "https://app.syncro.chat/api/v1/whatsapp/instances" \
  -H "X-API-Key: crm_SUA_CHAVE_AQUI"

Respuesta

{
  "success": true,
  "data": [
    {
      "id": 1,
      "provider": "waha",
      "display_name": "Número principal",
      "phone_number": "+5511999887766",
      "is_primary": true,
      "status": "connected",
      "supports_templates": false,
      "supports_buttons": false,
      "has_window_restriction": false
    },
    {
      "id": 2,
      "provider": "cloud_api",
      "display_name": "API Oficial",
      "phone_number": "+5521987654321",
      "is_primary": false,
      "status": "connected",
      "supports_templates": true,
      "supports_buttons": true,
      "has_window_restriction": true
    }
  ]
}

Listar plantillas (HSM)

GET/whatsapp/templates

Permiso: whatsapp:read

Lista las plantillas oficiales (HSM) de la cuenta.

Parámetros de query

instance_idintegeropcional

Filtra por número

statusstringopcional

APPROVED, PENDING, REJECTED, PAUSED, DISABLED

languagestringopcional

Idioma de la plantilla (ej.: pt_BR)

Usa el id de la plantilla en POST /leads/{id}/send-whatsapp-template, pasando variables en el orden de {{1}}, {{2}}...

Solicitud

curl "https://app.syncro.chat/api/v1/whatsapp/templates?status=APPROVED" \
  -H "X-API-Key: crm_SUA_CHAVE_AQUI"

Respuesta

{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "lembrete_proposta",
      "language": "pt_BR",
      "category": "UTILITY",
      "status": "APPROVED",
      "whatsapp_instance_id": 2,
      "variables": [
        "nome",
        "titulo",
        "data"
      ],
      "components": [
        {
          "type": "BODY",
          "text": "Olá {{1}}, sua {{2}} está agendada para {{3}}."
        }
      ],
      "quality_rating": "GREEN"
    }
  ]
}

Enviar mensajes

El envío es por lead:

Texto/imagen: POST /leads/{id}/send-whatsapp
Plantilla (HSM): POST /leads/{id}/send-whatsapp-template

Ambos requieren el permiso whatsapp:write.