Skip to main content
1

Own a number

Get credits → list available → purchase, or buy in the dashboard. Then list owned numbers.
2

Create

POST /api/v1/inbound-agents — starts inactive. Healthcare HMS: pass appointmentScope + Custom API URL (sets appointments + hcBookingPath automatically). Optional copyVoiceFromAgentId. Healthcare HMS integration.
3

Dashboard (optional)

Wire Sheets / Zoho / Custom API and finish script if you are not using the HMS APIs above. For HMS, pick Integration type HMS Custom API and use real hospital/doctor IDs from your system.
4

Sync doctors (HMS hospital/doctor)

POST .../sync-doctors.
5

Generate script

POST .../generate-script — poll until inboundScriptStatus: ready.
6

Activate

POST .../activate { "activate": true }.
7

Lookup (optional)

POST .../crm/lookup with useCase + phone/order fields.
Activate: phone_not_owned, script_not_ready. HMS scope: global_scope_locks_forbidden, branch_id_required, doctor_scope_ids_required.