会話プロパティの取得

リクエストで指定した conversation_id に基づき、会話単位の会話プロパティ一覧を取得します。会話プロパティ名、タイプ、および現在の会話での値が含まれます。Agent で定義済みのすべての会話プロパティが返されます。あるプロパティが現在の会話で未設定の場合、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キーページから取得できます。

リクエストパラメータ

フィールド	型	必須	説明
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	エージェントが削除されています