createSession (αναφορά API JavaScript) για το Dynamics 365 Channel Integration Framework 2.0

Σημείωμα

Τα API διαχείρισης περιόδων λειτουργίας σάς επιτρέπουν να ενσωματώσετε εμπειρίες πολλαπλών περιόδων λειτουργίας μόνο στην εφαρμογή χώρου εργασίας Copilot Service.

Δημιουργεί μια νέα συνεδρία με βάση το όνομα του προτύπου συνεδρίας και επιστρέφει το μοναδικό αναγνωριστικό της συνεδρίας που δημιουργήθηκε.

Εάν ο οργανισμός σας χρησιμοποιεί μία ή πολλές υπηρεσίες παροχής καναλιού, τότε μπορείτε να χρησιμοποιήσετε αυτήν τη μέθοδο για να ξεκινήσετε μια προεπιλεγμένη περίοδο λειτουργίας. Περισσότερες πληροφορίες: Ρύθμιση παραμέτρων υποστήριξης για μεμονωμένους και πολλούς παρόχους καναλιών

Πριν να καλέσετε αυτήν τη μέθοδο, πρέπει να καλέσετε το canCreateSession για να επαληθεύσετε εάν μπορεί να δημιουργηθεί μια νέα περίοδος λειτουργίας.

Σημαντικό

Αυτή η μέθοδος υποστηρίζει πρότυπα συνεδριών τύπου Generic μόνο και το πολύ 10 συνεδρίες ταυτόχρονα.

Σύνταξη

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

Παράμετροι

Ονομασία	Type	Απαραίτητο	Περιγραφή
εισαγωγή	Αντικείμενο JSON	Όχι	Συμβλοσειρά
correlationId	GUID	όχι	Χρησιμοποιείται για την ομαδοποίηση όλων των σχετικών κλήσεων API για διαγνωστική τηλεμετρία.
επιτυχίαΕπανάκληση	Λειτουργία	όχι	Μια λειτουργία κλήσης όταν η αίτηση είναι επιτυχής. Η είσοδος σε αυτήν τη λειτουργία είναι το μοναδικό αναγνωριστικό της περιόδου λειτουργίας που μόλις δημιουργήθηκε.
errorCallback	Λειτουργία	όχι	Μια λειτουργία κλήσης όταν αποτύχει η αίτηση

Η δομή της input παραμέτρου JSON έχει ως εξής:

{ 
   "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":"…."
   }
}

Τιμή επιστροφής

Υπόσχεση με μια τιμή ως συμβολοσειρά.

Παράδειγμα

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
});