createSession ("JavaScript" API nuoroda), skirta "Dynamics 365 Channel Integration Framework 2.0"

Pastaba.

Seansų valdymo API leidžia integruoti kelių seansų funkcijas tik į "Copilot Service" darbo srities programą.

Sukuria naują seansą pagal seanso šablono pavadinimą ir pateikia unikalų sukurto seanso identifikatorių.

Jei jūsų organizacija naudoja vieno ar kelių kanalų teikėjus, galite naudoti šį metodą numatytajam seansui pradėti. Daugiau informacijos: Vieno ir kelių kanalų teikėjų palaikymo konfigūravimas

Prieš iškviesdami šį metodą, turite iškviesti canCreateSession , kad patikrintumėte, ar galima sukurti naują seansą.

Svarbu

Šis metodas palaiko tik bendrojo tipo seansų šablonus ir ne daugiau kaip 10 seansų vienu metu.

Sintaksė

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

Parametrus

Pavadinimą Type Reikalingas Aprašą
Įvesties JSON objektas Taip Eilutės
koreliacijos ID GUID No Naudojamas visiems susijusiems API iškvietimams sugrupuoti diagnostinėje telemetrijoje.
sėkmėAtgalinis skambutis Funkcija No Funkcija, kurią reikia iškviesti, kai užklausa sėkminga. Šios funkcijos įvestis yra unikalus naujai sukurtos sesijos identifikatorius.
errorCallback Funkcija No Funkcija, skirta skambinti, kai užklausa nepavyksta

JSON parametro input struktūra yra tokia:

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

Grąžinama vertė

Pažadas, kurio reikšmė yra eilutė.

Pavyzdžiui

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
});
  • Last updated on