螢幕互動錄製 API

API可用於啟動桌面活動的螢幕錄製。 這可以在無聯絡正在進行時錄製客服專員的螢幕以及後台螢幕的錄製。

此API適用於具有語音或螢幕錄製功能的 Engagement Hub 使用者以及CXone MpowerACD使用者。

開始之前

您可以在CXone Mpower開發者入口網站上測試API。 使用CXone Mpower帳戶登入，然後您可以使用您帳戶的租戶關閉 用於管理CXone Mpower系統的技術支援、帳單和全域設定的高階組織群組。提出請求。

若要開始使用 API，您必須向 NiCE 註冊，以接收用於驗證的有效認證。 查看開發人員入口網站上的開始使用頁面 以取得說明。

此外，使用這些 API 需要Interactions Hub 錄製螢幕互動權限。

開始螢幕互動錄製

API 能夠為未正在進行通話的特定使用者啟動螢幕錄製。 您必須指定錄製持續時間，方法是在開始命令中提供錄製持續時間作為參數。 持續時間應介於 5 秒到 3:30 之間，即允許的最長時間。 到達持續時間時，錄音將自動停止。 此外，您可以透過調用停止螢幕互動記錄命令來停止螢幕錄製。

  • 當錄製已啟動（由回應代碼 202 指示）或成功（由回應代碼 200 指示）時，將提供與所錄製螢幕關聯的聯絡 ID。 發出停止命令時應使用此聯絡 ID。

  • 該 API 可以在客服專員和客戶之間的即時通話中利用，並可能被錄音。 在這種情況下，將有兩種不同的錄音 - 一個捕獲語音對話，另一個基於 API 互動 - 每個錄音與不同的聯絡 ID 關聯。

  • 如果將遮罩套用於即時呼叫，也將影響可能並行錄製的 API 螢幕錄製互動。

  • 使用 API 時，可以有單個螢幕錄製實例。 如果已透過 API 錄製客服專員的螢幕，則對該客服專員的任何後續 API 調用都不會產生新的螢幕錄製，或更新錄製持續時間。

方法：POST

端點：/interaction-recording-management-service/v1/interactions/start-screen-interaction-recording

參數：

userId*：

（查詢）

字串

要記錄的使用者 ID。

錄音持續時間*：

（查詢）

number

指定在 5-13200 秒範圍內所需的錄製持續時間

發布 /interaction-recording-management-service/interactions/start-screen-interaction-recording？user-id=1234567&recordingDuration=3000

回應

  • 狀態 200 - 操作成功。

    描述（字串）：回應的描述。

    contactId（號碼）：ACD 聯絡 ID。

    interactionId（字串）：全域互動 ID。

    httpStatus（字串）：HTTP 狀態描述。

  • 狀態 202 - 操作正在進行中。

    contactId（號碼）：ACD 聯絡 ID。

    interactionId（字串）：全域互動 ID。

    httpStatus（字串）：HTTP 狀態描述。

  • 狀態 400 - 請求錯誤。

  • 狀態 401 - 請求使用者驗證失敗。

  • 狀態 403 - 請求使用者未獲授權執行操作。

  • 狀態 404 - 未找到。 未找到活躍互動。

  • 狀態 425 — 處理先前的請求時，互動被鎖定。

  • 狀態 500 - 內部伺服器錯誤。

  • 狀態 504 - 請求逾時。

停止螢幕互動錄製

API 能夠停止特定使用者的聯絡 ID 的螢幕錄製，該螢幕錄製使用 start-screen-interaction-recording 命令開始。 您應該使用在 start-螢幕互動記錄命令的回應中提供的聯絡 ID。 如果不調用此方法，則螢幕錄製將在 start-螢幕互動記錄命令中提供的持續時間後自動停止。

方法：POST

端點：/interaction-recording-management-service/v1/interactions/stop-screen-interaction-recording

參數：

userId*：

字串

要停止的已記錄使用者的 ID。
contactId*：

number

「開始」螢幕錄製命令中傳回的聯絡 ID。

發布 /interaction-recording-management-service/interactions/stop-screen-interaction-recording？user-id=1234567&contactId=1122334455

回應

  • 狀態 200 - 操作成功。

  • 狀態 202 - 操作正在進行中。

  • 狀態 400 - 請求錯誤。

  • 狀態 401 - 請求使用者驗證失敗。

  • 狀態 403 - 請求使用者未獲授權執行操作。

  • 狀態 404 - 未找到。 未找到活躍互動。

  • 狀態 425 — 處理先前的請求時，互動被鎖定。

  • 狀態 500 - 內部伺服器錯誤。

  • 狀態 504 - 請求逾時。