ユーザーIDの設定

開発者はウェブサイト、アプリ、ライブチャットなどの異なるチャネルで、エージェントユーザーごとに一意のユーザーID（UserId）を設定できます。このユーザーID（UserId）は、チャネル間でのユーザー認証を可能にし、ユーザーの認証統合、ツールによるビジネスAPI連携、属性情報の管理、チャット履歴の関連付けが可能になります。具体的な利用シナリオは以下の通りです：

• ツール：AIエージェントがビジネスAPIを呼び出す際、リクエストのヘッダーにUserIdを含めることで、開発者側でユーザーを識別しやすくなります。
• ユーザー属性：UserIdを設定することで、ユーザー属性情報がUserIdに結び付けられます。
• チャット履歴：UserIdを設定することで、エージェントとのチャット履歴がそのUserIdに関連付けられます。
• イベントコールバック：開発者が UserId を設定すると、iframe やウィジェットで発生したイベントコールバックは、その情報を GA4 や Webhook に報告します。

⚠️ ユーザーID（UserId）は、開発者のビジネスシステム内でユーザーのユニークな認証情報となるべきです。このUserIdを通じて、ユーザーのVIPレベル、ユーザータグ、ユーザーオーダーなどのビジネスデータ情報の問い合わせが可能となります。

API経由でのユーザーID設定

開発者がエージェント機能をAPI経由でユーザーに提供する際、通常はユーザーごとに異なる会話ID（conversation_id）を作成する必要があります。これはAIサービスを提供するための基本的な単位となります。conversation_id を作成するには、事前にユーザーIDを設定しておく必要があります。

リクエストメソッド

POST

リクエストURL

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"
}'

                    

会話IDを作成する方法や詳細なガイドラインについては、Create Conversationをご覧ください。

Bubble Widge経由でのユーザーIDの設定

開発者が Bubble ウィジェット を用いてウェブサイトにエージェント機能を組み込み、サービスを提供する場合、
ウェブサイトのユーザーがログインしているタイミングで、GPTBots Bubble Widget SDK が提供する API インターフェースを通じてユーザーIDを設定することができます。

                      
                      window.ChatBot.setUserId("your_user_id")
// 注：エージェント開発者はカスタムユーザーIDを自由に指定できます

                    

より詳細な操作ガイドラインについては、Bubble Widget - Advanced Usageをご覧ください。

iframe経由でのユーザーIDの設定

開発者が iframe方式 を使用してウェブサイトにエージェントを連携しサービスを提供する場合、ウェブサイトのユーザーがログインしているタイミングで GPTBots が提供する iframe メソッドを通じてユーザーIDを設定することができます。

• ソリューション1：Webページに埋め込む iframe のアドレス形式は次の通りです：iframe_url + ?user_id=your_user_id

  注:エージェント開発者がユーザーIDを設定できます。設定しない場合は、GPTBotsが自動生成するデフォルトのユーザーIDが使用されます。

• ソリューション2：JavaScriptコードを使って動的にユーザーIDを設定します。

                      
                      Array.from(document.getElementsByTagName('iframe')).filter(iframe => iframe.src.includes('gptbots')).forEach(iframe => iframe.contentWindow.postMessage('{"type":"UserId","data":"your_user_id"}', '*'))

                    

注：上記はiframeモードで動的にuserIdを設定するための例です。your_user_idを実際のuserIdに置き換えてください。より詳細な操作ガイドラインについては、iframe - Advanced Usageをご覧ください。

LiveChat経由でのユーザーIDの設定

開発者がLiveChat Widgetを使用してウェブサイトユーザー向けのカスタマーサービスを提供し、同時にGPTBotsのAIエージェントを利用してcustomer serviceを提供する際、ユーザーIDを設定することで、Agent usersとwebsite logged-in usersの間での認証の統合を実現することができます。ウェブサイトのユーザーがログインしているときに LiveChat Widget SDK が提供するAPIインターフェースを通じてユーザーIDが設定できます。

                      
                      LiveChatWidget.call("set_session_variables", {
    user_id: "your_user_id"  // Identity ID after website user login
});