獲取對話詳情

根據提供的 conversation_id 取得對話的詳細訊息記錄。回應內容包含訊息詳情，例如 message_id、用戶問題、訊息類型、訊息內容，以及訊息建立的時間戳。

請求方法

GET

請求 URL

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

認證

請參閱 API 概述以取得認證詳情。

請求

範例請求

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 ${API Key}	使用 Authorization: Bearer ${API Key} 進行認證。API 金鑰可於 API Key 頁面取得。

請求參數

欄位	類型	是否必填	描述
conversation_id	string	是	對話識別碼。
page	int	是	要查詢的頁碼。
page_size	int	是	每頁顯示的結果數量，最多 100 筆。

回應

範例回應

{ "total": 100, "messages": [ { "message_id": "645dd86906931c4a9e0ffb1f", "parent_message_id": "", "message_type": "ANSWER", "text": "您好，我是客服人員，您有任何問題，請隨時提出。", "create_time": 1683871849906 }, { "message_id": "745dd86906931c4a9e0ffb1f", "parent_message_id": "645dd86906931c4a9e0ffb1f", "message_type": "QUESTION", "text": "JPush 的功能有哪些？", "create_time": 1683871849906 }, { "message_id": "845dd86906931c4a9e0ffb1f", "parent_message_id": "745dd86906931c4a9e0ffb1f", "message_type": "ANSWER", "text": "JPush 是一個功能強大且多用途的平台...", "create_time": 1683871849906 } ] }

                      
                      {
  "total": 100,
  "messages": [
    {
      "message_id": "645dd86906931c4a9e0ffb1f",
      "parent_message_id": "",
      "message_type": "ANSWER", 
      "text": "您好，我是客服人員，您有任何問題，請隨時提出。",
      "create_time": 1683871849906
    },
    {  
      "message_id": "745dd86906931c4a9e0ffb1f",
      "parent_message_id": "645dd86906931c4a9e0ffb1f",
      "message_type": "QUESTION",
      "text": "JPush 的功能有哪些？",
      "create_time": 1683871849906
    },
    {
      "message_id": "845dd86906931c4a9e0ffb1f",
      "parent_message_id": "745dd86906931c4a9e0ffb1f",
      "message_type": "ANSWER",
      "text": "JPush 是一個功能強大且多用途的平台...",
      "create_time": 1683871849906
    }
  ] 
}

此代碼塊在浮窗中顯示

成功回應

欄位	類型	描述
total	string	對話中的訊息總數。
messages	JSON Array	訊息詳情。
message_id	string	訊息的唯一識別碼。
parent_message_id	string	父訊息的識別碼。
message_type	string	訊息類型，ANSWER 或 QUESTION。
text	string	訊息內容。
create_time	long	訊息建立的時間戳。

失敗回應

欄位	類型	描述
code	int	錯誤碼。
message	string	錯誤說明。

錯誤碼

錯誤碼	錯誤訊息
40000	無效參數。
40005	頁碼超出總數。
40127	認證失敗。
40356	對話不存在。
20059	代理已刪除