Udostępnij przez

createSession (dokumentacja interfejsu API języka JavaScript) dla Dynamics 365 Channel Integration Framework 2.0

Uwaga / Notatka

Interfejsy API zarządzania sesjami umożliwiają integrowanie środowisk wielosesyjnych tylko w aplikacji obszaru roboczego usługi Copilot.

Tworzy nową sesję na podstawie nazwy szablonu sesji i zwraca unikatowy identyfikator utworzonej sesji.

Jeśli Twoja organizacja korzysta z jednego lub wielu dostawców kanałów, możesz użyć tej metody, aby uruchomić sesję domyślną. Więcej informacji: Konfigurowanie obsługi dla dostawców jednego i wielu kanałów

Przed wywołaniem tej metody należy wywołać metodę canCreateSession , aby sprawdzić, czy można utworzyć nową sesję.

Ważne

Ta metoda obsługuje szablony sesji typu Generic tylko i maksymalnie 10 sesji jednocześnie.

Składnia

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

Parametry

Name Typ Wymagane Description
dane wejściowe Obiekt JSON Tak Sznurek
correlationId (identyfikator korelacji) GUID Nie. Służy do grupowania wszystkich powiązanych wywołań interfejsu API na potrzeby telemetrii diagnostycznej.
successCallback (pomyślne wywołanie zwrotne) Funkcja Nie. Funkcja do wywołania, gdy żądanie zakończy się pomyślnie. Dane wejściowe tej funkcji są unikatowym identyfikatorem nowo utworzonej sesji.
errorOddzwanianie Funkcja Nie. Funkcja do wywołania, gdy żądanie zakończy się niepowodzeniem

Struktura parametru input JSON jest następująca:

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

Wartość zwracana

Obietnica z wartością jako ciąg.

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