API Documentation

Generate and return a QR code for a specific account to link a phone.

{
    "accountId": "YOUR_INSTANCE_UUID"
}

{
    "data": {
        "responseCode": "00",
        "QRCode": "data:image\/png;base64,...",
        "Timeout": 60
    }
}

Retrieve all your registered WhatsApp instances and their current connection status.

{
    "data": {
        "responseCode": "00",
        "accounts": [
            {
                "accountId": "uuid",
                "accountName": "CS 1",
                "whatsapp_number": "628xxx",
                "status": "active",
                "whatsapp_status": "connected"
            }
        ]
    }
}

Check real-time connection status of a specific device from the WhatsApp backend.

{
    "data": {
        "responseCode": "00",
        "isConnected": true,
        "whatsapp_status": "connected"
    }
}

Force a logout and disconnect a specific WhatsApp instance.

{
    "accountId": "YOUR_INSTANCE_UUID"
}

{
    "data": {
        "responseCode": "00",
        "message": "Device disconnected successfully"
    }
}

Send any type of message (text, image, doc, etc) to a single recipient. Available for all plans.

{
    "accountId": "uuid",
    "to": "628xxx",
    "messageType": "text",
    "content": "Hello!"
}

{
    "data": {
        "responseCode": "00",
        "message": "success",
        "messageId": "msg-123",
        "status": "sent"
    }
}

Send a message to multiple recipients at once. Exclusive to the Business plan.

{
    "accountId": "uuid",
    "to": [
        "628xxx",
        "628yyy"
    ],
    "messageType": "text",
    "content": "Hello fans!"
}

{
    "data": {
        "responseCode": "00",
        "message": "Broadcast queued for 2 recipients"
    }
}

Send a high-speed text message to a single recipient.

{
    "accountId": "uuid",
    "to": "628xxx",
    "text": "Hello world!"
}

{
    "data": {
        "responseCode": "00",
        "messageId": "msg-123",
        "status": "sent"
    }
}

Send an image via URL to a single recipient.

{
    "accountId": "uuid",
    "to": "628xxx",
    "url": "https:\/\/domain.com\/photo.jpg",
    "caption": "Photo description"
}

{
    "data": {
        "responseCode": "00",
        "messageId": "msg-124",
        "status": "sent"
    }
}

Send documents (PDF, Docx, xlsx, etc) to a single recipient.

{
    "accountId": "uuid",
    "to": "628xxx",
    "url": "https:\/\/domain.com\/file.pdf",
    "fileName": "invoice.pdf",
    "mimetype": "application\/pdf"
}

{
    "data": {
        "responseCode": "00",
        "messageId": "msg-125",
        "status": "sent"
    }
}

Fetch all groups where the authenticated instance is a participant.

{
    "data": {
        "responseCode": "00",
        "groups": [
            {
                "GroupId": "123@g.us",
                "Name": "IT Team"
            }
        ]
    }
}

Broadcast a message to an entire WhatsApp group.

{
    "accountId": "uuid",
    "groupId": "123@g.us",
    "text": "Team Meeting at 10 AM"
}

{
    "data": {
        "responseCode": "00",
        "messageId": "msg-grp-1",
        "status": "sent"
    }
}

Send media files (image, video, or document) to a WhatsApp group. Requires the send_group_media feature in your plan. Supports IMAGE, VIDEO, and DOCUMENT types with optional captions.

{
    "accountId": "YOUR_INSTANCE_UUID",
    "groupId": "120363xxxx@g.us",
    "messageType": "IMAGE",
    "url": "https:\/\/domain.com\/promo-banner.jpg",
    "caption": "New promo this week!"
}

{
    "data": {
        "responseCode": "00",
        "message": "success",
        "messageId": "msg-grp-media-1",
        "status": "sent"
    }
}

Schedule a WhatsApp message for future delivery. Supports Text, Image, and Document types.

{
    "accountId": "string (Required)",
    "to": "string (Required, e.g. 628123456789)",
    "messageType": "TEXT | IMAGE | DOCUMENT",
    "content": "string (Message text or caption)",
    "scheduled_at": "YYYY-MM-DD HH:mm:ss (WIB)",
    "url_file": "string (Required for IMAGE\/DOCUMENT)"
}

