API 動作

API動作是允許您在指令碼中使用Studio API 的CXone動作。 您可以使用動作，而不是使用傳統的整合方法，例如使用 snippet 或 RestAPI 動作。 API 動作均位於 Studio 中的框架標籤。

API 動作與標準 Studio 動作不同。 目前，在線上說明中沒有它們的記錄。 然而，與 API 動作相對應的 API 在CXone開發者入口網站中有記錄。 在您的指令碼中使用 API 動作時，可以使用這個文件。

不是每個 CXone API 在 Studio 中都有相應的 API 動作。

在指令碼中設定安全使用者

所有API操作和許多框架操作都需要安全使用者才能正常運行。 安全使用者是 CXone 員工設定檔，具有允許其存取 CXone 並與之互動的權限。 在指令碼中使用時，安全使用者會授予框架或 API 動作存取 CXone 權限。 其應該是僅用於此目的的專用帳戶。 您必須使用有效、有效的CXone員工設定檔。

安全使用者需要允許其存取和執行 CXone 中的必要動作。 沒有設定權限清單，因為要求是因所使用的動作而異。

1. 建立CXone員工設定檔。 對於該使用者：
   • 為其指定一個名稱，以將其標識為安全使用者。
   • 將「建立新員工」頁面的「安全性」標籤上的登入驗證器設定為無選擇。 沒有登入驗證器表示該帳戶無法用於登入CXone。 這沒關係，因為您不需要使用該帳戶登入。 此帳戶僅用於透過 Studio 指令碼提供存取權限。
   • 為此帳戶指派具有適當權限的角色。 最佳做法是專門為安全使用者建立角色。
   • 儲存新的員工設定檔後，前往 ACD > ACD 使用者 並搜尋新的設定檔。 記下 ID 欄中的號碼。 這是使用者的客服專員 ID。 您可以在配置指令碼時使用其來尋找使用者。
2. 在您的 Studio 指令碼中，新增 SetSecurityUser 動作。 此動作位於 Desktop Studio 中的「框架」標籤中的「API 動作」標籤上。 將該動作放在任何其他框架或 API 動作之前。
3. 在 SetSecurityUser 的客服專員屬性中，輸入安全使用者的名稱或客服專員 ID，然後選擇相符的記錄。 如果您使用多個安全使用者，則可以在此欄位中使用變數替換。
4. 將輸出變數保留為預設的 SecurityUser。 這是在 ScriptVar（輸出）屬性。 如果進行變更，則必須使用新變數來配置指令碼中的每個框架或 API 動作。 儲存變數的屬性有多種名稱，具體取決於所使用的框架或 API 動作。 Security User 和 AuthContext 是兩個常見名稱。

API 動作版本

隨著 CXone API 的新版本發佈，相應動作的新版本可能會在 Studio 中發佈。 一般來說，最好使用最新的動作版本。 舊版本在大多數情況下仍然有效。 您可以嘗試不同的版本，看看哪些版本有效並提供您需要的功能。

一些 API 動作在動作名稱中包含了版本。 當您在「框架」標籤上看到動作的樹狀結構時，就可以看到它。 不是所有的 API 動作均包含版本號。 對於這些動作，可以動作的擴展屬性中找到版本。 只有在「框架」標籤中選擇動作時，才能在「屬性」標籤中看到擴展屬性。

不是每個版本的每個 API 均在 Studio 中有相應的動作。

檢視 API 動作擴展屬性

1. 在 Studio 中，重新排列標籤，以便您可以同時看到「屬性」標籤和「框架」標籤。
2. 在「框架」標籤上，點擊 API 動作。
3. 在「屬性」標籤上，現在可以看到該動作的擴展屬性。 特別是，在了解一個 API 動作時，以下屬性很有幫助： 
   • 雜項 > 參數 > 動詞：此屬性顯示與該動作相關的方法或動詞。
   • 雜項 > 參數 > 版本：此屬性顯示您的 API 的版本。
   • 雜項 > Web > URI：此屬性在開發者入口網站中搜尋 API 文件時很有用。

   • 雜項 > 參數：在「參數」部分，可以展開屬性來檢視關於每個動作屬性的額外資訊。

     檢視圖像

     

尋找 API 文件

CXone API 在CXone開發者入口網站中有記錄。 Studio 中的 API 動作沒有直接連結到與其 API 對應的文件。 然而，您可以使用動作的擴展屬性中的資訊來幫助您找到文件。

使用 URI 需要熟悉整個 CXone 系統和不同的CXone API。 這是因為確定哪個 API 與 Studio 中的某個動作相匹配並不總是那麼簡單。 了解 聯絡人 在 CXone的一般流程有助於正確理解動作的 URI，並將其中的線索套用到開發人員門戶網站的 API 文件結構。 此部分中的範例展示了可能需要的解釋。

開發者入口網站 API 部分的主頁提供了每個 CXone API 的概述。

範例 1

有時，動作與其 API 之間有直接的關聯性：

• 動作：Agent Assignments for given Skills
• URI：/services/$VERSION$/skills/agents
• API 文件 : /API/AdminAPI#/Skills/getAgentsAllSkills

根據動作的名稱和 URI，首先要考慮的兩個 API 是客服專員 API 和管理 API。 透過檢視每個 API 的 AP 調用清單，可以排除「客服專員 API」。 如下圖所示，其描述表明，其是用來管理客服專員會話的，似乎沒有任何與技能有關的通話。

「管理 API」表明，其與技能等系統物件一起工作。 如下圖所示，該 API 的可用 API 調用清單包括技能。

當您展開「技能」部分，其中一個終點是 GET /skills/agents。 這個終點的簡短描述說，其會「返回技能指派」。

範例 2

如以下範例所示，有時相關性並不明顯。 在這樣的情況下，您需要運用自己對 CXone API 和平台本身的了解來找到相應的 API 終點。 -

• 動作：Active Contact Details
• URI： /services/$VERSION$/contacts/active
• API 文件：/API/RealTimeDataAPI#/RealTime/ActiveContacts

根據這個動作的名稱和 URI，並不能立即看出應該先查看哪個 API。 如果您不確定從哪裡開始，可以翻閱每個 API 的文件，檢查任何與聯絡人有關的部分。 「管理 API」是唯一一個有頂層聯絡部分的 API。 很遺憾，這個 API 不包含與活躍聯絡人有關的終點。

這時，您可以在行動名稱和 URI 中鍵入活躍字樣。 根據您對 CXone 的了解，您知道活躍表示目前正在處理的聯絡人。 這使您可以更仔細地觀察即時資料 API。 這個 API 只有一個部分，當您展開它時，即可看到其中一個終點是 GET /contacts/active。 這個終點的簡短描述說，其會「返回活躍的聯絡人」。