WhatsApp — Syncro API

Liste os números de WhatsApp conectados e os templates oficiais aprovados. O envio de mensagens é feito pelos endpoints de Leads.

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

Liste os números de WhatsApp conectados e os templates oficiais aprovados. O envio de mensagens é feito pelos endpoints de Leads (links no fim da página).

Listar números conectados

GET/whatsapp/instances

Permissão: whatsapp:read

Lista os números de WhatsApp conectados. Sem parâmetros.

Campos da resposta

providerstringopcional

waha (não oficial) ou cloud_api (API Oficial do Meta)

supports_templatesbooleanopcional

true se aceita templates HSM (apenas API Oficial)

has_window_restrictionbooleanopcional

true se respeita a janela de 24h (apenas API Oficial)

idintegeropcional

Use como instance_id ao enviar mensagens

Requisição

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

Resposta

{
  "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 templates (HSM)

GET/whatsapp/templates

Permissão: whatsapp:read

Lista os templates oficiais (HSM) da conta.

Parâmetros de query

instance_idintegeropcional

Filtra por número

statusstringopcional

APPROVED, PENDING, REJECTED, PAUSED, DISABLED

languagestringopcional

Idioma do template (ex.: pt_BR)

Use o id do template em POST /leads/{id}/send-whatsapp-template, passando variables na ordem dos {{1}}, {{2}}...

Requisição

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

Resposta

{
  "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 mensagens

O envio é por lead:

Texto/imagem: POST /leads/{id}/send-whatsapp
Template (HSM): POST /leads/{id}/send-whatsapp-template

Ambos exigem a permissão whatsapp:write.