ユーザー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キーページでキーをトークンとして取得してください。

リクエストパラメーター（クエリパラメーター）

パラメーター	型	説明	必須
user_id	string	開発者が定義するユーザーID	false
anonymous_id	string	GPTBotsプラットフォームによって生成される匿名IDで、通常はサードパーティプラットフォームのユーザー固有識別子に基づいて生成されます。「Agent/Workflow設定 - グローバル変数を参照」にある`anonymous_id`から取得できます。	false

user_id または anonymous_id のいずれか少なくとも1つのパラメーターを渡す必要があります。渡さない場合、パラメーターエラーが返されます。

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
                }
            ]
        }
    }
}

このコードブロックをポップアップで表示

成功レスポンス

レスポンスはオブジェクトであり、キーは user_id、値はそのユーザーのCDP情報です。

フィールド	型	説明
{user_id}	object	ユーザーIDをキーとするオブジェクトで、そのユーザーの完全な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	サーバーエラー