OMniLeads

https://docs.omnileads.net
Admin
OMniLeads is an open-source contact center platform that enables organizations to manage outbound...
Tokens:67,070
Snippets:891
Trust Score:7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Query Documentation API Example

Source: https://docs.omnileads.net/video-llamadas-pro/webphone-demo.md

Example of how to query the documentation dynamically using an HTTP GET request with 'ask' and optional 'goal' parameters.

```http
GET https://docs.omnileads.net/video-llamadas-pro/webphone-demo.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation Example

Source: https://docs.omnileads.net/instalacion-de-omnileads/deploy-utilizando-docker.md

Example of how to query the documentation dynamically using an HTTP GET request. This is useful for retrieving information not explicitly present on the current page.

```http
GET https://docs.omnileads.net/instalacion-de-omnileads/deploy-utilizando-docker.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Set up and Run OMniLeads Test Environment

Source: https://docs.omnileads.net/instalacion-de-omnileads/deploy-utilizando-docker.md

This example shows how to set up and run the 'test-env' Docker Compose environment for local testing. It involves copying an example .env file, navigating to the environment directory, starting the services, and initializing the environment.

```bash
$ cp env test-env/.env
$ cd test-env
$ docker-compose up -d
$ ../oml_manage --reset_pass
$ ../oml_manage --init_env
```

--------------------------------

### Install Flask and Run Webphone Demo

Source: https://docs.omnileads.net/video-llamadas-pro/webphone-demo.md

Install necessary Python packages and run the Flask development server locally. Ensure you are in the 'demo/' directory.

```bash
$ pip install Flask
$ pip install pyopenssl
$ cd demo/
$ FLASK_APP=webphone.py FLASK_DEBUG=1 flask run --cert=adhoc
```

--------------------------------

### Create Instance Directory and Copy Inventory

Source: https://docs.omnileads.net/instalacion-de-omnileads/deploy-utilizando-ansible/deploy-en-aio-all-in-one.md

Creates the 'instances' directory and a subdirectory for the on-premise deployment, then copies the example inventory file.

```bash
mkdir instances
mkdir instances/onpremise_oml
cp inventory.yml instances/onpremise_oml
```

--------------------------------

### Executing OmniLeads Tenant Installation

Source: https://docs.omnileads.net/instalacion-de-omnileads/deploy-utilizando-ansible/deploy-en-ha-high-availability.md

Command to initiate the installation of a new OmniLeads tenant using the deploy script. This command specifies the action to perform and the target tenant.

```bash
./deploy.sh --action=install --tenant=omlclusterha

```

--------------------------------

### Execute OMniLeads Installation

Source: https://docs.omnileads.net/instalacion-de-omnileads/deploy-utilizando-ansible/deploy-en-aio-all-in-one.md

Runs the Ansible deployment script to install a new tenant, specifying the action and the tenant's directory.

```bash
./deploy.sh --action=install --tenant=onpremise_oml
```

--------------------------------

### Example Docker Volume Mapping in `docker-compose.yml`

Source: https://docs.omnileads.net/instalacion-de-omnileads/deploy-en-entornos-de-desarrollo.md

This example shows how the Django code is mapped into the application container using a volume. Ensure the `REPO_PATH` environment variable is correctly set to your local repository path.

```yaml
volumes:
  - ${REPO_PATH}/omlapp/:/opt/omnileads/ominicontacto/
```

--------------------------------

### Start OMniLeads with Docker Compose

Source: https://docs.omnileads.net/instalacion-de-omnileads/deploy-utilizando-docker/deploy-en-docker-destkop.md

Execute this command to start all OMniLeads services defined in your docker-compose.yml file in detached mode.

```bash
$ docker-compose up -d
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.omnileads.net/instalacion-de-omnileads/deploy-en-entornos-de-desarrollo.md

Perform an HTTP GET request to the current page URL with `ask` and optional `goal` query parameters to dynamically query the documentation. This is useful for getting answers not explicitly present on the page.

```http
GET https://docs.omnileads.net/instalacion-de-omnileads/deploy-en-entornos-de-desarrollo.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Execute OMniLeads Installation

Source: https://docs.omnileads.net/instalacion-de-omnileads/deploy-utilizando-ansible/deploy-en-ait-all-in-three.md

Runs the Ansible deployment script to install the OMniLeads tenant. This command initiates the deployment process after the inventory is configured.

```bash
./deploy.sh --action=install --tenant=omlcluster
```

--------------------------------

### Create Instances Directory and Copy Inventory

Source: https://docs.omnileads.net/instalacion-de-omnileads/deploy-utilizando-ansible/deploy-en-ha-high-availability.md

This command sequence prepares the deployment environment by creating an 'instances' directory and a subdirectory for the HA cluster configuration. It then copies the example inventory file into the newly created directory.

```bash
mkdir instances
mkdir instances/omlclusterha
cp inventory.yml instances/omlclusterha
```

--------------------------------

### Create Instance Directories and Copy Inventory

Source: https://docs.omnileads.net/instalacion-de-omnileads/deploy-utilizando-ansible/deploy-en-ait-all-in-three.md

