Rest Api Action

Rest Api Action icon

同步處理 RESTful API 調用。此動作使系統可處理更高的負載。該動作同時返回 API 調用的主體和標頭。這可以方便測試指令碼以及對其偵錯。

要測試包含 REST API 選項的指令碼並查看回應資訊，必須運行該指令碼。使用以追蹤開始選項運行指令碼。

您還可以在SNIPPET動作中使用 GetRestProxy 函數進行同步 REST API 調用。此選項的負載不如 REST API 動作高。

Dependencies

此動作有使用限制。在網路Closed 用於管理 CXone 環境的技術支援、計費和全域設定的高級組織分組級別施加限制，因此不會相互影響。平台 中的限制是：

  • 回應格式：僅支援 JSON 回應格式。
  • 失敗時重試：若在返回回應之前收到失敗訊息，則動作處理程式將自動嘗試兩次。
  • 逾時：在請求中指定逾時值。該值不能超過 90 秒。
  • 最大回應大小：最大回應大小為 32KB。這與現有Snippet 功能一致。
  • 節流限制：節流限制由兩個參數定義：
    • 最大併行請求：預設情況下最多允許 100 個併行請求。此限制對所有 CXone 客戶都相同。這表示 100 個併行請求產生的輸送量比現有的 Snippet 功能高很多。如果您需要超過 100 個併行請求，請與您的CXone 客戶代表聯絡來增加您業務部門的限制。需要特別核准。
    • 佇列計數：當請求超過此限制時，額外的請求進入處理佇列。一旦請求下降到限制以下，佇列請求將被處理。
  • 斷路器：如果您指定的 URL 被關閉或無法存取，您的請求會出現太多失敗。當發生這種情況時，CXone 將在一段時間內緩解（即減少）REST API動作中所有 URL 的請求執行。這樣可以讓指定的 URL 從失敗中恢復。限制如下。
    • 緩解時間或中斷的持續時間：如果達到失敗率，REST API 動作將在 30 秒內不執行任何請求。
    • 最小輸送量：100 次請求/秒。若您的網路沒有執行最小數量的請求，即使請求失敗，亦會繼續執行您的請求。
    • 失敗率：若 50% 的請求在 30 秒內失敗，則在接下來的 30 秒內不會再執行請求。30 秒是一個捲動時窗。

Input Properties

這些屬性定義了動作執行時使用的資料。

屬性

描述

標題

輸入在指令碼中唯一標識此操作的短語。標題出現在指令碼畫布上的動作圖示下。The default is the action name.

Verb

支援 GET、PUT、POST、DELETE 和 PATCH 等基本的 REST 動作。
Parameters

支援能夠指定查詢參數或發布任何資料。任何類型的 JSON - Jobject、Jarray、Jtoken 均應可接受。目前，該動作需要在一行中提供 JSON。支援從包含 JSON 的字串或透過使用 asjson()函數將動態資料類型轉換為 JSON 來替換變數。您亦可將之前 REST API 動作中的輸出變數 resultSet(out) 傳遞給此屬性。
Headers

支援能夠新增自訂標頭以允許進行客戶身份驗證（如不記名權標）。接受以 JSON 格式表示的鍵值對。該動作需要在單個行中提供 JSON。支援從包含 JSON 的字串或透過使用 asjson()函數將動態資料類型轉換為 JSON 來替換變數。您亦可將之前REST API動作中的輸出變數resultSet(out)傳遞給此屬性。

重要提示若自訂 URL 端點需要不同的標頭，則必須在此屬性中指定。為了與現有的 Snippet 動作保持功能同位檢查，CXone 新增以下標頭。

{"Accept":"application/json", "Content-Type" :"application/x-www-form-urlencoded"}

Command

唯一的選項是MakeRestRequest，它與在Snippet action中使用時的功能相同。未來的開發可能會提供 Snippet 動作提供的附加命令。

TimeOutInMilliSeconds

允許指定和遵守 REST 調用的逾時。必須小於 90 秒（90000 毫秒）。如果未指定超時，默認為 10 秒（10000 毫秒）。
Service Address

允許提供自訂 URL，包括為 GET 指定查詢參數的能力。還支援變數替換。

輸出屬性

這些屬性包含變數，用於儲存執行動作後返回的資料。當動作完成後，它們可供參考和使用。

屬性

描述

resultSet(out)

包含從服務位址中指定的 API 返回的任何資訊的屬性。在 Studio 追蹤視窗中，顯示為 Dynamic Object 以便於查看。若需要，您亦可按原樣將此 resultSet 傳遞到標頭及參數中。

errorArgList(out)

錯誤條件具有類似於 REST 代理的對象，以實現兼容性。支援 DynamicData 類型。

結果分支條件

結果分支條件允許您在指令碼中建立分支，以處理執行動作時的不同結果。

條件

描述
Throttle

在短時間內執行過多請求時所採用的路徑。如需更多詳細資料，請參見下面的限制。
InvalidInput

發現無效輸入或發生逾時錯誤時所採用的路徑。儲存指令碼時會驗證每個參數。
Failure

在執行請求的 NICE CXone 應用程式 中發生任何錯誤或異常時所採用的路徑。
Error

遙距客戶端點返回 http 錯誤碼時所採用的路徑。
Default

在 90 秒內未收到回應時所採用的路徑。
Success

動作完成且無錯誤而且任何 API 調用或資料返回均成功時採用的路徑（2xx 回應代碼）。

Other Options

您可以替換當前在 Snippet action中完成的外部 RESTful API 請求。