載入Agent Session對話歷史列表。
介面說明
請求說明
agentName和sessionSourceList至少需要提供一個。支援通過
tagList,sessionId,sessionTitle進行組合過濾。返回結果符合阿里雲 OpenAPI 分頁規範，包括
totalCount,maxResults,nextToken以及sessionList。如果
nextToken為非法字串，則預設處理為 1。預設每頁返回 50 條記錄，可以通過
maxResults參數調整。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求文法
POST HTTP/1.1請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| Jsonrpc |
string |
否 |
JSON-RPC 版本，固定 2.0 |
2.0 |
| Id |
string |
否 |
請求方傳入的 id，原樣回顯 |
676303114031776 |
| Params |
object |
否 |
業務參數 |
|
| AgentName |
string |
否 |
Agent 名稱 精確過濾；與 |
chat_cli_chatbi |
| SessionSourceList |
array |
否 |
會話來源列表 過濾；與 |
|
|
string |
否 |
SessionSource |
pop-sdk |
|
| TagList |
array |
否 |
會話標籤 code 列表過濾 |
|
|
string |
否 |
標籤 |
user_123456 |
|
| SessionId |
string |
否 |
sessionId 精確匹配 |
sess_0f12abc34 |
| SessionTitle |
string |
否 |
會話標題模糊過濾 |
近 30 天銷售 |
| MaxResults |
integer |
否 |
單頁條數；預設 50 |
50 |
| NextToken |
string |
否 |
下一頁 token，首頁傳 1 |
10 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
50C5A9F7-B5BD-58B2-9EB8-ADFFA9E6A56F |
| JsonRpcResponse |
object |
JSON-PRC 的返回結果 |
|
| Jsonrpc |
string |
JSON-RPC 版本，固定 2.0 |
2.0 |
| Id |
string |
請求方傳入的 id，原樣回顯 |
29d9a29c-a284-48c1-9eaa-4a42c7c616d5 |
| Result |
object |
Session 查詢分頁結果集 |
|
| TotalCount |
integer |
匹配到的會話總數 |
200 |
| MaxResults |
integer |
實際生效的單頁條數 |
100 |
| NextToken |
string |
下一頁 token，首頁傳 1 |
1 |
| AgentSessions |
array<object> |
會話列表 |
|
|
array<object> |
|||
| SessionId |
string |
會話唯一 ID |
sess_0f12abc34 |
| SessionTitle |
string |
會話標題 |
近 30 天銷售分析 |
| SessionDescription |
string |
會話描述 |
銷售趨勢分析 |
| SessionCreatedAt |
integer |
會話建立時間 |
123456789 |
| SessionUpdatedAt |
integer |
會話修改時間 |
123456789 |
| Meta |
object |
DataWorks 擴充的 Session 資訊，非 ACP 標準協議的 |
|
| SessionStatus |
string |
會話串連狀態。 |
* NORMAL: 無狀態的session * INIT: 初始化狀態 * RUNNING: 運行中 * RELEASED: 釋放狀態 |
| SessionSource |
string |
會話來源 |
openapi_sdk |
| SessionTagList |
array<object> |
會話標籤列表 |
|
|
object |
|||
| SessionTagCode |
string |
會話標籤。可以基於會話標籤進行過濾，比如調用 OpenAPI 的時候用的是固定的 RAM 子帳號，但是調用系統中有自己的帳號體系，此時需要基於帳號 ID 過濾 Session 列表，該標籤就可以傳調用系統的帳號 ID。 |
user_123456 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "50C5A9F7-B5BD-58B2-9EB8-ADFFA9E6A56F",
"JsonRpcResponse": {
"Jsonrpc": "2.0",
"Id": "29d9a29c-a284-48c1-9eaa-4a42c7c616d5",
"Result": {
"TotalCount": 200,
"MaxResults": 100,
"NextToken": "1",
"AgentSessions": [
{
"SessionId": "sess_0f12abc34",
"SessionTitle": "近 30 天銷售分析",
"SessionDescription": "銷售趨勢分析",
"SessionCreatedAt": 123456789,
"SessionUpdatedAt": 123456789,
"Meta": {
"SessionStatus": "* NORMAL: 無狀態的session\n* INIT: 初始化狀態\n* RUNNING: 運行中\n* RELEASED: 釋放狀態",
"SessionSource": "openapi_sdk",
"SessionTagList": [
{
"SessionTagCode": "user_123456"
}
]
}
}
]
}
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。