Descripción general de los informes on ~.UcClient.~ Unified Communications

Obtener todos los informes

Mon, 01 Jan 0001 00:00:00 +0000

Obtener todos los informes #

Obtiene una lista de todos los informes configurados en un área de trabajo específica. Una vez que se ha recuperado una lista de todos los informes, se puede ejecutar y recuperar los datos mediante un reportId específico.

GET /v1.0/workspaces/{WORKSPACE_ID}/reports

Ejemplo #

Esta solicitud obtendrá una lista de todos los informes configurados dentro del área de trabajo especificada.

Pedir #

GET <https://api.na.myreports.cloud/api/v1.0/workspaces/00000000-0000-0000-0000-000000000001/reports> HTTP/1.1
Autorización: Portador {TOKEN}

Respuesta #

HTTP/1.1 200 OK
Tipo de contenido: application/json; charset=utf-8
Longitud del contenido: xx
{
	"page_size": 3,
    "page_index": 0,
    "datos": [ {
            "id": "00000000-0000-0000-0000-0000000000000001",
            "name": "Lista de llamadas (segmentada)"
        }, {
            "id": "000000000-0000-0000-0000-000000000000000002",
            "name": "Llamadas por nombre de cola"
        }, {
            "id": "00000000-0000-0000-0000-000000000000000003",
            "name": "Llamadas por usuario"
        }
    ][{
            "id": "00000000-0000-0000-0000-000000000001",
            "name": "Call List (Segmented)"
        }, {
            "id": "00000000-0000-0000-0000-000000000002",
            "name": "Calls by Queue Name"
        }, {
            "id": "00000000-0000-0000-0000-000000000003",
            "name": "Calls by User"
        }
    ],
	"status": "éxito",
	"marca de tiempo": "2019-05-01T10:00:00.2890319Z"
}

Errores #

Desautorizado #

Cuando el token no se proporciona, no es válido o ha caducado

HTTP/1.1 401 No autorizado

Solicitud de informe posterior

Mon, 01 Jan 0001 00:00:00 +0000

Solicitud de informe posterior #

Publique una solicitud para ejecutar un informe durante un período de tiempo específico (dateFilter).

POST /v1.0/workspaces/{WORKSPACE_ID}/reports/{REPORT_ID}/requests

Ejemplo de uso de un filtro de fecha preestablecido #

Esta solicitud ejecutará un informe para el trimestre actual. El cuerpo de retorno contiene como ' requestId' que se puede utilizar para consultar el estado del informe y recuperar el conjunto de datos.

Pedir #

POST <https://api.na.myreports.cloud/api/v1.0/workspaces/00000000-0000-0000-0000-000000000001/reports/00000000-0000-0000-0000-000000000001/requests> HTTP/1.1
Tipo-Contenido: application/json
Autorización: portador {TOKEN}
Conexión: mantener la vida
{
    "reportId": "00000000-0000-0000-0000-000000000001",
    "filterId": "00000000-0000-0000-0000-000000000001",
    "dateFilter": {
        "presetName": "ThisQuarter"
    },
    "Condiciones adicionales" : \[]

}

info
El ' presetName' Puede ser cualquiera de los < válidos c1". Filtros de fecha preestablecidos</c1>.

info
El ' filterId' puede usarse para aplicar un filtro predefinido al informe. Si no se suministra, se utilizará el filtro predeterminado aplicado al informe solicitado.

info
El 'adicionalConditions' puede usarse para aplicar Filtros Adicionales al informe. Estos filtros complementarán los parámetros especificados en un filtro predefinido.

Respuesta #

HTTP/1.1 200 OK
Tipo de contenido: application/json; charset=utf-8
Longitud del contenido: xx
{
    "datos": {
        "requestId": "000000000-0000-0000-0000-0000000000000005",
        "locale": "en-GB",
        "reportId": "000000000-0000-0000-0000-000000000000000001",
        "referenceDate": "2025-09-22T15:23:01.0201791+00:00",
        "dateFilter": {
            "presetName": "EsteTrimestre",
            "presetFilterObject": {
                "unidades": 5,
                "desplazamiento": 0,
                "longitud": 1,
                "roundingMode": 1,
                "díasDeSemana": 127
            },
            "díasDeSemana": 127
        },
        "startTime": "2025-07-01T00:00:00+01:00",
        "endTime": "2025-09-22T16:08:01.02159+01:00"
    },
    "status": "éxito",
    "marca de tiempo": "2025-09-22T15:23:02.2982477Z"
}

