即時通訊的 API 直接存取點

透過即時通訊的 API 直接存取點 (DAP),您可以根據設定的外部 API 端點回覆,自動將傳入的即時通訊工作階段轉送至佇列。這樣一來,使用者就不必從佇列選單中選取。端點可以是您自己的端點,也可以是第三方服務的端點。

啟用這項功能後,當使用者開始對話時,CCAI Platform 會將要求傳送至您的 API 端點。API 會傳回路由資料 (鍵/值組合),CCAI Platform 會使用這些資料將使用者導向正確的佇列。如果找不到相符項目,系統會改為顯示標準佇列選單。

API DAP 適用於下列項目:

  • 網頁和行動版對話

  • 新對話和續用對話

事前準備

這項功能預設為停用。如要為執行個體啟用這項功能,請與 Google Cloud 支援團隊聯絡。

DAP 類型

DAP 分為兩種:API 回應和 Webhook 回應。每種 DAP 類型都有不同的工作流程。

API 回應

以下是 API 回應工作流程:

  1. 使用者發起新的對話或繼續先前的對話。

  2. 在顯示佇列選單之前,CCAI Platform 會將要求傳送至 API 端點,包括您定義的任何參數,例如工作階段中繼資料或自訂資料。

  3. API 會傳回一或多組鍵/值組合。

  4. CCAI Platform 會將這些組合與您在即時通訊佇列中設定的鍵/值組合進行比對。所有配對都必須相符,系統才會將對話轉送至佇列。

  5. 如果找到相符項目,系統會直接將使用者導向該佇列。

  6. 發生下列任一情況時,系統會顯示標準佇列選單:

    • 找不到相符項目。

    • API 未在設定的 API 要求逾時時間內回應。

Webhook 回應

以下是 Webhook 回應工作流程:

  1. 使用者發起新的對話或繼續先前的對話。

  2. 在顯示佇列選單之前,CCAI Platform 會向您的 API 端點傳送要求,包括 Webhook 網址。

  3. API 會在 API 要求逾時前傳回確認回覆 (HTTP 200)。

  4. 系統會處理要求,並使用 Webhook 將路徑資料 (鍵/值組合) 傳送至 CCAI Platform。

  5. CCAI Platform 會將這些組合與您在即時通訊佇列中設定的鍵/值組合進行比對。所有配對都必須相符,系統才會將對話轉送至佇列。

  6. 如果找到相符項目,系統會直接將使用者導向該佇列。

  7. 發生下列任一情況時,系統會顯示標準佇列選單:

    • 找不到相符項目。

    • 在 API 要求逾時前未收到確認訊息。

    • 未在 API 回呼逾時時間內收到 Webhook 回應。

為全球聊天室設定 API DAP

