ใช้ CCaaS_GetRepresentativeAvailabilityBeforeConversation

ใช้ CCaaS_GetRepresentativeAvailabilityBeforeConversation เพื่อรับคิวและความพร้อมใช้งานของตัวแทนบริการก่อนที่การสนทนาจะเริ่มขึ้น

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

ใช้ API นี้เมื่อระบบภายนอกจําเป็นต้องทําการคิวรีความพร้อมใช้งานของตัวแทนบริการเชิงรุกและช่วยให้ผู้ควบคุมดูแลตัดสินใจเกี่ยวกับการปรับให้เหมาะสมสําหรับคิวของพวกเขา

ขอรายละเอียด

URL

/\<orgurl\>/api/data/v9.2/CCaaS\_ GetRepresentativeAvailabilityBeforeConversation

วิธีการ

POST

เวอร์ชัน

1.0

ส่วนหัวของคำขอ

ชื่อ คำอธิบาย:
การอ นุ ญาต บังคับ Microsoft Entra ID โทเค็นแบเรอร์สําหรับผู้เรียก API ในอินสแตนซ์ของ Contact Center เรียนรู้เพิ่มเติมใน โทเค็นการตั้งค่าสําหรับการอนุญาต API

คำขอตัวอย่าง

สถานการณ์จำลอง รหัสตัวอย่าง
ตรวจสอบความพร้อมใช้งานของตัวแทนบริการสําหรับเวิร์กสตรีมด้วยคิวเริ่มต้นเดียว curl --request POST \ --url https://<org-url>/api/data/v9.2/CCaaS_GetRepresentativeAvailabilityBeforeConversation \ --header 'Authorization: Bearer token' \ --header 'Content-Type: application/json' \ --data '{ "ApiVersion": "1.0", "LiveWorkStreamId": "8a581641-291b-2002-5b86-55e0cfa0fc63" }'
กำหนดความพร้อมใช้งานของคิวที่เกี่ยวข้องสำหรับเวิร์กสตรีมที่มีการใช้ตัวแปรบริบทในกฎการกำหนดเส้นทางไปยังคิว curl --request POST \ --url https://<org-url>/api/data/v9.2/CCaaS_GetRepresentativeAvailabilityBeforeConversation \ --header 'Authorization: Bearer token' \ --header 'Content-Type: application/json' \ --data '{ "ApiVersion": "1.0", "LiveWorkStreamId": "cf21df54-6d64-4aea-b668-405b8aa42b07", "CustomContextItems": "{\"contextItem1\": {\"value\": \"contextItemValue1\", \"isDisplayable\": true, \"datatype\": \"DataType1\"}, \"contextItem2\": {\"value\": \"contextItemValue2\", \"isDisplayable\": true, \"datatype\": \"DataType2\"}}" }'
เพิ่มหรือแทนที่รายการบริบท ตัวอย่างเช่น แบบสํารวจ curl --request POST \ --url https://<org-url>/api/data/v9.2/CCaaS_GetRepresentativeAvailabilityBeforeConversation \ --header 'Authorization: Bearer <Token>' \ --header 'Content-Type: application/json' \ --data '{ "ApiVersion": "1.0", "LiveWorkStreamId": "8a581641-291b-2002-5b86-55e0cfa0fc63", "CustomContextItems": "{\"Survey\": {\"value\": \"India\", \"isDisplayable\": true, \"datatype\": \"192350000\"}}" }'
กําหนดความพร้อมใช้งานของตัวแทนบริการเมื่อการสนทนามีกฎเกี่ยวกับเอนทิตีบริบทการมีส่วนร่วม curl --request POST \ --url https://<org-url>/api/data/v9.2/CCaaS_GetRepresentativeAvailabilityBeforeConversation \ --header 'Authorization: Bearer token' \ --header 'Content-Type: application/json' \ --data '{ "ApiVersion": "1.0", "LiveWorkStreamId": "8a581641-291b-2002-5b86-55e0cfa0fc63", "ChannelEngagementContext": "{"msdyn_browser": "Edge",\n "msdyn_city": "florida"\n}"" '
กําหนดความพร้อมใช้งานของตัวแทนบริการเมื่อมีกฎอยู่เหนือทั้งรายการบริบทและบริบทการมีส่วนร่วม curl --request POST \ --url https://<org-url>/api/data/v9.2/CCaaS_GetRepresentativeAvailabilityBeforeConversation \ --header 'Authorization: Bearer token' \ --header 'Content-Type: application/json' \ --data '{ "ApiVersion": "1.0", "LiveWorkStreamId": "8a581641-291b-2002-5b86-55e0cfa0fc63", "ChannelEngagementContext": "{"msdyn_browser": "Edge", \n "msdyn_city": "florida"\n}", "CustomContextItems": "{\"contextItem1\": {\n \"value\": \"contextItemValue1\",\n \"isDisplayable\": true,\n \"datatype\": \"DataType1\"\n },\"contextItem12\": {\n \"value\": \"contextItemValue2\",\n \"isDisplayable\": true,\n \"datatype\": \"DataType2\"\n }}" }'

โน้ต

  • ในเนื้อความของคำขอ CustomContextItems เป็นสตริงที่มีรายการบริบทที่ใช้ในกฎสำหรับการจัดเส้นทางไปยังคิว รายการตัวอย่างของรายการบริบท:

    {
      "contextItemName1": {
        "value": "contextItemValue1",
        "isDisplayable": true,
        "datatype": "DataType1"
      },
      "contextItemName2": {
        "value": "contextItemValue2",
        "isDisplayable": true,
        "datatype": "DataType2"
      }
    }
    
  • isDisplayable ระบุว่ารายการบริบทจะแสดงบนหน้าจอหรือไม่ ค่านี้เป็น True หรือ False

  • datatype สามารถเป็น ข้อความ = 192350000 หรือ จํานวนเต็ม = 192350001 เท่านั้น

