หมายเหตุ
การเข้าถึงหน้านี้ต้องได้รับการอนุญาต คุณสามารถลอง ลงชื่อเข้าใช้หรือเปลี่ยนไดเรกทอรีได้
การเข้าถึงหน้านี้ต้องได้รับการอนุญาต คุณสามารถลองเปลี่ยนไดเรกทอรีได้
Microsoft CIFramework มีวิธีการใช้ JavaScript API เพื่อจัดการแผงการสื่อสาร (วิดเจ็ต) การแจ้งเตือน แท็บแอปพลิเคชัน เซสชัน เรกคอร์ด และฟอร์มในแอปแบบจําลอง Dynamics 365
สําคัญ
- API ได้รับการสนับสนุนจากผู้ให้บริการช่องทางที่ใช้งานอยู่ที่กําหนดค่าไว้ในองค์กรของคุณเท่านั้น
- ต้องเรียกใช้ ตัวจัดการเหตุการณ์ CIFInitDone ก่อนที่จะเรียกใช้ API อื่น
- ขีดจํากัดการหมดเวลาสําหรับ API คือ 100 วินาที หาก API ไม่ทํางานภายใน 100 วินาที จะต้องเรียกใช้อีกครั้งด้วยพารามิเตอร์หรือขอบเขตที่เปลี่ยนแปลง
API การจัดการแผงการสื่อสาร
แผงการสื่อสารเป็นที่ที่คุณในฐานะตัวแทนโต้ตอบกับลูกค้า วิดเจ็ตพาร์ทเนอร์ที่สร้างขึ้นโดยใช้ Channel Integration Framework 2.0 จะถูกโหลดในแผงนี้ วิดเจ็ตในเวอร์ชันนี้จะแสดงทางด้านซ้ายของแผงเซสชัน และรองรับโหมด Docked, Minimized และ Hidden
ใช้ API ต่อไปนี้เพื่อจัดการสถานะของแผงการสื่อสาร (วิดเจ็ต)
| วิธี | คำอธิบาย |
|---|---|
| ตั้งค่าความกว้าง | ตั้งค่าความกว้างของแผงสําหรับเซสชันทั้งหมด |
| รับความกว้าง | รับความกว้างของแผงเป็นพิกเซล |
| ตั้งค่าโหมด | ตั้งค่าสถานะของแผงควบคุม |
| รับโหมด | ตั้งค่าสถานะของแผงควบคุม |
การดําเนินการ API ของ CRUD
ใช้ API ต่อไปนี้เพื่อดําเนินการ CRUD กับเรกคอร์ดเอนทิตี
| วิธี | คำอธิบาย |
|---|---|
| สร้างบันทึก | สร้างเรกคอร์ดเอนทิตี |
| ดึงบันทึก | ดึงข้อมูลเรกคอร์ดเอนทิตี |
| อัปเดตบันทึก | อัปเดตเรกคอร์ดเอนทิตี |
| ลบบันทึก | ลบเรกคอร์ดเอนทิตี |
API การจัดการการแจ้งเตือน
ใช้ API ต่อไปนี้เพื่อแสดงหรือยกเลิกการแจ้งเตือนเกี่ยวกับการสนทนาขาเข้า
| วิธี | คำอธิบาย |
|---|---|
| แจ้งเหตุการณ์ | แสดงการแจ้งเตือนที่สามารถใช้เพื่อแจ้งให้ตัวแทนทราบเกี่ยวกับการสนทนาที่เข้ามา |
| cancel เหตุการณ์ | ซ่อนหรือยกเลิกการแจ้งเตือนตามโทเค็นการยกเลิกตามที่ระบุไว้ใน notifyEvent วิธีการ |
API การจัดการแท็บแอปพลิเคชัน
ใช้ API ต่อไปนี้เพื่อสร้างและจัดการสถานะของแท็บแอปพลิเคชัน
| วิธี | คำอธิบาย |
|---|---|
| สร้างแท็บ | สร้างแท็บในเซสชันที่มุ่งเน้นและส่งคืนตัวระบุเฉพาะของแท็บที่สร้างขึ้น |
| getTabs | ส่งกลับอาร์เรย์ของตัวระบุแท็บที่เชื่อมโยงกับชื่อเทมเพลตหรือแท็กเทมเพลตสําหรับแท็บในเซสชันที่โฟกัส |
| แท็บโฟกัส | ตั้งค่าโฟกัสบนแท็บ หากเซสชันที่โฟกัสเป็นของผู้ให้บริการช่องทาง และหากแท็บเป็นของเซสชันที่โฟกัส |
| getFocusedTab | ส่งกลับตัวระบุแท็บในเซสชันที่มุ่งเน้น หากเซสชันเป็นของผู้ให้บริการ |
| รีเฟรชแท็บ | รีเฟรชแท็บ |
| setTabTitle | ตั้งค่าชื่อของแท็บ หากเซสชันที่โฟกัสเป็นของผู้ให้บริการช่องทาง และหากแท็บเป็นของเซสชันที่โฟกัส |
| ปิดแท็บ | ปิดแท็บที่ระบุในเซสชันปัจจุบัน |
การจัดการเซสชัน API
ใช้ API ต่อไปนี้เพื่อจัดการเซสชันในสภาพแวดล้อมของผู้ให้บริการแบบหลายเซสชัน
| วิธี | คำอธิบาย |
|---|---|
| canCreateSession | ช่วยให้คุณสามารถตรวจสอบว่าสามารถสร้างเซสชันใหม่ได้หรือไม่ |
| สร้างเซสชัน | สร้างเซสชันตามเท็มเพลตเซสชันที่กําหนดเป็นส่วนหนึ่งของเท็มเพลต และส่งคืนตัวระบุเฉพาะของเซสชันที่สร้างขึ้น |
| รับเซสชัน | ส่งกลับวัตถุที่มีตัวระบุเฉพาะของเซสชัน บริบท และค่าของ isFocused พารามิเตอร์ หากเซสชันเป็นของผู้ให้บริการช่องทาง |
| getFocusedSession | ส่งกลับตัวระบุเฉพาะของเซสชันที่อยู่ในโฟกัส หากเป็นของผู้ให้บริการช่องทาง มิฉะนั้นจะส่งคืน null |
| getAllSessions | ส่งกลับอาร์เรย์ของตัวระบุเซสชันสําหรับผู้ให้บริการช่องทาง |
| setSessionTitle | ตั้งค่าชื่อเซสชันหากเซสชันเป็นของผู้ให้บริการช่องทาง |
| requestFocusSession | ตั้งค่าโฟกัสบนเซสชันที่มีการส่งผ่านตัวระบุเซสชันเป็นพารามิเตอร์ หากเซสชันเป็นของผู้ให้บริการช่องทาง |
API การวิเคราะห์ช่องทาง
ใช้ API ต่อไปนี้เพื่อติดตามการวิเคราะห์เหตุการณ์
| วิธี | คำอธิบาย |
|---|---|
| logAnalytics เหตุการณ์ | เรียกใช้วิธีนี้เพื่อบันทึกการวิเคราะห์สําหรับเหตุการณ์ที่กําหนดเอง |
API ตัวบ่งชี้เซสชัน
ใช้ API ต่อไปนี้เพื่อระบุการละเมิดตัวบ่งชี้ประสิทธิภาพหลัก (KPI) และเพื่ออัปเดตจํานวนกิจกรรมใหม่ในเซสชันเฉพาะ
| วิธี | คำอธิบาย |
|---|---|
| แจ้ง KpiBreach | วิธีนี้ใช้เพื่อระบุการละเมิด KPI เมื่อใช้วิธีนี้ วงกลมสีแดงจะปรากฏบนภาพที่แสดงของผู้ติดต่อเมื่อมีการละเมิด KPI เกิดขึ้น |
| notifyNewActivity | วิธีนี้ใช้เพื่ออัปเดตจํานวนกิจกรรมใหม่ในเซสชันเฉพาะ |
API สถานะ
ใช้ API เหล่านี้เพื่อตั้งค่าและดึงข้อมูลตัวแทนช่องทาง Omni โดยทางโปรแกรม คุณสามารถใช้วิธีการเหล่านี้เมื่อตัวแทนแบบผสมกําลังทํางานบนแอปพลิเคชันที่ไม่ใช่ของ Microsoft ด้วย Omnichannel และคุณต้องการซิงโครไนส์สถานะการแสดงตนระหว่างแอปพลิเคชันต่างๆ เพื่อให้แน่ใจว่าความจุของตัวแทนถูกใช้อย่างเหมาะสมที่สุด
| วิธี | คำอธิบาย |
|---|---|
| ตั้งค่าการแสดงตน | อนุญาตให้ตั้งค่าการแสดงตนโดยทางโปรแกรมสําหรับตัวแทนในเซสชันไคลเอ็นต์ |
| รับการแสดงตน | อนุญาตให้ส่งคืนสถานะโดยทางโปรแกรมสําหรับตัวแทนในเซสชันไคลเอ็นต์ |
วิธีการเบ็ดเตล็ด
| วิธี | คำอธิบาย |
|---|---|
| getEntityMetadata | ส่งกลับข้อมูลเมตาของเอนทิตีสําหรับเอนทิตีที่ระบุ |
| ตั้งค่าคลิกทูแอคชั่น | ตั้งค่าบูลีนเพื่อเปิดหรือปิดใช้งานการสื่อสารขาออก (ClickToAct) |
| รับคลิกเพื่อดําเนินการ | ส่งกลับค่าบูลีนเพื่อระบุว่าเปิดใช้งานการสื่อสารขาออก (ClickToAct) หรือไม่ |
| ค้นหาและเปิดเรคคอร์ด | วิธีการจะค้นหาเรกคอร์ดจากวิดเจ็ตการสื่อสารระหว่างการสื่อสารขาเข้า และเปิดเรกคอร์ด |
| รับสิ่งแวดล้อม | รับรายละเอียดของแอปส่วนติดต่อแบบรวมและหน้าปัจจุบัน รายละเอียดรวมถึงรหัสแอปพลิเคชัน (appid), pageType(pageType), รหัสเรกคอร์ด (id), ภูมิศาสตร์ขององค์กร (orgGeo) และชนิดการนําทางเซสชัน (navigationType) |
| openForm | เปิดฟอร์มเอนทิตีหรือฟอร์มสร้างด่วน |
| renderSearchPage | ช่วยให้คุณสามารถค้นหาระหว่างเรกคอร์ดของชนิดเอนทิตีเฉพาะ API นี้จะเปิดหน้าเอนทิตีส่วนติดต่อแบบรวม โดยมีฟิลด์การค้นหาที่เติมไว้ล่วงหน้าด้วยสตริงการค้นหาที่ส่งผ่านเป็นพารามิเตอร์ |
| addHandler | เพิ่มผู้สมัครรับงานในกิจกรรม
Note API นี้สามารถใช้ได้ทั้งบนวิดเจ็ตและหน้าส่วนติดต่อแบบรวม |
| removeHandler | ลบผู้สมัครรับข้อมูลออกจากกิจกรรม
Note API นี้สามารถใช้ได้ทั้งบนวิดเจ็ตและหน้าส่วนติดต่อแบบรวม |
| raiseEvent | เรียกใช้ผู้สมัครใช้งานที่เกี่ยวข้องสําหรับเหตุการณ์
Note หากคุณสร้างเหตุการณ์แบบกําหนดเองโดยใช้ เมธอด addHandler คุณสามารถเพิ่มเหตุการณ์เหล่านั้นได้โดยส่งชื่อเหตุการณ์เป็นพารามิเตอร์ในเมธอดนี้ |
| update บริบท | วิธีนี้ช่วยให้คุณสามารถตั้งค่าพจนานุกรมอัตโนมัติได้ |
| update การสนทนา | วิธีนี้ช่วยให้คุณสามารถปรับปรุงเรกคอร์ดการสนทนาได้ |
ข้อมูลที่เกี่ยวข้อง
มีอะไรใหม่ใน Dynamics 365 Channel Integration Framework
ความต้องการของระบบสําหรับ Dynamics 365 Channel Integration Framework 2.0