LiraX API para telefonía

Información general sobre las API#

API le permite conectar cualquiera de sus productos de software (SPP) a LiraX.

La integración con LiraX resuelve varios problemas empresariales:

obtener el nombre de la persona que llama a partir de su número de teléfono;
obtener el número de gerente asignado al cliente;
mostrar información sobre una llamada entrante directamente dentro de la solicitud de propuestas (RFP);
guardar el historial de todas las llamadas y los enlaces a las grabaciones de las conversaciones dentro del WPP;
crear un contacto:
Crear una tarea para un contacto y un gerente;
Crear una nota para un contacto;
Creación de un acuerdo de contacto;
Actualización del acuerdo
realizar llamadas salientes directamente desde la interfaz RPP.

La integración debe ser bidireccional. Por lo tanto, algunas de las solicitudes que LiraX envía al RPP se dirigen a los puntos de entrada especificados, y otras, por el contrario, las envía el RPP a LiraX hacia un único punto de entrada.

La interacción se realiza mediante el protocolo HTTPS. La autorización se lleva a cabo en la dirección LiraX o VPP, respectivamente, utilizando la clave de autorización obtenida durante el proceso de configuración de la integración.

Principio de autorización e interacción#

HTTPS:

Las solicitudes a LiraX solo se aceptan a través de HTTPS. Esto proporciona un nivel de seguridad suficiente para que los sistemas interactúen a través de Internet.
З para garantizar la seguridad de sus datos, implemente también la aceptación de solicitudes en el lado de WPP utilizando HTTPS.

Clave (token):

Además, se utiliza una clave especial (token) para autorizar cada solicitud a LiraX. Puede obtenerla en la configuración de integración.
Implemente también la aceptación de solicitudes en WPP mediante una clave (token). Genere la clave y péguela en el campo correspondiente en la sección de configuración de la integración.
Las claves se crean una sola vez al configurar la integración. Si es necesario, puede cambiar la clave por su cuenta y actualizarla en la interfaz de LiraX.

Solicitudes de LiraX al PMA:

Las solicitudes deben enviarse a la dirección especificada en la configuración de integración para la recepción de mensajes, por ejemplo, https://dominio/LiraX.
En el cuerpo de la solicitud, siempre debe pasar una clave especial en el campo especial "token".
Las solicitudes se envían en el formato aplicación/x-www-form-urlencoded

Solicitudes del PMA a LiraX:

El PMA deberá enviar todas las solicitudes a la dirección especificada en la configuración de integración.
En el cuerpo del mensaje, el VPP debe transmitir la clave (token) que usted especificó en el gabinete web.
Las solicitudes se envían en el formato aplicación/x-www-form-urlencoded

Respuestas

Todas las respuestas a las solicitudes de LiraX deben ser enviadas por el PMA en formato JSON en el cuerpo de la respuesta.
LiraX envía todas las respuestas a las solicitudes WPP en formato JSON en el cuerpo de la respuesta.

Lista de comandos de la API#

De la pista de aterrizaje a LiraX:

makeCall (POST, GET)
killCall (POST, GET)
make2Calls (POST)
AskQuestion (POST)
AddTag (POST)
DelTag (POST)
get_sip_route_in (POST)
set_sip_route_in (POST)
getUserSips (POST)
IsFreeUsers (POST)
IsCalling (POST)
AddCampaign (POST)
AddPhoneCampaign (POST)
checkContact (POST)
getContact (POST)
getStatInfo (POST)
createTask (POST)
AddTaskResult (POST)
GetTask (POST)
createNote (POST)
createDeal (POST)
updateDeal (POST)
addBlackPhone (POST, GET)
addBlackIP (POST, GET)
getStages (POST)
getShops (POST)
getUserStatuses (POST)
getUsers (POST)
initStatuses (POST)
sendMsg (POST)
send_cloud_message (POST)
sendSMS (POST)
checkSMS (POST)
EncodePhone (POST)
DecodePhone (POST)
set_call_lost (POST)
get_makecall_data(POST)
get_calls
set_webhook
Descargar historial de llamadas

De LiraX a la pista de aterrizaje:

staton (POST)
smsDelivered (POST)
smsReceived (POST)
contact (POST)
event (POST)
record (POST)

*Todas las solicitudes con Content-Type: application/x-www-form-urlencoded

Comandos de la API y ejemplos de scripts disponibles#

Equipos desde WPP hasta LiraX#

makeCall#

Se requiere este comando para iniciar una llamada del administrador al cliente. Tras la correcta ejecución del comando, LiraX primero llamará al teléfono del administrador y luego lo conectará con el cliente.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso hacerLlamada	string
from	número corto del empleado que realiza la llamada saliente	string
to	número al que se realiza la llamada saliente	string
token	token de LiraX configurado en los ajustes de integración.	string
idshop	Parámetro opcional que especifica el ID de la tienda desde la que se realizará la llamada.	integer	(La lista de identificadores se puede obtener utilizando la función GetShops)

Ejemplo de consulta:

POST https://api.lirax.net/general

cmd=makeCall
from=101
to=19101234567
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200	{"id_makecall":"$id_makecall"}	OK, $id_makecall – se utiliza al recibir el webhook makecall_finished.
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

killCall#

Este comando es necesario para finalizar de forma forzosa una llamada de un gerente a un cliente.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos
cmd	el tipo de operación, en este caso killCall	string
Call_id	id llamada recibida en el evento makecall_finished	string
token	token de LiraX configurado en los ajustes de integración.	string

Ejemplo de consulta:

POST https://api.lirax.net/general

cmd=killCall
Call_id=101234234234s3
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200		OK
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

make2Calls#

