createSession (Référence API JavaScript) pour l’environnement d’intégration du canal de Dynamics 365 2.0

  • Article

Note

Les API de gestion de session vous permettent d’intégrer les expériences multisessions uniquement dans l’application Customer Service workspace.

Crée une nouvelle session en fonction du nom du modèle de session et renvoie l’identifiant unique de la session créée.

Si votre organisation utilise un ou plusieurs fournisseurs de canaux, vous pouvez utiliser cette méthode pour démarrer une session par défaut. En savoir plus : Configurer la prise en charge des fournisseurs de canal uniques et multiples

Avant d’appeler cette méthode, vous devez appeler canCreateSession pour vérifier si une nouvelle session peut être créée.

Important

Cette méthode prend en charge les modèles de session de type Générique uniquement et un maximum de 10 sessions simultanément.

Syntaxe

Microsoft.CIFramework.createSession(input, correlationId).then(successCallback, errorCallback);

Paramètres

Nom  Type Requise Description
input Objet JSON Oui String
correlationId GUID Non Utilisé pour regrouper tous les appels d’API associés pour la télémétrie de diagnostic.
successCallback Function Non Fonction à appeler lorsque la demande aboutit. L’entrée de cette fonction est l’identificateur unique de la session nouvellement créée.
errorCallback Function Non Fonction à appeler lorsque la requête échoue

La structure du paramètre input JSON est la suivante :

{ 
   "templateName":"<unique name of session template>",
   "templateParameters":{ 
      "globalparam":"number value OR boolean value OR json string value OR parameterized string value",
      "app template 1":{ 
         "param 1":"number value OR boolean value OR json string value OR parameterized string value",
         "param 2":"..."
      },
      "app template 2":"…."
   }
}

Valeur renvoyée

Objet Promise avec une valeur de chaîne.

Exemple

var input = {
   // unique name of the configured template  
    templateName: "msdyn_chat_session",
 
    templateParameters: {
        customer: "Contoso",
    }
    // Global and application tab template parameters, these values will override configured values
};
Microsoft.CIFramework.canCreateSession().then(function successCallback(result) {
    if (result === true) {
        Microsoft.CIFramework.createSession(input).then(function success(sessionId) {
            console.log(sessionId);
            // perform operations on session Id retrieved
        }, function(error) {
            console.log(error.message);
            // handle error conditions
        });
    } else {
        // cannot create new sessions
    }
}, function errorCallback(error) {
    console.log(error.message);
    // handle error conditions
});