Ressources pour les Intégrations Agent Assist personnalisées

Les ressources de cette page fournissent les informations nécessaires à la planification et à la mise en œuvre d’une intégration personnalisée d’aide aux agents avec NiCE CXone.

Applications d’agent prises en charge

MAX et les applications NiCE CXone Agent Workspace (Agent) sont prises en charge pour être utilisées avec les intégrations Agent Assist personnalisées. Dans les applications NiCE CXone Agent Workspace (Agent), les intégrations Agent Assist personnalisées s’ouvrent toujours dans un nouvel onglet.

Transmission audio

Les paquets audio sont encodés au format brut G711 μlaw 8 bits 8 000 kHz. Il s’agit du même format que tout l’audio de téléphonie NiCE CXone.

Lorsque vous configurez votre intégration Agent Assist personnalisée dans Agent Assist Hub, vous pouvez choisir l’audio que vous voulez envoyer à l’application Agent Assist. Vous pouvez envoyer l’audio du contact, de l’agent, ou des deux.

Au démarrer de chaque flux, NiCE CXone envoie un message initial à l’application Custom Agent Assist Endpoint. Le message initial comprend le paramètre streamPerspective, qui indique si le flux audio provient de l’agent ou du contact :

• "streamPerspective": "RX" : l’audio transmis par le téléphone de l’agent : l’agent qui parle.
• "streamPerspective": "TX" : l’audio que l’agent entend : le contact qui parle, ou plusieurs personnes si l’interaction est en mode conférence.
• "streamPerspective": "MIX" : Contient les flux audio de l’agent et du contact.

Une connexion websocket individuelle ne contient de l’audio que d’une seule perspective. Habituellement, il s’agit de TX ou RX, ce qui fournit une séparation stéréo. Un mélange des deux dans un seul flux mono est possible. Si une interaction a lieu en mode conférence, le son reçu dépend de la perspective de flux configurée. Si la perspective est TX, l’audio de tous les participants sauf l’agent est reçu.

Si la connexion est interrompue ou présente d’autres problèmes, comme des paquets perdus, le terminal Agent Assist personnalisé tente de rétablir la connexion au websocket. Il attend un nouvel l’établissement de liaison pour l’authentification identique au premier qu’il a reçu.

Si un contact est mis en attente, la connexion websocket est fermée. Lorsque l’interaction reprend, une nouvelle connexion websocket est établie. Il attend un établissement de liaison identique à celui d’origine.

Autorisation

Vous pouvez utiliser l’autorisation dans les intégrations Agent Assist personnalisées. Votre intégration peut nécessiter une authentification pour les demandes au tunnel mandataire et à l’application Agent Assist.

Autorisation pour le tunnel mandataire

Si vous voulez que le tunnel mandataire exige une autorisation pour les demandes lorsqu’elles y passent, vous devez inclure cette exigence dans votre conception. Vous pouvez utiliser n’importe quel type d’autorisation, comme des en-têtes ou une autorisation dynamique basée sur des jetons. Vous devez construire votre tunnel mandataire pour utiliser la méthode d’autorisation que vous avez choisie.

Vous devez également configurer votre script Studio pour gérer l’autorisation :

• Pour l’autorisation basée sur l’en-tête, le script doit inclure l’en-tête dans les requêtes qu’il envoie.
• Pour l’autorisation basée sur des jetons, le script doit demander un jeton, le stocker en cache et gérer l’expiration du jeton. Lorsque le jeton expire, le script doit demander un nouveau jeton, si nécessaire. Utilisez l’action REST API Studio action pour communiquer avec le serveur d’authentification.

Si vous utilisez l’autorisation dynamique, vous devez également configurer un serveur d’autorisation, si vous n’en avez pas déjà un. Le serveur d’autorisation fournit des jetons lorsque le script les demande.

Autorisation pour l’application d’aide aux agents

Si votre fournisseur d’aide aux agents exige une autorisation pour toutes les demandes, vous pouvez la configurer dans l’application Custom Agent Assist Endpoint dans Agent Assist Hub.

Pour utiliser l’autorisation avec votre intégration personnalisée, vous devez :

