How Our APIs Work
Visual guides to help you understand the architecture and flow of our API services.
Telique API - Telecommunications Data Flow
The Telique API provides real-time access to telecommunications data through direct SS7 network connections and various data sources. Here's how a typical CNAM lookup works:
Key Features:
- CNAM Lookups: Real-time caller name identification via SS7 network
- LRN Queries: Local Routing Number and porting status verification
- DNC/DNO Validation: Check numbers against Do Not Call/Originate databases
- STIR/SHAKEN: Call authentication and verification
- Caching: Intelligent caching for improved performance and reduced SS7 queries
Portability API - Number Porting Lifecycle
The Portability API manages the complete lifecycle of Local Number Portability (LNP) operations through Service Order Acceptance (SOA), facilitating smooth transitions between carriers:
Authentication:
Access the Portability API using Bearer tokens that you create and manage through the customer portal at soa.ringer.tel.
Port Request Lifecycle:
- Initiation: Customer requests number port from new carrier
- Validation: API validates customer information and number eligibility
- Submission: Port request sent to losing carrier via SOA gateway
- Confirmation: Losing carrier confirms or rejects port request
- Activation: Number ported on agreed date/time
- Completion: LRN updated, routing redirected to new carrier
Additional Operations:
- Port Cancellation: Cancel in-progress port requests
- Port Release: Release numbers back to original carrier
- LRN Management: Create, update, and remove Local Routing Numbers
- Event Tracking: Real-time notifications for port status changes
Ivy Business API - Platform Architecture
The Ivy Business API provides a comprehensive platform for managing business communication services, from customer accounts to billing and provisioning:
Core Components:
- Account Management: Create and manage customer accounts with hierarchical organization
- User & Permissions: Role-based access control for multi-user environments
- Site Management: Manage multiple locations with unique configurations
- Number Inventory: Provision and manage phone numbers across sites
- Billing Engine: Automated billing, invoicing, and payment processing
- Service Provisioning: Configure services, features, and call routing
Integration Points:
- RESTful API with OAuth 2.0 authentication
- Webhook notifications for real-time events
- Bulk operations for enterprise-scale management
- Compatible with third-party billing and CRM systems
Authentication Methods
IP Whitelist (Telique)
Server-to-server authentication using pre-approved IP addresses.
- Register your server IPs with Ringer
- No API keys or tokens required
- Ideal for fixed infrastructure
- Maximum security for sensitive operations
Bearer Token (Portability)
Self-service token authentication for SOA operations.
- Create and manage tokens at soa.ringer.tel
- Include token in Authorization header
- Full control over token lifecycle
- Ideal for automated porting operations
OAuth 2.0 (Ivy Business)
Token-based authentication for flexible, secure access.
- Support for multiple grant types
- Refresh tokens for long-lived sessions
- Scope-based permissions
- Ideal for web and mobile applications
Ready to Get Started?
Explore our comprehensive API documentation and start building today.