La versión 20 de 3cx le permite realizar consultas al API para obtener todos los detalles de las sesiones, acontinuación le detallamos cómo puede realizar este procedimiento:
Acaba de tener una sesión productiva y satisfactoria de su Reunión en Línea por la sección de
meets de 3cx. Ahora está esperando ansiosamente el correo electrónico con el informe y el
video grabado. Para su sorpresa, el correo electrónico ¡no ha llegado! ¿Le preocupa que se
haya perdido para siempre? ¡No se preocupe! Es posible consultar con la API REST el informe
de las sesiones de 3cx de hasta 30 días hacia atrás.
Si su centralita no guarda los registros – o si no tiene acceso a ellos – ¡no hay problema! Puede
utilizar la API de la Reunión en Línea para recuperar sus informes de reuniones anteriores.
Active su clave API de la Reunión en Línea desde su centralita, en Ajustes / Conferencia. Copie
su clave API:
1- Desde la consola de administrador de la PBX ingrese a las configuraciones de administrador, seleccione la opción sistema, de esta forma encontrará las opciones de su sistema y tendrá acceso al apartado Conferencias. El apartado conferencia dispone de un espacio al final que tiene la información para generar un API key para realizar las consultas, la posibilidad de copiar el api o eliminar el API key. En este caso puede generar un API key y copiarlo para utilizar en las consultas que vayan a realizar:
Para poder realizar las consultas es necesario dispone de un software de consulta para
ejecutar las sentencias, en este manual se detallan las dos opciones más populares del
mercado: POSTMAN e INSOMNIA.
Consultar la API de reportes de conferencias con POSTMAN
1- Debe contar con el software de postman previamente instalado(en este manual no
se detalla instalación), puede ejecutar la sentencia de consulta desde la versión web
o la versión de escritorio:
- Crear una nueva consulta GET HTTP:
En la nueva consulta ubique la opción Código, en este caso se encuentra en la sección derecha:
Cerciórese de que el código a insertar tenga seleccionado la opción cURL(Client URL) utilizada como herramienta de línea de comandos utilizada para la transferencia de ficheros con formato URL.
La consulta que va a ejecutar debe cumplir la siguiente estructura:
curl –location‘https://YOUR-PBXFQDN:YOURPBXPORT/webmeeting/api/v1/reports/ORGINIZER-EXTENSION-NUMBER?startDate=2022-05-20T10:50&endDate=2024-05-19'’-- header ‘3CX-ApiKey: YOUR-API-KEY’
- Parámetro 1 YOUR-PBX-FQDN: es el FQDN(dirección URL) de su centralita, por
ejemplo liwa.my3cx.co - Parámetro 2 YOUR-PBX-PORT: es el puerto TCP en el que su centralita está
“escuchando”, usualmente es 443 o 5001 (Si es 443, puede entonces omitir el puerto) - Parámetro 3 ORGANIZER-EXTENSION-NUMBER: es el número de la extensión del
Organizador quien creó la reunión, por ejemplo 1001 - Parámetro 4 YOUR-API-KEY: es la cadena que copió desde la página de
configuraciones de conferencia en su consola de administrador. - Parámetro 5 starDate: corresponde a la fecha de inicio desde que se generará la
consulta. - Parámetro 6 endDate: Corresponde a la fecha final de la consulta
Si los campos de consulta están correctamente diligenciados, obtendrá una respuesta JSON
con todas las reuniones organizadas por la extensión especificada en los últimos 30 días.
Puede reconstruir el informe a partir de ahí y obtener también la URL de la grabación.
Es posible realizar un filtro por fecha de inicio y fecha para lo que debe agregar estos dos
últimos parámetros al final de la consulta:
Tenga en cuenta que el código de respuesta del API cuando la consulta está correcta es 200
OK, con lo cual generará un JSON con toda la información de la extensión a consultar y el rango
de las fechas, participantes, y demás datos relacionados a la sesión a desarrollar. En caso de
que la sesión haya sido grabada obtendrá el enlace de la grabación para descargar
localmente(disponible 7 días).
Consultar el API de reportes de conferencias con INSOMNIA
1- Debe contar con el software de Insomnia previamente instalado(en este manual no se detalla instalación), una vez abierto el programa Debe crear una nueva consulta seleccionando la opción + y dando clic en HTTP Request
2- Una vez creada su nueva consulta es necesario que cargue la cURL(Client URL) utilizada como herramienta de línea de comandos utilizada para la transferencia de ficheros con formato URL, para esto diríjase al Botón Send y en la fecha desplegable seleccione Generate Client Code.
De esta forma se desplegará la ventana de comandos, cerciorarse de seleccionar la opción
cURL para que de este modo la consulta pueda ser aprobada:
La consulta que va a ejecutar debe cumplir la siguiente estructura:
curl –location‘https://YOUR-PBXFQDN:YOURPBXPORT/webmeeting/api/v1/reports/ORGINIZER-EXTENSION-NUMBER?startDate=2022-05-20T10:50&endDate=2024-05-19'’--header ‘3CX-ApiKey: YOUR-API-KEY’
- Parámetro 1 YOUR-PBX-FQDN: es el FQDN(direccion URL) de su centralita, por
ejemplo liwa.my3cx.co - Parámetro 2 YOUR-PBX-PORT: es el puerto TCP en el que su centralita está
“escuchando”, usualmente es 443 o 5001 (Si es 443, puede entonces omitir el puerto) - Parámetro 3 ORGANIZER-EXTENSION-NUMBER: es el número de la extensión del
Organizador quien creó la reunión, por ejemplo 1001 - Parámetro 4 YOUR-API-KEY: es la cadena que copió desde la página de
configuraciones de conferencia en su consola de administrador. - Parámetro 5 starDate: corresponde a la fecha de inicio desde que se generará la
consulta. - Parámetro 6 endDate: Corresponde a la fecha final de la consulta
Si los campos de consulta están correctamente diligenciados, obtendrá una respuesta JSON
con todas las reuniones organizadas por la extensión especificada en los últimos 30 días.
Puede reconstruir el informe a partir de ahí y obtener también la URL de la grabación.
Más información:
Comandos y ejemplos: https://documenter.getpostman.com/view/17439253/UUxzBnmk#6c3c8624-215a-4714-bd18-
b8993a81e34f
En caso de requerir asistencia o apoyo del área de soporte de Liwa empresas lo invitamos a
comunicarse por medio del correo electrónico: soporte.empresas@liwa.co o por medio de
nuestro WhatsApp (57) 3009122444.