• Générez l’en-tête d’autorisation à utiliser dans vos scripts d’intégration personnalisée d’aide aux agents. Reportez-vous à la documentation de votre fournisseur d’aide aux agents pour connaître toutes les configurations applicables.
• Ajoutez les en-têtes requis à l’application Custom Agent Assist Endpoint dans Agent Assist Hub. Si vous utilisez l’application d’aide aux agents avec des interactions de texte et de voix, vous avez besoin d’en-têtes distincts pour chaque type d’interaction. Reportez-vous à la documentation de votre fournisseur d’aide aux agents pour obtenir des informations sur la manière de générer des en-têtes.

Vous n’avez rien à configurer dans votre script. L’application Custom Agent Assist Endpoint gère le transfert de l’en-tête à l’application d’aide aux agents.

NiCE CXone Exigences de configuration de la Plateforme

Aucune modification de configuration n’est requise dans la plateforme NiCE CXone pour configurer une intégration personnalisée d’aide aux agents. Vous pouvez modifier des scripts existants pour inclure la nouvelle application d’aide aux agents. Cependant, une certaine configuration peut être nécessaire en fonction de la manière dont votre organisation utilise la nouvelle application. Vous devrez peut-être :

• Créer un nouveau canal Divers moyens de communication vocale et numérique qui facilitent les interactions avec les clients dans un centre de contacts. pour la Voix ou le clavardage ACD.
• Créer un nouveau profil de clavardage pour le clavardage ACD.
• Créer une ou plusieurs Compétences acd et les assigner aux agents pour lesquels vous souhaitez que l’application personnalisée d’aide aux agents soit disponible.
• Créer un point d’accès pour un nouveau canal.
• Modifiez un point de contact point d’entrée qu’un contact entrant utilise pour amorcer une interaction, comme un numéro de téléphone ou une adresse courriel. existant pour lancer un nouveau script. Ne faites pas cette modification tant que votre intégration personnalisée d’aide aux agents n’est pas entièrement testée et prête à être mise en production.

Diagrammes de séquence

Les diagrammes de séquence montrent comment les différentes parties d’une intégration personnalisée d’aide aux agents interagissent et l’ordre dans lequel ces interactions se produisent. Ils montrent une chronologie d’une interaction, commençant en haut à gauche, puis se déplaçant de haut en bas de la page.

Les diagrammes de séquence sont une partie importante de la planification de votre intégration personnalisée. Vous pouvez les utiliser pour cartographier le flux des demandes et des réponses entre NiCE CXone, Agent Assist Hub, le tunnel proxy et votre application d’aide aux agents. Ils peuvent également être utiles pour déterminer le flux que doit suivre votre script Studio.

Studio Exigences et directives en matière de script

Utilisez les exemples suivants comme base pour créer les scripts permettant d'intégrer votre application d'assistance à l'agent à NiCE CXone. Les interactions entrantes et sortantes nécessitent des scripts distincts. L'image suivante montre les actions essentielles d'un script entrant :

Cette image montre les actions essentielles pour un script sortant :

Dans les deux scripts, la Charge utile des paramètres de script Snippet est facultative. Vous devez l'inclure uniquement si vous devez transmettre des paramètres à l'application d'assistance à l'agent.

Pour terminer la configuration de votre script :

• Attribuez l'application de configuration Custom Agent Assist Endpoints à l'action Agent Assist.

• Assurez-vous que l'action Script Param Payload Snippet facultative contient le custom payload JSON à envoyer au fournisseur Agent Assist.

• Assurez-vous que la propriété scriptParams dans l'action Agent Assist est définie à {customPayloadJSON}. Cela est requis uniquement si vous incluez l'action Snippet facultative avec une charge utile personnalisée.

• Ajoutez des extraits d'initialisation au script à l'aide des Snippet actions. Vous pouvez le faire pour personnaliser votre application d'assistance à l'agent.
• Reconfigurez les connecteurs d'action pour assurer un flux de contact adéquat et corriger toute erreur potentielle.
• Terminez tout script supplémentaire et testez le script.

Si vous avez besoin d'aide pour la création de scripts dans Studio, communiquez avec votre représentant de compte, consultez la section Guide de Référence Technique de l'aide en ligne Studio, ou visitez le site Communauté NiCE pour NiCE CXone.

Extrait de code Charge utile des paramètres de scripts

