会話プロパティの更新

リクエストで指定した conversation_id に基づき、会話単位の会話プロパティ値を更新（upsert）します。Agent で定義済みの会話プロパティのみが保存され（未定義のプロパティ名は無視されます）、会話プロパティの定義タイプに従って値が正規化されます。今回渡したプロパティのみが更新され、その他のプロパティは影響を受けません。

リクエストメソッド

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キーページから取得できます。
Content-Type	application/json	固定値 `application/json`。

リクエストパラメータ

フィールド	型	必須	説明
conversation_id	string	はい	会話識別子。
properties	JSON Array	はい	更新する会話プロパティのリスト。
name	string	はい	会話プロパティ名。Agent で定義済みの会話プロパティである必要があり、未定義のものは無視されます。
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	エージェントが削除されています