Dynamics 365 채널 통합 프레임워크 2.0용 createSession(JavaScript API 참조)

비고

세션 관리 API를 사용하면 Copilot Service 작업 영역 앱에서만 다중 세션 환경을 통합할 수 있습니다.

세션 템플릿 이름을 기반으로 새 세션을 만들고 생성된 세션의 고유 식별자를 반환합니다.

조직에서 단일 또는 다중 채널 공급자를 사용하는 경우 이 방법을 사용하여 기본 세션을 시작할 수 있습니다. 추가 정보: 단일 및 다중 채널 공급자에 대한 지원 구성

이 메서드를 호출하기 전에 canCreateSession 을 호출하여 새 세션을 만들 수 있는지 확인해야 합니다.

중요합니다

이 메서드는 Generic Only 형식의 세션 템플릿과 최대 10개의 세션을 동시에 지원합니다.

Syntax

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

매개 변수

이름	유형	필수	Description
입력	JSON 객체	Yes	String
correlationId	GUID	아니오	진단 원격 분석을 위해 모든 관련 API 호출을 함께 그룹화하는 데 사용됩니다.
success콜백	기능	아니오	요청이 성공할 때 호출하는 함수입니다. 이 함수에 대한 입력은 새로 생성된 세션의 고유 식별자입니다.
error콜백	기능	아니오	요청이 실패할 때 호출할 함수

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