https://github.com/systemhelpcod/big-conect-api
Api de whastapp nao oficial com base na baileys e whaileys
https://github.com/systemhelpcod/big-conect-api
api-client bot open-source whatsapp whatsapp-api
Last synced: 20 days ago
JSON representation
Api de whastapp nao oficial com base na baileys e whaileys
- Host: GitHub
- URL: https://github.com/systemhelpcod/big-conect-api
- Owner: systemhelpcod
- Created: 2025-11-19T19:32:19.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-12-07T00:55:29.000Z (7 months ago)
- Last Synced: 2026-06-09T03:44:01.050Z (20 days ago)
- Topics: api-client, bot, open-source, whatsapp, whatsapp-api
- Language: TypeScript
- Homepage:
- Size: 83.9 MB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🌐 **API BIG CONECT - Documentação Completa**
**Solução Profissional de Automação WhatsApp Business**
[](https://receitaws.com.br/cnpj/48590314000118)
[](https://github.com/systemhelpcod/big-conect-api)
[](https://www.typescriptlang.org/)
[](LICENSE)
*Sua solução completa para automação WhatsApp Business*
---
## 🚀 **INSTALAÇÃO RÁPIDA**
### **Pré-requisitos**
* Node.js 16+ instalado
* Git instalado
* WhatsApp no celular para escanear QR Code
### **Passo a Passo para Instalação**
#### **1. Clone o repositório**
```bash
git clone https://github.com/systemhelpcod/big-conect-api.git
cd big-conect-api
```
#### **2. Configure as variáveis de ambiente**
```bash
cp .env-exemplo .env
nano .env
```
**Exemplo `.env`:**
```env
NODE_ENV=development
PORT=9009
IPV4=0.0.0.0
IPV6=
DOMAIN_SSL=
VIEW_QRCODE_TERMINAL=1
PATCH_TOKENS=./sessions
DEVICE_NAME=Big-Conect-API
HOST_NAME=BigConectAPI
WA_VERSION=
WA_URL=
AUTO_CLOSE=15
SECRET_KEY=123456789
SECRET_APIKEY=123456789
WEBHOOK_URL=https://exemplo/webhook-test/api
LOG_LEVEL=debug
ALLOWED_ORIGINS=*
```
#### **3. Instale as dependências**
```bash
npm install
```
#### **4. Caso ocorra erro na instalação**
```bash
rm -rf node_modules package-lock.json
npm install
```
#### **5. Execute a API**
```bash
npm run dev
```
#### **6. Configure a sessão WhatsApp**
1. Crie a sessão: `POST /api/sessions`
2. Obtenha QR Code: `GET /api/sessions/{sessionId}/qr`
3. Escaneie com WhatsApp (Dispositivos Conectados)
4. API pronta para uso 🎉
---
## 💻 **USO DA API COM X-API-KEY**
> Todos os endpoints exigem o header `x-api-key` com a chave do `.env` (`SECRET_APIKEY`).
```http
x-api-key: 123456789
```
Exemplo `curl` para criar sessão:
```bash
curl -X POST http://127.0.0.1:9009/api/sessions \
-H "Content-Type: application/json" \
-H "x-api-key: 123456789"
```
---
## 📋 **ENDPOINTS PRINCIPAIS**
### 🔄 **Gestão de Sessões**
* **Criar Nova Sessão**
```bash
curl -X POST http://127.0.0.1:9009/api/sessions \
-H "Content-Type: application/json" \
-H "x-api-key: 123456789"
```
* **Listar Sessões**
```bash
curl -X GET http://127.0.0.1:9009/api/sessions \
-H "x-api-key: 123456789"
```
* **Obter QR Code**
```bash
curl -X GET http://127.0.0.1:9009/api/sessions/{sessionId}/qr \
-H "x-api-key: 123456789"
```
* **Status da Sessão**
```bash
curl -X GET http://127.0.0.1:9009/api/sessions/{sessionId}/status \
-H "x-api-key: 123456789"
```
* **Deletar Sessão**
```bash
curl -X DELETE http://127.0.0.1:9009/api/sessions/{sessionId} \
-H "x-api-key: 123456789"
```
---
## 📤 **Envio de Mensagens**
> Todos os endpoints abaixo exigem `x-api-key`. Substitua `{sessionId}` pelo ID da sua sessão.
* **Mensagem de Texto**
```bash
curl -X POST http://127.0.0.1:9009/api/{sessionId}/messages/text \
-H "Content-Type: application/json" \
-H "x-api-key: 123456789" \
-d '{"to":"5511999999999","text":"Olá! Mensagem via API Big Conect 🚀"}'
```
* **Mensagem Formatada (negrito, itálico, tachado)**
```bash
curl -X POST http://127.0.0.1:9009/api/{sessionId}/messages/text \
-H "Content-Type: application/json" \
-H "x-api-key: 123456789" \
-d '{
"to": "5511999999999",
"text": "🚀 *Mensagem Formatada*\n✅ Negrito: *texto*\n✅ Itálico: _texto_\n✅ Tachado: ~texto~"
}'
```
* **Imagem**
```bash
curl -X POST http://127.0.0.1:9009/api/{sessionId}/messages/media \
-H "Content-Type: application/json" \
-H "x-api-key: 123456789" \
-d '{
"to": "5511999999999",
"mediaUrl": "https://raw.githubusercontent.com/systemhelpcod/big-conect-api/main/Imagem-exemplos/logoapi.jpeg",
"type": "image",
"caption": "Logo Big Conect 🖼️"
}'
```
* **Vídeo**
```bash
curl -X POST http://127.0.0.1:9009/api/{sessionId}/messages/media \
-H "Content-Type: application/json" \
-H "x-api-key: 123456789" \
-d '{
"to": "5511999999999",
"mediaUrl": "https://github.com/systemhelpcod/big-conect-api/raw/refs/heads/main/video-exemplo/video.mp4",
"type": "video",
"caption": "Vídeo enviado via API! 🎥"
}'
```
* **Áudio (PTT opcional)**
```bash
curl -X POST http://127.0.0.1:9009/api/{sessionId}/messages/media \
-H "Content-Type: application/json" \
-H "x-api-key: 123456789" \
-d '{
"to": "5511999999999",
"mediaUrl": "https://www.soundhelix.com/examples/mp3/SoundHelix-Song-1.mp3",
"type": "audio",
"ptt": false
}'
```
* **Botões Interativos**
```bash
curl -X POST http://127.0.0.1:9009/api/{sessionId}/messages/buttons \
-H "Content-Type: application/json" \
-H "x-api-key: 123456789" \
-d '{
"to": "5511999999999",
"text": "🔘 TESTE DE BOTÕES INTERATIVOS",
"buttons": [
{"id": "teste1", "text": "✅ Teste 1"},
{"id": "teste2", "text": "🔄 Teste 2"},
{"id": "teste3", "text": "📊 Teste 3"}
],
"footer": "API Big Conect - Botões Funcionando!"
}'
```
* **Botões com Imagem**
```bash
curl -X POST http://127.0.0.1:9009/api/{sessionId}/messages/buttons \
-H "Content-Type: application/json" \
-H "x-api-key: 123456789" \
-d '{
"to": "5511999999999",
"text": "💎 TESTE BOTÕES COM IMAGEM",
"buttons": [
{"id": "planos", "text": "💰 Ver Planos"},
{"id": "demo", "text": "🎬 Agendar Demo"},
{"id": "contratar", "text": "📝 Contratar"}
],
"image": {"url": "https://raw.githubusercontent.com/systemhelpcod/big-conect-api/main/Imagem-exemplos/logoapi.jpeg"},
"footer": "Big Conect - API Profissional"
}'
```
* **Lista Interativa**
```bash
curl -X POST http://127.0.0.1:9009/api/{sessionId}/messages/list \
-H "Content-Type: application/json" \
-H "x-api-key: 123456789" \
-d '{
"to": "5511999999999",
"text": "📋 TESTE DE LISTA INTERATIVA",
"buttonText": "Abrir Opções",
"title": "Menu de Testes",
"sections": [
{
"title": "🧪 Testes Básicos",
"rows": [
{"title": "Teste de Texto", "description": "Envio de mensagem simples", "rowId": "teste_texto"},
{"title": "Teste de Mídia", "description": "Envio de imagem e vídeo", "rowId": "teste_midia"}
]
},
{
"title": "⚡ Testes Avançados",
"rows": [
{"title": "Teste de Áudio", "description": "Envio de mensagem de voz", "rowId": "teste_audio"},
{"title": "Teste de Documento", "description": "Envio de arquivos PDF", "rowId": "teste_documento"}
]
}
]
}'
```
* **Mensagens em Lote**
```bash
curl -X POST http://127.0.0.1:9009/api/{sessionId}/messages/bulk \
-H "Content-Type: application/json" \
-H "x-api-key: 123456789" \
-d '{
"messages": [
{"to": "556292231423", "text": "📨 Mensagem 1 do lote de teste"},
{"to": "556292231423", "text": "📨 Mensagem 2 do lote de teste"},
{"to": "556292231423", "text": "📨 Mensagem 3 do lote de teste"}
],
"delayBetweenMessages": 1000
}'
```
---
## 🛠 **CONFIGURAÇÃO E MONITORAMENTO**
* **Health Check**
```bash
curl -X GET http://127.0.0.1:9009/health \
-H "x-api-key: 123456789"
```
* **Informações da API**
```bash
curl -X GET http://127.0.0.1:9009/ \
-H "x-api-key: 123456789"
```
---
## ✅ **NOTAS IMPORTANTES**
1. `x-api-key` obrigatório em todos os endpoints
2. `.env` atualizado com `SECRET_APIKEY`
3. Use sempre `IPV4=0.0.0.0` para conexões externas
4. Sessões retornam `user.id` e `user.name`
5. Mensagens multimídia, botões, listas e reações seguem padrão do header `x-api-key`
---
**🚀 API Big Conect - Desenvolvido com ❤️ por System Help**
*Solução profissional para automação WhatsApp Business*
[](https://github.com/systemhelpcod/big-conect-api)
[](https://nubank.com.br/pagar)