Dashboard
Live sending status across all your WhatsApp accounts.
Campaigns
| Campaign | Progress | Sent | Failed |
|---|
Send message
One number or your whole contact list โ sent through the safe queue.
Posted through a WhatsApp Web account. The Cloud API can't post into groups.
Tip: {Hi|Hello|Dear} picks one option per message, so bulk messages aren't all identical.
Cloud API template (only for official API accounts)
To start a conversation the Cloud API requires a Meta-approved template. Leave empty to use the account's default template.
An attachment fills the template's image / video / document header.
Contacts
Import, group, verify and manage who receives your messages.
๐ Import from Excel / CSV
First sheet is read. Headers like Phone / Mobile / Number and Name are detected; otherwise column A = number, B = name.
๐ Paste numbers
Inbox
Incoming replies and what the chatbot answered.
Chatbot & auto-reply
Keyword replies and menu flows. STOP / START opt-out is always handled automatically.
Flow
Add reply
Top level: matches anywhere in a chat. Under a parent: only right after that reply (menu options like 1, 2). Words of 3+ letters also match inside a sentence. * = anything.
Fallback reply and on/off switch are in Settings.
WhatsApp accounts
Messages rotate across enabled accounts; each stops for the day at its own cap.
| Account | Method | Status | Sent today |
|---|
Link WhatsApp โ
- On the phone with this number, open WhatsApp.
- Tap โฎ Menu (Android) or Settings (iPhone) โ Linked devices โ Link a device.
- Point the phone at this QR code.
Users & roles
Who can sign in and what they can do.
| Username | Role | Status | Created |
|---|
What each role can do
| Permission | Agent | Manager | Admin |
|---|---|---|---|
| Dashboard, contacts import, send / schedule messages, inbox | โ | โ | โ |
| Start / pause sending, delete contacts | โ | โ | |
| WhatsApp accounts & QR login, chatbot | โ | โ | |
| Users & roles, settings | โ |
My profile & security
Password and 2-step verification for your sign-in.
๐ Change password
๐ฑ 2-step verification
After your password, sign-in also asks for a 6-digit code from an authenticator app (Google Authenticator, Microsoft Authenticator, Authy).
1. Scan this QR code in your authenticator app:
Can't scan? Enter this key:
โ On Your sign-in is protected with an authenticator code.
Settings
Pacing, sending hours, chatbot and API configuration.
Sending & safety
Delays and rest breaks apply to WhatsApp Web accounts; Cloud API accounts send about one per second. Daily caps are per account.
๐ Sign-in security
Always on: passwords need 10+ characters with letters and numbers, 5 wrong attempts lock a user for 15 minutes, and sign-in is rate-limited per IP address.
Chatbot & auto-reply
Cloud API webhook (incoming messages)
Meta app dashboard โ WhatsApp โ Configuration: Callback URL https://<your-public-address>/webhook, the verify token below, subscribe to messages.
๐ Activity log
โฌ Today's log fileSign-ins, sent messages and emails, connection problems and errors. Saved daily in logs\notifydesk-YYYYMMDD.log on the server (kept 30 days).
Loadingโฆ
๐ API keys โ send from other applications
Give each application (CMS, HRMS, ATSโฆ) its own key so you can revoke it separately. See Guide โ API for examples.
| Name | Key | Created | Last used | Status |
|---|
Guide & manual
Everything you need to set up and run NotifyDesk.
๐ Quick start (5 steps)
- Add a WhatsApp account โ WhatsApp accounts โ Add account. Pick WhatsApp Web to use your existing number, or Cloud API for Meta's official API.
- Log in โ for WhatsApp Web click Connect (QR); the QR code appears right here in the portal (from any computer, no server access needed). On your phone: WhatsApp โ Linked devices โ Link a device, scan it. The WhatsApp Web window runs on the server; leave it open there.
- Add contacts โ Contacts: drop an Excel/CSV file (columns Name and Mobile) or paste numbers, and type a group name (e.g. "Batch Nov") to put them in a contact group. Invalid numbers are filtered and duplicates skipped. Optionally click Verify on WhatsApp.
- Write your message โ Send message: choose All contacts, Contact group, WhatsApp group or Single number, write the text (use
{name}and{Hi|Hello}), add an image/PDF if needed, optionally schedule it. - Start sending โ on the Dashboard press โถ Start sending. Watch the live log; use Retry failed on a campaign if needed. Press Pause any time.
After NotifyDesk restarts, linked WhatsApp Web accounts reconnect by themselves within a minute (no new QR scan while the phone stays linked). If one shows "not started", click Connect.
๐ก๏ธ Avoiding blocks โ read this first
No software can guarantee a number won't be blocked. WhatsApp mostly blocks numbers when recipients report or block you. What helps most:
- Only message people who expect it โ candidates who applied, employees, registered users. Never bought or scraped lists.
- Warm up new numbers: about 20 messages/day in week 1, 40 in week 2, then up to 80. Set the account's daily cap accordingly.
- Keep the safe defaults (Settings โ Sending & safety): 30โ90 s random gap, a 15-minute rest after every 20 messages, sending only 9:00โ20:00, at most 50 "Verify on WhatsApp" checks per day. At these settings 80 messages take about 2 hours โ that is intended.
- Vary the text:
{Hi|Hello|Dear} {name}makes every message slightly different. Add something personal (case number, interview date). - Invite replies ("Reply 1 to confirm"): conversations with replies look normal; one-way blasts to people who never answer look like spam.
- Use a separate business number, not your personal one, and keep the phone switched on and online.
- Personalise with
{name}and keep messages relevant; avoid link-only messages. - Always offer opt-out: "Reply STOP to unsubscribe". STOP replies are opted out automatically.
- Ask contacts to save your number โ messages from saved numbers are rarely reported.
- For high volume use the official Cloud API: it's built for business messaging and has no ban risk when used within Meta's policies.
๐ค Sending: bulk, single, media, scheduling
- All contacts queues every contact that hasn't opted out. Contact group sends only to contacts in that group. Choose contacts lets you tick contacts one by one (search and filter by group); or on Contacts tick them and click Send message to selected. Every contact always gets their own individual message. Single number sends to one person (added to Contacts automatically).
- WhatsApp group posts one message into a WhatsApp group chat your number belongs to. Type the group name exactly as it appears in WhatsApp. Works only with WhatsApp Web accounts.
- Personalise:
{name}becomes the contact's name;{Hi|Hello|Dear}picks one option per message. Use the preview under the message box. - Attachments: JPG/PNG/WEBP/GIF images, MP4 video, PDF documents (max 16 MB). The message becomes the caption.
- Schedule: pick a date/time; the campaign waits until then (and until sending is started and inside send hours).
- Rotation: with several accounts, messages are spread across them; each stops at its own daily cap and resumes the next day.
- Status: ๐ queued ยท โโ sent ยท โ failed (reason shown) ยท skipped (opted out / cancelled).
- Report: each campaign has a CSV report (number, name, status, time, error).
๐ค Contacts, groups & number verification
- Import: Excel (.xlsx) or CSV with a Name and a Mobile/Phone column. Numbers without a country code get the default code from Settings (91).
- Select contacts with the tick boxes (the top box selects everything shown) to send to them, verify them on WhatsApp or add them to a group.
- Contact groups: type a group name when importing, or click a contact's groups to edit them. A contact can be in several groups. Filter the list by group.
- Verify on WhatsApp opens each number's chat silently through a connected WhatsApp Web account to see whether it is registered (nothing is sent). Results: on WhatsApp, not on WhatsApp, check failed. Checks run 20โ45 s apart and stop at the daily limit (Settings).
- Remove invalid deletes contacts marked "not on WhatsApp". Export CSV downloads the list.
- Opt-out: contacts who reply STOP are marked opted out and skipped by every campaign; START subscribes them again. On WhatsApp Web accounts this needs Auto-reply turned on for the account (replies are only read then).
๐ Sign-in security
- Passwords need at least 10 characters with letters and numbers. 5 wrong attempts lock the user for 15 minutes (an Admin can Unlock in Users).
- 2-step verification: profile icon โ Profile โ scan the QR code with Google/Microsoft Authenticator and enter the 6-digit code. Admins can require it for everyone (Settings โ Sign-in security) and reset it for a user who lost their phone.
- Click the ๐ icon in any password box to show what you typed.
โ๏ธ Official WhatsApp Cloud API setup
- Create a Meta Business account and an app at developers.facebook.com โ add the WhatsApp product.
- Add and verify your business phone number (it can't be used in the normal WhatsApp app at the same time).
- Create a System User access token with
whatsapp_business_messagingpermission, copy the Phone number ID. - In NotifyDesk: WhatsApp accounts โ Add account โ Cloud API, paste token and phone number ID.
- Create message templates in WhatsApp Manager (e.g.
interview_invitewith body "Hi {{1}}, your interview for {{2}} is on {{3}}"). After approval, enter its name and variables on the Send screen:{name} | Accounts Assistant | 18 Nov 11 AM. - For replies/chatbot: expose NotifyDesk on a public HTTPS address (e.g. a reverse proxy or tunnel) and set the webhook in Settings.
Free-form text and media without a template are only delivered within 24 hours after the contact last messaged you.
๐ค Chatbot & auto-reply
- Top-level replies answer keywords anywhere, e.g.
hi, hello, menuโ a welcome menu. - Menu options are replies placed under a parent; they only match right after that parent's message, e.g.
1โ current openings. - Use Load recruitment bot sample to get a ready HR flow you can edit.
- Fallback reply (Settings) is sent when nothing matches, at most once per 24h per contact.
- Turn on Auto-reply on the WhatsApp account (WhatsApp accounts โ Edit) and keep Chatbot on in Settings.
- WhatsApp Web accounts are checked for unread chats every ~15 seconds while connected; Cloud API replies arrive instantly via webhook.
- Important: if someone opens the chat on the business phone first, WhatsApp marks it read and the bot will not answer it. Let NotifyDesk handle incoming chats, or answer them yourself.
- The bot answers one-to-one chats only, never WhatsApp groups.
- Every incoming message and bot answer is visible in the Inbox.
๐ฅ Users & roles
- Agent: contacts, send/schedule messages, dashboard, inbox.
- Manager: + start/pause sending, WhatsApp accounts, chatbot, delete contacts.
- Admin: + users and settings. The first account created on first run is the Admin.
๐งฉ Recruitment & HR use cases
- Job openings and walk-in drives to candidate databases (Excel export from your ATS / job portal).
- Interview invitations and reminders โ schedule the reminder the evening before.
- Document requests and offer/joining messages with a PDF attached.
- Employee notices: holidays, salary credited, shift changes, trainings, birthday wishes.
- Candidate FAQ bot: openings, how to apply, interview status, talk to HR.
๐ API integration manual โ send from your CMS, HRMS or any application
Your application calls NotifyDesk over HTTPS with an API key; NotifyDesk queues the message and sends it from the chosen WhatsApp account with the same pacing, send hours and opt-outs as everything else. API messages go before queued bulk campaigns.
1. One-time setup (Admin)
- Settings โ API keys: name the key after the application (e.g. Claims CMS), set Send from account to Only Account 1, and enter the CMS server's IP address under Allowed server IPs. Click Create key and copy it. It is shown only once.
- Store the key in the CMS's server configuration (environment variable or config file), never in browser JavaScript or a mobile app.
- Make sure the CMS server can reach NotifyDesk. Base URL here:
. For another server use the address from the Deployment section, behind HTTPS. - Click โถ Start sending on the Dashboard. API messages wait in the queue while sending is paused or outside send hours.
2. Authentication
Send the key on every request as X-Api-Key: ndk_โฆ (or Authorization: Bearer ndk_โฆ). Keys are stored only as a hash,
can be disabled or revoked any time, can be locked to one account and to fixed IP addresses, and only see messages they created themselves.
3. Example: notify on case registration
When a case is registered, the CMS sends the insured person a WhatsApp from Account 1:
POST /v1/messages
X-Api-Key: ndk_xxxxxxxxxxxxxxxx
Content-Type: application/json
{
"account": 1, // id or name ("Account 1"); optional if the key is locked to an account
"to": "9876543210", // or ["98...", "97..."], max 1000; 10-digit numbers get the default country code
"name": "Ravi Kumar",
"text": "Dear {name}, your claim case CLM-2026-0457 is registered. Surveyor: A. Sharma (98111 22233). We will update you here.",
"reference": "CMS case CLM-2026-0457" // shown on the Dashboard and in reports
}
Response 200:
{ "campaignId": 42,
"messages": [ { "to": "919876543210", "status": "queued", "id": 1201 } ] }
Save id (1201) against the case. Invalid or opted-out numbers come back as "status": "rejected" with an error.
PHP (in the case-registration handler):
$payload = [
'account' => 1,
'to' => $case['mobile'],
'name' => $case['insured_name'],
'text' => "Dear {name}, your claim case {$case['no']} is registered.",
'reference' => "CMS case {$case['no']}",
];
$ch = curl_init(getenv('NOTIFYDESK_URL') . '/v1/messages');
curl_setopt_array($ch, [
CURLOPT_POST => true, CURLOPT_RETURNTRANSFER => true, CURLOPT_TIMEOUT => 10,
CURLOPT_HTTPHEADER => ['Content-Type: application/json', 'X-Api-Key: ' . getenv('NOTIFYDESK_KEY')],
CURLOPT_POSTFIELDS => json_encode($payload),
]);
$res = json_decode(curl_exec($ch), true);
$code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($code === 200) { $msgId = $res['messages'][0]['id'] ?? null; /* save with the case */ }
else { error_log('NotifyDesk: ' . ($res['error'] ?? $code)); } // never block case registration on this
C# / .NET:
var http = new HttpClient { BaseAddress = new Uri(config["NotifyDesk:Url"]), Timeout = TimeSpan.FromSeconds(10) };
http.DefaultRequestHeaders.Add("X-Api-Key", config["NotifyDesk:Key"]);
var res = await http.PostAsJsonAsync("/v1/messages", new {
account = 1, to = c.Mobile, name = c.InsuredName,
text = $"Dear {{name}}, your claim case {c.CaseNo} is registered.",
reference = $"CMS case {c.CaseNo}" });
if (!res.IsSuccessStatusCode) logger.LogWarning("NotifyDesk: {body}", await res.Content.ReadAsStringAsync());
Node.js:
const r = await fetch(process.env.NOTIFYDESK_URL + '/v1/messages', {
method: 'POST',
headers: { 'Content-Type': 'application/json', 'X-Api-Key': process.env.NOTIFYDESK_KEY },
body: JSON.stringify({ account: 1, to: c.mobile, name: c.insuredName,
text: `Dear {name}, your claim case ${c.caseNo} is registered.`, reference: `CMS case ${c.caseNo}` }),
});
const data = await r.json(); // data.messages[0].id
curl โ ready-to-run examples
Replace ndk_xxx with your API key (Settings โ API keys) and the number / email with a real one. The examples use
.
Linux / macOS / Git Bash โ send one WhatsApp message:
curl -X POST /v1/messages \
-H "X-Api-Key: ndk_xxx" -H "Content-Type: application/json" \
-d '{"account":1,"to":"9876543210","name":"Ravi Kumar","text":"Dear {name}, your claim case CLM-2026-0457 is registered.","reference":"CMS case CLM-2026-0457"}'
Same message to several numbers (each gets an individual message):
curl -X POST /v1/messages \
-H "X-Api-Key: ndk_xxx" -H "Content-Type: application/json" \
-d '{"account":1,"to":["9876543210","9123456789"],"text":"Office closed on Monday for Diwali."}'
Check the status of message 1201 (the id from the reply):
curl /v1/messages/1201 -H "X-Api-Key: ndk_xxx"
Send an email:
curl -X POST /v1/emails \
-H "X-Api-Key: ndk_xxx" -H "Content-Type: application/json" \
-d '{"to":"ravi@example.com","name":"Ravi","subject":"Your claim CLM-2026-0457","text":"Dear {name}, your claim is registered.","reference":"CMS case CLM-2026-0457"}'
Health check (is sending paused, how many queued):
curl /v1/status -H "X-Api-Key: ndk_xxx"
Windows Command Prompt (cmd needs double quotes, with \" inside):
curl -X POST /v1/messages -H "X-Api-Key: ndk_xxx" -H "Content-Type: application/json" -d "{\"account\":1,\"to\":\"9876543210\",\"text\":\"Test from CMS\"}"
Windows PowerShell:
Invoke-RestMethod -Method Post -Uri "/v1/messages" -Headers @{ "X-Api-Key" = "ndk_xxx" } `
-ContentType "application/json" -Body '{"account":1,"to":"9876543210","text":"Test from CMS"}'
A successful call returns {"campaignId":42,"messages":[{"to":"919876543210","status":"queued","id":1201}]}.
Messages are sent when sending is started on the Dashboard, inside send hours, with the normal pacing.
4. All endpoints
| Method & path | Purpose |
|---|---|
POST /v1/messages | Queue WhatsApp message(s). Fields: to*, text*, account, name, reference; Cloud API accounts may add template, templateLang, templateParams [array]. |
GET /v1/messages/{id} | Status: queued, sent, failed (with error) or skipped (opted out / cancelled). |
GET /v1/accounts | Accounts this key may use: id, name, type, connection status. |
GET /v1/status | Health check: whether sending is paused, how many are queued. |
POST /v1/emails | Queue email(s): to*, subject*, text or html*, name, reference. |
GET /v1/emails/{id} | Email status. |
Errors: 401 missing/invalid key ยท 403 key disabled for this IP or account ยท 400 invalid request (JSON {"error": "โฆ"}).
Text: {name} is replaced; {Hi|Hello} picks one option.
5. Good practice
- Call NotifyDesk after the case is saved, with a 10-second timeout; if it fails, log it and carry on (or retry later).
- Only message people who gave their number for this purpose; NotifyDesk honours STOP replies automatically.
- One key per application; revoke it in Settings if it leaks.
๐ Deployment
- Copy the
publishfolder to the PC/server that will run NotifyDesk (Windows 10/11 or Server with Microsoft Edge). No .NET install needed. - Double-click
start.cmd. Openhttp://localhost:5080and create the admin on first run. - For other computers / the CMS server: edit
appsettings.jsonโ"Urls": "http://0.0.0.0:5080", allow port 5080 in Windows Firewall, and preferably put IIS / nginx / Caddy with an HTTPS certificate in front. - WhatsApp Web accounts open a visible Edge window, so run NotifyDesk in a signed-in Windows session (put a shortcut to
start.cmdin the Startup folder), not as a background service.start.cmdrestarts NotifyDesk by itself if it stops. - Start after a reboot: sign in as the user that runs NotifyDesk, open PowerShell as Administrator in the NotifyDesk folder and run
powershell -ExecutionPolicy Bypass -File .\install-autostart.ps1 -Lock(a scheduled task starts it silently at sign-in, with no console window, and then locks the screen). Its output goes tologs\notifydesk.log; stop it withstop.cmd, start it again withstart-hidden.vbs. Then turn on automatic sign-in for that user with Microsoft Sysinternals Autologon. On RDP, close the window (disconnect) instead of signing out. - Back up
wasender.db,keys\,media\andwa-profile\regularly.
๐ง Troubleshooting
- "Number not on WhatsApp / invalid" โ the number isn't registered; check the country code.
- Stuck at "waiting for QR scan" โ scan within 3 minutes; click Connect again to retry.
- Nothing is sending โ check: sending started, inside send hours, account enabled and below daily cap, campaign not scheduled for later.
- Failed after a WhatsApp update โ WhatsApp changes its web page occasionally. When a send fails, NotifyDesk saves a screenshot and a list of buttons to
logs\fail-*.png/.txt; unanswered incoming messages leavelogs\inbox-*.txt. Send these to your developer to update the app. They show your chats, so keep them private. - Bot not answering โ account Auto-reply on, Chatbot on in Settings, account connected, and the chat must still be unread (see Chatbot).
- WhatsApp group post failed โ the group name must match exactly and your number must be a member allowed to post.
- Cloud API 131047 / re-engagement โ outside the 24h window you must use an approved template.
- Data lives in
wasender.db(SQLite) next to the app; back it up by copying the file. Attachments are inmedia/, WhatsApp Web logins inwa-profile/.
Mack