Onboard clients,
at API speed.

Start onboarding a new client — the first step of partner-led signup.

How it works: Pass the client's name, email, mobile, password and country_code (optional promo). The platform creates a pending client and sends OTPs to verify the email and mobile, returning a request_id for the next step.

Use it for self-serve client signup from your own portal or sales flow.

Verify the email and mobile OTPs sent during registration.

How it works: Pass the request_id with the mobileotp and emailotp the client received. Successful verification moves onboarding on to the KYC steps.

Use it for confirming contact details before KYC and account creation.

Resend a verification OTP if the client didn't receive it.

How it works: Pass the request_id and the type (email or mobile) to trigger a fresh code.

Use it for recovering from expired or undelivered OTPs during signup.

Verify the client's business PAN as part of KYC.

How it works: Pass the temp_client_id, the pan number and the business type btype; the platform validates it against records.

Use it for meeting KYC requirements for business clients during onboarding.

Send an Aadhaar OTP to begin individual KYC.

How it works: Pass the temp_client_id and aadhar_num; an OTP is sent to the Aadhaar-linked mobile and a reference is returned for verification.

Use it for Aadhaar-based KYC for individual or proprietor clients.

Verify the Aadhaar OTP to complete Aadhaar KYC.

How it works: Pass the temp_client_id, the otp and the ref from the previous step to confirm the Aadhaar identity.

Use it for completing the Aadhaar leg of client KYC.

Verify the client's GST number.

How it works: Pass the temp_client_id and gst_num; the platform validates the GSTIN and links it to the client.

Use it for capturing GST details for tax-registered business clients.

Skip GST verification when the client isn't GST-registered.

How it works: Pass the temp_client_id to mark GST as not applicable and continue onboarding.

Use it for onboarding small or unregistered clients who have no GSTIN.

Review all collected KYC details before final submission.

How it works: Pass the temp_client_id to get a summary of the captured PAN, Aadhaar and GST data for confirmation.

Use it for showing a confirmation screen before the client account is created.

Accept the KYC and create the live client account.

How it works: Pass the temp_client_id and the client's signature; the platform finalizes KYC and converts the pending record into an active client.

Use it for completing onboarding and going live with a new client.

List all clients under your partner account.

How it works: Call the endpoint to get every client with their ID, status and basic details.

Use it for building a client dashboard or picking a client_id for other calls.

Get the full profile of a single client.

How it works: Pass the client_id in the path to retrieve that client's details, status and configuration.

Use it for showing or editing one client's account.

Activate or deactivate a client account.

How it works: Pass the client_id and the new status; a deactivated client can't use the platform until reactivated.

Use it for suspending clients for non-payment or pausing inactive accounts.

List registrations that started but haven't completed KYC.

How it works: Call the endpoint to get the temp (pending) clients still in onboarding.

Use it for following up on incomplete signups and chasing stalled KYC.

List the regions where DID numbers are available.

How it works: Call the endpoint to get the regions you can search for numbers in.

Use it for driving a region selector before searching DIDs for a client.

Search for DID numbers available to assign to a client.

How it works: Pass the client_id, country_code, region and an optional search_pattern; the API returns matching available numbers.

Use it for letting clients pick a local or vanity number during setup.

Buy a DID and assign it to a client.

How it works: Pass the client_id, the chosen number and country; the platform provisions the DID and links it to that client.

Use it for giving a client their first number or expanding their inventory.

Remove (unlink) a DID from a client.

How it works: Pass the client_id and the did_no; the number is released from that client.

Use it for reclaiming numbers from churned clients or correcting assignments.

List the DID numbers assigned to a client.

How it works: Pass the client_id in the path to get all of that client's DIDs and their status.

Use it for auditing a client's numbers and choosing one to configure.

Get a DID's working hours, timezone and holidays.

How it works: Pass the client_id and did_id to retrieve the number's schedule.

Use it for showing current office hours before editing them.

Set a DID's working hours and timezone.

How it works: Pass the client_id, did_id, timezone and working_hours; calls outside these hours follow your off-hours handling.

Use it for enforcing business hours on a client's inbound number.

Add a holiday to a DID's schedule.

How it works: Pass the client_id, did_id, a holiday name and date; the number is treated as closed that day.

Use it for blocking public holidays and one-off closures.

Remove a holiday from a DID's schedule.

How it works: Pass the client_id and the holiday_id to delete it.

Use it for correcting a mistaken holiday or reopening a date.

Create an agent under a client account.

How it works: Pass the client_id with the agent's name, email, phonenumber, password and extension (plus options like did_num, is_webrtc, dial_preference and permission_group). The agent is provisioned to take calls.

