会話詳細の取得

指定された conversation_id に基づいて、その会話に含まれるすべてのメッセージの詳細情報を取得します。取得できる情報には、message_id、ユーザーの質問、メッセージの種類、メッセージ内容、メッセージの生成時間などが含まれます。

リクエストメソッド

GET

リクエストURL

https://api-${endpoint}.gptbots.ai/v1/messages

リクエスト認証

認証方法の説明についてはAPI Overviewをご参照ください。

リクエスト

リクエスト例

curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/messages?conversation_id=xxxxxx&user_id=123456&page=1&page_size=100' \ -H 'Authorization: Bearer ${API Key}'

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/messages?conversation_id=xxxxxx&user_id=123456&page=1&page_size=100' \
-H 'Authorization: Bearer ${API Key}'

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

リクエストヘッダー

フィールド	タイプ	説明
Authorization	Bearer ${token}	認証には `Authorization: Bearer ${token}` を使用してください。トークンはAPIキーページから取得できます。
Content-Type	application/json	データの形式は `application/json` を設定してください。

クエリパラメータ

フィールド	タイプ	必須	説明
conversation_id	String	必須	会話を識別するためのID
page	Int	必須	取得するページ番号
page_size	Int	必須	1ページあたりの取得件数（最大100件）

レスポンス

レスポンス例

{ "total": 100, "messages": [ { "message_id": "645dd86906931c4a9e0ffb1f", "parent_message_id": "", "message_type": "ANSWER", "text": "Hello, I'm a customer service agent, please ask me anything.", "create_time": 1683871849906 }, { "message_id": "745dd86906931c4a9e0ffb1f", "parent_message_id": "645dd86906931c4a9e0ffb1f", "message_type": "QUESTION", "text": "What are the features of JPush?", "create_time": 1683871849906 }, { "message_id": "845dd86906931c4a9e0ffb1f", "parent_message_id": "745dd86906931c4a9e0ffb1f", "message_type": "ANSWER", "text": "JPush is a powerful platform...", "create_time": 1683871849906 } ] }

                      
                      {
  "total": 100,
  "messages": [
    {
      "message_id": "645dd86906931c4a9e0ffb1f",
      "parent_message_id": "",
      "message_type": "ANSWER", 
      "text": "Hello, I'm a customer service agent, please ask me anything.",
      "create_time": 1683871849906
    },
    {  
      "message_id": "745dd86906931c4a9e0ffb1f",
      "parent_message_id": "645dd86906931c4a9e0ffb1f",
      "message_type": "QUESTION",
      "text": "What are the features of JPush?",
      "create_time": 1683871849906
    },
    {
      "message_id": "845dd86906931c4a9e0ffb1f",
      "parent_message_id": "745dd86906931c4a9e0ffb1f",
      "message_type": "ANSWER",
      "text": "JPush is a powerful platform...",
      "create_time": 1683871849906
    }
  ] 
}

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

成功時のレスポンス

フィールド	タイプ	説明
total	Int	会話内のメッセージの総数
messages	JSON Array	メッセージの詳細情報
message_id	String	一意のメッセージID
parent_message_id	String	親メッセージID
message_type	String	メッセージタイプ（ANSWERまたはQUESTION）
text	String	メッセージの内容
create_time	Long	メッセージの作成時刻（タイムスタンプ）

エラー時のレスポンス

フィールド	タイプ	説明
code	Int	エラーコード
message	String	エラーの詳細情報

エラーコード

コード	メッセージ
40000	無効なパラメータ
40005	指定されたページ番号が総ページ数を超えています
40127	認証に失敗しました
40356	会話が存在しません
20059	エージェントが削除されています