Dynamics 365 チャネル統合フレームワーク 2.0 の createSession (JavaScript API リファレンス)

注意

セッション管理の API では、Customer Service workspace アプリでのみ、マルチ セッション エクスペリエンスを統合することができます。

セッション テンプレート名に基づいて新しいセッションを作成し、作成されたセッションの一意の識別子を返します。

組織が単一または複数のチャネルプロバイダーを使用している場合は、この方法を使用してデフォルトのセッションを開始できます。 詳細情報: 単一および複数のチャネル プロバイダーのサポートを構成する

このメソッドを呼び出す前に、canCreateSession を呼び出して新しいセッションを作成できるかどうかを確認します。

重要

このメソッドは、汎用タイプのセッション テンプレートのみをサポートし、最大 10 個のセッションを同時にサポートします。

構文

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

Parameters

件名	タイプ	Required	Description
input	JSON オブジェクト	可	String
correlationId	GUID	No	診断テレメトリのために関連するすべての API 呼び出しをグループ化するために使用されます。
successCallback	Function	No	要求が成功したときに呼び出す関数。 この関数への入力は、新しく作成されたセッションの一意の識別子です。
errorCallback	Function	No	要求が失敗したときに呼び出す関数

input パラメーター JSON の構造は次のとおりです:

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

値を返す

文字列を持つプロミスです。

例

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
});