Skip to main content

​
Outbound custom CRM

1

Request API key

Request API access - name the key, then Super Admin approve.
2

Dashboard prerequisites

Prerequisites - number, script, credits.
3

Create API campaign in UI

Create API campaign. Confirm with List campaigns / Get campaign.
4

Push leads

Push leads via POST /leads or /events. For WhatsApp/email with no dial, Send WhatsApp and email (GET /omni/templates then POST /leads).
5

Operate

Cancel / delete / follow-up via Contacts API; pull dials via GET .../calls and analysis via GET .../calls/{callId}; optional webhooks; kill switch if needed.

​
Direct WhatsApp / email (no dial)

1

Omni Channel in dashboard

Verified mailbox and/or WhatsApp profile + attached templates. API campaign started.
2

List ids

GET /api/v1/omni/templates?campaignId=… - List Omni templates.
3

Send

POST /leads with "channel": "whatsapp" or "channel": "email" (one channel per request), plus templateVariables / whatsappParams.
4

Poll

GET /contacts/{id} for whatsappQueueStatus / emailStatus.
Full walkthrough: Send WhatsApp and email.

​
Inbound agent via API

  1. Own a DID - dashboard or Public API: GET /credits → GET /numbers/available → POST /numbers/purchase
  2. POST /inbound-agents → activate
  3. Optional: POST .../crm/lookup
  4. Healthcare HMS: webhook + appointmentScope - Healthcare HMS integration
Create inbound agent

​
What this is not

  • Campaign CRUD over API
  • Twilio / Telnyx purchase or credit top-up via Public API (dashboard). Pool DID purchase is available via POST /api/v1/numbers/purchase.