用戶 CDP 查詢

允許開發者透過用戶 ID 或匿名 ID（由 GPTBots 平台生成的唯一識別碼）查詢 Agent/Workflow 用戶 CDP（客戶資料平台）資訊，包括用戶 ID、匿名 ID 和對話類型。

用戶 CDP 資訊儲存在各自的 Agent/Workflow 中，這表示相同用戶的數據在不同的 Agent/Workflow 之間是相互隔離的。

請求方法

GET

Endpoint

https://api.${endpoint}/v1/user/get-user-cdp

認證

請參考 API 概述以瞭解相關認證方法。

請求

請求範例

使用 user_id 查詢用戶資訊：

curl -X GET 'https://api.${endpoint}/v1/user/get-user-cdp?user_id=BC123' \ -H 'Authorization: Bearer ${token}'

                      
                      curl -X GET 'https://api.${endpoint}/v1/user/get-user-cdp?user_id=BC123' \
-H 'Authorization: Bearer ${token}'

此代碼塊在浮窗中顯示

使用 anonymous_id 查詢用戶資訊：

curl -X GET 'https://api.${endpoint}/v1/user/get-user-cdp?anonymous_id=22ses32dsafdabd1w2sad' \ -H 'Authorization: Bearer ${token}'

                      
                      curl -X GET 'https://api.${endpoint}/v1/user/get-user-cdp?anonymous_id=22ses32dsafdabd1w2sad' \
-H 'Authorization: Bearer ${token}'

此代碼塊在浮窗中顯示

同時使用 user_id 與 anonymous_id 進行精確查詢：

curl -X GET 'https://api.${endpoint}/v1/user/get-user-cdp?user_id=BC123&anonymous_id=22ses32dsafdabd1w2sad' \ -H 'Authorization: Bearer ${token}'

                      
                      curl -X GET 'https://api.${endpoint}/v1/user/get-user-cdp?user_id=BC123&anonymous_id=22ses32dsafdabd1w2sad' \
-H 'Authorization: Bearer ${token}'

此代碼塊在浮窗中顯示

當前用戶的匿名 ID 可於「Agent/Workflow 配置 - 全域變數」中取得。

請求標頭

欄位	類型	描述
Authorization	Bearer ${token}	用於驗證 API 請求的憑證。您可從 API 金鑰頁面取得 `${token}`。

查詢參數

參數	類型	描述	必填
user_id	string	開發者自訂的用戶 ID。	否
anonymous_id	string	由 GPTBots 平台生成的匿名 ID，通常基於第三方平台的唯一識別碼。可於「Agent/Workflow 配置 - 全域變數」中取得。	否

user_id 或 anonymous_id 至少需提供一項，否則將返回參數錯誤。

僅提供 user_id 時，可查詢此用戶的所有綁定資訊。

僅提供 anonymous_id 時，可查詢與該匿名 ID 關聯的用戶資訊。

同時提供 user_id 和 anonymous_id 時，可執行精確查詢。

回應

回應內容

{ "code": 0, "message": "OK", "data": { "user1": { "user_id": "user1", "anonymous_ids": [ { "anonymous_id": "aId3", "conversation_type": "WEB", "source_id": null } ] }, "67b58121035e5b152b0419ee": { "user_id": "67b58121035e5b152b0419ee", "anonymous_ids": [ { "anonymous_id": "aId3", "conversation_type": "C", "source_id": null } ] } } }

                      
                      {
    "code": 0,
    "message": "OK",
    "data": {
        "user1": {
            "user_id": "user1",
            "anonymous_ids": [
                {
                    "anonymous_id": "aId3",
                    "conversation_type": "WEB",
                    "source_id": null
                }
            ]
        },
        "67b58121035e5b152b0419ee": {
            "user_id": "67b58121035e5b152b0419ee",
            "anonymous_ids": [
                {
                    "anonymous_id": "aId3",
                    "conversation_type": "C",
                    "source_id": null
                }
            ]
        }
    }
}

此代碼塊在浮窗中顯示

成功回應

回應為一個物件，鍵為 user_id，值為該用戶的完整 CDP 資訊：

欄位	類型	描述
{user_id}	object	以用戶 ID 為鍵的物件，包含該用戶的完整 CDP 資訊。
{user_id}.user_id	string	用戶 ID。
{user_id}.anonymous_ids	array	當前綁定到該用戶 ID 的所有匿名 ID 及其對話類型。
{user_id}.anonymous_ids[].anonymous_id	string	匿名 ID。
{user_id}.anonymous_ids[].conversation_type	string	對話類型。對應表請參考用戶概覽中的對話類型部分。
{user_id}.anonymous_ids[].source_id	string	對話平台的來源 ID。例如，若整合了 `TELEGRAM` 並添加了 2 個 TG Bots，每個 Bot 都有自己的來源 ID。

錯誤回應

欄位	類型	描述
code	int	錯誤代碼
message	string	錯誤訊息，例如「未授權（例如，提供的憑證無效）」等

狀態碼

狀態碼	描述
200	成功
400	參數錯誤（未提供查詢參數）
401	未授權（例如，提供的憑證無效）
403	權限不足
500	伺服器錯誤