如要為全球的即時通訊設定 API DAP,請按照下列步驟操作:

  1. 在 CCAI Platform 入口網站中,依序點選「Settings」>「Developer Settings」。 如果沒有看到「設定」選單,請按一下「選單」圖示

  2. 前往「API Request Direct Access Point」窗格,然後按一下「Manage API Request Direct Access Point」

  3. 按一下「對話」分頁標籤。

  4. 將「API Request Direct Access Point for Chat」(API 要求 Chat 的直接存取點) 切換鈕設為開啟。

  5. 在「Direct Access Point Type」(直接存取點類型) 中,選取下列其中一種 DAP 類型:

    • API 回應:API 會在回覆中傳回路線資料。

    • Webhook 回應:API 會確認要求,然後將路徑資料傳送至 Webhook。

  6. 如要指定觸發 API DAP 的即時通訊類型,請在「即時通訊類型」中選取下列一或多個選項:

    • 新對話

    • 已繼續的對話

  7. 在「API Request」(API 要求) 欄位中,輸入要用於 DAP 的 API 端點網址。

  8. 如要設定驗證,請採取下列其中一項做法:

    • 如要設定基本驗證,請按照下列步驟操作:

      1. 在「Authentication Method」部分,選取「Basic Authentication」

      2. 在「Authentication Credentials」(驗證憑證) 部分,輸入使用者名稱和密碼。

    • 如要設定自訂標頭,請按照下列步驟操作:

      1. 在「Authentication Method」部分,選取「Custom Header」

      2. 按一下「新增欄位」,系統會顯示「新增欄位」對話方塊。

      3. 輸入欄位鍵和欄位值,然後按一下「儲存」

  9. 如要設定 API 請求逾時,請按照下列步驟操作:

    1. 如要設定 API 要求逾時,請輸入秒數,CCAI Platform 會等待 API 回應,超過這個時間就會逾時。

    2. 選用 (只有在選取「Webhook 回應」DAP 類型時才會顯示):針對「API 回呼逾時」,設定 CCAI Platform 等待 Webhook 傳送路由資料的時間 (以秒為單位),超過這個時間就會逾時 (在初始確認後)。

  10. 如要設定要求方法,請在「API Request Method」(API 要求方法) 中選取「POST」或「GET」

  11. 如要設定資料參數,請按照下列步驟操作:

    1. 將「傳遞資料參數」切換鈕設為開啟。

    2. 按一下「新增參數」。系統會隨即顯示「新增參數」對話方塊。

    3. 執行下列其中一個步驟:

      • 如要設定固定資料參數,請按照下列步驟操作:

        1. 在「Type」(類型) 清單中,按一下「Fixed」(固定)

        2. 在「Destination Field」(目的地欄位) 欄位中,輸入目的地鍵。

        3. 在「Destination Value」(目的地值) 欄位中,輸入目的地值。 「預覽」欄位會顯示資料參數的預覽畫面。

      • 如要設定動態資料參數,請按照下列步驟操作:

        1. 在「Type」(類型) 清單中,按一下「Dynamic」(動態)

        2. 執行下列其中一個步驟:

          • 如要設定工作階段中繼資料,請按照下列步驟操作:

            1. 在「來源」清單中,選取「工作階段中繼資料」

            2. 在「Incoming Field」(傳入欄位) 清單中,選取中繼資料類型。

          • 如要設定已簽署的自訂資料,請按照下列步驟操作:

            1. 在「來源」清單中,選取「已簽署的自訂資料」

            2. 在「Incoming Field」(傳入欄位) 清單中,輸入傳入欄位。

          • 如要設定未簽署的自訂資料,請執行下列操作:

            1. 在「來源」清單中,選取「未簽署的自訂資料」

            2. 在「Incoming Field」(傳入欄位) 清單中,輸入傳入欄位。

        3. 在「Destination Field」(目的地欄位) 欄位中,輸入目的地欄位。 「預覽」欄位會顯示資料參數的預覽畫面。

    4. 按一下「新增參數」。資料參數會顯示在「資料參數」清單中。

  12. 選用:如要測試設定,請按照下列步驟操作:

    1. 前往「測試連線」部分。資料參數會顯示在清單中。

    2. 選用:如要嘗試不同的參數值,請編輯清單中的參數值。

    3. 按一下「測試這個連線」

  13. 按一下「儲存 Chat API」

變更轉送邏輯

路由邏輯是指 CCAI Platform 嘗試各種比對類型,將即時通訊與佇列配對的順序。CCAI Platform 會依序評估每個相符類型,並將即時通訊轉送至第一個相符佇列。如果找不到相符項目,系統會顯示標準佇列選單。

比對類型分為三種:

  • API 回應:根據 API 回應鍵/值配對進行比對。

  • 一般存取點標籤:根據佇列的一般存取點標籤進行比對。

  • 使用者區隔:根據使用者區隔資料進行比對。

如要變更路徑邏輯,請按照下列步驟操作:

  1. 在 CCAI Platform 入口網站中,依序點選「Settings」>「Developer Settings」。 如果沒有看到「設定」選單,請按一下「選單」圖示

  2. 前往「API Request Direct Access Point」窗格,然後按一下「Manage API Request Direct Access Point」

  3. 按一下「對話」分頁標籤。

  4. 如要調整路徑邏輯,請將游標懸停在相符類型上,然後拖曳至新位置。

  5. 視需要重複這個步驟。

  6. 按一下「儲存 Chat API」

在佇列層級設定 Chat 的 DAP

如要在佇列層級設定對話的 DAP,請按照下列步驟操作:

  1. 在 CCAI Platform 入口網站中,依序點選「Settings」>「Queue」。如果沒有看到「設定」選單,請按一下「選單」圖示 。系統隨即會顯示「Queue Menu Settings」(佇列選單設定) 頁面。

  2. 視所需管道而定,執行下列任一操作:

    • 在「行動裝置」窗格中,按一下「編輯 / 查看」

    • 在「網站」窗格中,按一下「編輯 / 查看」

  3. 按一下要編輯的佇列。

  4. 在「設定」窗格中,前往「存取點」部分。

  5. 按一下「建立直接存取點」。系統會顯示「建立直接存取點」對話方塊。

  6. 在「存取點類型」清單中,按一下「API 回應」

  7. 在「Access Point Name」(存取點名稱) 欄位中,輸入存取點名稱。

  8. 按一下「新增鍵/值」。輸入鍵/值組合,與 API 回應中傳回的鍵/值組合比對。

  9. 如要新增更多鍵/值組合,請重複上述步驟。

  10. 選用:在「問候訊息」欄位中,輸入您想在使用者前往這個選單選項時使用的問候訊息。

  11. 點按「Create」(建立)。您的 DAP 會顯示在「存取點」清單中。