VOS3000 API Integración y Desarrollo – Guía Completa Web API V2.1.9.07
VOS3000 API integración desarrollo es la clave para automatizar operaciones, crear portales de clientes personalizados e integrar sistemas externos con su plataforma VoIP. La Web API V2.1.9.07 de VOS3000 proporciona una interfaz completa basada en JSON que permite gestionar cuentas, teléfonos, gateways, tarifas y CDR de forma programática. Esta guía técnica completa le enseñará a utilizar todos los endpoints disponibles.
📞 ¿Necesita desarrollar integraciones con VOS3000? WhatsApp: +8801911119966
Table of Contents
Visión General de VOS3000 Web API (VOS3000 API Integración)
La interfaz Web API de VOS3000 permite a desarrolladores e integradores interactuar con el softswitch de forma programática, eliminando la necesidad de operaciones manuales en la interfaz gráfica. Esto es esencial para portales de autoservicio, sincronización con CRM, automatización de procesos y desarrollo de aplicaciones móviles.
📊 Características Técnicas de la API (VOS3000 API Integración)
| 🔧 Aspecto | 📋 Especificación |
|---|---|
| Formato de Datos | JSON con codificación UTF-8 |
| Método HTTP | POST para todas las peticiones |
| Content-Type | text/html; charset=UTF-8 |
| Puerto por Defecto | Configurable (varía según instalación) |
| Protocolos | HTTP y HTTPS soportados |
| Versión Actual | V2.1.9.07 (Documento 05, 2022-10-19) |
⚙️ Formato de Dirección de la API (VOS3000 API Integración)
# Formato HTTP http://[IP-Servidor]:[Puerto-HTTP]/external/server/[Endpoint] # Formato HTTPS https://[IP-Servidor]:[Puerto-HTTPS]/external/server/[Endpoint] # Ejemplo práctico http://192.168.1.100:8080/external/server/CreateCustomer # Nota: El puerto puede variar según configuración del servidor
Configuración de Acceso API (VOS3000 API Integración)
Antes de utilizar la API, debe configurar los permisos de acceso desde la interfaz de gestión de VOS3000. Esta configuración controla qué direcciones IP pueden acceder a la API y qué endpoints están disponibles para cada cliente.
📊 Parámetros de Configuración
| 📋 Parámetro | 🔧 Descripción |
|---|---|
| Web Server Device | Nombre del dispositivo para identificación |
| Directory Name | Rango de directorios API permitidos |
| /external/server | Interfaz oficial de producción |
| /external/test/server | Interfaz de prueba para depuración visual |
| Allowed Access IP | Direcciones IP autorizadas para acceder |
📖 Descargar Manual Web API V2.1.9.07 completo: vos3000.com/downloads.php
Endpoints Principales de VOS3000 Web API (VOS3000 API Integración)
La API V2.1.9.07 incluye más de 80 endpoints para gestión completa del softswitch. A continuación se detallan los más utilizados para operaciones comunes de integración.
📊 Gestión de Cuentas (Accounts)
| 🔗 Endpoint | 📋 Función | 📝 Parámetros Clave |
|---|---|---|
| /CreateCustomer | Crear nueva cuenta | account, name, money, limitMoney, feeRateGroup, type, lockType |
| /ModifyCustomer | Modificar cuenta existente | account, name, limitMoney, feeRateGroup, lockType, validTime |
| /DeleteCustomer | Eliminar cuenta | account (requerido) |
| /GetCustomer | Consultar información de cuenta | accounts[], e164s[], filterAgentAccount |
| /GetAllCustomers | Obtener todas las cuentas | key (entero) |
📊 Gestión de Teléfonos (Phones)
| 🔗 Endpoint | 📋 Función | 📝 Parámetros Clave |
|---|---|---|
| /CreatePhone | Crear teléfono/SIP account | e164, account, password, displayNumber, callLevel, registerType |
| /ModifyPhone | Modificar configuración de teléfono | e164, password, displayNumber, lockType, callLevel, feerateGroup |
| /DeletePhone | Eliminar teléfono | e164 (requerido) |
| /GetPhone | Consultar información de teléfono | e164s[] o accounts[] |
| /GetPhoneOnline | Ver teléfonos online | e164s[] (lista de teléfonos) |
📊 Gestión de Gateways (Gateways)
| 🔗 Endpoint | 📋 Función | 📝 Parámetros Clave |
|---|---|---|
| /CreateGatewayMapping | Crear gateway de mapeo (origination) | name, password, registerType, remoteIps, capacity, priority |
| /CreateGatewayRouting | Crear gateway de enrutamiento (termination) | name, prefix, registerType, remoteIp, protocol, signalPort |
| /GetGatewayMapping | Consultar gateways de mapeo | names[] (opcional) |
| /GetGatewayMappingOnline | Ver gateways online con estadísticas | names[], softswitchName |
Ejemplo de Implementación: Crear Cuenta (VOS3000 API Integración)
El siguiente ejemplo muestra cómo crear una nueva cuenta en VOS3000 mediante la API, incluyendo todos los parámetros principales y la estructura de respuesta esperada.
📝 Solicitud JSON para Crear Cuenta
POST /external/server/CreateCustomer HTTP/1.1
Host: 192.168.1.100:8080
Content-Type: text/html; charset=UTF-8
{
"account": "cliente001",
"name": "Cliente Empresarial ABC",
"money": 100.00,
"limitMoney": 500.00,
"feeRateGroup": "tarifa_mayorista",
"type": 0,
"lockType": 0,
"agentAccount": "",
"phoneBookLimit": 0,
"validTime": 0,
"memo": "Cuenta creada vía API"
}
📝 Respuesta Exitosa
{
"retCode": 0,
"exception": null
}
📝 Respuesta con Error
{
"retCode": -10007,
"exception": "Not found, operation failed."
}
Tipos de Datos y Validaciones
La API VOS3000 utiliza tipos de datos específicos que deben respetarse para evitar errores de validación. Conocer estos tipos es esencial para implementaciones correctas.
📊 Tipos de Datos de la API (VOS3000 API Integración)
| 📋 Tipo | 📏 Descripción | 📝 Ejemplo |
|---|---|---|
| String | Cadena de hasta 255 caracteres | “cliente001” |
| LongString | Cadena de hasta 65,535 caracteres | Reglas de marcado extensas |
| Integer | Número entero | 0, 1, 2, 100 |
| Double | Número decimal | 100.50, 0.015 |
| Boolean | Valor lógico | true, false |
| Long | Timestamp Unix en milisegundos | 1666195200000 |
| String[] | Array de strings | [“cuenta1”, “cuenta2”] |
Seguridad y Mejores Prácticas
Implementar la API VOS3000 de forma segura es crítico para proteger los datos de su operación y evitar accesos no autorizados que podrían resultar en fraude o pérdida de datos.
🛡️ Recomendaciones de Seguridad API (VOS3000 API Integración)
| 🔒 Práctica | 📋 Implementación |
|---|---|
| Whitelist de IP | Solo permitir IPs autorizadas en configuración de acceso |
| HTTPS obligatorio | Usar HTTPS para encriptación de datos en tránsito |
| Autenticación robusta | Implementar tokens de acceso con expiración |
| Rate limiting | Limitar número de peticiones por minuto |
| Logs de acceso | Registrar todas las llamadas API para auditoría |
| Validación de entrada | Validar todos los parámetros antes de enviar |
Integración con Sistemas Externos
La API VOS3000 permite integración con múltiples sistemas externos para automatizar flujos de trabajo y sincronizar datos entre plataformas.
📊 Casos de Uso de Integración
| 🔗 Sistema | 📋 Funcionalidad | 💡 Beneficio |
|---|---|---|
| CRM (Salesforce, etc.) | Sincronizar clientes, consultar saldo | Visión 360° del cliente |
| Pasarela de Pago | Recargas automáticas de saldo | Autoservicio 24/7 |
| Portal Web | Autogestión de clientes finales | Reducción de soporte |
| Sistema de Facturación | Exportar CDR para facturación | Conciliación automática |
| Monitoreo | Alertas de balance, tráfico inusual | Detección temprana de problemas |
🔗 Recursos Relacionados (VOS3000 API Integración)
- 📖 Manual de Desarrollo Web Interface VOS3000
- 📖 Web API Manual V2.1.9.07 en Inglés
- 📖 FAQ VOS3000 Basado en Manual Oficial
- 📖 Problemas Comunes de Conexión API VOS3000
- 📖 Descarga Manual Web API V2.1.9.07: vos3000.com/downloads.php
❓ Preguntas Frecuentes (VOS3000 API Integración)
¿El puerto de la API siempre es el mismo?
No, el puerto HTTP/HTTPS para la API puede variar según la configuración de cada instalación. Verifique en su servidor qué puerto está configurado para el servicio web de VOS3000. El puerto por defecto suele ser 8080 pero puede modificarse.
¿Cómo obtengo acceso a la API de mi VOS3000?
El acceso a la API debe configurarse desde Gestión de Operación > Gestión de Interfaz Web en el cliente VOS3000. Allí debe agregar su IP a la lista de IPs permitidas y especificar qué endpoints puede utilizar.
¿Qué hacer si recibo error retCode negativo?
Un retCode negativo indica error. Consulte el campo “exception” para ver la causa específica. Los errores comunes incluyen parámetros faltantes, tipos de datos incorrectos, cuentas inexistentes o permisos insuficientes.
¿Puedo usar la API para crear portal de clientes?
Sí,这正是 la API está diseñada para esto. Puede crear un portal web donde los clientes consulten su saldo, vean CDR, recarguen saldo y gestionen sus configuraciones, todo mediante llamadas API al VOS3000.
📞 Desarrollo e Integración Profesional
¿Necesita desarrollar integraciones personalizadas con VOS3000 API? Ofrecemos servicios de desarrollo de portales de clientes, integración con CRM, sistemas de facturación y automatización de procesos. Nuestro equipo conoce la API en profundidad y puede implementar soluciones robustas y seguras.
📱 WhatsApp: +8801911119966
¡Automatice su operación VOS3000 con integraciones API profesionales!
📞 Need Professional VOS3000 Setup Support?
For professional VOS3000 installations and deployment, VOS3000 Server Rental Solution:
📱 WhatsApp: +8801911119966
🌐 Website: www.vos3000.com
🌐 Blog: multahost.com/blog
📥 Downloads: VOS3000 Downloads
 | | |
