ws-connect

Biblioteca TypeScript para fazer requisições à API WAPI (WhatsApp API).

Instalação

# com npm
npm install ws-connect

# com pnpm
pnpm install ws-connect

# com yarn
yarn add ws-connect

Uso

import { WAPIClient } from 'ws-connect';

// Criar instância do cliente (base URL padrão: http://localhost:3001/api/wapi)
const client = new WAPIClient();

// Ou com configuração customizada
const client = new WAPIClient({
  baseUrl: 'http://localhost:3001/api/wapi'
});

// Criar uma sessão
const session = await client.createSession('123456778', '+5519971557114');

// Obter informações da sessão
const sessionInfo = await client.getSession(session.id);

// Enviar uma mensagem
const message = await client.sendMessage(
  session.id,
  '+5519971557114',
  'Olá, esta é uma mensagem de teste'
);

API

createSession(userId: string, phoneNumber: string)

Cria uma nova sessão.

Parâmetros:

• userId: ID do usuário
• phoneNumber: Número de telefone com código do país (ex: +5519971557114)

Retorna: Promise<CreateSessionResponse>

getSession(sessionId: string)

Obtém informações da sessão incluindo QR code.

Parâmetros:

• sessionId: ID da sessão

Retorna: Promise<GetSessionResponse>

sendMessage(sessionId: string, to: string, content: string)

Envia uma mensagem.

Parâmetros:

• sessionId: ID da sessão
• to: Número do destinatário com código do país
• content: Conteúdo da mensagem

Retorna: Promise<SendMessageResponse>

Tipos

A biblioteca exporta os seguintes tipos TypeScript:

• CreateSessionResponse
• GetSessionResponse
• SendMessageResponse
• CreateSessionParams
• SendMessageParams
• WAPIClientConfig

Desenvolvimento

# Instalar dependências
pnpm install

# Compilar TypeScript
pnpm run build

Licença

MIT