Knowledgebase
20Important & Helpful Info 2Sales & Quoting Tools 9Add Customers & Services 7TeamMate 8Customer Billing 12Phone Numbers 107Hosted PBX 15SIP Trunking 8Microsoft Teams Direct Routing 6IP Fax 2Audio Conferencing 1Other Services 16Platform Settings 7Platform Reports 1010DLC - TCR Messaging Compliance 4VoIP Troubleshooting Tools 25Router & Network Help 1API Access 8Release Notes
Knowledgebase: API Access
RingLogix API Overview
Posted by Albert Diaz, Last modified by Albert Diaz on 25 September 2024 08:00 AM


RingLogix provides two powerful APIs designed to help partners integrate communication and billing solutions seamlessly into their own systems. Whether you’re looking to automate call flows, manage real-time billing data, or customize communication tools for your customers, the CPaaS API and RingOS API give you the flexibility and control to build custom solutions that fit your business needs.

In this article, we’ll introduce both APIs, explain how to get started, and provide links to the documentation for further guidance.


CPaaS API (Fully Launched)
The RingLogix CPaaS API allows partners to manage communication services, including full control over calls, system configurations, and real-time event notifications. This API is ideal for partners looking to integrate communications into their systems under their own brand.

Key Features:
  • Call Control: Manage and automate call functions such as initiating, transferring, and terminating calls.
  • Webhook Notifications: Receive real-time notifications of call activity such as ringing, answering, and hanging up.
  • System Configurations & Provisioning: Automate the provisioning of users, phone numbers, and system configurations to streamline your operations.

Use Cases:
The CPaaS API allows for integration into third-party platforms like CRMs to automate communications and streamline customer interactions. It’s ideal for partners who want to enhance their communication systems and customize how they manage services.


RingOS API (Currently in Beta)
The RingOS API provides access to critical billing data and allows partners to build automated solutions based on that data. Partners currently use this API to manage billing and commission systems, with features expanding based on partner requests. For example, one partner is leveraging the API to build an agent commissioning system using real-time billing data.

Key Features:
  • Billing Data Access: Retrieve detailed billing data to create custom reports or automate financial processes.
  • Automation: Automate complex billing tasks, such as agent commissions, and integrate billing data with third-party platforms

Use Cases:
The RingOS API is actively used for creating custom billing solutions and commissioning systems. As the API grows, partners can request additional functionality related to billing or provisioning by contacting their Success Manager.


Authentication and Access
To use the APIs, you will need to follow the steps below to obtain credentials and keys for secure access:

CPaaS API Access:
  • OAuth Keys: Contact your Success Manager to request your OAuth keys. The Success Manager will open a service ticket, and the keys will be provided through a one-time link.
  • PBX User Credentials: OAuth keys identify the app connecting to the PBX, but PBX user credentials determine which data and PBX domains the authenticated user can access. These credentials are tied to the PBX user, not reseller staff credentials.

The CPaaS API offers three access levels (scopes):
  • Basic User: Read and modify any data related to the subscriber.
  • Office Manager: Read and modify any data related to the subscriber's domain.
  • Reseller: Read and modify any data related to any domain under the same reseller. The reseller scope is not available via the portal and must be requested by specifying which PBX users should have this elevated access.

RingOS API Access:
  • Partner Key: Contact your Success Manager to request your Partner Key. The Success Manager will open a service ticket, and the key will be provided through a one-time link.
  • Reseller Staff Credentials: The RingOS API uses Reseller Staff credentials to identify and authenticate the user accessing the billing data.


CPaaS API Documentation: Access Here

RingOS API Documentation: Coming soon


Feedback for Beta Testers
If you’re using the RingOS API and are part of the beta program, we welcome your feedback! Use the feedback widget located in the bottom right corner of the page to share your experience or report any issues.


Requesting Additional Features for RingOS API
The RingOS API is in active development and evolves based on partner needs. If you require additional billing or provisioning functions that are not currently available, contact your Success Manager to schedule a meeting with the Product Manager. This will help identify your requirements and establish a delivery timeline for requested features.


Important Disclaimer
RingLogix provides comprehensive API documentation to help you get started, but use of the API is at your own risk. We offer limited support for third-party application development and do not provide assistance with custom code or integrations. For any issues related to API functionality, please contact your Success Manager.
(0 vote(s))
Helpful
Not helpful
Comments (0)
Post a new comment
 
 
Full Name:
Email:
Comments:
CAPTCHA Verification 
 
Please enter the text you see in the image into the textbox below (we use this to prevent automated submissions).