Creates the necessary directories for OMniLeads instances and copies the example inventory file. This is the first step in setting up a new deployment.

```bash
mkdir instances
mkdir instances/omlcluster
cp inventory.yml instances/omlcluster
```

--------------------------------

### Initialize Environment with Testing Data

Source: https://docs.omnileads.net/instalacion-de-omnileads/first-login.md

This script generates initial data, such as agents and test campaigns, to expedite the environment setup for testing purposes.

```bash
./oml_manage --init_env
```

--------------------------------

### Query Documentation API

Source: https://docs.omnileads.net/manual-de-agente/llamadas-preview.md

Use this GET request to query the documentation dynamically. Include your question in the 'ask' parameter and an optional broader goal in the 'goal' parameter.

```http
GET https://docs.omnileads.net/manual-de-agente/llamadas-preview.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Omnileads Documentation

Source: https://docs.omnileads.net/instalacion-de-omnileads/first-login.md

Perform an HTTP GET request to query the documentation dynamically. Use the 'ask' parameter for your question and optionally 'goal' for broader context.

```http
GET https://docs.omnileads.net/instalacion-de-omnileads/first-login.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Display Deploy Script Help

Source: https://docs.omnileads.net/instalacion-de-omnileads/deploy-utilizando-ansible.md

View the available options and usage instructions for the deploy script. This command helps understand how to parameterize deployment actions.

```bash
./deploy.sh --help
```

--------------------------------

### Execute Initial Development Environment Deployment Script

Source: https://docs.omnileads.net/instalacion-de-omnileads/deploy-en-entornos-de-desarrollo.md

Run the `deploy.sh` script once to set up the development environment. Specify the host OS and the Git clone method (SSH or HTTPS).

```bash
$ ./deploy.sh --os_host= --gitlab_clone=
```

--------------------------------

### Example CRM Response for Call Routing

Source: https://docs.omnileads.net/campanas-de-contacto/campana-entrante/identificacion-de-llamada-entrante.md

This example shows a CRM response directing a call to an incoming campaign. '1' signifies an incoming campaign, and '3' is the specific ID of that campaign (e.g., 'clientes bronce').

```json
{
  "status": "ok",
  "destination": "1,3"
}
```

--------------------------------

### Acceder al CLI de Asterisk en OMniLeads (Docker)

Source: https://docs.omnileads.net/integracion-entre-omnileads-y-pbxs.md

Comando para ejecutar el CLI de Asterisk dentro del contenedor Docker de OMniLeads.

```bash
docker exec -it oml-asterisk-prodenv
```

--------------------------------

### Execute Upgrade

Source: https://docs.omnileads.net/instalacion-de-omnileads/deploy-utilizando-ansible/migracion-desde-centos7.md

Run the deploy script with the 'upgrade' action to complete the migration process.

```bash
./deploy.sh --action=upgrade --tenant=$your_inventory_folder_name
```

--------------------------------

### Get Contact Database Structure

Source: https://docs.omnileads.net/

Retrieves the structure of the contact database.

```APIDOC
## Get Contact Database Structure

### Description
Fetches the schema and structure of the contact database.

### Method
GET

### Endpoint
/contacts/structure
```

--------------------------------

### Ejemplo de Petición GET para Consultar Documentación

Source: https://docs.omnileads.net/configuracion-whatsapp-business/integracion-con-gupshup/dar-de-alta-whatsapp-business-en-gupshup.md

Para obtener información adicional o aclaraciones no presentes directamente en la página, realice una petición GET a la URL de la página con los parámetros `ask` y opcionalmente `goal`.

```HTTP
GET https://docs.omnileads.net/configuracion-whatsapp-business/integracion-con-gupshup/dar-de-alta-whatsapp-business-en-gupshup.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Download and Execute OMniLeads Deploy Script

Source: https://docs.omnileads.net/instalacion-de-omnileads/deploy-utilizando-docker/deploy-en-docker-para-vps-cloud-o-vm.md

Use this command to download the deploy script and make it executable. It sets up the OMniLeads environment on your server. Ensure DOCKER_ENGINE_IPV4 is set to your server's IP address.

```bash
$ curl -o deploy.sh -L "https://gitlab.com/omnileads/omldeploytool/-/raw/main/docker-compose/prod-env/deploy.sh?ref_type=heads" && chmod +x deploy.sh
$ export DOCKER_ENGINE_IPV4=X.X.X.X && ./deploy.sh
```

--------------------------------

### Get Agent SIP Credentials

Source: https://docs.omnileads.net/omnileads-restful-api-pro.md

Retrieve SIP credentials for agent authentication with a WebPhone. Requires the Omnileads address.

```http
GET https://<omnileads_addr>/api/v1/sip/credentials/agent/
```

--------------------------------

### Get Agent SIP Credentials

Source: https://docs.omnileads.net/omnileads-restful-api-pro.md

Retrieve the SIP credentials required for an agent to authenticate with the SIP server, typically used by a WebPhone.

```APIDOC
## GET /api/v1/sip/credentials/agent/

