WaPilot TypeScript Client (Comprehensive)

A type-safe, developer-friendly TypeScript library for the WaPilot API v2.

Installation

npm i wapilot-api-client

Quick Start

import { WaPilot } from 'wapilot-api-client';

// Initialize the client
export const wapilot = new WaPilot({
    token: "API_TOKEN",
    defaultCountryCode: '20' // Optional: defaults to '20' (Egypt)
});

Features

• Automatic Phone Formatting: Automatically prepends country codes and appends @c.us to phone numbers.
• Full API Coverage: Includes all endpoints for Instances, Messaging, Campaigns, and Lookups.
• Type Safety: Full TypeScript interfaces for all request parameters and response bodies.
• Next.js Compatible: Works in both client and server environments.
• Simplified API: Grouped endpoints for better developer experience.

API Reference

Instances (wapilot.instances)

• list()
• details(instanceId)
• checkStatus(instanceId)
• start(instanceId)
• restart(instanceId)
• logout(instanceId)
• troubleshoot(instanceId)
• getQrCode(instanceId)
• getScreenshot(instanceId)
• getQueueSettings(instanceId)
• updateQueueSettings(instanceId, settings)

Messaging (wapilot.messages)

• sendText(instanceId, params)
• sendImage(instanceId, params)
• sendFile(instanceId, params)
• sendVideo(instanceId, params)
• sendList(instanceId, params)
• retryAll(instanceId, params)
• retry(instanceId, messageId)
• list(instanceId, page)
• details(instanceId, messageId)

Campaigns (wapilot.campaigns)

• list()
• create(params)
• updateDelay(campaignId, settings)
• showDelay(campaignId)
• finish(campaignId)
• copy(campaignId)
• listMessages(campaignId)
• stats(campaignId)
• getQueue(campaignId)
• getDone(campaignId)
• bulkAdd(campaignId, messages)
• bulkDelete(campaignId)
• start(campaignId)
• schedule(campaignId, sendAt)
• unschedule(campaignId)
• pause(campaignId)
• resetFailed(campaignId)

Lookup (wapilot.lookup)

• getChatIdByLid(lid)
• getLidByPhone(phoneOrId)

License

MIT