{
    "data": {
        "responseCode": "00",
        "message": "Message scheduled successfully",
        "scheduleId": 123,
        "scheduled_at": "2026-03-30T15:00:00+07:00"
    }
}

Retrieve a list of your pending scheduled messages.

{
    "data": [
        {
            "id": 123,
            "to": "628123456789",
            "type": "TEXT",
            "scheduled_at": "2026-03-30T15:00:00+07:00",
            "status": "pending"
        }
    ]
}

Schedule a media message (image, video, document) for future delivery. Include the url field for the media source and specify the messageType accordingly. The fileName and mimetype fields are optional but recommended for DOCUMENT types.

{
    "accountId": "YOUR_INSTANCE_UUID",
    "to": "6281234567890",
    "messageType": "DOCUMENT",
    "content": "Monthly invoice attached",
    "url": "https:\/\/domain.com\/invoice-march.pdf",
    "fileName": "invoice-march.pdf",
    "mimetype": "application\/pdf",
    "scheduled_at": "2026-04-01T08:00:00+07:00"
}

{
    "data": {
        "responseCode": "00",
        "message": "Message scheduled successfully",
        "scheduleId": 43,
        "scheduled_at": "2026-04-01T01:00:00.000000Z"
    }
}

Retrieve all scheduled messages for the authenticated user. Returns pending, sent, and failed messages sorted by scheduled delivery time. Use this endpoint to monitor the status of your scheduled campaigns.

{
    "data": {
        "responseCode": "00",
        "scheduled_messages": [
            {
                "id": 42,
                "to": "6281234567890@s.whatsapp.net",
                "type": "TEXT",
                "payload": {
                    "message": "Hello! Scheduled reminder."
                },
                "scheduled_at": "2026-04-01T02:00:00.000000Z",
                "status": "pending",
                "error_message": null,
                "created_at": "2026-03-28T16:00:00.000000Z"
            }
        ]
    }
}

Cancel a pending scheduled message before it is sent. Only messages with status "pending" can be cancelled. Once a message has been sent or has failed, it cannot be deleted via this endpoint. Replace {id} with the scheduleId returned from the schedule endpoint.

{
    "data": {
        "responseCode": "00",
        "message": "Scheduled message cancelled successfully"
    }
}

When a message is received on your WhatsApp account, the system automatically forwards it to the webhook URL configured on your instance. The payload is signed using HMAC-SHA256 with your webhook secret. Verify the signature via the X-Zuwinda-Signature header to ensure authenticity.

{
    "data": {
        "event": "messaging.whatsapp.message.incoming",
        "accountId": "YOUR_INSTANCE_UUID",
        "whatsapp_number": "628123xxxx",
        "from": "6289876xxxx",
        "messageType": "conversation",
        "text": {
            "body": "Hello, I need help!"
        },
        "timestamp": "2026-03-28T16:00:00.000000Z"
    }
}

Advanced Webhook — Receive real-time status updates for messages you've sent. The system tracks delivery lifecycle events: "sent" (server received), "delivered" (recipient device received), "read" (recipient opened), and "played" (for audio/video messages). Requires the advance_webhook feature in your plan. Payload is HMAC-SHA256 signed.

{
    "data": {
        "event": "messaging.whatsapp.message.update",
        "accountId": "YOUR_INSTANCE_UUID",
        "messageId": "BAE5xxxx",
        "remoteJid": "6281234567890@s.whatsapp.net",
        "status": "read",
        "timestamp": "2026-03-28T16:05:00.000000Z"
    }
}

Receive instant alerts when your WhatsApp device goes offline unexpectedly. The payload includes the disconnect reason code and whether the system will attempt automatic reconnection. Requires the downtime_notification feature in your plan. Use this to build monitoring dashboards or trigger fallback messaging flows.

{
    "data": {
        "event": "device.disconnected",
        "accountId": "YOUR_INSTANCE_UUID",
        "whatsapp_number": "628123xxxx",
        "reason": 515,
        "shouldReconnect": true,
        "timestamp": "2026-03-28T16:10:00.000000Z"
    }
}