会話履歴の取得
会話履歴の取得
指定した条件に一致する範囲でエージェントに関連するすべての会話について、以下の情報を取得します：
各会話の conversation_id、user_id、最新の会話日時、会話のタイトル、会話の種類、メッセージの総数、使用されたクレジット数など。
リクエスト方法
GET
リクエストURL
https://api-${endpoint}.gptbots.ai/v1/bot/conversation/page
リクエスト認証
認証方法の説明についてはAPI Overviewをご参照ください。
リクエスト
リクエスト例
curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/bot/conversation/page?page=1&conversation_type=ALL&start_time=1691942400000&end_time=1699868066999&page_size=50&user_id=1234567890' \
-H 'Authorization: Bearer ${API Key}' \
curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/bot/conversation/page?page=1&conversation_type=ALL&start_time=1691942400000&end_time=1699868066999&page_size=50&user_id=1234567890' \
-H 'Authorization: Bearer ${API Key}' \
このコードブロックをポップアップで表示
リクエストヘッダー
| フィールド | タイプ | 説明 |
|---|---|---|
| Authorization | Bearer ${token} | 認証には Authorization: Bearer ${token} を使用してください。トークンはAPIキーページから取得できます。 |
リクエストボディ
| フィールド | タイプ | 必須 | 説明 |
|---|---|---|---|
| conversation_type | string | 是 | 会話IDのソースタイプ。ALL、API、EMBEDなどの複数のソースタイプを設定できます。 |
| user_id | String | 任意 | ユーザーID。未入力の場合は制限なしとみなされます。 |
| start_time | Long | 必須 | 会話の開始時刻（タイムスタンプ形式） |
| end_time | Long | 必須 | 会話の終了時刻（タイムスタンプ形式） |
| page | Int | 必須 | リクエストするページ番号（1から開始） |
| page_size | Int | 必須 | 1ページあたりのデータ数（10〜100の範囲） |
注意：
conversation_typeの値については、ユーザー概要の表にある会話ID（conversation_id）ソースフィールド値一覧をご参照ください。
レスポンス
レスポンス例
{
"list": [
{
"conversation_id": "AaACmo05Yrqb6bOSTbsg",
"user_id": "3",
"anonymous_id": "202607000198150",
"recent_chat_time": 1694572952383,
"subject": "2+3=?",
"conversation_type": "API",
"source_page": null,
"message_count": 2,
"cost_credit": 0.01,
"bot_id": "64b902a84f1ff25d1c60c10b",
"quality_score": null
},
{
"conversation_id": "64ec1508c9c1ed5605e6ff28",
"user_id": "33",
"anonymous_id": "202607000198151",
"recent_chat_time": 1693194862160,
"subject": "Hello!",
"conversation_type": "LIVECHAT",
"source_page": "https://www.livechat.com/",
"message_count": 20,
"cost_credit": 0.59,
"bot_id": "64b902a84f1ff25d1c60c10b",
"quality_score": null
}
],
"total": 2
}
{
"list": [
{
"conversation_id": "AaACmo05Yrqb6bOSTbsg",
"user_id": "3",
"anonymous_id": "202607000198150",
"recent_chat_time": 1694572952383,
"subject": "2+3=?",
"conversation_type": "API",
"source_page": null,
"message_count": 2,
"cost_credit": 0.01,
"bot_id": "64b902a84f1ff25d1c60c10b",
"quality_score": null
},
{
"conversation_id": "64ec1508c9c1ed5605e6ff28",
"user_id": "33",
"anonymous_id": "202607000198151",
"recent_chat_time": 1693194862160,
"subject": "Hello!",
"conversation_type": "LIVECHAT",
"source_page": "https://www.livechat.com/",
"message_count": 20,
"cost_credit": 0.59,
"bot_id": "64b902a84f1ff25d1c60c10b",
"quality_score": null
}
],
"total": 2
}
このコードブロックをポップアップで表示
成功時のレスポンス
| フィールド | タイプ | 説明 |
|---|---|---|
| list | JSON Array | 会話のリスト |
| conversation_id | String | 会話ID |
| user_id | String | ユーザーID。LINE や Telegram などのサードパーティチャネル経由の会話では null になる場合があり、その際は anonymous_id でユーザーを識別できます |
| anonymous_id | String | 匿名ID。GPTBots がユーザーの流入元プラットフォームに基づいて自動生成します |
| recent_chat_time | Long | 最新の会話時刻（タイムスタンプ形式） |
| subject | String | 会話の主題 |
| conversation_type | String | 会話の種類 |
| source_page | String | ユーザーの最初のメッセージの送信元ページ。現在、このフィールドは LIVECHAT チャネルのみ対応しており、conversation_type が LIVECHAT 以外の場合、値は null になります |
| message_count | Int | 会話内のメッセージ数 |
| cost_credit | Float | 会話で消費されたクレジット数 |
| bot_id | String | エージェント（Bot）のID |
| quality_score | Float | 会話の品質スコア。未評価の場合は null |
| total | Int | 絞り込み条件に一致する会話の総数（現在のページで返された件数ではありません） |
エラー時のレスポンス
| フィールド | タイプ | 説明 |
|---|---|---|
| code | Int | エラーコード |
| message | String | エラーの詳細情報 |
エラーコード
| コード | メッセージ |
|---|---|
| 40000 | 無効なパラメータ |
| 20059 | エージェントが削除されています |
| 40127 | 開発者認証に失敗しました |