การตอบสนอง

หากสําเร็จ วิธีนี้จะส่งกลับรหัสการตอบสนอง 200 ตกลง เมธอด จะส่งกลับรหัสสถานะต่อไปนี้ด้วย

สถานะของ HTTP คำอธิบาย:
400 คําขอไม่ถูกต้อง (พารามิเตอร์อินพุตไม่ถูกต้อง)
401 ไม่ได้รับอนุญาต
404 ไม่พบทรัพยากร
429 ขีดจํากัดอัตรา (คําขอมากเกินไป)
405 ไม่อนุญาต API
500 ข้อผิดพลาดภายในของเซิร์ฟเวอร์

ค่าการตอบสนอง

หากสําเร็จ วิธีนี้จะส่งกลับรหัสการตอบสนอง 200 ตกลง เมธอด จะส่งกลับรหัสสถานะต่อไปนี้ด้วย

สถานะของ HTTP คำอธิบาย:
400 คําขอไม่ถูกต้อง (พารามิเตอร์อินพุตไม่ถูกต้อง)
401 ไม่ได้รับอนุญาต
404 ไม่พบทรัพยากร
429 ขีดจํากัดอัตรา (คําขอมากเกินไป)
405 ไม่อนุญาต API
500 ข้อผิดพลาดภายในของเซิร์ฟเวอร์

ค่าการตอบสนอง

ชื่อ ชนิด คำอธิบาย:
queueId สตริง คิวเป้าหมายที่คําขอถูกส่งตามการกําหนดค่ากฎการกําหนดเส้นทางและข้อมูลป้อนเข้า เช่น ค่าเอนทิตีและบริบทที่เป็นส่วนหนึ่งของกฎการกําหนดเส้นทาง
isQueueAvailable แบบบูลีน แสดง TRUE ถ้าคิวอยู่ภายในชั่วโมงทําการ ค่าความผิดพลาด ถ้าคิวอยู่นอกเวลาทำงาน
เวลาเริ่มต้นของชั่วโมงการทำงานถัดไป วันที่และเวลา เวลาเริ่มต้น (UTC) ของชั่วโมงการทำงานสำหรับคิว หากเวลานี้อยู่นอกเวลาทำการ ส่งกลับ 01-01-0001 ในช่วงชั่วโมงทํางาน
เวลาสิ้นสุดของชั่วโมงการทำงานถัดไป วันที่และเวลา เวลา (UTC) ที่ชั่วโมงการทำงานของคิวสิ้นสุด หากในขณะนั้นอยู่นอกเวลาทำการ ส่งกลับ 01-01-0001 ในช่วงชั่วโมงทํางาน
เวลาการเปลี่ยนผ่านครั้งถัดไป วันที่และเวลา เวลา (UTC) เมื่อคิวกลับมาทํางานอีกครั้งหากอยู่นอกเวลาทําการ ในระหว่างชั่วโมงการทำงาน จะแสดงเมื่อคิวไม่สามารถใช้งานได้
ตำแหน่งในคิว ตัวเลข จัดตําแหน่งในคิวสําหรับลูกค้าที่กําลังรอผู้อื่นอยู่เบื้องหลังในคิวเดียวกัน
ตัวแทนพร้อมใช้งานหรือไม่ แบบบูลีน แสดง:
  • TRUE ถ้าตัวแทนบริการในคิวพร้อมให้บริการสําหรับคําขอตามกฎการกำหนดเส้นทางและการกำหนดงานในขณะนี้
  • FALSE ถ้าตัวแทนบริการไม่สามารถรับคําขอได้
เวลาเฉลี่ยในการรอ ตัวเลข เวลารอเฉลี่ยเป็นนาทีสําหรับลูกค้าในคิวเป้าหมาย
เวลาเฉลี่ยในการรอเป็นวินาที ตัวเลข เวลารอเฉลี่ยเป็นวินาทีสําหรับลูกค้าในคิวเป้าหมาย
จำนวนผู้เชี่ยวชาญที่พร้อมให้บริการในคิว ตัวเลข จํานวนตัวแทนบริการที่พร้อมใช้งานในปัจจุบันเพื่อยอมรับการสนทนาในคิวเป้าหมาย

การตอบสนองตัวอย่าง

{  
"@odata.context": "https://<org-url>/api/data/v9.2/\$metadata#Microsoft.Dynamics.CRM.CCaaS_GetRepresentativeAvailabilityForConversationResponse",  
"NextTransitionTime": "9999-12-31T23:59:59Z",
"NumberOfExpertsAvailableInQueue": 5,
"AverageWaitTimeInSeconds": 45  
"PositionInQueue": 1,  
"AverageWaitTime": null,  
"StartTimeOfNextOperatingHour": "0001-01-01T00:00:00Z",  
"EndTimeOfNextOperatingHour": "0001-01-01T00:00:00Z",  
"QueueId": "85e55877-f27a-e911-a81a-000d3a1ca610",  
"IsAgentAvailable": true,  
"IsQueueAvailable": true  
}

ใช้ API ความพร้อมใช้งานของตัวแทน
CCaaS_GetRepresentativeAvailabilityForConversation