Use it for onboarding a client's call-centre team programmatically.

Update an existing agent's details or settings.

How it works: Pass the client_id and agent_id with any fields to change — name, extension, did_num, is_webrtc, permission_group and more.

Use it for reassigning extensions, updating contact details or changing permissions.

Remove an agent from a client account.

How it works: Pass the client_id and agent_id; the agent is deactivated (status set to 0) and can no longer take calls.

Use it for offboarding agents who've left a client's team.

Change the DID tied to a client's agent.

How it works: Pass the client_id, the agent_ext and the did_num; the agent's outbound caller ID updates.

Use it for giving agents local caller IDs or moving numbers between them.

Get an agent's availability schedule.

How it works: Pass the client_id and agent_id to retrieve their working hours and timezone.

Use it for reviewing an agent's shift before editing it.

Set an agent's availability schedule.

How it works: Pass the client_id, agent_id, timezone and working_hours; calls route to the agent only during these hours.

Use it for defining agent shifts and routing windows.

Set an agent online or offline right now.

How it works: Pass the client_id, agent_id and the available flag to flip their live status.

Use it for wiring agent presence to your own dashboard or break button.

Get every agent for a client with their live availability.

How it works: Pass the client_id to see which agents are online, offline or on a call.

Use it for a live wallboard of agent presence.

Create a basic IVR call flow for a client.

How it works: Pass the client_id, a flow_name, the target agent_ext, the did_no and an optional recording_id. The platform builds a simple routing flow for that number.

Use it for standing up quick call routing for a client without the full flow builder.

Edit a client's basic call flow.

How it works: Pass the client_id and flow_id with fields to change — flow_name, recording_id, transfer_to, agent_ext or a wss_bot_id to route to a voice bot.

Use it for retuning routing, greetings or bot handoff for a client.

Attach a call flow to a client's DID number.

How it works: Pass the client_id, the flow_id and the did_no; inbound calls to that number then run the flow.

Use it for activating a flow on a number, or swapping which flow a number uses.

Create or update a WSS voice bot for a client.

How it works: Pass the client_id, a bot_name, the wss_url (with optional api_url/wss_header) and to_be_used; pass an id to update an existing bot. Flows can then route calls to this bot.

Use it for wiring a client's AI/WebSocket bot into their call flows.

List all WSS voice bots configured for a client.

How it works: Pass the client_id in the path to get each bot with its ID and settings.

Use it for showing a bot picker when building call flows.

Get a single WSS voice bot's configuration.

How it works: Pass the client_id and the bot id to retrieve its URLs and headers.

Use it for inspecting or pre-filling a bot's settings before editing.

Delete a WSS voice bot from a client.

How it works: Pass the client_id and the bot id; it's removed and can no longer be used in flows.

Use it for cleaning up unused or deprecated bots.

Link a WhatsApp Business number to a client.

How it works: Pass the client_id, the phone_number_id, access_token, display_number and verified_name; the WhatsApp number is connected for the client.

Use it for adding WhatsApp as a channel for a client.

List a client's linked WhatsApp numbers.

How it works: Pass the client_id to get every WhatsApp DID and its status.

Use it for managing a client's WhatsApp channels.

Unlink a WhatsApp number from a client.

How it works: Pass the client_id and the wa_did_id; the number is disconnected.

Use it for removing a deprecated or migrated WhatsApp number.

Set working hours for a client's WhatsApp number.

How it works: Pass the client_id, wa_did_id, timezone and working_hours to define when the number is active.

Use it for enforcing business hours on WhatsApp conversations.

Get a WhatsApp number's schedule.

How it works: Pass the client_id and wa_did_id to retrieve its working hours, timezone and holidays.

Use it for reviewing WhatsApp availability before editing.

Add a holiday to a WhatsApp number's schedule.

How it works: Pass the client_id, wa_did_id, a holiday name and date to mark it closed.

Use it for blocking holidays on WhatsApp channels.

Remove a holiday from a WhatsApp number's schedule.

How it works: Pass the client_id and holiday_id to delete it.

Use it for correcting or reopening a WhatsApp closure date.

Pull a client's wallet transaction history.

How it works: Pass the client_id with optional filters — page, limit, expense_type, start_date, end_date, did — to page through debits and credits.

Use it for billing dashboards, statements and usage reconciliation.

Check a client's current wallet balance and account expiry.

How it works: Pass the client_id to get the live balance and validity date.

Use it for showing balance widgets and triggering low-balance top-ups.

Add credits and/or extend a client's validity.

How it works: Pass the client_id, a credit amount and/or a new valid_till date; the wallet and expiry update immediately.

Use it for top-ups, plan renewals and promotional credit.