Accéder aux enregistrements à partir d’applications externes

Vous pouvez lire et télécharger des Recordings à partir d’applications externes, telles que votre système CRM.

Il existe 2 façons principales d’accéder aux enregistrements depuis l’extérieur de CXone Mpower :

API de lecture multimédia

Utilisez les API de lecture multimédia pour accéder aux médias et métadonnées Recording lors de l'extraction de segments d'appel et de contacts.

L'utilisation de ces API peut nécessiter des frais supplémentaires. Consultez votre contrat ou contactez votre CXone Mpower Représentant de compte pour plus d'informations.

  • Lors de l'extraction d'une interaction :

    • Pour les types de médias voix uniquement et voix et écran, l'API fournit les métadonnées d'interaction. Le lien vers le fichier multimédia se trouve sous le champ fileToPlayUrl dans la réponse de réussite.

    • Pour les types de médias chat et e-mail, l'API fournit les métadonnées d'interaction et la transcription. Dans la réponse Success, vous pouvez trouver la transcription sous le champ messages et le lien vers le fichier multimédia sous le champ filetoplayurl .

      Si le type de média est défini sur tous (et non spécifiquement défini sur chat ou e-mail), alors s'il y a un enregistrement d'écran, vous obtiendrez également un lien vers le fichier multimédia pour les interactions numériques. Vous pouvez utiliser cette API pour accéder aux médias et métadonnées d'enregistrement CXone.

  • Lors du téléchargement, l’API transfère un lien vers le fichier multimédia.

Les API de lecture multimédia sont disponibles dans le DEVoneportail de la communauté des développeurs.

Avant de commencer

Avant de commencer à utiliser l’API de lecture multimédia, vous devez définir des autorisations d’utilisateur, générer une clé d’accès et suivre la procédure d’enregistrement et d’authentification expliquée sur le portail des développeurs. Autorisations requises :

  • Si vous recherchez des enregistrements qui ne sont pas sous votre compte, vous avez besoin de l’autorisation Recherche et lecture > Lecteur > Lire/télécharger des enregistrements : Lire tout.

  • Si vous souhaitez que la demande renvoie des sentiments et des catégories, vous avez également besoin de l’autorisation Recherche et lecture > Lecteur > Afficher les sentiments et les catégories.

GET Contacts

Accédez au contact complet (toute l’interaction avec tous les segments) en fonction de l’identification d’appel ACD. L’ID d’appel ACD dépend de la solution ACD, par exemple, il est identique à l’ID de contact principal (maître) CXone Mpower.

Vous pouvez trouver l’ID d’appel ACD correct de la manière suivante :

  • Utiliser l’ID de contact principal du rapport sur l’historique des contacts.

  • Utiliser l’ID d’appel ACD provenant de l’entité Métadonnées de l’API d’extraction de données.

Gardez à l’esprit qu’en utilisant la méthode ACD Call ID GET, vous pouvez lire ou télécharger les interactions enregistrées à partir du 13 décembre 2018. L’accès à une interaction enregistrée avant le 13 décembre 2018 entraînera une erreur d’interaction non trouvée.

Lecture

