createSession (Referenční dokumentace rozhraní JavaScript API) pro Dynamics 365 Channel Integration Framework 2.0

Poznámka:

Rozhraní API pro správu relací umožňují integrovat prostředí s více relacemi pouze do aplikace pracovního prostoru služby Copilot.

Vytvoří novou relaci na základě názvu šablony relace a vrátí jedinečný identifikátor relace, která byla vytvořena.

Pokud vaše organizace používá jednoho nebo více poskytovatelů kanálů, můžete použít tuto metodu k zahájení výchozí relace. Další informace: Konfigurace podpory pro poskytovatele s jedním a více kanály

Před voláním této metody je nutné zavolat canCreateSession a ověřit, zda lze vytvořit novou relaci.

Důležité

Tato metoda podporuje šablony relací pouze typu Obecné a maximálně 10 relací současně.

Syntaxe

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

Parametry

Název	Typ	Povinné	Description
vstup	Objekt JSON	Ano	String
ID korelace	GUID	Ne	Slouží k seskupení všech souvisejících volání rozhraní API pro diagnostickou telemetrii.
úspěchZpětné volání	Funkce	Ne	Funkce, která se má volat v případě úspěchu požadavku. Vstupem do této funkce je jedinečný identifikátor nově vytvořené relace.
errorCallback	Funkce	Ne	Funkce, která se má volat v případě selhání požadavku

Struktura parametru input JSON je následující:

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

Návratová hodnota

Promise s hodnotou jako 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
});