### Description
Provides the necessary SIP credentials for an agent to authenticate with the SIP server, enabling WebPhone functionality.

### Method
GET

### Endpoint
/api/v1/sip/credentials/agent/

### Response
#### Success Response (200)
Returns an object containing the agent's SIP credentials.
```

--------------------------------

### Get Agent Status List by Campaign

Source: https://docs.omnileads.net/omnileads-restful-api-pro.md

Provides a list of agents within a campaign, detailing each agent's current status.

```APIDOC
## GET api/v1/agent_status_list/campaign/<int:campaign_id>

### Description
Retrieves a list of agents and their current statuses for a specified campaign.

### Method
GET

### Endpoint
api/v1/agent_status_list/campaign/<int:campaign_id>

### Parameters
#### Path Parameters
- **campaign_id** (Number) - Required - Campaign unique ID

#### Headers
- **Authorization** (Bearer) - Required - Bearer xxxxx

### Response
#### Success Response (200)
- **name** (String) - Agent's name
- **status** (String) - Agent's status

### Response Example
```json
[
  {
    "name": "Kirk Mccall",
    "status": "OFFLINE"
  },
  {
    "name": "Kimberly Leonard",
    "status": "PAUSE"
  }
]
```

#### Error Responses
- **404 CampanaNotFound**: The `campaign_id` of the Campana was not found.
- **403 Forbidden**: Authentication credentials were not provided.
- **500 InternalServerError**: The server encountered an internal error.
```

--------------------------------

### Initialize Development Environment with Test Data

Source: https://docs.omnileads.net/instalacion-de-omnileads/deploy-en-entornos-de-desarrollo.md

Execute this command to populate your development environment with initial test data. This is helpful for testing features without manual data entry.

```bash
./manage.sh --init_env
```

--------------------------------

### Get Call Status by Campaign

Source: https://docs.omnileads.net/omnileads-restful-api-pro.md

Fetches the counts of attended, abandoned, and expired calls for a given campaign, with optional date filtering.

```APIDOC
## GET api/v1/call_status/campaign/<int:campaign_id>

### Description
Retrieves the status of calls within a specified campaign, including attended, abandoned, and expired counts. Can be filtered by date range.

### Method
GET

### Endpoint
api/v1/call_status/campaign/<int:campaign_id>

### Parameters
#### Path Parameters
- **campaign_id** (Number) - Required - Campaign unique ID

#### Query Parameters
- **date_start** (Date) - Optional - Format YYYY-MM-DD
- **date_end** (Date) - Optional - Format YYYY-MM-DD

#### Headers
- **Authorization** (Bearer) - Required - Bearer xxxxx

### Response
#### Success Response (200)
- **attended** (Number) - Quantity of calls attended
- **abandoned** (Number) - Quantity of calls abandoned
- **expired** (Number) - Quantity of calls expired

### Response Example
```json
{
  "attended": 2,
  "abandoned": 0,
  "expired": 2
}
```

#### Error Responses
- **404 CampanaNotFound**: The `campaign_id` of the Campana was not found.
- **403 Forbidden**: Authentication credentials were not provided.
- **500 InternalServerError**: The server encountered an internal error.
```

--------------------------------

### Verificar Troncal SIP con Asterisk CLI

Source: https://docs.omnileads.net/integracion-entre-omnileads-y-pbxs.md

Comando para verificar la accesibilidad de los endpoints SIP desde el CLI de Asterisk en OMniLeads. Si OMniLeads corre en Docker, acceda primero al contenedor Asterisk.

```bash
asterisk -rx 'pjsip show endpoints'
```

--------------------------------

### Display oml_manage Script Help

Source: https://docs.omnileads.net/instalacion-de-omnileads/first-login.md

Use this command to view the available administrative actions and options provided by the oml_manage script.

```bash
./oml_manage --help
```

--------------------------------

### Get Agent Status by Campaign

Source: https://docs.omnileads.net/omnileads-restful-api-pro.md

Retrieves the current status counts for agents within a specific campaign, including agents ready, on call, and in pause.

```APIDOC
## GET api/v1/agent_status/campaign/<int:campaign_id>

### Description
Retrieves the real-time status of agents within a specified campaign.

### Method
GET

### Endpoint
api/v1/agent_status/campaign/<int:campaign_id>

### Parameters
#### Path Parameters
- **campaign_id** (Number) - Required - Campaign unique ID

#### Headers
- **Authorization** (Bearer) - Required - Bearer xxxxx

### Response
#### Success Response (200)
- **ready** (Number) - Quantity of agents in ready state
- **oncall** (Number) - Quantity of agents on a call
- **pause** (Number) - Quantity of agents in pause

### Response Example
```json
{
  "ready": 2,
  "oncall": 0,
  "pause": 2
}
```

#### Error Responses
- **404 CampanaNotFound**: The `campaign_id` of the Campana was not found.
- **403 Forbidden**: Authentication credentials were not provided.
- **500 InternalServerError**: The server encountered an internal error.
```
Tokens:
Raw