通过

适用于 Dynamics 365 渠道集成框架 2.0 的 createSession（JavaScript API 参考）

注释

会话管理 API 允许您仅在 Copilot 服务工作区应用中集成多会话体验。

根据会话模板名称创建新会话，并返回已创建会话的唯一标识符。

如果您的组织使用单个或多个渠道提供商，则可以使用此方法启动默认会话。 详细信息： 配置对单个和多个渠道提供程序的支持

在调用此方法之前，必须调用 canCreateSession 来验证是否可以创建新会话。

重要

此方法仅支持“ 通用 ”类型的会话模板，最多同时支持 10 个会话。

Syntax

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

参数

Name 类型 必选 Description
输入 JSON 对象 是的 String
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
});
  • Last updated on