Documentação da API

Integre seu CRM de forma simples e rápida através da nossa API RESTful.

Autenticação

Todas as requisições devem incluir a sua API Key no header x-api-key.

x-api-key: SUA_API_KEY_AQUI

POST /send-text

Envia uma mensagem de texto simples.

Body (JSON)

{
  "instanceName": "nome-da-instancia",
  "phone": "5511999999999",
  "text": "Sua mensagem aqui"
}

POST /send-media

Envia uma mensagem de mídia (imagem, áudio, vídeo ou documento). Você pode usar as rotas específicas como /send-image, /send-audio, /send-video, /send-document com o mesmo padrão.

Body (JSON)

{
  "instanceName": "nome-da-instancia",
  "phone": "5511999999999",
  "image": "URL_DA_IMAGEM_OU_BASE64",
  "text": "Legenda opcional da imagem"
}

GET /instance/status/:instanceName

Retorna o status atual da instância (QR_READY, STARTING, CONNECTED, etc).

POST /instance/create

Cria ou recria uma nova instância/aparelho no sistema e gera o QR Code.

Body (JSON)

{
  "instanceName": "nome-da-instancia",
  "webhookUrl": "https://seu-crm.com/webhook"
}

DELETE /instance/:instanceName

Exclui permanentemente a instância e apaga sua sessão do servidor.

Webhooks

Quando um número conectado na instância recebe mensagens (textos, imagens, áudios), nossa API fará um POST automático para o seu webhookUrl com o seguinte formato JSON:

{
  "instance": "nome-da-instancia",
  "sender": "5511888888888",
  "messageId": "B2J9...",
  "text": "Olá, tudo bem?",
  "messageType": "conversation",
  "isGroup": false,
  "timestamp": 1690000000
}