var(--codeSnippetCopyLabel) 
https://na1.nice-incontact.com/media-playback/v1/contacts?acd-call-id=123456&media-type=all&exclude-waveforms=true
var(--codeSnippetCopyLabel) 
200 OK
    {
  "value": {
    "contactId": "11e766de-4ace-33d0-9ff6-0242ac110004",
    "Interactions": [
      {
        "Interaction": {
          "mediaType": "voice-and-screen",
          "startTime": "2018-11-20T08:20:31.941Z",
          "endTime": "2018-11-20T08:25:56.957Z",
          "data": {
            "startTime": "2018-11-20T08:20:31.941Z",
            "endTime": "2018-11-20T08:25:56.957Z",
            "acwEndTime": "2018-11-20T08:27:09.643Z",
            "fileToPlayUrl": "https://test-mcrplaybackmanager-4b5e-9234-54cbe7855ca1.mp4",
            "videoImageUrl": null,
            "waveformDataList": [
              {
                "channel": 0,
                "normalizedPcmData": [
                  0.001,
                  0.001,
                  0.001
                ]
              }
            ],
            "participantDataList": [
              {
                "participantType": "AGENT",
                "agentName": "Mary Walker",
                "participantId": "271863",
                "userId": "11e846d2-dd9f-6f10-9aef-0242ac110002",
                "voiceStages": [
                  {
                    "stageType": "ACTIVE",
                    "startTime": "2018-11-20T08:20:31.941Z",
                    "endTime": "2018-11-20T08:25:56.957Z",
                    "segmentID": "e079511b-c077-489e-85a3-24b1b147d3c7",
                    "displays": null
                  }
                ],
                "screenStages": [
                  {
                    "stageType": "ACTIVE",
                    "startTime": "2018-11-20T08:20:31.941Z",
                    "endTime": "2018-11-20T08:25:56.957Z",
                    "segmentID": "e7621f2c-32e4-47cd-bfc5-29a48343f7e0",
                    "displays": [
                      {
                        "width": 1680,
                        "height": 1050,
                        "topLeftX": -1680,
                        "topLeftY": 0
                      },
                      {
                        "width": 1680,
                        "height": 1050,
                        "topLeftX": 0,
                        "topLeftY": 0
                      },
                      {
                        "width": 1366,
                        "height": 768,
                        "topLeftX": 1680,
                        "topLeftY": 0
                      }
                    ]
                  }
                ],
                "channel": 0
              },
              {
                "participantType": "CUSTOMER",
                "agentName": null,
                "participantId": "68367118",
                "userId": null,
                "voiceStages": [
                  {
                    "stageType": "ACTIVE",
                    "startTime": "2018-11-20T08:20:31.941Z",
                    "endTime": "2018-11-20T08:25:56.957Z",
                    "segmentID": "e079511b-c077-489e-85a3-24b1b147d3c7",
                    "displays": null
                  }
                ],
                "screenStages": [],
                "channel": 0
              }
            ],
            "segmentsDataList": [
              {
                "startTime": "2018-11-20T08:20:31.941Z",
                "endTime": "2018-11-20T08:25:56.957Z",
                "acwEndTime": "2018-11-20T08:27:09.643Z",
                "openReasonType": "SEGMENT",
                "closeReasonType": "SEGMENT",
                "directionType": "OUTBOUND",
                "source": null
              }
            ],
            "categoryMatchesList": [
              {
                "categoryHierarchy": [
                  "Account Inquiries",
                  "Account Problems"
                ],
                "secondsOffsets": [
                  24
                ],
                "confidence": 95
              }
            ],
            "sentiments": [
              {
                "overallSentiment": "POSITIVE",
                "segmentStartTime": "2018-11-20T08:20:31.941Z",
                "channel": 1
              },
              {
                "overallSentiment": "POSITIVE",
                "segmentStartTime": "2018-11-20T08:20:31.941Z",
                "channel": 0
              }
            ]
          }
        }
      },
      {
        "Interaction": {
          "mediaType": "chat",
          "startTime": "2018-11-21T08:27:09.643Z",
          "endTime": "2018-11-21T18:20:31.941Z",
          "data": {
            "startTime": "2018-11-21T08:27:09.643Z",
            "endTime": "2018-11-21T18:20:31.941Z",
            "transferPoints": [
              "2018-11-21T10:34:23.433Z"
            ],
            "participants": [
              {
                "participantType": "AGENT",
                "participantName": "Kevin Allen"
              },
              {
                "participantType": "CUSTOMER",
                "participantName": ""
              }
            ],
            "messages": [
              {
                "participantType": "AGENT",
                "participantName": "Kevin Allen",
                "text": "agent 1",
                "timeStamp": "2018-11-21T10:35:23.643Z"
              },
              {
                "participantType": "CUSTOMER",
                "participantName": "",
                "text": "Betty Alexander"
              }
            ]
          }
        }
      },
      {
        "Interaction": {
          "mediaType": "email",
          "startTime": "2018-11-21T18:30:09.643Z",
          "endTime": "2018-11-21T18:36:36.347Z",
          "data": {
            "startTime": "2018-11-21T18:30:09.643Z",
            "endTime": "2018-11-21T18:34:56.957Z",
            "acwEndTime": "2018-11-21T18:36:36.347Z",
            "participants": [
              {
                "participantType": "AGENT",
                "participantName": "Angela Bryant",
                "actions": [
                  {
                    "timeStamp": "2018-11-21T18:30:09.643Z",
                    "action": "NewOutbound"
                  },
                  {
                    "timeStamp": "2018-11-21T18:34:56.957Z",
                    "action": "Send"
                  }
                ]
              }
            ],
            "content": {
              "sentTime": "2018-11-21T18:34:56.957Z",
              "from": "doNotAnswer@ourcompany.com",
              "to": [
                "angelab@yourcompany.com"
              ],
              "cc": [],
              "bcc": [],
              "subject": "Hello",
              "body": "Hi"
            }
          }
        }
      }
    ]
  }
 }

Télécharger

