更新对话属性

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

错误码

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