createSession (JavaScript API-Referenz) für Dynamics 365-Kanalintegrationsframework 2.0

Anmerkung

Mit den Sitzungsverwaltungs-APIs können Sie Multisession-Erlebnisse nur in der Copilot Service Workspace-App integrieren.

Erstellt eine neue Sitzung basierend auf dem Sitzungsvorlagenamen und gibt den eindeutigen Bezeichner der erstellten Sitzung zurück.

Wenn Ihre Organisation einzelne oder mehrere Kanalanbieter verwendet, können Sie diese Methode verwenden, um eine Standardsitzung zu starten. Weitere Informationen: Unterstützung von Anbietern einzelner und mehrere Kanäle konfigurieren

Bevor Sie diese Methode aufrufen, müssen Sie canCreateSession aufrufen, um zu überprüfen, ob eine neue Sitzung erstellt werden kann.

Wichtig

Diese Methode unterstützt nur Sitzungsvorlagen vom Typ Generisch und maximal 10 Sitzungen gleichzeitig.

Syntax

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

Parameter

Name des Dataflows	typ	Erforderlich	Beschreibung
input	JSON-Objekt	Ja	Zeichenfolge
correlationId	GUID	Nr.	Zur Gruppierung aller verwandten API-Aufrufe für die diagnostische Telemetrie.
successCallback	Funktion	Nr.	Eine Funktion, die bei erfolgreicher Anfrage aufgerufen wird. Die Eingabe für diese Funktion ist die eindeutige Kennung der neu erstellten Sitzung.
errorCallback	Funktion	Nr.	Eine Funktion, die aufgerufen wird, wenn die Anforderung fehlschlägt

Der input JSON-Parameter hat die folgende Struktur:

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

Zurückgegebener Wert

Promise mit einem Wert als Zeichenfolge.

Beispiel

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