適用於 Dynamics 365 管道整合架構 2.0 的 createSession （JavaScript API 參考）

備註

工作階段管理 API 可讓您僅在 Copilot 服務工作區應用程式中整合多工作階段體驗。

根據工作階段範本名稱建立新的工作階段，並傳回所建立工作階段的唯一識別碼。

如果您的組織使用單一或多個通道提供者，則您可以使用此方法來啟動預設工作階段。 其他資訊： 設定對單一和多個通道提供者的支援

在呼叫這個方法之前，您必須呼叫 canCreateSession 來確認是否可以建立新的工作階段。

這很重要

此方法僅支援「 僅限泛型 」類型的階段作業範本，最多同時支援 10 個階段作業。

語法

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

參數

名稱	類型	為必填項目	Description
輸入	JSON 物件	Yes	繩子
correlationId	GUID	否	用來將所有相關的 API 呼叫分組在一起，以進行診斷遙測。
successCallback 回調	功能	否	請求成功時要呼叫的函式。 此函數的輸入是新建立階段作業的唯一識別碼。
errorCallback 回調	功能	否	請求失敗時要調用的函數

參數JSON的 input 結構如下：

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

返回值

Promise 的值為 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
});