createSession (JavaScript API-reference) til Dynamics 365 Channel Integration Framework 2.0

Notat

API'er til sessionsadministration giver dig kun mulighed for at integrere oplevelser med flere sessioner i Copilot Service workspace-appen.

Opretter en ny session baseret på navnet på sessionsskabelonen og returnerer det entydige id for den session, der blev oprettet.

Hvis din organisation bruger udbydere af en eller flere kanaler, kan du bruge denne metode til at starte en standardsession. Flere oplysninger: Konfigurere understøttelse af udbydere af en enkelt og flere kanaler

Før du kalder denne metode, skal du kalde canCreateSession for at kontrollere, om der kan oprettes en ny session.

Vigtigt

Denne metode understøtter kun sessionsskabeloner af typen Generisk og maksimalt 10 sessioner samtidigt.

Syntaks

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

Parametre

Navn	Type	Obligatorisk	Beskrivelse
input	JSON-objekt	Ja	String
correlationId	GUID	Nej	Bruges til at gruppere alle relaterede API-kald sammen til diagnostisk telemetri.
succesTilbagekald	Funktion	Nej	En funktion, der skal kaldes, når anmodningen er vellykket. Inputtet til denne funktion er den entydige identifikator for den nyoprettede session.
errorCallback	Funktion	Nej	En funktion, der skal kaldes, når anmodningen mislykkes

Strukturen af parameteren input JSON er som følger:

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

Returværdi

Løfte med en værdi som String.

Eksempel

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