var(--codeSnippetCopyLabel) 
https://na1.nice-incontact.com/media-playback/v1/contacts?acd-call-id=123456&media-type=all&exclude-waveforms=true&isDownload=true
var(--codeSnippetCopyLabel) 
{
    "redirectUrl" : "https://na1-mcrplaybackmanager-12345ABCDEF.s3.us-west-2.amazonaws.com/tenant/output_12345ABCDEF.mp4?X-Amz-Security-Token=12345ABCDEF12345X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200820T114056Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Credential=12345ABCDEFus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=12345ABCDEF"
}

Réponses

  • 200 succès

  • 400 Requête non valide

  • 401 Non autorisé à lire

  • 403 Autorisation requise

  • Interaction 404 introuvable

  • 500 Erreur de serveur interne

    Une réponse « 500 Erreur de serveur interne » avec le code d’erreur interne 8401 indique une limitation technique de l’API. Vous pouvez lire et télécharger tous les enregistrements dans le lecteur CXone Mpower.

GET Instructions

Accéder à un relevé d’enregistrement basé sur l’ID de contact ACD et l’ID de déclaration. L’ID de contact ACD dépend de la solution ACD. Par exemple, ici, acdContactId est l’ID de contact principalFermé ID principal ou parent d’un ou de plusieurs contacts associés. Un nouvel ID de contact principal sera attribué si un contact a été transféré 3 fois ou plus..

L’URL renvoyée par l’API est valable pendant 30 minutes ou pendant la durée de l’appel, la durée la plus longue étant retenue.

Réponses

  • 200 succès

  • 400 Requête non valide

  • 401 Non autorisé à lire

  • 403 Autorisation requise

  • Interaction 404 introuvable

  • 500 Erreur de serveur interne

GET ID de segment

Accédez à un segment d’enregistrement à l’aide de l’ID de segment, indépendamment de l’ID de contact associé. Les identifiants de segment peuvent être trouvés dans la recherche d'interaction ou en utilisant l'API d'extraction de données. Seuls les segments du stockage actif sont accessibles. Les segments du stockage à long terme doivent être déplacés vers le stockage actif avant de pouvoir y accéder.

Réponses

  • Statut 200 - Opération réussie.

  • Statut 202 – L’opération est en cours.

  • Statut 400-Mauvaise demande.

  • Statut 401 - L'utilisateur demandeur n'a pas pu s'authentifier.

  • Statut 403 - L'utilisateur demandeur n'est pas autorisé à effectuer l'opération.

  • Statut 404-Non trouvé. Aucune interaction active n’a été trouvée.

  • Statut 425 - L'interaction est verrouillée lors du traitement d'une demande précédente.

  • Statut 500 - Erreur interne du serveur.

  • Statut 504 - La demande a expiré.

Accéder aux fichiers multimédias à partir de votre système CRM

Vous pouvez lire ou télécharger des fichiers multimédias directement à partir de votre système CRM à l’aide d’une URL.

Générer l’URL dans Studio et intégrez-la dans votre système CRM. Les services professionnels peuvent vous aider, mais ce service peut être payant. Contactez votre Représentant de compte pour en apprendre davantage.

Par exemple :

  • Pour lire le fichier :

    • Enregistrement vocal ou numérique : https://na1.nice-incontact.com/player/#/cxone-player/acd-contacts/acdContactId

    • Déclaration enregistrée : https://na1.nice-incontact.com/player/#/cxone-player/acd-contacts/acdContactId/statements/statementId

    L’URL de lecture lance le lecteur CXone Mpower par défaut. Vous pouvez le configurer pour qu’il s’ouvre dans d’autres lecteurs.

  • Pour télécharger le fichier :

    • Enregistrement vocal et vidéocapture d’écran : https://na1.nice-incontact.com/media-download/#/acd-contacts?acdContactId=acdContactId&isDownload=true

    • Voix uniquement : https://na1.nice-incontact.com/media-download/#/acd-contacts?acdContactId=acdContactId&isDownload=true&mediaType=voice-only

    • Déclaration enregistrée : https://na1.nice-incontact.com/media-download/#/acd-contacts/acdContactId/statements/statementId?isDownload=true&mediaType=voice-only

    Le nom de fichier est formaté comme CXone recording_{nom de l’agent}_{heure de début d’appel}[UTC]_{Id}.mp4. Notez que la date dans le nom de fichier est en UTC, contrairement au Lecteur, qui s’affiche dans votre fuseau horaire local.

L’acdContactId est l’ID de contact principalFermé ID principal ou parent d’un ou de plusieurs contacts associés. Un nouvel ID de contact principal sera attribué si un contact a été transféré 3 fois ou plus. CXone Mpower.