Cet extrait définit les données transmises à l'application d'assistance à l'agent par l'Agent Assist Action. Ajoutez ce code à une Snippet Action dans votre script :

DYNAMIC customParam
customParam.param1 = "{value1}"
customParam.param2 = "{value2}"
customParam.param3 = "{value3}"
customParam.param4 = "{value4}"

ASSIGN customParamjson = "{customParam.asJSON()}" 

S'il n'y a aucun paramètre de charge utile personnalisée à envoyer, mais que l'extrait paramètres de script est requis, vous pouvez inclure les déclarations de Variable dans l'extrait sans attribuer de valeurs. Par exemple :

DYNAMIC customParam
ASSIGN customParamjson = "{customParam.asJSON()}" 

Pour utiliser cet extrait de code :

1. Modifiez les noms et les valeurs des paramètres en fonction des besoins de votre organisation et de l’application d’aide aux agents que vous utilisez.
2. Placez l'Action Snippet dans le script avant l'Action Agent Assist.
3. Configurez la propriété scriptParams dans l'Action Agent Assist Action avec le nom de la Variable qui contient le JSON. Dans l'exemple fourni, il s'agirait de customParamjson.

Nouveaux scripts ou scripts existants

Vous pouvez créer de nouveaux scripts à utiliser avec votre intégration personnalisée d’aide aux agents. Vous pouvez également modifier des scripts existants. Ne faites pas de modifications directement aux scripts actuellement en production. Cela peut entraîner des erreurs qui interrompent le routage des contacts.

Si vous souhaitez utiliser un script existant, enregistrez une copie du script et modifiez-la. Lorsque votre intégration personnalisée est entièrement testée et prête pour l’implémentation, vous pouvez remettre le script modifié en production. Mettez un script en production en effectuant l’une des actions suivantes :

• Enregistrez-le avec le nom d’un script en cours de production.
• Configurez un point d’accès point d’entrée qu’un contact entrant utilise pour amorcer une interaction, comme un numéro de téléphone ou une adresse courriel. pour utiliser le script. Vous pouvez enregistrer le script sous un nouveau nom avant de configurer le point d’accès.

Développement et spécifications du webhook du tunnel mandataire

Le tunnel mandataire est l’intergiciel entre NiCE CXone et le terminal de votre application d’assistance à l’agent. Toutes les demandes et les réponses y transitent. Il doit traduire les demandes provenant de NiCE CXone dans un format que l’application d’assistance à l’agent comprend. De même, il doit traduire les réponses de l’application d’assistance à l’agent dans le format que NiCE CXone comprend. Pour effectuer ces traductions, vous devez mapper les terminaux entre NiCE CXone et l’application d’assistance à l’agent.

Le tunnel mandataire n’est pas obligatoire. Cependant, il est recommandé de l’inclure dans votre intégration. Le tunnel mandataire offre les avantages suivants :

• Il offre une sécurité accrue, car il n’y a qu’un seul point d’entrée à gérer dans votre centre de données.
• Il assure le basculement et l’équilibrage de la charge.
• Il traduit les protocoles entre NiCE CXone et le système du fournisseur d’aide aux agents.

Si vous n’incluez pas de tunnel mandataire dans votre intégration, le script envoie la demande websocket initiale aux URL du webhook. Vous devez configurer votre script pour envoyer et recevoir des demandes dans le format attendu par l’application d’assistance à l’agent.

Les sections suivantes fournissent les éléments suivants :

• Faits marquants sur les intégrations personnalisées d’aide de l’agent et les terminaux du tunnel de mandataire.
• Format de la demande websocket initiale de NiCE CXone pour les interactions voix.
• Format de la réponse à l’établissement de liaison pour les interactions vocales.
• Format de la connexion webhook pour les interactions de clavardage.
• Format pour inclure les paramètres de configuration dans les requêtes.

Faits marquants sur le développement d’un tunnel mandataire

Les informations suivantes peuvent vous aider à planifier et à développer le terminal du tunnel mandataire :

• Le terminal de relais de texte doit utiliser HTTPS. Il ne fonctionnera pas avec HTTP.

• Le terminal de relais audio doit être un websocket. Il peut être sécurisé (WSS) ou non sécurisé (WS).

• Tous les terminaux de tunnel mandataire doivent être en mesure d’envoyer et de recevoir des communications du réseau NiCE CXone.

