createSession (JavaScript API-referentie) voor Dynamics 365 Channel Integration Framework 2.0

Opmerking

Met API's voor sessiebeheer kunt u ervaringen met meerdere sessies alleen integreren in de Copilot Service-werkruimte-app.

Hiermee maakt u een nieuwe sessie op basis van de naam van de sessiesjabloon en retourneert u de unieke id van de sessie die is gemaakt.

Als uw organisatie gebruikmaakt van één of meerdere kanaalproviders, kunt u deze methode gebruiken om een standaardsessie te starten. Meer informatie: Ondersteuning configureren voor providers met één of meerdere kanalen

Voordat u deze methode aanroept, moet u canCreateSession aanroepen om te controleren of er een nieuwe sessie kan worden gemaakt.

Belangrijk

Deze methode ondersteunt alleen sessiesjablonen van het type Algemeen en maximaal 10 sessies tegelijkertijd.

Syntaxis

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

Parameterwaarden

Naam	Typologie	Verplicht	Description
invoer	JSON-object	Yes	String
correlatie-id	GUID (Globaal Unieke Identificatiecode)	Nee.	Wordt gebruikt om alle gerelateerde API-aanroepen te groeperen voor diagnostische telemetrie.
succesTerugbellen	Functie	Nee.	Een functie om te bellen wanneer de aanvraag is gelukt. De invoer voor deze functie is de unieke id van de nieuw gemaakte sessie.
foutCallback	Functie	Nee.	Een functie om aan te roepen wanneer het verzoek mislukt

De structuur van de input parameter JSON is als volgt:

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

Retourwaarde

Beloof met een waarde als String.

Example

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