查询用户CDP

支持开发者通过用户ID或匿名ID来查询 Agent/Workflow 的用户 CDP 信息，即用户ID、匿名ID及其对话类型。

用户 CDP 信息存储于 Agent/Workflow 之下，同个用户在不同的 Agent/Workflow 下数据是相互隔离的。

请求方式

GET

调用地址

https://api.${endpoint}/v1/user/get-user-cdp

调用验证

详情参见 API 概述的鉴权方式说明。

请求

请求示例

通过 user_id 查询：

curl -X GET 'https://api.${endpoint}/v1/user/get-user-cdp?user_id=BC123' \ -H 'Authorization: Bearer ${token}'

                      
                      curl -X GET 'https://api.${endpoint}/v1/user/get-user-cdp?user_id=BC123' \
-H 'Authorization: Bearer ${token}'

此代码块在浮窗中显示

通过 anonymous_id 查询：

curl -X GET 'https://api.${endpoint}/v1/user/get-user-cdp?anonymous_id=22ses32dsafdabd1w2sad' \ -H 'Authorization: Bearer ${token}'

                      
                      curl -X GET 'https://api.${endpoint}/v1/user/get-user-cdp?anonymous_id=22ses32dsafdabd1w2sad' \
-H 'Authorization: Bearer ${token}'

此代码块在浮窗中显示

同时通过 user_id 和 anonymous_id 查询：

curl -X GET 'https://api.${endpoint}/v1/user/get-user-cdp?user_id=BC123&anonymous_id=22ses32dsafdabd1w2sad' \ -H 'Authorization: Bearer ${token}'

                      
                      curl -X GET 'https://api.${endpoint}/v1/user/get-user-cdp?user_id=BC123&anonymous_id=22ses32dsafdabd1w2sad' \
-H 'Authorization: Bearer ${token}'

此代码块在浮窗中显示

可通过「Agent/Workflow 配置-引用全局变量」中的anonymous_id获得当前用户的匿名ID

请求头

字段	类型	说明
Authorization	Bearer ${token}	使用 Authorization: Bearer ${token} 进行调用验证，请在 API 密钥页面获取密钥作为 token。

请求参数（Query Parameters）

参数	类型	说明	required
user_id	string	开发者自定义的用户ID	false
anonymous_id	string	GPTBots平台生成的匿名ID，通常会根据三方平台的用户惟一标识符生成。可通过Agent/Workflow 配置-引用全局变量中的`anonymous_id`获取	false

必须至少传递 user_id 或 anonymous_id 中的一个参数，否则会返回参数错误。

可以只传 user_id，查询该用户的所有绑定信息

可以只传 anonymous_id，查询该匿名ID关联的用户信息

可以同时传 user_id 和 anonymous_id，进行精确查询

响应

响应体

{ "code": 0, "message": "OK", "data": { "user1": { "user_id": "user1", "anonymous_ids": [ { "anonymous_id": "aId3", "conversation_type": "WEB", "source_id": null } ] }, "67b58121035e5b152b0419ee": { "user_id": "67b58121035e5b152b0419ee", "anonymous_ids": [ { "anonymous_id": "aId3", "conversation_type": "C", "source_id": null } ] } } }

                      
                      {
    "code": 0,
    "message": "OK",
    "data": {
        "user1": {
            "user_id": "user1",
            "anonymous_ids": [
                {
                    "anonymous_id": "aId3",
                    "conversation_type": "WEB",
                    "source_id": null
                }
            ]
        },
        "67b58121035e5b152b0419ee": {
            "user_id": "67b58121035e5b152b0419ee",
            "anonymous_ids": [
                {
                    "anonymous_id": "aId3",
                    "conversation_type": "C",
                    "source_id": null
                }
            ]
        }
    }
}

此代码块在浮窗中显示

成功响应

响应为一个对象，其中 key 为 user_id，value 为该用户的 CDP 信息：

字段	类型	描述
{user_id}	object	以用户ID为 key 的对象，包含该用户的完整 CDP 信息
{user_id}.user_id	string	用户ID
{user_id}.anonymous_ids	array	该用户ID当前绑定的所有匿名ID及其对话类型
{user_id}.anonymous_ids[].anonymous_id	string	匿名ID
{user_id}.anonymous_ids[].conversation_type	string	对话类型，可在用户概览的对话类型(conversation_type)中找到映射表
{user_id}.anonymous_ids[].source_id	string	对话来源平台中的来源ID，如：集成为 `TELEGRAM` 且添加 2 个 TG Bot 时，每个 Bot 会有自己的 Source ID

失败响应

字段	类型	描述
code	int	错误码
message	string	错误信息

状态码

状态码	说明
200	成功
400	参数错误（未传递任何查询参数）
401	未授权
403	权限不足
500	服务器错误