• Seules des données binaires transitent par le webhook.

• Pour les interactions vocales, les seules données envoyées depuis l’appel sont des octets audio. Aucun contrôle d’appel ni aucune autre métadonnée n’est inclus.

• Les intégrations personnalisées d’aide aux agents prennent en charge au moins 2 000 demandes simultanées.

• Il n’y a pas de délai d’expiration ou de durée maximale de connexion pour la diffusion en continu d’une interaction. Les intégrations personnalisées d’assistance à l’agent permettent aux appels de rester ouverts tant que l’appel est actif. Lorsque l’appel se termine, la connexion se ferme.

• Lorsqu’un appel est mis en attente, la connexion reste ouverte, mais aucune donnée n’est envoyée.

• Les IDs de contact sont uniques par locataire Regroupement organisationnel de haut niveau utilisé pour gérer le soutien technique, la facturation et les paramètres globaux de votre système NiCE CXone.. NiCE CXone dispose d’une API que vous pouvez utiliser pour obtenir des données en temps réel sur le contactID. Pour consulter la documentation sur l’API, vous devez avoir accès au Dev Portal de NiCE CXone. Demandez à votre représentant de compte des informations sur l’accès.

Se connecter au webhook audio : Demande initiale

Les interactions vocales doivent utiliser des demandes websocket (WSS ou WS). La demande websocket initiale de NiCE CXone respecte le format suivant :

 

"authenticationToken": "[header provided in Custom Agent Assist app]",

"executionInfo": {    

      "contactId": 0, 

      "busNo": 0, 

      "requestId": 0,  

      "actionType": "string",  

      "actionId": 0,  

      "scriptName": "string"

},

      "systemTelemetryData": {    

            "consumerProcessHost": "string",  

            "consumerProcessName": "string",  

            "consumerProcessVersion": "string",  

            "inContactClusterAlias": "string",  

            "inContactScriptEngineHost": "string",  

            "consumerMetaData": {  

                  "additionalProp1": "string",

                  "additionalProp2": "string",   

                  "additionalProp3": "string"  

            }

      },

"streamPerspective": "TX/RX/MIX",

"streamsConfiguration": "string",

"appParams": "string",

"appConfig": "string"

			

		

Les paramètres de cette demande sont décrits dans la section Schémas de cette page :

• authenticationToken, streamsConfiguration, appParams et appConfig sont tous décrits dans la section WebSocketHookInitializeMessage.
• systemTelemetryData est décrit dans sa propre section.
• streamPerspective est décrit dans sa propre section.

Connexion au webhook audio : Réponse de prise de contact

Si authenticationToken est fourni, validez le jeton ou l'en-tête, puis envoyez la réponse de prise de contact. La réponse doit respecter le format de la classe CXoneWebSocketMessage :

public class CXOneWebSocketMessage 

{ 

/// Type of command - see CXOneWebSocketCommandType below

public CXOneWebSocketCommandType command { get; set; } 



/// Type of message returned 

public string messageType { get; set; } 



/// Text message 

public string message { get; set; } 



/// Additional parameters 

public object parameters { get; set; } 

)



public enum CXOneWebSocketCommandType

{ 

CONNECT, 

/// When the initial message/auth validation is a success 

CONNECTED, 

/// Message command 

MESSAGE,  

/// Error command, for example when the initial message/auth is invalid 

ERROR

}

		

Par exemple :

{

    "command": "CONNECTED",

    "messageType": "COMMAND",

    "message": "BEGIN AUDIO STREAM"

}

		

Un exemple de code pour se connecter avec socket Web :

	

WebSocketReceiveResult result = await webSocket.ReceiveAsync(buffer, CancellationToken.None);

if (result.MessageType == WebSocketMessageType.Text)

