获取对话属性

根据入参的 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 密钥页面获取密钥作为`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	错误详情。

错误码

Code	Message
40000	参数错误
40127	开发者鉴权失败
40356	会话不存在
20059	Agent 已删除