取得 ChatFlow 執行資料。
介面說明
-
在呼叫此介面前,請確保您建立的流程已上線且已觸發流程。
-
若您的流程未上線,可在流程編輯器介面按一下流程名稱進入畫布編排介面手動上線流程或透過 OnlineFlowVersion 介面上線流程。
-
觸發器類型為手動的流程需要透過 TriggerChatFlow 介面觸發流程或在行銷活動管理介面透過關聯行銷活動觸發流程。
-
觸發器類型為非手動的流程則無需手動觸發流程,在對應綁定的商家帳號給商家傳送訊息以後就會觸發流程。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
cams:GetChatFlowMetric |
get |
*All Resource
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| BizCode |
string |
否 |
業務租戶編碼,預設:ALICOM_OPAAS。 枚舉值:
|
ALICOM_OPAAS |
| BizExtend |
object |
否 |
業務擴充資訊,預設為一個空集合。 |
{} |
| From |
integer |
否 |
開始時刻。時間戳記,單位:秒。 |
1751299200 |
| To |
integer |
否 |
結束時刻。時間戳記,單位:秒。 |
1751385599 |
| FlowCode |
string |
否 |
流程編碼。在流程編輯器介面檢視流程編碼。 |
9ccc41************************** |
| FlowVersion |
string |
否 |
流程版本。在流程編輯器介面按一下流程名稱進入流程編輯器畫布介面檢視流程版本。 |
1 |
| MetricName |
string |
是 |
監控項目名稱。取值:
枚舉值:
|
nodeUsageStatistics |
| MetricParam |
object |
否 |
監控項目查詢的擴充參數。當 MetricName 為 nodeErrorDetails 時,需傳入一段 JSON 資料。JSON 欄位取值:
|
{ "pageNo": 1, "pageSize": 20, "nodeId": "SendWhatsAppMessage#H7fKq5rM" } |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| AccessDeniedDetail |
string |
存取被拒絕詳細資訊。 |
None |
| Message |
string |
錯誤描述資訊。 |
None |
| RequestId |
string |
請求唯一 ID。 |
90E63D28-E31D-1EB2-8939-A94866411B2O |
| Data |
object |
返回資料物件。 |
|
| Code |
string |
錯誤碼。更多詳情請參見錯誤碼。 |
OK |
| Success |
boolean |
操作是否成功。取值:
|
true |
樣本
正常返回樣本
JSON格式
{
"AccessDeniedDetail": "None",
"Message": "None",
"RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
"Data": {
"test": "test",
"test2": 1
},
"Code": "OK",
"Success": true
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。