logo
開發者文件
搜尋
设置用户ID

设置用户ID

GPTBots 支持开发者在不同渠道(如:网站、APP 、LiveChat )为 Agent 用户设置唯一身份ID,通过该用户ID(UserId) 可以在不同渠道之间进行用户 身份关联,实现跨渠道用户身份合并、 通过 Tools 实现业务业务查询、维护用户属性和聊天记录等。具体应用场景如下:

  • Tools: AI Agent 在调用 Tools 向开发者业务 API 发起请求时,会将 UserId 放在 Header 中,便于开发者识别用户身份。
  • 用户属性:开发者设置 UserId 后,用户属性信息将被归属于该 UserId。
  • 对话日志:开发者设置 UserId 后,用户与 Agent 的对话日志记录将被归属于该 UserId。
  • 对话日志:开发者设置 UserId 后,用户与 Agent 的对话日志记录将被归属于该 UserId。
  • 事件回调: 开发者设置 UserId 后,在 iframe/widget 中所产生的事件回调上报至GA4/webhook 时会携带该信息。

⚠️用户ID(UserId) 应是用户在开发者业务系统内的唯一身份标识。通过该 UserId 可以查询到该用户的 VIP 等级、用户标签、用户订单等业务数据信息。

API设置用户ID

开发者通过 API 集成 Agent 能力为用户提供服务时,通常需要为不同的用户创建一个对话 ID(conversation_id) 作为提供 AI 服务的基础载体,创建converstation_id 的前提条件是必须设置一个用户ID 方可创建成功。

请求方式

POST

请求地址

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

请求示例

curl -X POST "https://api-${endpoint}.gptbots.ai/v1/conversation" \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "user_id": "your_user_id" }'
                      
                      curl -X POST "https://api-${endpoint}.gptbots.ai/v1/conversation" \ 
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \ 
-d '{
      "user_id": "your_user_id"
}'

                    
此代碼塊在浮窗中顯示

创建 conversation_id 的方法和具体指南请参考 创建对话

设置用户ID的其他方法