{"id":33346506,"url":"https://github.com/systemhelpcod/big-conect-api","last_synced_at":"2026-06-09T03:44:01.746Z","repository":{"id":325552569,"uuid":"1100057260","full_name":"systemhelpcod/big-conect-api","owner":"systemhelpcod","description":"Api  de whastapp nao oficial com base na baileys e  whaileys","archived":false,"fork":false,"pushed_at":"2025-12-07T00:55:29.000Z","size":87936,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-09T03:44:01.050Z","etag":null,"topics":["api-client","bot","open-source","whatsapp","whatsapp-api"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/systemhelpcod.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-11-19T19:32:19.000Z","updated_at":"2025-12-03T16:02:47.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/systemhelpcod/big-conect-api","commit_stats":null,"previous_names":["systemhelpcod/big-conect-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/systemhelpcod/big-conect-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/systemhelpcod%2Fbig-conect-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/systemhelpcod%2Fbig-conect-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/systemhelpcod%2Fbig-conect-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/systemhelpcod%2Fbig-conect-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/systemhelpcod","download_url":"https://codeload.github.com/systemhelpcod/big-conect-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/systemhelpcod%2Fbig-conect-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34090751,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-09T02:00:06.510Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-client","bot","open-source","whatsapp","whatsapp-api"],"created_at":"2025-11-22T07:01:18.006Z","updated_at":"2026-06-09T03:44:01.740Z","avatar_url":"https://github.com/systemhelpcod.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🌐 **API BIG CONECT - Documentação Completa**\n\n\u003cdiv align=\"center\"\u003e\n\n\u003cimg src=\"https://raw.githubusercontent.com/systemhelpcod/big-conect-api/main/Imagem-exemplos/logoapi.jpeg\" alt=\"Big Conect Logo\" width=\"200\" height=\"200\" /\u003e\n\n**Solução Profissional de Automação WhatsApp Business**\n\n[![CNPJ](https://img.shields.io/badge/CNPJ-48.590.314/0001--18-blue)](https://receitaws.com.br/cnpj/48590314000118)\n[![WhatsApp API](https://img.shields.io/badge/WhatsApp-API-green)](https://github.com/systemhelpcod/big-conect-api)\n[![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue)](https://www.typescriptlang.org/)\n[![License](https://img.shields.io/badge/License-MIT-yellow)](LICENSE)\n\n*Sua solução completa para automação WhatsApp Business*\n\n\u003c/div\u003e\n\n---\n\n## 🚀 **INSTALAÇÃO RÁPIDA**\n\n### **Pré-requisitos**\n\n* Node.js 16+ instalado\n* Git instalado\n* WhatsApp no celular para escanear QR Code\n\n### **Passo a Passo para Instalação**\n\n#### **1. Clone o repositório**\n\n```bash\ngit clone https://github.com/systemhelpcod/big-conect-api.git\ncd big-conect-api\n```\n\n#### **2. Configure as variáveis de ambiente**\n\n```bash\ncp .env-exemplo .env\nnano .env\n```\n\n**Exemplo `.env`:**\n\n```env\nNODE_ENV=development\nPORT=9009\nIPV4=0.0.0.0\nIPV6=\nDOMAIN_SSL=\nVIEW_QRCODE_TERMINAL=1\nPATCH_TOKENS=./sessions\nDEVICE_NAME=Big-Conect-API\nHOST_NAME=BigConectAPI\nWA_VERSION=\nWA_URL=\nAUTO_CLOSE=15\nSECRET_KEY=123456789\nSECRET_APIKEY=123456789\nWEBHOOK_URL=https://exemplo/webhook-test/api\nLOG_LEVEL=debug\nALLOWED_ORIGINS=*\n```\n\n#### **3. Instale as dependências**\n\n```bash\nnpm install\n```\n\n#### **4. Caso ocorra erro na instalação**\n\n```bash\nrm -rf node_modules package-lock.json\nnpm install\n```\n\n#### **5. Execute a API**\n\n```bash\nnpm run dev\n```\n\n#### **6. Configure a sessão WhatsApp**\n\n1. Crie a sessão: `POST /api/sessions`\n2. Obtenha QR Code: `GET /api/sessions/{sessionId}/qr`\n3. Escaneie com WhatsApp (Dispositivos Conectados)\n4. API pronta para uso 🎉\n\n---\n\n## 💻 **USO DA API COM X-API-KEY**\n\n\u003e Todos os endpoints exigem o header `x-api-key` com a chave do `.env` (`SECRET_APIKEY`).\n\n```http\nx-api-key: 123456789\n```\n\nExemplo `curl` para criar sessão:\n\n```bash\ncurl -X POST http://127.0.0.1:9009/api/sessions \\\n  -H \"Content-Type: application/json\" \\\n  -H \"x-api-key: 123456789\"\n```\n\n---\n\n## 📋 **ENDPOINTS PRINCIPAIS**\n\n### 🔄 **Gestão de Sessões**\n\n* **Criar Nova Sessão**\n\n```bash\ncurl -X POST http://127.0.0.1:9009/api/sessions \\\n  -H \"Content-Type: application/json\" \\\n  -H \"x-api-key: 123456789\"\n```\n\n* **Listar Sessões**\n\n```bash\ncurl -X GET http://127.0.0.1:9009/api/sessions \\\n  -H \"x-api-key: 123456789\"\n```\n\n* **Obter QR Code**\n\n```bash\ncurl -X GET http://127.0.0.1:9009/api/sessions/{sessionId}/qr \\\n  -H \"x-api-key: 123456789\"\n```\n\n* **Status da Sessão**\n\n```bash\ncurl -X GET http://127.0.0.1:9009/api/sessions/{sessionId}/status \\\n  -H \"x-api-key: 123456789\"\n```\n\n* **Deletar Sessão**\n\n```bash\ncurl -X DELETE http://127.0.0.1:9009/api/sessions/{sessionId} \\\n  -H \"x-api-key: 123456789\"\n```\n\n---\n\n## 📤 **Envio de Mensagens**\n\n\u003e Todos os endpoints abaixo exigem `x-api-key`. Substitua `{sessionId}` pelo ID da sua sessão.\n\n* **Mensagem de Texto**\n\n```bash\ncurl -X POST http://127.0.0.1:9009/api/{sessionId}/messages/text \\\n  -H \"Content-Type: application/json\" \\\n  -H \"x-api-key: 123456789\" \\\n  -d '{\"to\":\"5511999999999\",\"text\":\"Olá! Mensagem via API Big Conect 🚀\"}'\n```\n\n* **Mensagem Formatada (negrito, itálico, tachado)**\n\n```bash\ncurl -X POST http://127.0.0.1:9009/api/{sessionId}/messages/text \\\n  -H \"Content-Type: application/json\" \\\n  -H \"x-api-key: 123456789\" \\\n  -d '{\n    \"to\": \"5511999999999\",\n    \"text\": \"🚀 *Mensagem Formatada*\\n✅ Negrito: *texto*\\n✅ Itálico: _texto_\\n✅ Tachado: ~texto~\"\n  }'\n```\n\n* **Imagem**\n\n```bash\ncurl -X POST http://127.0.0.1:9009/api/{sessionId}/messages/media \\\n  -H \"Content-Type: application/json\" \\\n  -H \"x-api-key: 123456789\" \\\n  -d '{\n    \"to\": \"5511999999999\",\n    \"mediaUrl\": \"https://raw.githubusercontent.com/systemhelpcod/big-conect-api/main/Imagem-exemplos/logoapi.jpeg\",\n    \"type\": \"image\",\n    \"caption\": \"Logo Big Conect 🖼️\"\n  }'\n```\n\n* **Vídeo**\n\n```bash\ncurl -X POST http://127.0.0.1:9009/api/{sessionId}/messages/media \\\n  -H \"Content-Type: application/json\" \\\n  -H \"x-api-key: 123456789\" \\\n  -d '{\n    \"to\": \"5511999999999\",\n    \"mediaUrl\": \"https://github.com/systemhelpcod/big-conect-api/raw/refs/heads/main/video-exemplo/video.mp4\",\n    \"type\": \"video\",\n    \"caption\": \"Vídeo enviado via API! 🎥\"\n  }'\n```\n\n* **Áudio (PTT opcional)**\n\n```bash\ncurl -X POST http://127.0.0.1:9009/api/{sessionId}/messages/media \\\n  -H \"Content-Type: application/json\" \\\n  -H \"x-api-key: 123456789\" \\\n  -d '{\n    \"to\": \"5511999999999\",\n    \"mediaUrl\": \"https://www.soundhelix.com/examples/mp3/SoundHelix-Song-1.mp3\",\n    \"type\": \"audio\",\n    \"ptt\": false\n  }'\n```\n\n* **Botões Interativos**\n\n```bash\ncurl -X POST http://127.0.0.1:9009/api/{sessionId}/messages/buttons \\\n  -H \"Content-Type: application/json\" \\\n  -H \"x-api-key: 123456789\" \\\n  -d '{\n    \"to\": \"5511999999999\",\n    \"text\": \"🔘 TESTE DE BOTÕES INTERATIVOS\",\n    \"buttons\": [\n      {\"id\": \"teste1\", \"text\": \"✅ Teste 1\"},\n      {\"id\": \"teste2\", \"text\": \"🔄 Teste 2\"},\n      {\"id\": \"teste3\", \"text\": \"📊 Teste 3\"}\n    ],\n    \"footer\": \"API Big Conect - Botões Funcionando!\"\n  }'\n```\n\n* **Botões com Imagem**\n\n```bash\ncurl -X POST http://127.0.0.1:9009/api/{sessionId}/messages/buttons \\\n  -H \"Content-Type: application/json\" \\\n  -H \"x-api-key: 123456789\" \\\n  -d '{\n    \"to\": \"5511999999999\",\n    \"text\": \"💎 TESTE BOTÕES COM IMAGEM\",\n    \"buttons\": [\n      {\"id\": \"planos\", \"text\": \"💰 Ver Planos\"},\n      {\"id\": \"demo\", \"text\": \"🎬 Agendar Demo\"},\n      {\"id\": \"contratar\", \"text\": \"📝 Contratar\"}\n    ],\n    \"image\": {\"url\": \"https://raw.githubusercontent.com/systemhelpcod/big-conect-api/main/Imagem-exemplos/logoapi.jpeg\"},\n    \"footer\": \"Big Conect - API Profissional\"\n  }'\n```\n\n* **Lista Interativa**\n\n```bash\ncurl -X POST http://127.0.0.1:9009/api/{sessionId}/messages/list \\\n  -H \"Content-Type: application/json\" \\\n  -H \"x-api-key: 123456789\" \\\n  -d '{\n    \"to\": \"5511999999999\",\n    \"text\": \"📋 TESTE DE LISTA INTERATIVA\",\n    \"buttonText\": \"Abrir Opções\",\n    \"title\": \"Menu de Testes\",\n    \"sections\": [\n      {\n        \"title\": \"🧪 Testes Básicos\",\n        \"rows\": [\n          {\"title\": \"Teste de Texto\", \"description\": \"Envio de mensagem simples\", \"rowId\": \"teste_texto\"},\n          {\"title\": \"Teste de Mídia\", \"description\": \"Envio de imagem e vídeo\", \"rowId\": \"teste_midia\"}\n        ]\n      },\n      {\n        \"title\": \"⚡ Testes Avançados\",\n        \"rows\": [\n          {\"title\": \"Teste de Áudio\", \"description\": \"Envio de mensagem de voz\", \"rowId\": \"teste_audio\"},\n          {\"title\": \"Teste de Documento\", \"description\": \"Envio de arquivos PDF\", \"rowId\": \"teste_documento\"}\n        ]\n      }\n    ]\n  }'\n```\n\n* **Mensagens em Lote**\n\n```bash\ncurl -X POST http://127.0.0.1:9009/api/{sessionId}/messages/bulk \\\n  -H \"Content-Type: application/json\" \\\n  -H \"x-api-key: 123456789\" \\\n  -d '{\n    \"messages\": [\n      {\"to\": \"556292231423\", \"text\": \"📨 Mensagem 1 do lote de teste\"},\n      {\"to\": \"556292231423\", \"text\": \"📨 Mensagem 2 do lote de teste\"},\n      {\"to\": \"556292231423\", \"text\": \"📨 Mensagem 3 do lote de teste\"}\n    ],\n    \"delayBetweenMessages\": 1000\n  }'\n```\n\n---\n\n## 🛠 **CONFIGURAÇÃO E MONITORAMENTO**\n\n* **Health Check**\n\n```bash\ncurl -X GET http://127.0.0.1:9009/health \\\n  -H \"x-api-key: 123456789\"\n```\n\n* **Informações da API**\n\n```bash\ncurl -X GET http://127.0.0.1:9009/ \\\n  -H \"x-api-key: 123456789\"\n```\n\n---\n\n## ✅ **NOTAS IMPORTANTES**\n\n1. `x-api-key` obrigatório em todos os endpoints\n2. `.env` atualizado com `SECRET_APIKEY`\n3. Use sempre `IPV4=0.0.0.0` para conexões externas\n4. Sessões retornam `user.id` e `user.name`\n5. Mensagens multimídia, botões, listas e reações seguem padrão do header `x-api-key`\n\n---\n\n\u003cdiv align=\"center\"\u003e\n\n**🚀 API Big Conect - Desenvolvido com ❤️ por System Help**\n\n*Solução profissional para automação WhatsApp Business*\n\n[![GitHub](https://img.shields.io/badge/GitHub-Repository-black)](https://github.com/systemhelpcod/big-conect-api)\n[![PIX](https://img.shields.io/badge/Doação-PIX-green)](https://nubank.com.br/pagar)\n\n\u003c/div\u003e\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsystemhelpcod%2Fbig-conect-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsystemhelpcod%2Fbig-conect-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsystemhelpcod%2Fbig-conect-api/lists"}