{ 

    _logger.LogInformation(string.Concat ("MessageType : ", result.MessageType.ToString()));

    if (buffer == null || buffer?.Length == 0)

    {

       return;

    }

    var message = Encoding.UTF8.GetString(buffer, 0, buffer?.Length ?? 0);

    _logger.LogInformation(string.Concat("On Connected", message));

 

    // Validates initial message

    var initialMessage = JsonConvert.DeserializeObject<WebSocketHookInitializeMessage>(message);

    webSocketHookInitilizeMessage = initialMessage;

    param = JsonConvert.SerializeObject(webSocketHookInitializeMessage.appConfig);

 

    // Send response back to  after successful validation

    CXOneWebSocketMessage connectedMessage = new CXOneWebSocketMessage

    {

       command = CXOneWebSocketCommandType.CONNECTED,

       messageType = "COMMAND", 

       message = "BEGIN AUDIO STREAM"

   }; 



    var jsonResponse = Newtonsoft.Json.JsonConvert.SerializeObject(connectedMessage);

    await webSocket?.SendAsync(buffer: new ArraySegment<byte>(array: Encoding.UTF8.GetBytes(jsonResponse),

             offset: 0,

             count: jsonResponse.Length),

             messageType: WebSocketMessageType.Text,

             endOfMessage: true,

             cancellationToken: CancellationToken.None);

}



else if (result.MessageType == WebSocketMessageType.Binary)

{

// You can read the binary voice data

}		

				

		

Voir une image de l’exemple de code

La section Schémas de cette page décrit les éléments suivants :

• WebSocketHookInitializeMessage
• CXoneWebSocketMessage
• CXoneWebSocketCommandType

Connexion au webhook de texte

Pour recevoir des données de clavardage textuel, vous devez vous connecter au webhook de texte. Seules les demandes HTTP/HTTPS sont acceptées.

Chaque demande comprend les objets suivants. L'en-tête d'autorisation est envoyé uniquement si vous en ajoutez un dans l'application Custom Agent Assist Endpoints dans Agent Assist Hub. Les en-têtes d'autorisation ne sont pas obligatoires.

public class WebHooksMessagesRequest

{

	/// If you provide this information in the configuration, it's included.

	public string authorizationHeader { get; set; }

	public int contactId { get; set; }

	public int busNo { get; set; }

	public string tenantId { get; set; }

	

	/// This will be one of the following: patron, agent, or system

	public string participantId { get; set; }

	

	/// Text of the user input (from participantId)

	public string messageBody { get; set; }

	

	/// Other useful data about the message or that are part of the message, such as images or links.

	public object messageData { get; set; }

	

	/// Configuration blob from Agent Assist Hub. 

	/// It may only include the configuration identifier for apps that have large amounts of configuration data.

	public object agentAssistAppConfig { get; set; }

}

 	

Les paramètres de ce code sont décrits dans la section Schémas de cette page.

Paramètres de configuration

Vous pouvez inclure des paramètres supplémentaires lorsque vous configurez l'application Custom Agent Assist Endpoints dans Agent Assist Hub. Cela est utile si votre fournisseur d'aide à l'agent exige que certains paramètres soient envoyés avec chaque demande. Ils ne sont pas obligatoires. Tout paramètre que vous ajoutez est envoyé dans l'objet agentAssistAppConfig de l'objet WebHooksMessagesRequest. Par exemple :

"agentAssistAppConfig":{ 

   "param1": "value1", 

   "param2": "value2",

} 

		

TerminauxNiCE CXone pour les Intégrations personnalisées d’aide aux agents

Les terminaux API fournis ici sont des références interactives que vous pouvez utiliser avec votre intégration d'aide à l'agent personnalisée pour obtenir des exemples de demandes provenant de NiCE CXone. Des informations supplémentaires, y compris les schémas originaux, sont disponibles dans la documentation Swagger de l'API.

Terminaux pour les Applications d’aide aux agents basées sur la Voix

GET ​/agent_assist_audio_websocket_hooks​/example-websocket-server : ce terminal vous donne un exemple d'URL de demande de serveur websocket. Cet exemple respecte la spécification du webhook websocket audio NiCE CXone.

GET /agent_assist_audio_websocket_hooks/initializemessage-example : Ce terminal vous donne un exemple de message d’initialisation de WebSocket.

POST /agent_assist_audio_websocket_hooks/custom-assist-endpoint/initialize-audio-message-example : ce terminal vous donne un exemple de la demande initiale et de la réponse. Consultez le schéma WebSocketHookInitializeMessage et le schéma CXoneWebSocketMessage pour plus de détails.

Terminal pour les Applications d’aide de l’agent basées sur le clavardage

