createSession (JavaScript API-referens) för Dynamics 365 Channel Integration Framework 2.0

Anmärkning

Med API:er för sessionshantering kan du endast integrera multisessionsupplevelser i Copilot Service-arbetsyteappen.

Skapar en ny session baserat på sessionsmallens namn och returnerar den unika identifieraren för sessionen som skapades.

Om din organisation använder en eller flera kanalleverantörer kan du använda den här metoden för att starta en standardsession. Mer information: Konfigurera stöd för en och flera kanalleverantörer

Innan du anropar den här metoden måste du anropa canCreateSession för att kontrollera om en ny session kan skapas.

Viktigt!

Den här metoden stöder endast sessionsmallar av typen Allmän och högst 10 sessioner samtidigt.

Syntax

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

Parameterar

Namn	Typ	Krävs	Description
inmatning	JSON-objekt	Yes	String
correlationId	GUID (globalt unikt identifierare)	Nej	Används för att gruppera alla relaterade API-anrop för diagnostisk telemetri.
framgångCallback	Funktion	Nej	En funktion som ska anropas när begäran lyckas. Indata till den här funktionen är den unika identifieraren för den nyligen skapade sessionen.
errorCallback	Funktion	Nej	En funktion som ska anropas när begäran misslyckas

Strukturen för input parametern JSON är följande:

{ 
   "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ärde

Lova med ett värde som 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
});