createSession (JavaScript API-referanse) for Dynamics 365 Channel Integration Framework 2.0

Note

Med API-er for øktadministrasjon kan du bare integrere opplevelser med flere økter i Copilot Service workspace-appen.

Oppretter en ny økt basert på navnet på øktmalen og returnerer den unike identifikatoren for økten som ble opprettet.

Hvis organisasjonen bruker én eller flere kanalleverandører, kan du bruke denne metoden til å starte en standardøkt. Mer informasjon: Konfigurere støtte for enkelt- og flerkanalsleverandører

Før du kaller denne metoden, må du kalle canCreateSession for å bekrefte om en ny økt kan opprettes.

Viktig!

Denne metoden støtter øktmaler av typen Bare generisk og maksimalt 10 økter samtidig.

Syntaks

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

Parametere

Navn	Type:	Kreves	Bekrivelse
inndata	JSON-objekt	Ja	Streng
korrelasjonId	GUID	Nei	Brukes til å gruppere alle relaterte API-kall sammen for diagnostisk telemetri.
suksessTilbakeringing	Funksjon	Nei	En funksjon som skal kalles når forespørselen er vellykket. Inndataene til denne funksjonen er den unike identifikatoren for den nyopprettede sesjonen.
feilTilbakeringing	Funksjon	Nei	En funksjon som skal kalles når forespørselen mislykkes

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

Returverdi

Løfte med en verdi 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
});