VOS3000 API Integration and Development Complete Important Guide
The VOS3000 Web API provides a comprehensive programmatic interface for integrating the softswitch platform with external applications, customer portals, billing systems, and third-party services. This RESTful API enables developers to automate account management, phone provisioning, gateway configuration, and numerous other operational tasks that would otherwise require manual intervention through the VOS3000 client application.
The API architecture follows modern web service standards, using JSON for data exchange and supporting both HTTP and HTTPS protocols for secure communications. Understanding the capabilities and implementation requirements of this API is essential for organizations seeking to build integrated telecommunications solutions.
Table of Contents
📌 API Overview and Configuration – VOS3000 API Integration
The VOS3000 API interface format is defined in JSON and encoded in UTF-8 format, ensuring compatibility with virtually all modern programming languages and development frameworks. All API requests use the POST method to submit data to VOS3000 web services, with request bodies containing structured JSON parameters that specify the operation to perform.
Before utilizing the API, proper access configuration must be completed within the VOS3000 management interface. The configuration is located under Interface Management > Web Access Control, where administrators define which directories and interfaces are accessible to external systems.
For detailed API documentation, see our VOS3000 Web Interface Developing Manual.
🔧 API Access Configuration
The primary interface directories include:
| Directory | Purpose | Usage |
|---|---|---|
| /external/server | Production interfaces | Live API operations |
| /external/test/server | Testing interfaces | Development and debugging |
| /external/server/GetCustomer | Specific interface | Account query operations |
The interface address follows a consistent URL pattern: http://IP_Address:HTTP_Port/directory_name for standard HTTP access or https://IP_Address:HTTPS_Port/directory_name for encrypted HTTPS connections. For production implementations, HTTPS should always be used.
For the complete API reference, check our VOS3000 2.1.9.07 Web API Manual.
📱 Account Management API Operations – VOS3000 API Integration
The VOS3000 API provides comprehensive account management capabilities through a suite of related endpoints:
🔹 CreateCustomer Interface
The CreateCustomer interface (/external/server/CreateCustomer) enables programmatic creation of new billing accounts with configurable parameters:
- account: Account identifier (unique, required)
- name: Account name (required)
- money: Initial balance (default: 0)
- limitMoney: Overdraft limit (default: 0)
- feeRateGroup: Billing rate group
- type: Account type (0=Ordinary, 1=Phone card, 2=Settlement)
- lockType: Lock status (0=Unlocked, 1=Locked)
🔹 Other Account Operations
- ModifyCustomer: Update existing account configurations
- DeleteCustomer: Remove accounts from the system
- GetCustomer: Query account information
- GetAllCustomers: Retrieve all account identifiers
For API overview, see VOS3000 API Overview.
📞 Phone Management API Operations
Phone number management through the VOS3000 API provides extensive capabilities for provisioning and configuring telephone endpoints. The CreatePhone interface (/external/server/CreatePhone) creates new phone entries with a comprehensive set of configuration options.
🔹 Phone Creation Parameters
| Parameter | Type | Description |
|---|---|---|
| e164 | String (Required) | Phone number |
| autoCreateAccount | Boolean (Required) | Auto-create billing account |
| account | String | Associated account |
| password | String | Phone password |
| displayNumber | String | Outgoing caller ID |
| callLevel | Integer | Permission level (1-5) |
| lockType | Integer | Lock status (0-3) |
The call permission system uses the callLevel parameter: 1 for intra-network calls only, 2 for local calls, 4 for domestic long distance, and 5 for international long distance.
🌐 Gateway Management API Operations
Gateway configuration through the API provides complete control over both routing gateways (termination points) and mapping gateways (origination points). The CreateRoutingGateway interface enables creation of routing gateways with parameters for gateway identification, prefix configuration, line limits, and priority settings.
For mobile app development using the API, see our guide on VOS3000 Web Management Android iOS Mobile Apps.
📊 CDR and Billing API Access – VOS3000 API Integration
The VOS3000 API provides interfaces for accessing Call Detail Records and billing information, enabling integration with external billing systems and reporting platforms. CDR query interfaces support filtering by time periods, account identifiers, phone numbers, and gateway names.
The billing interfaces support payment processing, balance queries, and consumption reporting. These capabilities enable development of customer self-service portals where users can view their call history, check current balances, and make payments.
💻 Code Example: Account Creation
Here is a practical example demonstrating how to create a VOS3000 account using the API:
Request to /external/server/CreateCustomer:
{
"account": "customer001",
"name": "Test Customer Account",
"money": 100.00,
"limitMoney": 50.00,
"feeRateGroup": "standard_rate",
"type": 0,
"lockType": 0,
"memo": "Created via API integration"
}
Response:
{
"retCode": 0
}
A retCode of 0 indicates success. Non-zero values indicate failure, with the exception field providing error details.
⚙️ Implementation Best Practices – VOS3000 API Integration
- ✅ Use HTTPS for all production communications
- ✅ Store credentials securely using secrets management
- ✅ Implement proper error handling for all return codes
- ✅ Use connection pooling for high-volume applications
- ✅ Test in staging environment before production deployment
- ✅ Implement rate limiting to prevent API abuse
🔧 Debugging and Testing Tools
VOS3000 provides browser-based debugging tools accessible through the test interface directory (/external/test/server). Each API endpoint has a corresponding test page that allows developers to interactively test API calls directly from a web browser.
When debugging API integrations, verify that the Content-Type header is set to text/html; charset=UTF-8 as required by the VOS3000 API.
🔗 Related Resources
Internal Resources:
- VOS3000 Web Interface Developing Manual
- VOS3000 2.1.9.07 Web API Manual
- VOS3000 API Overview
- Mobile App Development with API
External Resources:
❓ Frequently Asked Questions (FAQ) – VOS3000 API Integration
Q1: What is the API request format?
💡 A1: VOS3000 API uses JSON format with POST method. All requests should include Content-Type: text/html; charset=UTF-8 header.
Q2: How do I authenticate API requests?
💡 A2: Configure IP allowlisting in Web Access Control. API requests must originate from authorized IP addresses.
Q3: Can I create accounts and phones in one API call?
💡 A3: Use the autoCreateAccount parameter in CreatePhone to automatically create the billing account when provisioning a phone.
Q4: What return codes indicate success or failure?
💡 A4: retCode 0 indicates success. Non-zero values indicate failure with details in the exception field.
Q5: Is there a rate limit for API calls?
💡 A5: VOS3000 does not impose built-in rate limits, but implement client-side rate limiting for production stability.
📞 Need API Development Support?
For professional VOS3000 API integration and development:
📱 WhatsApp: +8801911119966
🌐 Website: www.vos3000.com
🌐 Blog: multahost.com/blog
📥 Downloads: VOS3000 Downloads
 | | |
