更新對話屬性

根據入參的 conversation_id，更新（upsert）該會話維度的對話屬性值。僅儲存代理已定義的對話屬性（未定義的屬性名稱將被忽略），並依對話屬性的定義類型對值進行正規化。僅更新本次傳入的屬性，其餘屬性不受影響。

請求方法

POST

端點

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

認證

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

請求

範例請求

curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/conversation/property/update' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "conversation_id": "6a55ff78f847452309cae7d4", "properties": [ { "name": "vip_level", "value": "3" }, { "name": "user_city", "value": "Bangkok" }, { "name": "is_member", "value": "true" } ] }'

                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/conversation/property/update' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
  "conversation_id": "6a55ff78f847452309cae7d4",
  "properties": [
    { "name": "vip_level", "value": "3" },
    { "name": "user_city", "value": "Bangkok" },
    { "name": "is_member", "value": "true" }
  ]
}'

此代碼塊在浮窗中顯示

請求標頭

欄位	類型	說明
Authorization	Bearer ${API Key}	使用 `Authorization: Bearer ${API Key}` 進行認證。API 金鑰可從 API Key 頁面取得。
Content-Type	application/json	固定值 `application/json`。

請求參數

欄位	類型	必填	說明
conversation_id	string	是	對話識別碼。
properties	JSON Array	是	要更新的對話屬性清單。
name	string	是	對話屬性名稱，須為代理已定義的對話屬性；未定義的將被忽略。
value	string	否	對話屬性值，統一傳入字串：DATETIME 傳 epoch 毫秒字串，BOOLEAN 傳 "true"/"false"，NUMBER/INTEGER 傳數字字串，STRING 原樣傳入。後端會依對話屬性的定義類型自動正規化。

回應

範例回應

{ "code": 0, "message": "OK" }

                      
                      {
  "code": 0,
  "message": "OK"
}

此代碼塊在浮窗中顯示

成功回應

欄位	類型	說明
code	int	返回碼，0 表示成功。
message	string	描述資訊。

錯誤回應

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

錯誤碼

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