eduuw SDK — TypeScript

WhatsApp Business API client for eduuw. Core messaging: messages, templates, broadcasts, contacts.

Install

npm add @vertikon/eduuw

Quickstart

import Eduuw from "@vertikon/eduuw";

const eduuw = new Eduuw({
  apiKey: process.env.EDUUE_API_KEY!,   // vtk_live_...
  tenantId: process.env.TENANT_ID,      // your organization UUID
});

// Free-form text (needs an open 24h window)
await eduuw.messages.sendText("5585992009999", "Olá!");

// Start a conversation with an approved template
await eduuw.messages.sendTemplate("5585992009999", "confirmacao_matricula", "pt_BR", { "1": "João", "2": "Enfermagem" });

// Templates
const { templates } = await eduuw.templates.list();
const suggestion = await eduuw.templates.generate("confirmar matrícula do aluno");

// Broadcast (opt-out aware on the server)
await eduuw.broadcasts.create({ templateName: "lembrete", recipients: ["5585...","5511..."], scheduledAt: new Date().toISOString() });

// Contacts
await eduuw.contacts.upsert([{ phone: "5585992009999", name: "João", tags: ["leads"] }]);

Auth

• apiKey — X-API-Key (create in the dashboard → Chaves de API).
• tenantId — X-Tenant-ID (your org id, in Contas). Optional if the key is bound to one tenant.
• baseUrl defaults to https://api.eduue.com.br/ext/v1/whatsapp.

Errors

Methods throw APIError with .status and .message on non-2xx responses.

License

MIT © Vertikon / eduuw

Webchat (canal WEBSITE) — desde 0.2.0

Cliente do plano autenticado do chat de site (https://api.eduuw.com.br/ext/v1/webchat). A credencial é PRÓPRIA (key com scopes webchat:read|manage|reply|analytics), diferente da key da borda WhatsApp — peça a sua ao operador da plataforma.

import { EduuwWebchat } from "@vertikon/eduuw";

const wc = new EduuwWebchat({ apiKey: process.env.WEBCHAT_API_KEY!, tenantId: process.env.EDUUW_TENANT_ID });
const { items } = await wc.listWidgets();
await wc.updateDraft(items[0].id, { greeting: "Olá! Como posso ajudar?" });
await wc.publish(items[0].id);                      // vai ao ar no site
const sim = await wc.simulate(items[0].id, ["Quanto custa?"]); // testa o bot sem persistir

Servidor MCP — eduuw-mcp (agentes de IA)

O pacote traz um servidor MCP stdio (zero dependências) que expõe as funções do SDK como tools — WhatsApp (wa_*) e chat de site (webchat_*). Configure no seu cliente MCP (Claude Code, Claude Desktop, etc.):

{
  "mcpServers": {
    "eduuw": {
      "command": "npx",
      "args": ["-y", "-p", "@vertikon/eduuw", "eduuw-mcp"],
      "env": {
        "EDUUW_API_KEY": "<key da borda WhatsApp>",
        "EDUUW_TENANT_ID": "<uuid do tenant>",
        "WEBCHAT_API_KEY": "<key do webchat (opcional)>"
      }
    }
  }
}

Uma família de credencial ausente só desabilita as tools daquela família. As keys nunca são impressas; ações em massa (ex.: wa_create_broadcast) devem ser confirmadas com o usuário.