Présentation des rapports on ~.UcClient.~ Unified Communications

Obtenir tous les rapports

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

Obtenir tous les rapports #

Obtient la liste de tous les rapports configurés dans un espace de travail spécifique. Une fois qu'une liste de tous les rapports a été récupérée, elle peut être exécutée et les données récupérées à l'aide d'un reportId spécifique.

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

Exemple #

Cette demande obtiendra une liste de tous les rapports configurés dans l'espace de travail spécifié.

Demander #

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

Réponse #

HTTP/1.1 200 OK
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : xx
{
	« page_size » : 3,
    « page_index » : 0,
    « données » : [ {
            « id » : « 00000000-0000-0000-0000-0000000001 »,
            « name » : « Liste d'appels (segmentée) »
        }, {
            « id » : « 00000000-0000-0000-0000-00000000002 »,
            « name » : « Appels par nom de file d'attente »
        }, {
            « id » : « 00000000-0000-0000-0000-0000000003 »,
            « name » : « Appels par l'utilisateur »
        }
    ][{
            "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 » : « succès »,
	« timestamp » : « 2019-05-01T10:00:00.2890319Z »
}

Erreurs #

Non autorisée #

Lorsque le jeton n'est pas fourni, qu'il n'est pas valide ou qu'il a expiré

HTTP/1.1 401 Non autorisé

Demande de rapport après la publication

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

Demande de rapport après la publication #

Publiez une demande d'exécution d'un rapport pour une période spécifique (dateFilter).

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

Exemple d'utilisation d'un filtre de date prédéfini #

Cette demande exécutera un rapport pour le trimestre en cours. Le corps du retour contient comme ' requestId' qui peut être utilisé pour interroger l'état du rapport et récupérer le jeu de données.

Demander #

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
Type de contenu : application/json
Autorisation : porteur {TOKEN}
Connexion : maintien en vie
{
    « reportId » : « 00000000-0000-0000-0000-000000000001 »,
    « filterId » : « 00000000-0000-0000-0000-000000000001 »,
    « dateFilter » : {
        « PresetName » : « ThisQuarter »
    },
    « ConditionsAdditionnelles » : \[]

}

info
Le ' presetName' Il peut s'agir de l'un des < valides c1. Filtres de date prédéfinis </c1>.

info
Le ' filterId' peut être utilisé pour appliquer un filtre prédéfini au rapport. Si elle n'est pas fournie, le filtre par défaut appliqué au rapport demandé sera utilisé.

info
Les 'additionalConditions' peuvent être utilisées pour appliquer Additional Filters au rapport. Ces filtres complètent les paramètres spécifiés dans un filtre prédéfini.

Réponse #

HTTP/1.1 200 OK
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : xx
{
    « données » : {
        « requestId » : « 00000000-0000-0000-0000-0000000005 »,
        « locale » : « fr-GB »,
        « reportId » : « 00000000-0000-0000-0000-0000000001 »,
        « referenceDate » : « 2025-09-22T15:23:01.0201791+00:00 »,
        « dateFilter » : {
            « presetName » : « Ce quart »,
            « presetFilterObject » : {
                « unités » : 5,
                « décalage » : 0,
                « longueur » : 1,
                « roundingMode » : 1,
                « jours de la semaine » : 127
            },
            « jours de la semaine » : 127
        },
        « startTime » : « 2025-07-01T00:00:00+01:00 »,
        « endTime » : « 2025-09-22T16:08:01.02159+01:00 »
    },
    « status » : « succès »,
    « timestamp » : « 2025-09-22T15:23:02.2982477Z »
}

Exemple d'utilisation d'une plage de dates fixe #

Obtenir le statut

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

Obtenir le statut #

Cette demande accepte un rapport ' requestId' et renvoie l'état de la demande.

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

Exemple - Demande en cours #

Cette demande renvoie l'état d'une demande de rapport qui est toujours en cours d'exécution.

Demander #

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> HTTP/1.1
Autorisation : porteur {TOKEN}

Réponse #

HTTP/1.1 200 OK
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : xx
{
    « données » : {
        « 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 » : « Terminé »,
        « statusMessage » : « Traitement du rapport terminé »,
        « reportTemplateName » : « CallListByUserSegmented »
    },
	« status » : « succès »,
	« timestamp » : « 2019-05-01T10:00:00.2890319Z »
}

Erreurs #

Non autorisée #

Lorsque le jeton n'est pas fourni, qu'il n'est pas valide ou qu'il a expiré

HTTP/1.1 401 Non autorisé

Obtenir des résultats

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

Obtenir des résultats #

Cette demande accepte un rapport ' requestId' et renvoie les résultats du rapport s'il est terminé.

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

Exemple #

Cette demande renvoie les données de résultat d'une demande de rapport terminée.

Demander #

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
Autorisation : porteur {TOKEN}

Réponse #

HTTP/1.1 200 OK
Type de contenu : application/json ; charset=utf-8
Contenu - Durée : xx
{
    « requestId » : « 00000000-0000-0000-0000-000000000005 »,
    « tenantId » : « 00000000-0000-0000-0000-0000000000 »,
    « demande » : {
        « requestId » : « 00000000-0000-0000-0000-000000000005 »,
        « dateCreated » : « 2025-09-22T15:27:40.1946146Z »,
        « tenantId » : « 00000000-0000-0000-0000-0000000000 »,
        « reportId » : « 00000000-0000-0000-0000-000000000001 »,
        « reportTemplateName » : « CallListByUserSegmented »,
        « filterConditions » : \[
            {
                « fieldName » : « start »,
                « operator » : « >= »,
                « valeurs » : [« 2025-01-01T00:00:00.0000000+00:00 »][
                    "2025-01-01T00:00:00.0000000+00:00"
                ]
            },
            {
                « fieldName » : « fin »,
                « opérateur » : « \< »,
                « valeurs » : [« 2025-09-22T15:12:40.1423517+00:00 »][
                    "2025-09-22T15:12:40.1423517+00:00"
                ]
            }
        ],
        « sortFields » : [
            {
                « fieldName » : « start »,
                « Direction » : 1
            }
        ][
            {
                "fieldName": "start",
                "direction": 1
            }
        ],
        « displayFields » : [
            {
                « fieldName » : « connId »,
                « obligatoire » : faux
            },
            {
                « fieldName » : « start »,
                « obligatoire » : faux
            },
            {
                « fieldName » : « userName »,
                « obligatoire » : faux
            },
            {
                « fieldName » : « userNum »,
                « obligatoire » : faux
            },
            {
                « fieldName » : « cli »,
                « obligatoire » : faux
            },
            {
                « fieldName » : « cliName »,
                « obligatoire » : faux
            },
            {
                « fieldName » : « hgNum »,
                « obligatoire » : faux
            },
            {
                « fieldName » : « callType »,
                « obligatoire » : faux
            },
            {
                « fieldName » : « callDir »,
                « obligatoire » : faux
            },
            {
                « fieldName » : « ans »,
                « obligatoire » : faux
            },
            {
                « fieldName » : « ref »,
                « obligatoire » : faux
            },
            {
                « fieldName » : « lost »,
                « obligatoire » : faux
            },
            {
                « fieldName » : « ring »,
                « obligatoire » : faux
            },
            {
                « fieldName » : « duration »,
                « obligatoire » : faux
            },
            {
                « fieldName » : « calledUserNum »,
                « obligatoire » : faux
            },
            {
                « nomDechamp » : « appeléDeNomDeUtilisateur »,
                « obligatoire » : faux
            },
            {
                « fieldName » : « callUserName »,
                « obligatoire » : faux
            },
            {
                « fieldName » : « callUserNum »,
                « obligatoire » : faux
            },
            {
                « fieldName » : « hgName »,
                « obligatoire » : faux
            }
        ][
            {
                "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 » : faux,
        « metadata » : {
            « reportName » : null,
            « dateFilter » : {
                « présetName » : « ThisYear »,
                « presetFilterObject » : {
                    « unités » : 6,
                    « décalage » : 0,
                    « longueur » : 1,
                    « roundingMode » : 1,
                    « joursDeSemaine » : 127
                },
                « joursDeSemaine » : 127
            },
            « dateRéférence » : « 2025-09-22T15:27:40.1423161+00:00 »,
            « timeZoneReferenceDate » : « 2025-09-22T16:27:40 »,
            « filterId » : null,
            « additionalFilters » : \[],
            « workspaceFilterId » : null,
            « timezoneDateFrom » : « 2025-01-01T00:00:00 »,
            « timezoneDateTo » : « 2025-09-22T16:12:40 »,
            « timeZoneDateCreated » : « 2025-09-22T15:27:40.1423517+00:00 »,
            « timeZone Abréviation » : « BST »
        },
        « source » : « api.onboarding »,
        « pageTaille » : -1,
        « batchSize » : -1,
        « rowLimit » : 1000000,
        « PriorityLevel » : 2,
        « callRatePeriod » : 120,
        « ignorerAppelsAbandonnés » : faux,
        « ignorerShortAnsweredCalls » : faux,
        « accountCodeLabels » : {},
        « seuilsDeDurée de l'anneau » : [
            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
        ],
        « Recettes estiméesEntrantes » : 100,0,
        « incomingCallsPerSale » : 5,
        « Recettes estimées sortantes » : 100,0,
        « AppelsSortantsPerVente » : 5,
        « DuréeGroupPériodeEnSecondes » : 10,
        « timeZoneID » : « Europe/Londres »,
        « countryCode » : « GB »,
        « locale » : « en-GB »,
        « totalTrunks » : 10,
        « maxRows » : 0
    },
    « effort » : 210,17,
    « queryDurée » : 2076,
    « totalDurée » : 2121,
    « queryCount » : 2053,
    « rowLimitExceeded » : faux,
    « totalCount » : 922,
    « data » : [
        {
            « connId » : « 00000000-0000-0000-000000-00000000001 »,
            « start » : « 2025-09-18T11:16:31 »,
            « userName » : « Test User User 1 »,
            « userNum » : « 101 »,
            « cli » : « +11234567890 »,
            « cliName » : «  »,
            « hgNum » : « 200 »,
            « callType » : 2,
            « callDir » : 2,
            « ring » : 1.0,
            « durée » : 1,0,
            « appeléUserNum » : « +19876543210 »,
            « appeléDeNom d'Utilisateur » : « Inconnu »,
            « callUserNum » : « +11234567890 »,
            « hgName » : « File d'attente 200 »,
            « docId » : « 00000000-0000-0000-0000-000000000009 »
        },
        {
            « connId » : « 00000000-0000-0000-0000-000000000002 »,
            « start » : « 2025-09-18T11:16:13 »,
            « userName » : « Test User User 1 »,
            « userNum » : « 101 »,
            « cli » : « +11234567890 »,
            « cliName » : «  »,
            « callType » : 2,
            « callDir » : 3,
            « Réponse » : 1,
            « Ring » : 5.0,
            « durée » : 6,0,
            « appeléUserNum » : « +19876543210 »,
            « callUserName » : Utilisateur test 1 »,
            « callUserNum » : « 101 »,
            « docId » : « 00000000-0000-0000-0000-0000000000010 »
        },
        {
            « connId » : « 00000000-0000-0000-000000-00000000003 »,
            « start » : « 2025-01-03T16:44:40 »,
            « userName » : « Test User 2 »,
            « userNum » : « 102 »,
            « callType » : 1,
            « callDir » : 2,
            « Réponse » : 1,
            « ring » : 0.0,
            « durée » : 498,0,
            « appeléUserNum » : « 00000000-0000-0000-0000-000000000012 »,
            « appeléDeNom d'Utilisateur » : « Tester l'Utilisateur 2 »,
            « docId » : « 00000000-0000-0000-0000-00000000011 »
        }
    ][
        {
            "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"
        }
    ],
    « résumé » : [
        {
            « réponse » : 621,
            « réf. » : 37,
            « perdu » : 79,
            « Ring » : 3318.0,
            « durée » : 124315,0
        }
    ][
        {
            "ans": 621,
            "ref": 37,
            "lost": 79,
            "ring": 3318.0,
            "duration": 124315.0
        }
    ],
    « statut » : 1,
    « statusMessage » : « Traitement du rapport terminé »,
    « rowLimit » : 1000000
}

Erreurs #

Non autorisée #

Lorsque le jeton n'est pas fourni, qu'il n'est pas valide ou qu'il a expiré

HTTP/1.1 401 Non autorisé