createSession (การอ้างอิง JavaScript API) สําหรับ Dynamics 365 Channel Integration Framework 2.0

Note

API การจัดการเซสชันช่วยให้คุณสามารถรวมประสบการณ์หลายเซสชันในแอปพื้นที่ทํางาน Copilot Service เท่านั้น

สร้างเซสชันใหม่ตามชื่อเท็มเพลตเซสชัน และส่งกลับตัวระบุเฉพาะของเซสชันที่สร้างขึ้น

หากองค์กรใช้ผู้ให้บริการช่องทางเดียวหรือหลายราย คุณจะใช้วิธีนี้เพื่อเริ่มเซสชันเริ่มต้นได้ ข้อมูลเพิ่มเติม: กําหนดค่าการสนับสนุนสําหรับผู้ให้บริการช่องทางเดียวและหลายช่องทาง

ก่อนที่คุณจะเรียกใช้เมธอดนี้ คุณต้องเรียกใช้ canCreateSession เพื่อตรวจสอบว่าสามารถสร้างเซสชันใหม่ได้หรือไม่

สําคัญ

วิธีนี้สนับสนุนเท็มเพลตเซสชันของชนิด ทั่วไป เท่านั้นและสูงสุด 10 เซสชันพร้อมกัน

Syntax

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

Parameters

ชื่อ	ประเภท	ต้องมี	คำอธิบาย
อินพุต	วัตถุ JSON	ใช่	สตริง
correlationId	GUID	ไม่	ใช้เพื่อจัดกลุ่มการเรียก API ที่เกี่ยวข้องทั้งหมดเข้าด้วยกันสําหรับการวัดทางไกลในการวินิจฉัย
successCallback	ฟังก์ชัน	ไม่	ฟังก์ชันที่จะเรียกใช้เมื่อคําขอสําเร็จ อินพุตของฟังก์ชันนี้คือตัวระบุเฉพาะของเซสชันที่สร้างขึ้นใหม่
errorCallback	ฟังก์ชัน	ไม่	ฟังก์ชันที่จะเรียกใช้เมื่อคําขอล้มเหลว

โครงสร้างของ 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
});