Se necesita este comando para conectar a dos suscriptores. Tras la ejecución exitosa del comando, LiraX primero llamará al teléfono to1 y luego lo conectará a to2. Se necesita el parámetro "from" para el correcto enrutamiento de llamadas.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso make2Calls	string
from	número corto del empleado en cuyo nombre se realizan las llamadas salientes.	string
to1	número al que se realiza la primera llamada	string
to2	el número al que se realiza la segunda llamada o la URL del archivo de audio (mp3, wav) en caso de que solo necesite reproducir el archivo de audio	string
speech	El texto que se debe decir después de descolgar el teléfono to1. El texto debe constar del código de idioma ("uk", "en", "ru") y el texto en sí.	string	Opcional
atempo	Parámetro opcional que especifica la velocidad de reproducción de 0,5 a 2,0.	string	Opcional
timeout	Tiempo en minutos (si es superior a 10, se repetirán los intentos cada 10 minutos hasta que ambos suscriptores contesten el teléfono). Valor predeterminado: 0 – solo un intento.	string	Opcional
successtime	Tiempo en segundos: cuántos segundos debe durar la conversación para considerarse exitosa. Valor predeterminado: 0	string	Opcional
notbefore	Hora en horas: hasta qué hora no se puede llamar. El valor predeterminado es 08.	string	Opcional
notafter	Tiempo en horas: después de qué hora no se puede llamar, valor predeterminado 20	string	Opcional
try	Número de intentos de devolver la llamada a la primera parte con un intervalo de 10 minutos.	integer	Opcional, valor predeterminado = 1
vtime	Hora en horas y minutos – hh:mm. Este parámetro se puede utilizar para IVR.	string	Opcional
vdate	Fecha: ”dd.mm.AAAA”, “hoy” o “mañana”. Este parámetro se puede utilizar para IVR.	string	Opcional
vmoney	El valor de la cantidad de dinero es un número decimal de tipo 0.00 con dos dígitos después del punto. Este parámetro se puede utilizar para IVR.	string	Opcional
token	token de LiraX configurado en los ajustes de integración.	string
idshop	Parámetro opcional que especifica el ID de la tienda desde la que se realizará la llamada.	integer	(La lista de identificadores se puede obtener utilizando la función GetShops)
FirstInternal	Parámetro opcional que indica que la primera pata es una llamada interna si =1	integer	Opcional
SecondInternal	Parámetro opcional que indica que la segunda parte es una llamada interna si =1	integer	Opcional
SpeechNoWait	El parámetro opcional, si es igual a 1, especifica que se reproduce voz en lugar de pitidos al llamar a la parte 2.	integer	Opcional

Ejemplo de consulta:

POST https://api.lirax.net/general

cmd=make2Calls
from=101
to1=19101234561
to2=19101234567
speech=en Hello Customer
timeout=60
successtime=30
notbefore=18
notafter=21
token=202cb962ac59075b964b07152d234b70
cmd=make2Calls
from=201
to1=19101234567
to2=https://www.test.mp3/tttt.mp3
timeout=60
successtime=30
notbefore=18
notafter=21
try=4
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200	{"id_make2calls":"$id_make2calls"}	OK, $id_make2calls – se utiliza al recibir el webhook make2calls_finished.
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

AskQuestion#

Se necesita este comando para hacerle una pregunta al suscriptor y obtener una respuesta. Tras la ejecución exitosa del comando, LiraX primero realizará una llamada al teléfono to1 y luego reproducirá el saludo "hola". Si es necesario, se pueden reproducir hasta 4 mensajes adicionales ("texto1-4") en el idioma seleccionado (se requieren pausas si es necesario). A continuación, se reproduce la pregunta. Si la opción de reconocimiento de voz está activada, se espera la respuesta correcta ("ok"). Si no hay reconocimiento, se espera que se presione el botón. "From" es necesario para el enrutamiento correcto de la llamada. La reacción es similar al comando make2calls.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos
cmd	el tipo de operación, en este caso Preguntar	string
from	número corto del empleado en cuyo nombre se realizan las llamadas salientes.	string
to1	número al que se realiza la primera llamada	string
token	token de LiraX configurado en los ajustes de integración.	string
hello	Parámetro opcional; la frase debe ser un saludo (como Felicitaciones).	string
text1	Parámetro opcional, Mensaje 0	string
text2	Parámetro opcional, Mensaje 0	string
text3	Parámetro opcional, Mensaje 0	string
text4	Parámetro opcional, Mensaje 0	string
bye	El parámetro opcional, Mensaje de despedida, funciona después de la pregunta.	string
ask	Informar de una pregunta	String
ok	Palabras entre espacios que esperamos recibir como respuesta positiva (por ejemplo: sí, de acuerdo).	String
cburl	Parámetro opcional, URL para el webhook con el mensaje make2calls_finished, que transmite datos con la respuesta del suscriptor.	String

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=AskQuestion
from=101
cburl=https://mydomain.co/
to1=19101234561
token=202cb962ac59075b964b07152d234b70
hello=ru Felicidades
text1=ru Se ofrece un nuevo servicio.
ask=ru Si lo quieres, dilo.
ok=ru ojalá.
bye=ru Adiós

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200	{"id_make2calls":"$id_make2calls"}	OK, $id_make2calls – se utiliza al recibir el webhook make2calls_finished.
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

AddTag#

El equipo añade una etiqueta al contacto.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso AddTag	string
ani	número de teléfono de contacto	string	Opcional
tag	etiqueta	string	Opcional
token	token de LiraX configurado en los ajustes de integración.	string

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=AddTag
ani=19101234567
tag=OK
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200		OK
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

DelTag#

Este comando elimina una etiqueta de un contacto.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso DelTag	string
ani	número de teléfono de contacto	string	Opcional
tag	etiqueta	string	Opcional
token	token de LiraX configurado en los ajustes de integración.	string

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=DelTag
ani=19101234567
tag=OK
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200		OK
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

get_sip_route_in#

Este comando es necesario para definir una lista de números SIP para la extensión telefónica.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso get_sip_route_in	string
token	token de LiraX configurado en los ajustes de integración.	string
phone	Número interno	string	Ejemplo: 302

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=get_sip_route_in
phone=302
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200	{ "N":2, "description":"route_in_sip. ", "results":[ { "sip_name":"Test", "sip_number":"1115", "user_name":"User", "ext":"222", "priority":"0", "time_plan":"1" }, { "sip_name":"Test1", "sip_number":"1156", "user_name":"User1", "ext":"223", "priority":"0", "time_plan":"1" } ] }	OK, si no hay números SIP obtendremos “N”:0, N número de números SIP, sip_name nombre SIP, sip_number – número SIP, user_name – Nombre de usuario, ext – número de extensión del usuario, priority – prioridad SIP actual, time_plan – id plan semanal (trabajo=1, tarde=2, noche=3, vacaciones=4)
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.
402		Error interno

set_sip_route_in#

