Referência da API REST

Conecte seu CRM, ERP ou sistema próprio para enviar mensagens ativas, criar tickets, gerenciar contatos e automatizar o relacionamento com o cliente — tudo via chamadas HTTP padronizadas.

Acesso: Automação e Integrações › API › clique em Adicionar e selecione o canal desejado para gerar o token.

---

🔑 Autenticação

Todas as requisições precisam incluir o token de autenticação no header HTTP:

Authorization: Bearer SEU_TOKEN_AQUI
Content-Type: application/json

⚠️Guarde seu Token com Segurança

Trate o token como uma senha. Não o inclua em repositórios públicos nem o compartilhe com terceiros. Para revogar o acesso, gere um novo token nas configurações do canal.

---

📋 Visão Geral dos Endpoints

Grupo	Endpoint	Método	Descrição
Mensagens	/message/send-text	POST	Enviar mensagem de texto
Mensagens	/message/send-media	POST	Enviar arquivo, imagem ou vídeo
Mensagens	/message/send-template	POST	Disparar template WhatsApp oficial
Tickets	/ticket	GET	Listar tickets com filtros
Tickets	/ticket/:id	GET	Buscar ticket por ID
Tickets	/ticket/:id/assign	PUT	Transferir ticket para fila ou usuário
Contatos	/contact	POST	Criar ou atualizar contato
Contatos	/contact/:id	GET	Buscar contato por ID
Webhooks	/webhook	POST	Receber eventos em tempo real

---

📤 Enviar Mensagem de Texto

Endpoint: POST /message/send-text

curl -X POST https://api.galaxychat.com.br/api/v1/message/send-text \
  -H "Authorization: Bearer seu_token_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "5511999998888",
    "body": "Olá {{name}}, sua fatura está disponível para pagamento via PIX.",
    "variables": {
      "name": "Carlos Silva"
    }
  }'

Resposta de sucesso (200):

{
  "success": true,
  "messageId": "msg_98765432",
  "status": "sent",
  "timestamp": "2026-10-21T14:30:00-03:00"
}

---

📎 Enviar Arquivo ou Mídia

Endpoint: POST /message/send-media

curl -X POST https://api.galaxychat.com.br/api/v1/message/send-media \
  -H "Authorization: Bearer seu_token_aqui" \
  -F "number=5511999998888" \
  -F "caption=Segue o boleto para pagamento:" \
  -F "file=@/caminho/do/boleto.pdf"

---

🎫 Criar ou Atualizar Contato

Endpoint: POST /contact

{
  "name": "Carlos Silva",
  "number": "5511999998888",
  "email": "carlos@empresa.com.br",
  "tags": ["cliente-ativo", "sp"],
  "customFields": {
    "cpf": "123.456.789-00",
    "plano": "Premium"
  }
}

---

📬 Receber Webhooks

Configure uma URL no painel para receber notificações em tempo real de eventos:

{
  "event": "ticket.updated",
  "data": {
    "ticketId": 5890,
    "status": "closed",
    "contact": {
      "name": "Carlos Silva",
      "number": "5511999998888"
    },
    "assignedTo": "Ana Souza",
    "closedAt": "2026-10-21T16:45:00-03:00"
  }
}

Eventos disponíveis:

• message.received — Nova mensagem recebida
• message.sent — Mensagem enviada com sucesso
• ticket.created — Novo ticket aberto
• ticket.updated — Ticket atualizado (fila, operador, status)
• ticket.closed — Atendimento encerrado

---

⚠️ Códigos de Resposta

Código	Significado
200	Sucesso
201	Recurso criado
400	Parâmetros inválidos ou ausentes
401	Token inválido ou ausente
403	Sem permissão para esta ação
404	Recurso não encontrado
429	Limite de requisições excedido
500	Erro interno — contate o suporte

---

💡 Boas Práticas de Integração

• Rate Limiting: Respeite o limite de 60 requisições por minuto por token. Para disparos em massa, use o módulo de Campanhas.
• Idempotência: Use o campo externalId para evitar mensagens duplicadas em caso de retry.
• Ambiente de Teste: Ative o Testar API para explorar os endpoints no Swagger UI antes de ir para produção.
• Webhooks seguros: Valide o header X-Galaxy-Signature usando HMAC-SHA256 para confirmar que a requisição é legítima.

💡Coleção Postman Oficial

Baixe a coleção completa em Automação e Integrações › API › Baixar Postman Collection para importar todos os endpoints com exemplos prontos no Postman ou Insomnia.