Documentation

Quickstart for installing the desktop app, activating your license, and sending your first campaign.

Quick Start

  1. Download the desktop app: /download
  2. Open the app and sign in / register.
  3. Activate your license (Trial, Pro Solo, Pro Biz, or Pro Elite).
  4. Send a test campaign via the API or the UI.

Install (Windows)

Download and run the installer from the Download page.

  • Windows 10/11 (x64)
  • .NET Desktop Runtime not required
  • Auto-update enabled (when online)

Activate License

In the desktop app, open Settings → License, paste your license token, and click Activate.

Tokens contain your plan, quota, and device_id. Internet is required on first activation.

Send Campaign (API)

Use the webhook API to send a small batch. Replace values with your license and audience. Example (PowerShell):

$body = @"
{
  "license_token": "<YOUR_LICENSE_TOKEN>",
  "plan": "ProSolo",
  "branding_opt_in": true,
  "locale": "sw",
  "message_template": "Habari {{name}}! Tazama ofa: {{short_url}}",
  "audience": [
    { "phone": "+255710000001", "name": "Asha", "short_url": "https://idp.africa/promo" },
    { "phone": "+255710000002", "name": "Baba", "short_url": "https://idp.africa/promo" }
  ]
}
"@

Invoke-RestMethod -Uri http://127.0.0.1:8001/api/campaigns/send -Method POST -ContentType "application/json" -Body $body

Success response shows accepted count and branding/quota status.

Health & Admin

# Health
curl http://127.0.0.1:8001/healthz

# License verify (debug)
curl -X POST http://127.0.0.1:8001/debug/verify -H "Content-Type: application/json" -d '{"license_token":"<YOUR_LICENSE_TOKEN>"}'

# Admin metrics
curl http://127.0.0.1:8001/api/admin/metrics

Plans & Pricing

See detailed quotas and prices on /pricing.

FAQ

Does the app work offline?

You can prepare drafts offline; license verification and sending require internet.

How are quotas enforced?

Quotas are checked per license token and device. The server validates plan and remaining credits.