Méthodes Microsoft.CIFramework (référence d’API JavaScript) pour Environnement d’intégration du canal de Dynamics 365 2.0
Microsoft CIFramework fournit des méthodes pour utiliser l’API JavaScript pour gérer le panneau de communication (widget), la notification, l’onglet d’application, les sessions, les enregistrements et les formulaires dans l’application Dynamics 365 pilotée par le modèle.
Important
- Les API sont prises en charge uniquement par les fournisseurs de canaux actifs configurés dans votre organisation.
- Le gestionnaire d’événements CIFInitDone doit être invoqué avant d’appeler les autres API.
- Le délai d’expiration des API est de 100 secondes. Si les API ne s’exécutent pas dans les 100 secondes, elles doivent être réexécutées avec des paramètres ou une portée modifiés.
API de gestion du volet de communication
Le volet Communications vous permet, en tant qu’agent, d’interagir avec le client. Les widgets partenaires créés avec Environnement d’intégration du canal 2.0 sont chargés dans ce panneau. Le widget de cette version est affiché à gauche du panneau de session et prend en charge les modes Ancré, Minimisé et Masqué.
Utilisez les API suivantes pour gérer l’état du panneau de communication (widget).
| Méthodes | Description |
|---|---|
| setWidth | Définit la largeur du panneau pour toutes les sessions. |
| getWidth | Obtient la largeur du volet en pixels. |
| setMode | Définit l’état du volet. |
| getMode | Définit l’état du volet. |
API d’opérations CRUD
Utilisez les API suivantes pour effectuer des opérations CRUD sur les enregistrements d’entité.
| Méthodes | Description |
|---|---|
| createRecord | Crée un enregistrement d’entité. |
| retrieveRecord | Récupère un enregistrement d’entité. |
| updateRecord | Met à jour un enregistrement d’entité. |
| deleteRecord | Supprime un enregistrement d’entité. |
API de gestion de notification
Utilisez les API suivantes pour afficher ou annuler les notifications concernant les conversations entrantes.
| Méthodes | Description |
|---|---|
| notifyEvent | Affiche une notification qui peut être utilisée pour informer l’agent d’une conversation entrante. |
| cancelEvent | Masque ou annule une notification basée sur le jeton d’annulation, comme spécifié dans la méthode notifyEvent. |
API de gestion d’onglet d’application
Utilisez les API suivantes pour créer et gérer l’état du panneau d’un onglet d’application.
| Méthodes | Description |
|---|---|
| createTab | Crée un onglet dans une session ciblée et renvoie l’identificateur unique de l’onglet créé. |
| getTabs | Renvoie un tableau d’identificateurs d’onglets associés au nom du modèle ou aux balises de modèle pour les onglets de la session active, si la session appartient au fournisseur de canal. |
| focusTab | Définit le focus sur un onglet, si la session ciblée appartient au fournisseur de canal et si l’onglet appartient à la session ciblée. |
| getFocusedTab | Renvoie l’identificateur de l’onglet dans une session ciblée, si la session appartient au fournisseur. |
| refreshTab | Actualise l’onglet. |
| setTabTitle | Définit le titre de l’onglet, si la session ciblée appartient au fournisseur de canal et si l’onglet appartient à la session ciblée. |
| closeTab | Ferme l’onglet spécifié dans la session en cours. |
API de gestion de session
Utilisez les API suivantes pour gérer les sessions dans un environnement de fournisseur multisession.
| Méthodes | Description |
|---|---|
| canCreateSession | Permet de vérifier si une nouvelle session peut être créée. |
| createSession | Crée une session en fonction du nom du modèle de session défini dans le cadre du modèle et renvoie l’identifiant unique de la session créée. |
| getSession | Renvoie un objet contenant l’identificateur unique de la session, le contexte et la valeur du paramètre isFocused , dans le cas où la session appartient au fournisseur de canal. |
| getFocusedSession | Renvoie l’identificateur unique de la session en cours, si elle appartient au fournisseur de canal, sinon renvoie null. |
| getAllSessions | Renvoie le tableau d’identifiants de session pour un fournisseur de canal. |
| setSessionTitle | Définit le titre de la session, si la session appartient au fournisseur de canal. |
| requestFocusSession | Définit le focus sur la session dont l’identificateur de session est passé en paramètre, si la session appartient au fournisseur de canal. |
API d’analyse du canal
Utilisez les API suivantes pour suivre l’analyse des événements.
| Méthodes | Description |
|---|---|
| logAnalyticsEvent | Appelez cette méthode pour enregistrer les analyses des événements personnalisés. |
API d’indicateur de session
Utilisez les API suivantes pour indiquer une violation d’indicateur de performance clé (KPI) et pour mettre à jour le nombre de nouvelles activités dans une session particulière.
| Méthodes | Description |
|---|---|
| notifyKpiBreach | Cette méthode est utilisée pour indiquer une violation d’indicateur de performance clé. Lorsque cette méthode est utilisée, un cercle rouge apparaît sur l’image d’affichage du contact lorsqu’une violation d’indicateur de performance cIé s’est produite. |
| notifyNewActivity | Cette méthode est utilisée pour mettre à jour le nombre de nouvelles activités dans une session particulière. |
API de présence
Utilisez ces API pour définir et récupérer la présence de l’agent Omnicanal par programmation. Vous pouvez utiliser ces méthodes lorsqu’un agent mixte travaille sur une application tierce avec omnicanal et que vous souhaitez synchroniser les états de présence entre différentes applications pour garantir que la capacité de l’agent est utilisée de manière optimale.
| Méthodes | Description |
|---|---|
| setPresence | Permet de définir par programme la présence de l’agent dans la session client. |
| getPresence | Permet de retourner par programme la présence de l’agent dans la session client. |
Méthodes diverses
| Méthodes | Description |
|---|---|
| getEntityMetadata | Renvoie les métadonnées pour l’entité spécifiée. |
| setClickToAct | Définit une valeur booléenne pour activer ou désactiver la communication sortante (ClickToAct). |
| getClickToAct | Renvoie une valeur booléenne pour indiquer si la communication sortante (ClickToAct) est activée ou non. |
| searchAndOpenRecords | La méthode recherche l’enregistrement du widget de communication pendant la communication entrante et ouvre l’enregistrement. |
| getEnvironment | Permet d’obtenir des détails sur l’application et la page Unified Interface actuelles. Les détails incluent l’ID d’application (appid), le type de page (pageType), l’ID d’enregistrement (id), la géographie de l’organisation (orgGeo) et le type de navigation de session (navigationType). |
| openForm | Ouvre un formulaire d’entité ou un formulaire de création rapide. |
| renderSearchPage | Vous permet de rechercher parmi les enregistrements d’un type d’entité spécifique. Cette API ouvre la page d’entité Unified Interface avec le champ de recherche déjà complété avec la chaîne recherchée transmise comme paramètre. |
| addHandler | Ajoute l’abonné aux événements.
Note Cette API peut être utilisée à la fois sur le widget et sur la page Unified Interface. |
| removeHandler | Supprime l’abonné des événements.
Note Cette API peut être utilisée à la fois sur le widget et sur la page Unified Interface. |
| raiseEvent | Appelle l’abonné associé à l’événement.
Note Si vous avez créé des événements personnalisés à l’aide de la méthode addHandler, vous pouvez déclencher ces événements en passant le nom de l’événement en tant que paramètre dans cette méthode. |
| updateContext | Cette méthode vous permet de définir le dictionnaire d’automatisation. |
| updateConversation | Cette méthode vous permet de mettre à jour un enregistrement de conversation. |
Voir aussi
Nouveautés de l’Environnement d’intégration du canal Dynamics 365
Configuration requise pour l’Environnement d’intégration du canal de Dynamics 365 2.0