Ejemplo de uso de un intervalo de fechas fijo #

Obtener estado

Mon, 01 Jan 0001 00:00:00 +0000

Obtener estado #

Esta solicitud acepta un informe ' requestId' y devuelve el estado de la solicitud.

GET /v1.0/workspaces/{WORKSPACE_ID}/reports/{REPORT_ID}/results/{REQUEST_ID}

Ejemplo: solicitud en curso #

Esta solicitud devuelve el estado de una solicitud de informe que aún se está ejecutando.

Pedir #

OBTENER <https://api.na.myreports.cloud/api/v1.0/workspaces/00000000-0000-0000-0000-000000000001/reports/00000000-0000-0000-0000-000000000001/results/00000000-0000-0000-0000-000000000005> HTTP/1.1
Autorización: portador {TOKEN}

Respuesta #

HTTP/1.1 200 OK
Tipo de contenido: application/json; charset=utf-8
Longitud del contenido: xx
{
    "datos": {
        "dateCreated": "2025-09-22T15:27:40.1946146Z",
        "tenantId": "f8322e65-ddac-4f5c-1f6c-08db2fa7b464",
        "requestId": "65224fa5-f4c6-4796-b3c8-c4f67d504971",
        "reportId": "2aafb829-91aa-4d17-a5d3-bb6fde34ca10",
        "status": "Completo",
        "statusMessage": "Procesamiento de informes completado",
        "reportTemplateName": "CallListByUserSegmented"
    },
	"status": "éxito",
	"marca de tiempo": "2019-05-01T10:00:00.2890319Z"
}

Errores #

Desautorizado #

Cuando el token no se proporciona, no es válido o ha caducado

HTTP/1.1 401 No autorizado

Obtener resultados

Mon, 01 Jan 0001 00:00:00 +0000

Obtener resultados #

Esta solicitud acepta un informe ' requestId' y devuelve los resultados del informe si está completo.

GET /v1.0/workspaces/{WORKSPACE_ID}/reports/{REPORT_ID}/results/{REQUEST_ID}/data

Ejemplo #

Esta solicitud devuelve los datos de resultado de una solicitud de informe que está completa.

Pedir #

GET <https://api.na.myreports.cloud/api/v1.0/workspaces/00000000-0000-0000-0000-000000000001/reports/00000000-0000-0000-0000-000000000001/results/00000000-0000-0000-0000-000000000005/data> HTTP/1.1
Autorización: portador {TOKEN}

Respuesta #