Se necesita este comando para establecer la prioridad del número SIP para el número de extensión telefónica.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso set_sip_route_in	string
token	token de LiraX configurado en los ajustes de integración.	string
phone	Número interno	string	Ejemplo: 302
sip_number	número SIP	string	Ejemplo: 1115
time_plan	id plan semanal (trabajo=1, tarde=2, noche=3, vacaciones=4)	string	Ejemplo: 1
priority	prioridad SIP para el número de extensión	string	Ejemplo: 1

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=set_sip_route_in
phone=302
sip_number=1115
priority=0
time_plan=1
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200	{"result":"1"}	OK, si la actualización es exitosa, el resultado es 1; si no hay actualización, el resultado es 0.
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.
402		Error interno

getUserSips#

El comando es necesario para determinar si hay teléfonos disponibles para la extensión.

El equipo almacena los datos en caché y los actualiza una vez por hora.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso getUserSips	string
token	token de LiraX configurado en los ajustes de integración.	string
ext	Número interno	string	Ejemplo: 302
web	Si se establece en > 0, solo se devuelven los teléfonos web.	integer	Opcional

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=getUserSips
ext=302
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200	{"user_sips":[{"phone":"10000", "user_id":"1111", "ext":"302"}]}	OK, si no hay sorbos disponibles, los obtendremos. {"user_sips":[]}
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

IsFreeUsers#

Este comando es necesario para determinar si un usuario de un teléfono web puede contestar una llamada.

El comando comprueba: - si el teléfono web está encendido; - si no hay conversación con el usuario y devuelve el primer número libre.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	el tipo de operación, en este caso IsFreeUsers	string
token	token de LiraX configurado en los ajustes de integración.	string
phones	Lista de números de teléfono internos o SIP	string	Ejemplo: 1212121, 1212123, 302
amo	Si se establece en 1, entonces los números se utilizan como amocrm user_id	string	Opcional

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=IsFreeUsers
Phones=1212121,1212123,302
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200	{"result":"phoneFromPhones", "sip":"sip_number", "ext":"number"}	OK, si todos los números están ocupados, recibiremos {"result":null}
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

IsCalling#

El comando comprueba si existe una conversación con un número SIP y devuelve el primer número sin conversación (verifica el registro).

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	el tipo de operación, en este caso IsFreeUsers	string
token	token de LiraX configurado en los ajustes de integración.	string
phones	Lista de números de teléfono internos o SIP	string	Ejemplo: 1212121, 1212123

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=IsCalling
Phones=1212121,1212123
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200	{"result":"phoneFromPhones", "ext":"number"}	OK, si todos los números están ocupados, recibiremos {"result":null}
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

AddCampaign#

Este comando es necesario para crear o configurar una campaña para llamar a los suscriptores o enviarles SMS.

Al llamar a los suscriptores, la llamada primero se dirige al usuario y luego al suscriptor.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	el tipo de operación, en este caso AddCampaign	string
from	número corto del empleado en cuyo nombre se está llevando a cabo la campaña.	string
ext	número corto del empleado, en el que los empleados recibirán la llamada (por defecto es igual a from)	string	Opcional
days	Lista de días (0-domingo, 6-sábado)	string	Predeterminado: 1, 2, 3, 4, 5
time	Intervalo de tiempo	string	Predeterminado: 10:00-18:00
pdd	Tiempo de posprocesamiento (segundos)	integer	Predeterminado: 5
preview_timeout	Retraso en las llamadas salientes después de que el empleado contesta el teléfono (valor predeterminado: 0)	integer	Opcional
try	número de intentos	integer	Predeterminado: 1
token	token de LiraX configurado en los ajustes de integración.	string
type	Tipo de campaña: 1 - Teléfono, 2 - SMS	integer	Predeterminado: 1
phones	Lista de números de teléfono (si la lista está vacía, la campaña se detiene).	string	Ejemplo: 12121234567, 12121234568
message	Texto del mensaje, para type=1 la primera palabra debe ser idioma {en, uk, ru, …} (en este caso, primero se llamará al suscriptor y se ignora preview_timeout)	string	Requerido para tipo=2
idshop	Parámetro opcional que especifica el ID de la tienda desde la que se realizará la llamada.	integer	Opcional (la lista de identificadores se puede obtener con la función GetShops).

Nota: Para type=1, el número de llamadas simultáneas se define en la configuración de la campaña en la cuenta del usuario.

En el modo de vista previa, la llamada se dirige primero al usuario y luego al suscriptor, mientras que con message!=NULL ocurre lo contrario.

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=AddCampaign
from=101
days=1,2
time=10:00-11:00
timeout=60
pdd=30
try=2
idshop=2
type=2
message=Hello
Phones=12121234567,12121234568,12121234569
token=202cb962ac59075b964b07152d234b70
o
cmd=AddCampaign
from=101
days=1,2
time=10:00-11:00
timeout=60
pdd=30
try=2
idshop=2
type=1
message=en Hello
Phones=12121234567,12121234568,12121234569
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200		OK
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

AddPhoneCampaign#

Este comando es necesario para añadir números de teléfono a una campaña para llamar a los suscriptores o enviarles mensajes SMS.

al llamar a los suscriptores, la llamada primero va al usuario y luego al suscriptor para el modo de vista previa, con message!=NULL ocurre lo contrario.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso AddPhoneCampaign	string
from	número corto del empleado en cuyo nombre se está llevando a cabo la campaña.	string
token	token de LiraX configurado en los ajustes de integración.	string
phones	Lista de números de teléfono	string	Ejemplo: 12121234567, 12121234568

Ejemplo de consulta:

POST https://api.lirax.net/general

cmd=AddPhoneCampaign
from=101
Phones=12121234567,12121234568,12121234569
token=202cb962ac59075b964b07152d234b70

checkContact#

