logo
Development
検索
ユーザーIDの設定

ユーザー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" }'
                      
                      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をご覧ください。

その他のユーザーID設定方法