nCall API Server

nCall REST API Server

The nCall REST API Server is an optional nCall module that lets other software securely read from, and where appropriate write to, your nCall database. In practical terms, it is the bridge between nCall and the systems your answering service already uses: your website, client portal, CRM, billing system, reporting tools, dashboards, reminder tools, or a customer’s own software.

You do not need to be a programmer to benefit from it. The module is usually configured by nSolve, your IT provider, or your web developer. Once in place, it allows routine work that would normally involve copying, exporting, retyping, or emailing information to happen automatically.

What the API Server allows you to do

The API Server exposes key areas of nCall, including clients, contacts, calls, messages, tasks, reminders, users, telephone numbers, billing information, call actions, message actions and webhooks. Your integration can then request just the information it needs, or create and update records where your nCall permissions allow it.

• Create clients automatically: a new sign-up form on your website can create the client in nCall, add the general contact, allocate a telephone number, set up default call handling and add message actions.
• Keep client and contact details up to date: a customer portal can let authorised clients maintain their own names, numbers, email addresses, call instructions and web access details.
• Show calls and messages online: clients can view recent calls, missed calls, messages, call notes or message delivery status without waiting for a manual report.
• Build live dashboards: managers can monitor today’s answered calls, undelivered calls, active clients, operator sessions, call volumes, message counts, or other operational figures.
• Improve billing and profitability reporting: your billing process can obtain call counts, call durations, messages taken, extras, client billing totals and activity over a chosen date range.
• Create tasks, to dos and reminders: a website form or external system can create follow-up work inside nCall, including reminders for selected users or all users.
• Connect nCall to other services: webhooks can notify another system when selected nCall data changes, for example when a client, call, message, task or reminder is updated.

Typical uses for an answering service

• A new customer completes a website sign-up form, and nCall is populated without a member of staff rekeying the details.
• A client logs into your portal and sees their latest messages and missed calls from nCall.
• Your accounts team runs a month-end billing report that pulls current nCall billing data directly into a spreadsheet or finance system.
• A supervisor opens a wallboard showing call traffic, undelivered calls, current workload and client activity in real time.
• An external CRM checks nCall for a matching telephone number, then displays the correct client record to your team.
• A form on your website creates an nCall reminder or task for the right operator team.

How it works in plain English

The API Server runs as a small web service connected to your nCall system. Instead of returning web pages for people to read, it returns structured data that another computer program can understand. The data is returned in JSON format, which is a common way for modern systems to exchange information.

A script, website, app or reporting tool sends a request to a special nCall address. The request might ask for information, such as “give me the calls for this client today”, or it might ask nCall to create or update something, such as “add this new contact”. The API Server checks the username, password and permissions, talks to the nCall database, and sends back the result.

For example, an integration could ask nCall for a contact’s first name, last name and mobile number, or ask for all calls for a client between two dates. It can also ask only for the fields it needs, which helps keep requests quick and tidy.

Security and permissions

The API Server uses nCall usernames and passwords, so you can create a dedicated nCall user for integrations. Access can be limited by role: administrators can be given read and write access, supervisors are commonly read-only, and ordinary users can be blocked from API access unless you choose otherwise.

The server supports HTTP and HTTPS, and it is normally installed on your own network or placed behind a controlled web server rather than being openly exposed to the internet. nSolve can advise on the best arrangement for your installation.

Developer-friendly, but business-led

The API Server includes generated documentation of the available endpoints, fields and examples from the server itself. Example scripts are available in common scripting tools such as JavaScript, PHP, Visual Basic, Python and cURL. These are intended to help your IT team or developer get started quickly, while still allowing bespoke workflows that match the way your answering service operates.

Common data areas include CLIENTS, CONTACTS, CALLS, MESSAGES, TASKS, TODO, REMINDERS, USERS, TELEPHONE_NUMBERS, SCHEMES, WEBHOOKS and WEBHOOK_EVENTS.

Benefits

• Less manual administration: reduce copying and retyping between nCall and other systems.
• Fewer mistakes: use one live source of data instead of repeated manual exports.
• Faster customer service: give staff, managers or clients access to current nCall information when they need it.
• Better reporting: build the dashboards and KPI reports that matter to your answering service.
• More flexible client services: offer online portals, self-service updates, custom reporting or automated workflows as added-value services.
• Room to grow: connect nCall to new tools without changing the way operators use nCall day to day.

Getting started

A typical project starts by deciding what you want to automate or display. For example: “new website sign-ups should create nCall clients”, “clients should see their messages online”, or “accounts need a monthly billing export”. From there, nSolve or your developer can map the required nCall fields, configure a secure API user, and build the script, portal page or report.

If you already have a developer, we can provide the technical documentation and example scripts. If you would prefer nSolve to create the integration, we can discuss your workflow and provide a quotation.

For more background, please read our blog post: What is the nCall REST API Server module for?

Please contact us for further information and/or a price quote.

Back to nCall