Developer Section for System Integrators
Welcome to the Developer Section of DLS Hosted PBX. This resource is for system integrators who want to connect DLS Hosted PBX to their own software. Below you will find what each of our two APIs covers and where its documentation lives: the Admin API for managing the PBX itself, and the User API for building on behalf of a user.
Admin API: Control of the Whole PBX
The Admin API is for system administrators who need comprehensive control over the PBX. It automates user management, call routing rules, billing settings and more.
Campaign Registry
Query campaign opt-in lists and tenant opt-out lists.
Predictive Dialer
Manage campaigns, scripts, contact lists and contacts.
Call Detail Records
Pull CDR data for billing and reporting.
Real-Time Statistics
Calls, users, queues, faxes, conferences, provisioning and the dialer.
SMS
Send SMS to numbers or extensions and query the SMS record table.
Access to the Admin API is requested from your DLS Hosted PBX administrator, who generates your API keys.
User API: Build for Your Users
The User API lets end users manage their own settings without an administrator. It is built for user portals, mobile apps and desktop applications, and covers the resources you see on the Hosted PBX web interface: placing calls, sending SMS and MMS, retrieving call records and recordings, managing contacts and more.
Call Control
Calls, call data, recordings and notes.
Contacts
Create, update and search contacts.
Voicemail
Read, play and manage voicemail.
Provisioning
Users and user extensions.
SMS and MMS
Send and receive messages.
Fax
Send faxes and retrieve received ones.
User API credentials and keys are available by logging into your DLS Hosted PBX.
Getting Started With Integration
To begin integrating DLS Hosted PBX with your software, follow these four steps.
1. Choose the API
Pick the API that fits your application and read its documentation for capabilities and limits.
2. Request Access
Ask your DLS Hosted PBX administrator. You need a PBX account with administrative access.
3. Set Up Your Environment
Follow the guidelines in the API documentation.
4. Begin Coding
Use our guides and examples to build and test.
Questions While You Integrate?
Our developer support team is at engineering@noc.dls.net. We also welcome feedback and contributions from our developer community; your input shapes what the APIs do next.