取得對話屬性

根據入參的 conversation_id，取得該會話維度的對話屬性清單，包含對話屬性名稱、類型，以及當前會話的值。返回代理已定義的全部對話屬性；若某屬性在當前會話尚未賦值，value 將回退為該屬性定義的預設值。

請求方法

GET

端點

https://api-${endpoint}.gptbots.ai/v1/conversation/property

認證

請參考 API 概述了解認證指引。

請求

範例請求

curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/conversation/property?conversation_id=6a55ff78f847452309cae7d4' \ -H 'Authorization: Bearer ${API Key}'

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/conversation/property?conversation_id=6a55ff78f847452309cae7d4' \
-H 'Authorization: Bearer ${API Key}'

此代碼塊在浮窗中顯示

請求標頭

欄位	類型	說明
Authorization	Bearer ${API Key}	使用 `Authorization: Bearer ${API Key}` 進行認證。API 金鑰可從 API Key 頁面取得。

請求參數

欄位	類型	必填	說明
conversation_id	string	是	對話識別碼。

回應

範例回應

[ { "id": "66aa1b2c3d4e5f60718293a4", "name": "vip_level", "type": "INTEGER", "value": "3" }, { "id": "66aa1b2c3d4e5f60718293a5", "name": "user_city", "type": "STRING", "value": "Bangkok" }, { "id": "66aa1b2c3d4e5f60718293a6", "name": "is_member", "type": "BOOLEAN", "value": "true" } ]

                      
                      [
  {
    "id": "66aa1b2c3d4e5f60718293a4",
    "name": "vip_level",
    "type": "INTEGER",
    "value": "3"
  },
  {
    "id": "66aa1b2c3d4e5f60718293a5",
    "name": "user_city",
    "type": "STRING",
    "value": "Bangkok"
  },
  {
    "id": "66aa1b2c3d4e5f60718293a6",
    "name": "is_member",
    "type": "BOOLEAN",
    "value": "true"
  }
]

此代碼塊在浮窗中顯示

成功回應

欄位	類型	說明
id	string	對話屬性定義的唯一識別碼。
name	string	對話屬性名稱。
type	string	對話屬性類型，可能的值：STRING、INTEGER、NUMBER、BOOLEAN、DATETIME。
value	string	對話屬性值，統一以字串返回（DATETIME 為 epoch 毫秒字串，BOOLEAN 為 "true"/"false"）。當前會話已賦值時取會話值，否則取該屬性定義的預設值。

錯誤回應

欄位	類型	說明
code	int	錯誤碼。
message	string	錯誤詳情。

錯誤碼

錯誤碼	訊息
40000	參數錯誤
40127	開發者認證失敗
40356	對話不存在
20059	代理已被刪除