Dashboard
Create New Device Token
Token Name
Checking...
Connection Manager
Waiting for generation...
OR PAIR WITH PHONE
Send Message
Contacts
Groups
Contacts
Groups
API Documentation
Authentication
Include your API Key in the header for all protected requests.
Header:
apikey: YOUR_API_KEY
1. Start Session
POST /api/start
Initialize a session for a token. Must be called before generating QR.
{
"token": "my-token",
"reject_call": "Y", // Optional: "Y" to reject calls
"reject_message": "Busy" // Optional: message to send
}
2. Get QR Code
POST /api/qrcode
Get QR code for login. Returns status info if already logged in.
{
"token": "my-token"
}
// Response (if not logged in):
{
"status": true,
"qrcode": "data:image/png;base64,..."
}
// Response (if already logged in):
{
"status": true,
"message": "AUTHENTICATED",
"name": "User Name",
"phone": "628123456789",
...
}
3. Get Status
GET /api/status?token=my-token
Get connection status of a token.
// Response:
{
"status": true/false,
"message": "AUTHENTICATED" or "DISCONNECTED",
"name": "User Name",
"phone": "628123456789",
"pic": "https://...",
"data": { "id": "...", "lid": "", "name": "..." }
}
4. Send Message
POST /api/send
Send a text or media message.
{
"token": "my-token",
"phone": "628123456789",
"message": "Hello World",
"file_url": "https://example.com/image.jpg", // Optional
"file_name": "image.jpg" // Optional
}
5. Get Contacts
GET /api/contacts?token=my-token
Get all saved contacts.
6. Get Groups
GET /api/groups?token=my-token
Get all joined groups.
7. Logout
POST /api/logout?token=my-token
Logout and disconnect session.
8. Reconnect
POST /api/reconnect?token=my-token
Reconnect an existing session.
9. List Devices
GET /api/devices
Get a list of all devices. (Protected)
Query Params:
?page=1
?limit=10
?q=search_term
?workspace=Marketing
10. Delete Device
DELETE /api/device?token=my-token
Delete a device token. (Protected)
11. Update Webhook
POST /api/webhook
Set webhook URL for a token. (Protected)
{
"token": "my-token",
"url": "https://your-webhook.com/endpoint"
}
12. Update Workspace
POST /api/workspace
Assign a workspace to a token. (Protected)
{
"token": "my-token",
"workspace": "Marketing"
}
13. Get Workspaces
GET /api/workspaces
Get list of all workspaces. (Protected)