Authorization: Bearer YOUR_API_TOKEN

?token=YOUR_API_TOKEN

{
  success: boolean;
  qrCode?: string;         // QR code data (if method is qrCode)
  pairingCode?: string;    // Pairing code (if method is pairingCode)
  status?: string;         // Connection status
  error?: string;          // Error message if failed
}

const result = await client.connect({
  method: "qrCode",
  forceNew: true,
});

curl -X POST "https://whatify.dev/api/whatsapp/v1/connect?method=qrCode" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

{
  success: boolean;
  message?: string;
  error?: string;
}

const result = await client.disconnect();

curl -X POST "https://whatify.dev/api/whatsapp/v1/disconnect" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

{
  success: boolean;
  status?: string;          // connected, disconnected, connecting
  phone?: string;           // WhatsApp phone number
  name?: string;            // WhatsApp account name
  profilePic?: string;      // Profile picture URL
  error?: string;
}

const status = await client.status();
console.log(status.status); // "connected"

curl -X GET "https://whatify.dev/api/whatsapp/v1/status" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

{
  to: string | string[];           // Recipient phone number(s)
  text?: string;                   // Message text (optional if attachment provided)
  attachment?: {                   // Optional attachment
    type: 'image' | 'video' | 'audio' | 'document' | 'sticker';
    url?: string;                  // URL to attachment
    base64?: string;               // Base64 encoded attachment data
    filename?: string;             // Filename for the attachment
    caption?: string;              // Caption for media
    mimeType?: string;             // MIME type
  };
  existingMessageId?: string;      // Message ID to reply to
}

{
  success: boolean;
  messageId?: string;
  error?: string;
  details?: any;
}

await client.send({
  to: "1234567890",
  text: "Hello, World!",
});

curl -X POST "https://whatify.dev/api/whatsapp/v1/send" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "1234567890",
    "text": "Hello, World!"
  }'

await client.send({
  to: "1234567890",
  text: "Check this out!",
  attachment: {
    type: "image",
    url: "https://example.com/image.jpg",
    caption: "Beautiful sunset",
  },
});

curl -X POST "https://whatify.dev/api/whatsapp/v1/send" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "1234567890",
    "text": "Check this out!",
    "attachment": {
      "type": "image",
      "url": "https://example.com/image.jpg",
      "caption": "Beautiful sunset"
    }
  }'

await client.send({
  to: "1234567890",
  attachment: {
    type: "document",
    base64: "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC...",
    filename: "report.pdf",
    mimeType: "application/pdf",
    caption: "Monthly Report",
  },
});

await client.send({
  to: ["1234567890", "0987654321", "1111111111"],
  text: "Bulk message to multiple recipients",
});

{
  phone: string;                    // Recipient phone number with country code
  code: string | number;            // OTP code (4-8 digits)
  language?: "Arabic" | "English";  // Message language (default: "English")
}

{
  success: boolean;
  message?: string;
  data?: {
    messageId: string;
    whatsappMessageId: string;
    phone: string;
    code: string;
    language: string;
    sentAt: string;
  };
  error?: string;
}

await client.sendOTP({
  phone: "1234567890",
  code: "123456",
  language: "English",
});

curl -X POST "https://whatify.dev/api/whatsapp/v1/otp" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "1234567890",
    "code": "123456",
    "language": "English"
  }'

await client.sendOTP({
  phone: "1234567890",
  code: "654321",
  language: "Arabic",
});

{
  success: false,
  error: string,        // Error message
  details?: any         // Additional error details (for validation errors)
}

{
  "success": false,
  "error": "Invalid API token"
}

{
  "success": false,
  "error": "Invalid request data",
  "details": [
    {
      "path": ["text"],
      "message": "Either text or attachment must be provided"
    }
  ]
}

{
  "success": false,
  "error": "Rate limit exceeded",
  "resetIn": 45
}

X-RateLimit-Limit: 30
X-RateLimit-Remaining: 25
X-RateLimit-Reset: 1234567890

const result = await client.send({ to: "123", text: "Hi" });

if (!result.success && result.error === "Rate limit exceeded") {
  // Wait and retry
  await new Promise((resolve) => setTimeout(resolve, result.resetIn * 1000));
  // Retry the request
}

import {
  Whatify,
  ConnectResponse,
  StatusResponse,
  SendMessageResponse,
} from "whatify";

const client = new Whatify({ apiToken: "token" });

const status: StatusResponse = await client.status();