HTTP/1.1 200 OK
Tipo de contenido: application/json; Charset=UTF-8
Contenido-Duración: xx
{
    "requestId": "00000000-0000-0000-0000-000000000005",
    "inquilino": "00000000-0000-0000-00000-00000000000",
    "request": {
        "requestId": "00000000-0000-0000-0000-000000000005",
        "fechaCreación": "2025-09-22T15:27:40.1946146Z",
        "inquilino": "00000000-0000-0000-00000-00000000000",
        "reportId": "00000000-0000-0000-0000-000000000001",
        "NombreDePlantilla": "ListaDellamadasPorSegmentadoUsuario",
        "filterConditions": \[
            {
                "fieldName": "start",
                "operador": ">=",
                "valores": ["2025-01-01T00:00:00.0000000+00:00"][
                    "2025-01-01T00:00:00.0000000+00:00"
                ]
            },
            {
                "fieldName": "fin",
                "operador": "\<",
                "valores": ["2025-09-22T15:12:40.1423517+00:00"][
                    "2025-09-22T15:12:40.1423517+00:00"
                ]
            }
        ],
        "sortFields": [
            {
                "fieldName": "start",
                "dirección": 1
            }
        ][
            {
                "fieldName": "start",
                "direction": 1
            }
        ],
        "displayFields": [
            {
                "fieldName": "connId",
                "obligatorio": falso
            },
            {
                "fieldName": "start",
                "obligatorio": falso
            },
            {
                "NombreDecampo": "NombreDeUsuario",
                "obligatorio": falso
            },
            {
                "nombreCampo": "userNum",
                "obligatorio": falso
            },
            {
                "fieldName": "cli",
                "obligatorio": falso
            },
            {
                "fieldName": "cliName",
                "obligatorio": falso
            },
            {
                "fieldName": "hgNum",
                "obligatorio": falso
            },
            {
                "fieldName": "callType",
                "obligatorio": falso
            },
            {
                "fieldName": "callDir",
                "obligatorio": falso
            },
            {
                "fieldName": "ans",
                "obligatorio": falso
            },
            {
                "fieldName": "ref",
                "obligatorio": falso
            },
            {
                "fieldName": "lost",
                "obligatorio": falso
            },
            {
                "fieldName": "ring",
                "obligatorio": falso
            },
            {
                "fieldName": "duración",
                "obligatorio": falso
            },
            {
                "nombreDecampo": "llamadoNumUsuario",
                "obligatorio": falso
            },
            {
                "nombreDecampo": "llamadoNombreDeUsuario",
                "obligatorio": falso
            },
            {
                "nombreDecampo": "nombreDeUsuarioLlamada",
                "obligatorio": falso
            },
            {
                "fieldName": "callUserNum",
                "obligatorio": falso
            },
            {
                "fieldName": "hgName",
                "obligatorio": falso
            }
        ][
            {
                "fieldName": "connId",
                "mandatory": false
            },
            {
                "fieldName": "start",
                "mandatory": false
            },
            {
                "fieldName": "userName",
                "mandatory": false
            },
            {
                "fieldName": "userNum",
                "mandatory": false
            },
            {
                "fieldName": "cli",
                "mandatory": false
            },
            {
                "fieldName": "cliName",
                "mandatory": false
            },
            {
                "fieldName": "hgNum",
                "mandatory": false
            },
            {
                "fieldName": "callType",
                "mandatory": false
            },
            {
                "fieldName": "callDir",
                "mandatory": false
            },
            {
                "fieldName": "ans",
                "mandatory": false
            },
            {
                "fieldName": "ref",
                "mandatory": false
            },
            {
                "fieldName": "lost",
                "mandatory": false
            },
            {
                "fieldName": "ring",
                "mandatory": false
            },
            {
                "fieldName": "duration",
                "mandatory": false
            },
            {
                "fieldName": "calledUserNum",
                "mandatory": false
            },
            {
                "fieldName": "calledUserName",
                "mandatory": false
            },
            {
                "fieldName": "callUserName",
                "mandatory": false
            },
            {
                "fieldName": "callUserNum",
                "mandatory": false
            },
            {
                "fieldName": "hgName",
                "mandatory": false
            }
        ],
        "childDisplayFields": \[],
        "ignoreDisplayFields": falso,
        "metadatos": {
            "reportName": null,
            "dateFilter": {
                "presetName": "EsteAño",
                "presetFilterObject": {
                    "unidades": 6,
                    "desplazamiento": 0,
                    "longitud": 1,
                    "roundingMode": 1,
                    "díasDeSemana": 127
                },
                "díasDeSemana": 127
            },
            "dataReferencia": "2025-09-22T15:27:40.1423161+00:00",
            "TimeZoneReferenceDate": "2025-09-22T16:27:40",
            "filterId": null,
            "adicionalalFilters": \[],
            "workspaceFilterId": null,
            "timezoneDateFrom": "2025-01-01T00:00:00",
            "timezoneDateTo": "2025-09-22T16:12:40",
            "timeZoneDateCreated": "2025-09-22T15:27:40.1423517+00:00",
            "timeZoneAbbreviatura": "BST"
        },
        "fuente": "api.onboarding",
        "Tamaño de página": -1,
        "batchSize": -1,
        "rowLimit": 1000000,
        "priorityLevel": 2,
        "callRatePeriod": 120,
        "ignorarLlamadasAbandonadas": falso,
        "ignorarLlamadasContestadasCortas": falso,
        "accountCodeLabels": {},
        "ringDurationThresholds": [
            10,
            20,
            30,
            40,
            50,
            60,
            70,
            80,
            90,
            100,
            110,
            120,
            120
        ][
            10,
            20,
            30,
            40,
            50,
            60,
            70,
            80,
            90,
            100,
            110,
            120,
            120
        ],
        "ingresosEstimadosIngresos": 100,0,
        "incomingCallsPerSale": 5,
        "IngresosEstimados de salida": 100,0,
        "LlamadasSalientesPerSale": 5,
        "duraciónGrupoPeriodEnSegundos": 10,
        "timeZoneId": "Europa/Londres",
        "countryCode": "GB",
        "locale": "en-GB",
        "totalTrunks": 10,
        "maxRows": 0
    },
    "esfuerzo": 210,17,
    "queryDuración": 2076,
    "totalDuración": 2121,
    "queryCount": 2053,
    "rowLimitExceed": false,
    "totalCount": 922,
    "datos": [
        {
            "connId": "00000000-0000-0000-00000-000000000001",
            "inicio": "2025-09-18T11:16:31",
            "usuarioNombre": "Usuario de prueba 1",
            "userNum": "101",
            "cli": "+11234567890",
            "cliName": "",
            "hgNum": "200",
            "callType": 2,
            "callDir": 2,
            "ring": 1.0,
            "duración": 1.0,
            "llamadoUsuarioNum": "+19876543210",
            "llamadoNombreDeUsuario": "Desconocido",
            "callUserNum": "+11234567890",
            "hgName": "Cola 200",
            "docId": "00000000-0000-0000-0000-0000000000009"
        },
        {
            "connId": "00000000-0000-0000-000000-00000000002",
            "inicio": "2025-09-18T11:16:13",
            "usuarioNombre": "Usuario de prueba 1",
            "userNum": "101",
            "cli": "+11234567890",
            "cliName": "",
            "callType": 2,
            "callDir": 3,
            "respuesta": 1,
            "ring": 5.0,
            "duración": 6.0,
            "llamadoUsuarioNum": "+19876543210",
            "callUserName": Probar Usuario 1",
            "callUserNum": "101",
            "docId": "00000000-0000-0000-00000-000000000010"
        },
        {
            "connId": "00000000-0000-0000-00000-000000000003",
            "inicio": "2025-01-03T16:44:40",
            "usuarioNombre": "Prueba de usuario 2",
            "userNum": "102",
            "callType": 1,
            "callDir": 2,
            "respuesta": 1,
            "ring": 0.0,
            "duración": 498,0,
            "llamadoUserNum": "00000000-0000-0000-0000-00000000012",
            "llamadoNombreDeUsuario": "Prueba de Usuario 2",
            "docId": "00000000-0000-0000-0000-000000000011"
        }
    ][
        {
            "connId": "00000000-0000-0000-0000-000000000001",
            "start": "2025-09-18T11:16:31",
            "userName": "Test User 1",
            "userNum": "101",
            "cli": "+11234567890",
            "cliName": "",
            "hgNum": "200",
            "callType": 2,
            "callDir": 2,
            "ring": 1.0,
            "duration": 1.0,
            "calledUserNum": "+19876543210",
            "calledUserName": "Unknown",
            "callUserNum": "+11234567890",
            "hgName": "Queue 200",
            "docId": "00000000-0000-0000-0000-000000000009"
        },
        {
            "connId": "00000000-0000-0000-0000-000000000002",
            "start": "2025-09-18T11:16:13",
            "userName": "Test User 1",
            "userNum": "101",
            "cli": "+11234567890",
            "cliName": "",
            "callType": 2,
            "callDir": 3,
            "ans": 1,
            "ring": 5.0,
            "duration": 6.0,
            "calledUserNum": "+19876543210",
            "callUserName": Test User 1",
            "callUserNum": "101",
            "docId": "00000000-0000-0000-0000-000000000010"
        },
        {
            "connId": "00000000-0000-0000-0000-000000000003",
            "start": "2025-01-03T16:44:40",
            "userName": "Test User 2",
            "userNum": "102",
            "callType": 1,
            "callDir": 2,
            "ans": 1,
            "ring": 0.0,
            "duration": 498.0,
            "calledUserNum": "00000000-0000-0000-0000-000000000012",
            "calledUserName": "Test User 2",
            "docId": "00000000-0000-0000-0000-000000000011"
        }
    ],
    "Resumen": [
        {
            "respuesta": 621,
            "ref": 37,
            "perdidos": 79,
            "ring": 3318.0,
            "duración": 124315.0
        }
    ][
        {
            "ans": 621,
            "ref": 37,
            "lost": 79,
            "ring": 3318.0,
            "duration": 124315.0
        }
    ],
    "estado": 1,
    "statusMessage": "Procesamiento de informes completado",
    "límiteRowLimit": 1000000
}

Errores #

Desautorizado #

Cuando el token no se proporciona, no es válido o ha caducado

HTTP/1.1 401 No autorizado