Este comando es necesario para crear un contacto nuevo o actualizar uno existente; se actualizan el nombre del contacto y el empleado responsable.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso checkContact	string
ext	número corto del empleado responsable del contacto	string
ani	Número de teléfono principal del contacto	string
name	nombre de contacto	string
add_phone	Lista de teléfonos adicionales	string	Opcional
emails	Lista de correo electrónico	string	Opcional
token	token de LiraX configurado en los ajustes de integración.	string
trackid	Google tracking id for site	string	Opcional
clientid	Google Client id	string	Opcional
sitename	Nombre del sitio	string	Opcional
source	Fuente	string	Opcional
stype	Tipo de fuente (Medio	string	Opcional
campain	Campaña	string	Opcional
Term	Palabra clave	string	Opcional
tag	Etiqueta (la etiqueta se inserta si está disponible)	string	Opcional

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=checkContact
ext=101
ani=19101234567
Name=Dima
token=202cb962ac59075b964b07152d234b70
add_phone=380123456789,380234567890,380112345678
emails=a@a.com,b@b.com

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200		OK
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

getContact#

Este comando es necesario para obtener información sobre un contacto existente y su empleado responsable.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso getContact	string
ani	número de teléfono de contacto	string	Opcional
email	e-mail	string	Opcional
token	token de LiraX configurado en los ajustes de integración.	string

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=getContact
ani=19101234567
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200	{"result":{"name":"Dmytro", "mainphone":"12345678901", "responsable":"209", "sip":"111"}}	OK Name - Nombre de contacto, mainphone – el primer número de teléfono de contacto, responsible - el número de extensión de la persona a cargo, sip - sip número de persona responsable
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

getStatInfo#

Este comando es necesario para obtener estadísticas de llamadas a empleados durante un período máximo de un mes. Puede utilizarse como máximo una vez por hora.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso getStatInfo	string
Start	Fecha en formato “AAAA-MM-DD HH:MM:SS” - inicio del intervalo	string
Stop	Fecha en formato “AAAA-MM-DD HH:MM:SS” - fin del intervalo	string	Opcional, si está ausente, entonces en 24 horas
token	token de LiraX configurado en los ajustes de integración.	string

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=getStatInfo
Start=2021:01:01 00:00:00
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200	{ "results":[ { "description":"stat_info. ", "stat":[ { "login":"alex", "nombre": "Alexei", "count_incoming":"0", "count_incoming_unique":"0", "count_incoming_answered":"0", "count_incoming_answered_unique":"0", "count_incoming_lost":"0", "count_incoming_lost_unique":"0", "count_outgoing":"10", "count_outgoing_unique":"4", "count_outgoing_answered":"5", "count_outgoing_answered_unique":"2", "count_outgoing_lost":"5", "count_outgoing_lost_unique":"4", "incoming_duration_talk":"0", "outgoing_duration_talk":"765" } ] } ] }	OK
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

createTask#

Se necesita este comando para crear una nueva tarea para el empleado y el contacto responsables. Si el contacto no existe, se crea uno nuevo.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	el tipo de operación, en este caso crearTarea	string
ext	número corto del empleado responsable del contacto	string
department	Nombre del departamento	string	opcional
ani	número de teléfono de contacto	string	Se requiere ani o correo electrónico
email	e-mail contacto	string	Se requiere ani o correo electrónico
token	token de LiraX configurado en los ajustes de integración.	string
webhook	URL para informar sobre los resultados	string	El texto se añadirá al final.
text	Texto de la tarea	string
date	Fecha de finalización de la tarea	Date	Opcional, por defecto hora actual +1 segundo. Ejemplo: "2017-01-01 17:00:00", debe ser posterior a la fecha actual y anterior a dos años en el futuro.
type	Tipo	Integer	1, 2, 3 (Follow-up, Reunión, Llamada)

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=createTask
ext=101
departamento=Ventas
ani=19101234567
texto=Preparar tarea
date=2017-01-01 17:00:01
type=1
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200	{"idtask":"22"}	OK
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

AddTaskResult#

Se necesita un equipo para añadir un resultado a una tarea, completar una tarea o cambiar a la persona responsable.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	el tipo de operación, en este caso AddTaskResult	string	obligatorio
ext	número reducido de empleados que añadieron el resultado	string	obligatorio
idtask	Id Tarea	Integer	obligatorio
newext	Nuevo responsable	string	opcional
finish	Completar la tarea	bool	opcional
token	token de LiraX configurado en los ajustes de integración.	string
text	Texto del resultado	string	obligatorio

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=AddTaskResult
ext=101
idtask=123123
newext=191
texto=La tarea en la etapa 1
finish=0
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200	{"idtask":"123123"}	OK
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

GetTask#

Se necesita un equipo para añadir un resultado a una tarea, completar una tarea o cambiar a la persona responsable.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	el tipo de operación, en este caso AddTaskResult	string	obligatorio
task_id	Id Tarea	Integer	obligatorio
token	token de LiraX configurado en los ajustes de integración.	string

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=GetTask
task_id=123123
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200	{ "task_id":"609", "type":"Follow-up", "date_insert":"2014-12-09 14:15:55", "date_end":"2014-12-09 15:12:07", "text":"test Task!", "ext":"101", "Name":"System", "coauthors":"1", "list":[ { "ext":"504", "Nombre": "Sergiy Rybalchenko" } ] }	Aquí, tipo es el tipo de tarea; date_insert – fecha de creación; date_end – fecha de ejecución; text – texto de la tarea; ext – responsable; Name - nombre de la persona responsable; coauthors - número de co-intérpretes; list – lista de co-intérpretes
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

createNote#

Se necesita este comando para crear una nota para un contacto existente del empleado responsable.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos
cmd	tipo de operación, en este caso createNote	string
ext	número corto del empleado responsable del contacto	string
ani	número de teléfono de contacto	string
token	token de LiraX configurado en los ajustes de integración.	string
text	Texto de la nota	string

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=createNote
ext=101
ani=19101234567
texto=Noticias
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200		OK
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

createDeal#

Se necesita este comando para crear un nuevo acuerdo para el empleado responsable y un contacto existente.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de transacción, en este caso createDeal	string
ext	número corto del empleado responsable del contacto	string
ani	número de teléfono de contacto	string
token	token de LiraX configurado en los ajustes de integración.	string
name	Nombre del trato	string
sum	Importe de la transacción	Integer
stage	Etapa de acuerdo	Integer	Solo se permiten escenarios existentes.
status	Estado de la oferta (opcional)	Integer	0-Activo, 1- Completado con éxito, 2- Completado sin éxito

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=createDeal
ext=101
ani=19101234567
nombre=Tarea de preparación
sum=3030
stage=1
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200	{"id_deal":$integer}	OK ($integer - entero)
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

updateDeal#

Se necesita este comando para actualizar un acuerdo existente con id_deal para el empleado responsable y un contacto existente.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso updateDeal	string
ext	número corto del empleado responsable del contacto	string
ani	número de teléfono de contacto	string
token	token de LiraX configurado en los ajustes de integración.	string
id_deal	Id acuerdos	Integer
name	Nombre del trato	string
sum	Importe de la transacción	Integer
stage	Etapa de acuerdo	Integer	Solo se permiten escenarios existentes.
status	Estado del acuerdo	Integer	0-Activo, 1- Completado con éxito, 2- Fallido

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=updateDeal
ext=101
ani=19101234567
id_deal=1910
nombre=Tarea de preparación
sum=3030
stage=2
status=0
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200		OK
400		Se han pasado parámetros incorrectos o los parámetros no se han actualizado.
401		Se ha pasado un token no válido.

addBlackPhone#

Se necesita este comando para agregar un número de teléfono a la lista negra (solo números).

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso addBlackPhone	string
phone	número de teléfono	string	Solo números
token	token de LiraX configurado en los ajustes de integración.	string

Ejemplo de consulta:

POST https://api.lirax.net/general

cmd=addBlackPhone
phone=100111000101
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200		OK
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

listBlackPhone#

Se necesita este comando para obtener la lista negra de teléfonos.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso listBlackPhone	string
token	token de LiraX configurado en los ajustes de integración.	string

Ejemplo de consulta:

POST https://api.lirax.net/general

cmd=listBlackPhone
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200	{"blacklist":["phone1", "phone2", . .. , "phoneN"]}	OK
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

delBlackPhone#

Se necesita este comando para eliminar un número de teléfono de la lista negra (solo números).

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso delBlackPhone	string
phone	número de teléfono	string	Solo números
token	token de LiraX configurado en los ajustes de integración.	string

Ejemplo de consulta:

POST https://api.lirax.net/general

cmd=delBlackPhone
phone=100111000101
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200		OK
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

listBlackIP#

Se necesita este comando para obtener la lista negra de direcciones IP.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso listBlackIP	string
token	token de LiraX configurado en los ajustes de integración.	string

Ejemplo de consulta:

POST https://api.lirax.net/general

cmd=listBlackIP
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200	{"blacklist":["IP1", "IP2", . .. , "IPN"]}	OK
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

addBlackIP#

Este comando es necesario para añadir una dirección IP a la lista negra.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos
cmd	tipo de operación, en este caso addBlackIP	string
IP	IP DIRECCIÓN	string
token	token de LiraX configurado en los ajustes de integración.	string

Ejemplo de consulta:

POST https://api.lirax.net/general

cmd=addBlackPhone
IP=100.111.000.101
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200		OK
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

delBlackIP#

Este comando es necesario para eliminar una dirección IP de la lista negra.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos
cmd	tipo de operación, en este caso delBlackIP	string
IP	IP DIRECCIÓN	string
token	token de LiraX configurado en los ajustes de integración.	string

Ejemplo de consulta:

POST https://api.lirax.net/general

cmd=delBlackPhone
IP=100.111.000.101
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200		OK
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

getStages#

Se necesita este comando para obtener una lista de las etapas de la transacción ordenadas por Vortex.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	el tipo de operación, en este caso getStages	string
token	token de LiraX configurado en los ajustes de integración.	string

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=getStages
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200	{"stages":[{"stage":$stage, "title":". .. "}, . .. ]}	OK
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

getShops#

Se necesita este comando para obtener una lista de tiendas.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso getShops	string
token	token de LiraX configurado en los ajustes de integración.	string

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=getShops
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200	{"shops":[{"id":$id_shop, "name":". .. "}, . .. ]}	OK
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

getUserStatuses#

Este comando es necesario para obtener una lista de los estados de los usuarios.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	el tipo de operación, en este caso getUserStatuses	string
token	token de LiraX configurado en los ajustes de integración.	string

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=getUserStatuses
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200	{"statuses":[{"status":$status, "title":". .. "}, . .. ]}	OK
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

getUsers#

Se necesita este comando para obtener una lista de usuarios.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	el tipo de operación, en este caso getUsers	string
token	token de LiraX configurado en los ajustes de integración.	string

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=getUsers
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200	{"users":[{"id":$id, "Name":". .. ", "ext":". .. ", "active":"0\|1"}, . .. ]}	OK
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

initStatuses#

Este comando es necesario para obtener el estado actual de los operadores mediante webhooks. Se utiliza al habilitar la integración. Se recibirán actualizaciones de estado si cambian; los estados anteriores deben ignorarse.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	el tipo de operación, en este caso initStatuses	string
token	token de LiraX configurado en los ajustes de integración.	string

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=initStatuses
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200		OK
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

sendMsg#

Se necesita este comando para enviar un mensaje a un empleado a través del sistema de mensajería corporativa.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos
cmd	tipo de operación, en este caso sendMsg	string
ext	número corto del empleado al que se envía el mensaje	string
ani	el nombre del contacto que envió el mensaje	string
token	token de LiraX configurado en los ajustes de integración.	string
text	Texto del mensaje	string

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=sendMsg
ext=101
ani=19101234567
texto=Preparar tarea
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200		OK
400		Se han pasado parámetros incorrectos o los parámetros no se han actualizado.
401		Se ha pasado un token no válido.

send_cloud_message#

Este comando es necesario para enviar un mensaje a un servicio de mensajería instantánea (Telegram, Viber, Facebook).

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso send_cloud_message	string
client	ID de cliente de Cloud Messenger	string	obligatorio en ausencia de ani
ani	Número de teléfono del cliente (solo se utiliza Telegram)		obligatorio en ausencia de un cliente
token	token de LiraX configurado en los ajustes de integración.	string
text	Texto del mensaje	string

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=send_cloud_message
client=web_t123123123_00000
texto=Preparar tarea
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200		OK
400		Se han pasado parámetros incorrectos o los parámetros no se han actualizado.
401		Se ha pasado un token no válido.
402		Mensaje no entregado

sendSMS#

Se requiere este comando para enviar SMS a través de un módem GSM. Las solicitudes no deben enviarse más de una vez cada 5 segundos por módem.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso sendSMS	string
ext	número corto del empleado que envía el SMS	string	Solo números
provider	identificador del proveedor (número de teléfono en el módem GSM)	string	Solo números
phone	Número de teléfono al que enviamos el mensaje	string
token	token de LiraX configurado en los ajustes de integración.	string
text	Texto del mensaje	string

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=sendSMS
ext=101
phone=19101234567
provider=380123456789
texto=Preparar tarea
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200	{"id_sms":$id_sms}	OK
400		Se han pasado parámetros incorrectos o los parámetros no se han actualizado.
401		Se ha pasado un token no válido.
402		El módem no está conectado.
403		El módem está ocupado, por favor inténtelo de nuevo más tarde.

checkSMS#

Este comando es necesario para comprobar el estado de la entrega de SMS a través de un módem GSM. Las solicitudes no deben enviarse más de una vez cada 5 segundos por módem.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso checkSMS	string
ext	número corto del empleado que envía el SMS	string	Solo números
provider	identificador del proveedor (número de teléfono en el módem GSM)	string	Solo números
id_sms	Id recibido por el comando sendSMS	Integer
token	token de LiraX configurado en los ajustes de integración.	string

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=checkSMS
ext=101
id_sms=1910123
provider=380123456789
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200	{"sms_status":$id_status}	OK, 1- transferido al proveedor, estado desconocido; 2- transferido al proveedor, la entrega está en curso; 3- entregado; 4- El plazo de entrega ha expirado.
400		Se han pasado parámetros incorrectos o los parámetros no se han actualizado.
401		Se ha pasado un token no válido.

EncodePhone#

Este comando es necesario para verificar el número cifrado recibido.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso EncodePhone	string
phone	Número de teléfono	string	Solo números
token	token de LiraX configurado en los ajustes de integración.	string

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=EncodePhone
phone=12123123123
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200	{"phone":$encoded}	OK
400		Se han pasado parámetros incorrectos o los parámetros no se han actualizado.
401		Se ha pasado un token no válido.

DecodePhone#

Se necesita este comando para obtener el número descifrado.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso EncodePhone	string
phone	Número de teléfono	string	Solo números
token	token de LiraX configurado en los ajustes de integración.	string

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=DecodePhone
phone=12123120960170061170799
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200	{"phone":$decoded}	OK
400		Se han pasado parámetros incorrectos o los parámetros no se han actualizado.
401		Se ha pasado un token no válido.

set_call_lost#

Se necesita este comando para configurar un número de teléfono como llamada perdida para la devolución de llamada.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso set_call_lost	string	obligatorio
phone	Número de teléfono	string	Solo números, obligatorio
ext	Número de teléfono del empleado para devolución de llamada	string	Solo números, obligatorio
time_plan	1 - Horario laboral, 2 - Noche, 3 - Noche, 4 - Fin de semana	números	El intervalo de tiempo se define en el plan semanal, por defecto 1
max_try	Número máximo de intentos para conectar con un abonado (sin incluir al operador).	números	Valor predeterminado 3
interval	Intervalo inicial entre intentos en minutos, múltiplo de 6. El intervalo subsiguiente es igual al intervalo inicial multiplicado por el número de intentos.	números	Valor predeterminado 6
minutes	Número de minutos de retraso	números	Valor predeterminado 0
hours	Número de horas de retraso	números	Valor predeterminado 0
days	Número de días de retraso	números	Valor predeterminado 0
weeks	Número de semanas de retraso	números	Valor predeterminado 0
months	Número de meses de retraso	números	Valor predeterminado 0
info	Texto que se le dirá al empleado. Formato: voz y texto. Ejemplo: "Servicio de devolución de llamada del Reino Unido para llamadas perdidas, espere la conexión con el abonado".	string
token	token de LiraX configurado en los ajustes de integración.	string	obligatorio

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=set_call_lost
phone=12123120960
ext=222
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200		OK
400		Se han pasado parámetros incorrectos o los parámetros no se han actualizado.
401		Se ha pasado un token no válido.
402		Problemas del servidor

get_makecall_data#

Este comando permite obtener información sobre la llamada utilizando id_makecall, que se obtiene mediante el comando makecall.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso get_makecall_data	string	obligatorio
id_makecall	como resultado de makecall	string	Solo números, obligatorio
token	token de LiraX configurado en los ajustes de integración.	string	obligatorio

Ejemplo de consulta:

POST https://api.lirax.net/general
cmd=get_makecall_data
id_makecall=e5251de22f99e071
token=202cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200	{ "id_makecall":"e5251de22f99e071", "call_start":"2021-10-28 16:02:32", "call_record":"https://files. lirax. net/voicerec. wav", "duration":"5" }	OK
400		Se han pasado parámetros incorrectos o los parámetros no se han actualizado.
401		Se ha pasado un token no válido.
402		Problemas del servidor

get_calls#

El comando permite el registro de llamadas en formato JSON (máximo 5000) para un rango de tiempo. Puede utilizar el método GET para el comando.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso get_calls	string	obligatorio
date_start	Inicio de la gama	string	En formato SQL, requerido
date_finish	Fin de rango	string	En formato SQL, requerido el intervalo debe ser inferior a 48 horas.
call_type	tipo de llamada, {-1, 0, 1}, de acuerdo {interno, entrada, salida }, si está ausente, entonces todos	numerical	opcional
ani	¿Quién llamó?	string	opcional
dnis	¿A dónde llamaron?	string	opcional
offset	Saltar el número de líneas en la salida	numerical	opcional
token	token de LiraX configurado en los ajustes de integración.	string	obligatorio

Ejemplo de consulta:

GET https://api.lirax.net/general?cmd=get_calls&date_start=2023-10-04 10:00:00&date_finish=2023-10-04 11:00:00&token=-----

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200	[{"call_id":"6708", "ani":"203", "dnis":"380123123", "start":"2023-10-04 10:21:14", "connect":"2023-10-04 10:21:25", "record": "https://files. lirax. net/voice_record2/x_10_21_14. wav", "type":"1", "duration": "163", "disconnect_side":"0", "call_call_center_id":"6" }, {"call_id":"8326", "ani":"380111111", "dnis":"380123123", "start":"2023-10-04 10:04:07", "connect":"", "record":"", "type":"1", "duration":"0", "disconnect_side":"-1", "call_call_center_id":"0" }]	OK connect – si no hay respuesta, aparecerá una línea en blanco. record – url grabación de conversación disconnect_side – Quién colgó, -1 sistema (posiblemente debido a tiempo de espera), 0 – Quién llamó, 1 – a quién llamaron call_call_center_id – ¿Qué centro de atención telefónica gestionó la llamada (si lo hubo)?
400		Se han pasado parámetros incorrectos o los parámetros no se han actualizado.
401		Se ha pasado un token no válido.
402		Problemas del servidor

set_webhook#

El comando permite el registro de llamadas en formato JSON (máximo 5000) para un rango de tiempo. Puede utilizar el método GET para el comando.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso set_webhook	string	obligatorio
type	"0" - entrada, "1" - salida	numerical	obligatorio
event_type	init - al inicio de la llamada, intentar - al inicio del tramo saliente, conectar - cuando el abonado descuelga el teléfono, soltar - al final del tramo saliente, desconectar - al final de la llamada	string	obligatorio
json	Plantilla JSON para usar en el cuerpo del webhook. Aquí puedes usar macros: [ani] — quién llama, [dnis] — a quién se llama, [date] — hora actual, [startto] — inicio de la llamada entrante, [starta] — momento en que el abonado contesta el teléfono, [durationo] — duración de la llamada entrante, [durationa] — duración de la llamada saliente, [anidnis] — número del operador para la llamada entrante, [type] — tipo de llamada: "-1" — interna, "0" — entrante, "1" — saliente. Ejemplo: {"call_type":"[type]", "event_date":"[date]", "number_a":"[ani]", "number_b":"[dnis]", "call_duration": "[durationa]"}	string	puede faltar; si se utiliza el método POST, el cuerpo de la solicitud se utilizará como plantilla.
header_field	Un campo de encabezado adicional que LiraX insertará en el webhook. ejemplo: Authorisation: 123123123	string	opcional
method	GET\|POST	string	Opcional por defecto GET
url	Url para webhooks ejemplo: https://test.test.test.com/webhook?a=1&b=2	string	obligatorio
token	token de LiraX configurado en los ajustes de integración.	string	obligatorio

Ejemplo de consulta:

GET https://api.lirax.net/general?cmd=set_webhook&type=0&event_type=disconnect&url=https://test.test.test.com/webhook?a=1&b=2
&json={"call_type":"[type]","event_date":"[date]","number_a":"[ani]","number_b":"[dnis]","call_duration":"[durationa]"}
&token=-----

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200		exitosamente
400		Se han pasado parámetros incorrectos o los parámetros no se han actualizado.
401		Se ha pasado un token no válido.
402		Problemas del servidor

Descargar historial de llamadas#

Autorización mediante API

Autoriza al usuario en el sistema. Todos los métodos de la API solo se pueden utilizar después de la autorización.

En respuesta a la solicitud, tras una autorización exitosa, además del cuerpo de la respuesta, se devuelve un archivo de cookies que contiene la clave de sesión, de forma similar a como se trabaja con un navegador web. En las solicitudes posteriores a los métodos de la API, se debe pasar la cookie recibida. La sesión tiene una duración de 15 minutos.

Todas las solicitudes a la API se realizan desde el usuario cuyos atributos se utilizaron para la autorización mediante este método. De esta forma, se tienen en cuenta todos los derechos del usuario; es decir, no se puede obtener a través de la API más información de la que el propio usuario puede ver a través de la interfaz del sistema. Recomendamos crear un usuario independiente para la API para configurar de forma más específica los permisos de la aplicación conectada.

Resource URL

POST

https://lira. lirax. net/api/private/api/auth. php

Parameters

PARAMETER	DESCRIPTION
USER_LOGIN	require Inicio de sesión de usuario.
USER_HASH	require Contraseña de usuario.

Llamadas

https://lira. lirax. net/services/call_show. php?action=show&date_start=2016-12-06 00:00:00&date_finish=2016-12-13 23:59:59&filter=call_ani_dnis&filter_value=&call_type=&call_connect=&call_export=1

date_start

Fecha desde

date_finish

Fecha para

filter

Filtrar por campo

valores posibles:

"call_ani", "call_dnis", "call_ani_dnis", "call_originip", "call_destination", "call_origination", "call_utm_source", "call_utm_medium", "call_utm_campaign", "call_utm_term"

filter_value

Valor de filtro

call_type

valores posibles:

0 entrante, 1 saliente

call_connect

valores posibles:

0 no hubo conversación, 1 hubo una conversación

Equipos desde LiraX hasta la pista de aterrizaje#

makecall_finished#

El comando informa que la tarea de crear una llamada para 2 suscriptores se ha completado correctamente.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso makecall_finished	string
id_makecall	Id - makecall	string
Call_id	Call_id el brazo de salida de la llamada	string	si éxito=0 vacío
success	El abonado contestó el teléfono.	Integer	0\|1
from_LiraX_token	el token WPP especificado en la configuración de integración	string

Ejemplo de consulta:

POST https://domain/LiraX
cmd=makecall_finished
id_makecall=ef232234feb12
from_LiraX_token=303cb962ac59075b964b07152d234b70
Call_id=b964b07152d
success=1

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200		OK
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

make2calls_finished#

El comando informa que la tarea de crear una llamada para 2 suscriptores se ha completado correctamente.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	el tipo de operación, en este caso make2calls_finished	string
id_make2calls	Id - make2calls	string
success	¿Contestaron el teléfono?	Integer	0- no había nadie, 1- cogió el teléfono
duration_success	la duración de la conversación no fue menor de lo esperado en el parámetro successtime.	Integer	0- menor que, 1- mayor que igual
keys	Json conjunto de botones pulsados, ivr_name – Nombre del IVR, ivr_entry – Elemento del menú del IVR, key – Botón seleccionado	Json	puede estar ausente
from_LiraX_token	el token WPP especificado en la configuración de integración	string

Ejemplo de consulta:

POST https://domain/LiraX
cmd=make2calls_finished
id_make2calls=ef232234feb12
from_LiraX_token=303cb962ac59075b964b07152d234b70
success=1
keys=[{"ivr_name":"Test","ivr_entry":"0","key":"9"},{"ivr_name":"Test","ivr_entry":"09","key":"7"}]
duration_success=0

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200		OK
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

staton#

El equipo informa sobre la situación de los empleados.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso estación	string
ext	número de extensión de empleado de LiraX	string
status	identificador de estado de empleado en la cuenta personal	Integer	0- desconectado, 1- libre, >1 - ocupado, valor según la configuración
from_LiraX_token	el token WPP especificado en la configuración de integración	string

Ejemplo de consulta:

POST https://domain/LiraX
cmd=staton
ext=910
from_LiraX_token=303cb962ac59075b964b07152d234b70
status=1

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200		OK
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

smsDelivered#

El equipo informa sobre la entrega de SMS.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos
cmd	tipo de operación, en este caso smsDelivered	string
id_sms	Id SMS, recibido por el comando sendSMS	Integer
from_LiraX_token	el token WPP especificado en la configuración de integración	string

Ejemplo de consulta:

POST https://domain/LiraX
cmd=smsDelivered
from_LiraX_token=303cb962ac59075b964b07152d234b70
id_sms=1212

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200		OK
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

smsReceived#

El equipo informa sobre la recepción de un SMS.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso smsReceived	string
ani	Número de teléfono del suscriptor	string
id	Id SMS, recibido del proveedor	Integer
provider	Nombre del proveedor (número de teléfono)	string
text	Texto del mensaje	string	En UTF8
from_LiraX_token	el token WPP especificado en la configuración de integración	string

Ejemplo de consulta:

POST https://domain/LiraX
cmd=smsReceived
from_LiraX_token=303cb962ac59075b964b07152d234b70
id_sms=121
ani=38012345679
provider=380112345678
text=Hello

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200		OK
400		Se pasaron parámetros incorrectos.
401		Se ha pasado un token no válido.

contact#

Una orden para obtener información sobre el nombre del cliente y su empleado responsable a través de su número de teléfono.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso contacto	string
phone	número de contacto	string
callid	identificador de llamada único	string
diversion	número de teléfono externo de LiraX desde el que se recibió la llamada.	string	cuando el número de salidas es igual al número de suscriptores
from_LiraX_token	el token WPP especificado en la configuración de integración	string

Ejemplo de consulta:

POST https://domain/LiraX
cmd=contact
phone=19101234567
diversion=12101234567
from_LiraX_token=303cb962ac59075b964b07152d234b70
callid=D12D0EB124F4E64AF4EA-1511

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200	{ "contact_name": "Ivanov Ivan Ivanovich", "responsable": 103 }	responsible — número corto del usuario responsable; puede estar ausente si no hay un usuario responsable o no se le ha asignado un número corto.
400	{ "error": "Invalid parameters" }	Se pasaron parámetros incorrectos.
401	{ "error": "Invalid token" }	Se ha pasado un token no válido.

event#

LiraX envía notificaciones al WPP sobre eventos de llamadas: inicio, aceptación o finalización de una llamada, así como información sobre la llamada una vez finalizada.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos	Nota
cmd	tipo de operación, en este caso evento	string
type	tipo de llamada	in/out	entrantes / salientes
event	tipo de evento asociado a la llamada: INCOMING - ha entrado una llamada (en este momento debería empezar a sonar el teléfono del gerente). ACCEPTED - la llamada se recibió correctamente (el gerente contestó el teléfono). COMPLETED - la llamada ha terminado (el gerente o el cliente colgó después de la conversación). CALL_COMPLETED – la llamada ha finalizado por completo.	string
phone	número de teléfono del cliente	string
diversion	número de teléfono externo de LiraX a través del cual se recibió o realizó la llamada.	string
ext	número de extensión del empleado de LiraX, en caso de CALL_COMPLETED y type=in, contiene el número al que se realizó la llamada.	string
callid	identificador de llamada único	string
duration	Duración de la llamada en segundos	int	cuando event=COMPLETED, CALL_COMPLETED
call_duration	Duración de la llamada en el momento del evento en segundos.	int	cuando event=COMPLETED, CALL_COMPLETED
is_recorded	¿Se graba la llamada?	0/1	cuando event=COMPLETED, CALL_COMPLETED
status	estado de la llamada entrante: Success - llamada entrante exitosa Missed – llamada entrante perdida estado de la llamada saliente: Success - llamada saliente exitosa Busy - LiraX obtuve la respuesta Zanyato NotAvailable - LiraX se recibió una respuesta. El suscriptor no está disponible. NotAllowed - Las llamadas en esta dirección están prohibidas.	string	cuando event=COMPLETED, CALL_COMPLETED
record_link	enlace a la grabación de la llamada, si LiraX puede proporcionarlo inmediatamente; de lo contrario, el enlace se envía mediante el comando de grabación.	string	cuando event=COMPLETED, CALL_COMPLETED
tid	Tracking Id
cid	Client Id
cs	Fuente
cm	Medio
cc	Campaña
ct	Termia
keys	Menú IVR de última opción	json	cuando evento=LLAMADA_COMPLETA
From_LiraX_token	el token WPP especificado en la configuración de integración	string

Ejemplo de consulta:

POST https://domain/LiraX

cmd=event
type=out
event=COMPLETED
phone=19101234567
ext=102
callid=D10D0EB124F4E64AF4EA-1511
duration=124
is_recorded=1
status=Success
record_link=https://link/file.wav
keys=[{"ivr_name":"Test","ivr_entry":"09","key":"4"}]
from_LiraX_token=303cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200		OK
400	{ "error": "Invalid parameters" }	Se pasaron parámetros incorrectos.
401	{ "error": "Invalid token" }	Se ha pasado un token no válido.

record#

El mensaje contiene información sobre la grabación de la conversación.

Parámetros de consulta:

Nombre	Descripción	Tipo/formato de datos
cmd	tipo de operación, en este caso registro	string
callid	identificador de llamada único	string
record_link	enlace a la grabación de la llamada	string
from_LiraX_token	el token WPP especificado en la configuración de integración	string

Ejemplo de consulta:

POST https://domain/LiraX

cmd=record
callid=D10D0EB124F4E64AF4EA01511
record_link=https://link/file.wav
from_LiraX_token=303cb962ac59075b964b07152d234b70

Opciones de respuesta:

HTTP código	Cuerpo	Descripción
200		OK
400	{ "error": "Invalid parameters" }	Se pasaron parámetros incorrectos.
401	{ "error": "Invalid token" }	Se ha pasado un token no válido.

ChangeLog#

2021-01-28

make2calls- se agregó el campo FirstInternal.

2021-02-18

getContact- método añadido

2021-02-19

getStatInfo- método añadido

2021-04-12

AskQuestion- método añadido

2021-04-13

AddTag- método añadido

2021-04-13

DelTag- método añadido

2021-04-14

checkContact — se agregó el campo de etiqueta

2021-08-13

get_sip_route_in — método añadido

2021-08-13

set_sip_route_in — método añadido

2021-09-12

SecondInternal en la función make2calls

2021-09-12

SpeechNoWait en la función make2calls

2021-10-26

set_call_lost- método añadido

2021-10-28

get_makecall_data - método añadido

2021-11-19

set_call_lost - se agregaron los campos de información, minutos, horas, días, semanas y meses.

2021-12-30

createTask — se agregó el parámetro de correo electrónico; si el contacto no existe, se crea uno nuevo.

2022-08-25

Event — se agregó el parámetro call_duration

2022-11-10

send_cloud_message - método añadido

2023-10-04

get_calls- método añadido

2023-10-20

AddTaskResult- método añadido

2024-09-24

GetTask- método añadido

2026-09-16

Se utiliza el dominio api.lirax.net