> For the complete documentation index, see [llms.txt](https://docs.omnileads.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.omnileads.net/english/introduction-to-omnileads.md).
# Introduction to OMniLeads
[OMniLeads](https://www.omnileads.net/) is an innovative, open-source software solution that leverages WebRTC technology to empower contact centers. Designed with versatility in mind, OMniLeads supports a wide range of communication channels, including voice, video, and WhatsApp Chat & Voice, and also includes Collaboration Tools and Text-to-Speech (TTS) for generating custom audio messages.
This makes it an ideal option for organizations looking to manage and implement efficient omnichannel customer service strategies.
Furthermore, it provides metrics, reports and indicators, real-time agent monitoring, back-office audit modules, and other advanced features for QA, contact management, and campaigns.
Having [WebRTC](https://webrtc.org/) technology makes it ideal for handling Voice and Video channels with agents in both onsite and home-office modes, due to the efficiency and cryptographic security that WebRTC technology implies in its default operation when maintaining sessions over the Internet.
On the other hand, administration and management through 100% web access makes it easier to implement an omnichannel strategy with collaborative tools.
Different user profiles (agents, supervisors, administrators, or clients) can access OMniLeads from any modern web browser. Since it doesn't require desktop applications (softphones), there's no need for typical configurations on contact center agents' workstations. Simply by accessing the HTTPS web address where the application resides, both agents and supervisors can be online managing communications with clients. This ease of use represents a significant advantage when providing cloud-based CCaaS (Contact Center as a Service) services.
OMniLeads can adapt to a company or organization that needs to set up its own contact center integrated with its PBX, as well as scale to companies that provide customer contact services (BPO - Business Process Outsourcing), whether in on-premises environments or cloud deployments.
Esquema Básico
### ¿How do i get it?
The [repository](https://gitlab.com/omnileads/omldeploytool) is available on GitLab for free download, installation, modification, and use of the software.
### ¿Cómo lo instalo?
En la sección Instalación de OMniLeads se aborda éste asunto, presentando los pasos a seguir para instalar la aplicación bajo ciertos esquemas que se mencionan en el mismo documento.
### ¿Cómo me capacito?
Ésta documentación cubre todos los aspectos del producto, desde cuestiones técnicas inherentes al Administrador (DevOps), hasta aspectos funcionales orientados a los agentes, supervisores o líderes del Contact Center.
El usuario, entusiasta o empresa afin puede tener acceso a [Trainings Profesionales Sin Costo](https://www.omnileads.net/slides), con el objetivo de profundizar en la materia y know-how del producto.
### Características generales
* [Características generales de OMniLeads](/english/introduction-to-omnileads-1/omnileads-general-specs.md)
* [WebRTC - Tecnología subyacente de OMniLeads](/english/introduction-to-omnileads-1/omnileads-general-specs.md#webrtc-tecnologia-subyacente-de-omnileads)
* [Características y funcionalidades de OMniLeads](/english/introduction-to-omnileads-1/omnileads-general-specs.md#caracteristicas-y-funcionalidades-de-omnileads)
* [OMniLeads como Contact Center integrado a una PBX basada en SIP](/english/introduction-to-omnileads-1/omnileads-general-specs.md#omnileads-como-contact-center-integrado-a-una-pbx-basada-en-sip)
* [OMniLeads en una compañía de servicios de Customer Contact](/english/introduction-to-omnileads-1/omnileads-general-specs.md#omnileads-en-una-compania-de-servicios-de-customer-contact)
* [OMniLeads para carriers o proveedores de cloud PBX](/english/introduction-to-omnileads-1/omnileads-general-specs.md#omnileads-para-carriers-o-proveedores-de-cloud-pbx)
### Arquitectura
En ésta sección, se introduce la arquitectura del proyecto, junto a la descripción de todos sus componentes:
* [Arquitectura y componentes](/english/introduction-to-omnileads-1/architecture-and-components.md)
* [Descripción de cada componente](/english/introduction-to-omnileads-1/architecture-and-components.md#descripcion-de-cada-componente)
* [Deploy y variables de entorno](/english/introduction-to-omnileads-1/architecture-and-components.md#deploy-y-variables-de-entorno)
* [El potencial de acudir a cloud-init como provisioner](/english/introduction-to-omnileads-1/architecture-and-components.md#el-potencial-de-acudir-a-cloud-init-como-provisioner)
### Instalación
En éste capítulo, se cubren todos los tipos de instalación de la aplicación:
* [Instalación de OMniLeads](/english/omnileads-installation-methods.md)
* [Deploy de OMniLeads OnPremise](/english/omnileads-installation-methods.md#deploy-de-omnileads-onpremise)
* [Deploy de OMniLeads OnPremise Alta Disponibilidad](/english/omnileads-installation-methods.md#deploy-de-omnileads-onpremise-alta-disponibilidad)
* [Deploy de OMniLeads sobre DigitalOcean](/english/omnileads-installation-methods.md#deploy-de-omnileads-sobre-digitalocean)
* [Deploy de OMniLeads basado en Terraform](/english/omnileads-installation-methods.md#deploy-de-omnileads-basado-en-terraform)
### Seguridad
En ésta sección, se plantean las configuraciones mínimas a realizar para que la aplicación se ejecute en un marco de seguridad mínima recomendada:
* [Consideraciones sobre seguridad](/english/security-considerations.md)
### Configuración inicial
En éste capítulo, se plantean las configuraciones escenciales a realizar una vez que dejamos instalada una instancia de OMniLeads:
* [Configuración inicial](/english/initial-configuration.md#configuracion-inicial)
* [Roles y permisos](/english/initial-configuration.md#roles-y-permisos)
* [Usuarios](/english/initial-configuration.md#usuarios)
* [Grupos de agentes](/english/initial-configuration.md#grupos-de-agentes)
* [Adicionar paquetes de audios en otros idiomas](/english/initial-configuration.md#adicionar-paquetes-de-audios-en-otros-idiomas)
* [Música de espera](/english/initial-configuration.md#musica-de-espera)
* [Pausas](/english/initial-configuration.md#pausas)
* [Primer login de agente](/english/initial-configuration.md#primer-login-de-agente)
* [Registro de la instancia](/english/initial-configuration.md#registro-de-la-instancia)
* [Addons comerciales disponibles](/english/initial-configuration.md#addons-comerciales-disponibles)
### Campañas
Toda comunicación entre «el exterior» y un agente de OMniLeads, es encapsulado dentro de una campaña. En éste capítulo, se aborda todo lo inherente a la gestión de campañas entrantes y salientes (manuales, preview y dialer):
* [Campañas telefónicas](/english/contact-campaigns.md)
* [Calificaciones](/english/contact-campaigns.md#calificaciones)
* [Base de contactos](/english/contact-campaigns.md#base-de-contactos)
* [Configuración de restricciones sobre campos de contactos](/english/contact-campaigns.md#configuracion-de-restricciones-sobre-campos-de-contactos)
* [Formularios](/english/contact-campaigns.md#formularios)
* [Campañas, calificaciones y formularios](/english/contact-campaigns.md#campanas-calificaciones-y-formularios)
* [Campañas manuales](/english/contact-campaigns.md#campanas-manuales)
* [Campañas preview](/english/contact-campaigns.md#campanas-preview)
* [Campañas con Discador](/english/contact-campaigns.md#campanas-con-discador-predictivo)
* [Campañas entrantes](/english/contact-campaigns.md#campanas-entrantes)
* [Plantillas de campaña](/english/contact-campaigns.md#plantillas-de-campana)
* [Interacción con sistemas de gestión externos](/english/contact-campaigns.md#interaccion-con-sistemas-de-gestion-externos)
### Auditoría de gestiones de agentes
Cada vez que un agente genera una *gestión positiva* con un contacto, existe la posibilidad de auditar la misma desde el *módulo de auditorías*:
* [Auditoría de gestiones (backoffice)](/english/backoffice-management-audit.md)
### Gestiones del administrador IT
En éste capítulo, se cubren algunas tareas inherentes al administrador técnico de OMniLeads. Cuestiones como la configuración de bajo nivel del módulo de discador predictivo, gestión de actualizaciones, backup and restore, y cambio de dirección IP de la plataforma, son tratadas en éste capítulo de la documentación:
* [Gestiones del administrador IT](/english/it-administrators-tasks.md)
* [Variables de entorno](/english/it-administrators-tasks.md#variables-de-entorno)
* [Configuración del módulo de *Discador predictivo*](/english/it-administrators-tasks.md#configuracion-del-modulo-de-discador-predictivo)
* [Cambiar certificados SSL](/english/it-administrators-tasks.md#cambiar-certificados-ssl)
* [Resetear contraseña web de admin](/english/it-administrators-tasks.md#resetear-contrasena-web-de-admin)
* [Backup & Restore](/english/it-administrators-tasks.md#backup-restore-de-base-de-datos)
* [Actualizaciones](/english/it-administrators-tasks.md#actualizaciones)
* [Cambios de los parámetros de red (Hostname y/o Dirección IP) y cambios de contraseñas de servicios](/english/it-administrators-tasks.md#cambios-de-los-parametros-de-red-hostname-y-o-direccion-ip-y-cambios-de-contrasenas-de-servicios)
* [Desbloqueo de usuarios](/english/it-administrators-tasks.md#desbloqueo-de-usuarios)
* [Recovery & Takeover nodo PostgreSQL HA](/english/it-administrators-tasks.md#recovery-and-takeover-nodo-postgresql-ha)
* [Desinstalación de OMniLeads](/english/it-administrators-tasks.md#desinstalacion-de-omnileads)
### OMniLeads RESTful API
En ésta sección, se puede encontrar todas las especificaciones de la API Rest del sistema:
* [OMniLeads RESTful API](/english/omnileads-restful-api.md)
* [Endpoint de Login](/english/omnileads-restful-api.md#endpoint-de-login)
* [Endpoint obtener estructura de Base de Datos de Contactos](/english/omnileads-restful-api.md#endpoint-obtener-estructura-de-base-de-datos-de-contactos)
* [Endpoint creacion de contacto](/english/omnileads-restful-api.md#endpoint-creacion-de-contacto)
* [Endpoint de Generación de llamadas](/english/omnileads-restful-api.md#endpoint-de-generacion-de-llamadas)
* [Endpoint listado de opciones de calificación](/english/omnileads-restful-api.md#endpoint-listado-de-opciones-de-calificacion)
* [Endpoint listado de calificaciones](/english/omnileads-restful-api.md#endpoint-listado-de-calificaciones)
* [Endpoint crear nueva calificación](/english/omnileads-restful-api.md#endpoint-crear-nueva-calificacion)
* [Endpoint crear nuevo contacto y asignarle calificación](/english/omnileads-restful-api.md#endpoint-crear-nuevo-contacto-y-asignarle-calificacion)
* [Endpoint para modificar una calificación existente](/english/omnileads-restful-api.md#endpoint-para-modificar-una-calificacion-existente)
* [API de Sesión de Agente en Asterisk](/english/omnileads-restful-api.md#api-de-sesion-de-agente-en-asterisk)
* [Endpoint para obtener las credenciales SIP de Agente](/english/omnileads-restful-api.md#endpoint-para-obtener-las-credenciales-sip-de-agente)
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.omnileads.net/english/introduction-to-omnileads.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.