POST ​/agent_assist_text_webhooks​/utterance : ce terminal vous donne un exemple de réception d'énoncés Ce qu’un contact dit ou tape. textuels en temps réel et de fourniture d'aide à l'agent de façon asynchrone. Les énoncés peuvent concerner uniquement le contact, uniquement l’agent ou les deux.

Schémas

Les sections suivantes fournissent des informations sur les schémas utilisés avec les terminaux d'aide à l'agent personnalisés. Vérifiez toujours les schémas dans la dernière version du document Swagger avant d'utiliser ces informations dans vos scripts.

ActionExecutionInfo

Contient des informations sur l’action et le script en cours d’exécution.

Paramètre	Catégorie	Détails
contactId	Nombre entier	L’identifiant unique de l’interaction.
busNo	Nombre entier	L’ID de l’NiCE CXoneunité commerciale Regroupement organisationnel de haut niveau utilisé pour gérer le soutien technique, la facturation et les paramètres globaux de votre système NiCE CXone. où se trouve le script.
requestId	Nombre entier	Un nombre itératif qui identifie chaque demande dans une interaction particulière. Si vous incluez le requestId dans les demandes, il peut être inclus dans les réponses. Cela peut s’avérer utile pour le dépannage ou la résolution d’autres problèmes. Si requestID est une valeur unique, elle peut être utilisée pour localiser une seule demande/réponse dans les fichiers journaux.
actionType	String	Le type d’action qui effectue la requête auprès du terminal personnalisé.
actionId	Nombre entier	Le numéro d’ID de l’action Studio dans le script. Les Id d’action sont basés sur l’ordre dans lequel les actions ont été ajoutées au script.
scriptName	String	Le chemin d’accès et le nom du script à l’origine de la requête.

AgentAssistUtterance_V1

Contient le corps du message et des informations sur le message.

Paramètre	Catégorie	Détails
contactId	integer ($int64)	L’ID du contact dans l’instance actuelle du script.
busNo	integer ($int32)	L'ID de l'unité commerciale Regroupement organisationnel de haut niveau utilisé pour gérer le soutien technique, la facturation et les paramètres globaux de votre système NiCE CXone. NiCE CXone où se trouve le script.
tenantId	string	L'ID du locataire NiCE CXone où se trouve le script.
participantId	string	Indique si le message inclut le contact (Client), l’agent (Agent) ou les deux (Système).
messageBody	string	Le texte du message.
messageMetaData		Contient les paramètres qui renferment des données utiles sur le message dans messageBody. Si le message est un message clavardage, ce paramètre peut également contenir des images, des liens ou tout autre contenu envoyé dans le cadre du message.
agentAssistAppConfig		Contient les informations de configuration provenant de Agent Assist Hub. Pour les applications d'aide aux agents comportant des blobs de configuration large, cet objet peut inclure uniquement l'identifiant de configuration. { "agentAssistAppConfig":         {           "param1": "value1",           "param2": "value2"         } }

CXoneWebSocketCommandType

Définit le type de commande envoyé. Les valeurs possibles sont :

• CONNECTER.
• CONNECTÉ lorsque le message initial ou la validation de l’autorisation est réussie.
• MESSAGE à utiliser lors de l’envoi d’un message.
• ERREUR à utiliser lorsque le message initial ou la validation de l’autorisation n’est pas valide.

CXoneWebSocketMessage

Contient le message envoyé à NiCE CXone par l’application d’aide aux agents.

{

	additional parameters

}

StreamPerspective

Contient un tableau de chaînes avec trois valeurs possibles. Ce paramètre reflète la configuration de Participants effectuée dans l’application Custom Agent Assist Endpoints dans Agent Assist Hub. Il définit si le flux audio contient l’audio du contact uniquement (0 (TX)), de l’agent uniquement (1 (RX) ), ou une combinaison (2 (MX)).

SystemTelemetryData

Contient des données sur le consommateur de l'API qui ne sont pas associées à l'Action de script Studio. Les données contenues dans cet objet peuvent être utiles pour le débogage, la facturation, les rapports, etc.

{
	< * >:

}

WebSocketHookInitializeMessage

Voici la structure du message pour la première charge utile provenant d’un client websocket en connexion, comme le serveur multimédia NiCE CXone.

{

	parameters

}

{

	parameters

}