擷取Flow詳細資料。
介面說明
-
在調用此介面前，請確保您已有成功建立的 WhatsApp Flow。
-
若您沒有已成功建立的 WhatsApp Flow，可調用 CreateFlow 介面建立 WhatsApp Flow。
QPS 限制
本介面的單使用者 QPS 限制為 5 次/秒。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理調用。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
cams:GetFlow |
get |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| FlowId |
string |
是 |
流程 ID，即為在建立 WhatsApp Flow 時通過 CreateFlow 介面返回的 FlowId。 |
333993838*** |
| CustSpaceId |
string |
否 |
ISV 子客戶的 SpaceId/直客客戶執行個體 ID。在 通道管理 介面查看 Space ID。 |
cams-kei**** |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回參數。 |
||
| RequestId |
string |
請求 ID。 |
DAC72B08-3327-33EF-BEDC-8EC3E83A6575 |
| Code |
string |
錯誤碼。更多詳情請參見錯誤碼。 |
OK |
| Message |
string |
錯誤描述資訊。 |
None |
| Data |
object |
返回資料。 |
|
| Status |
string |
Flow 的狀態。取值：
|
DRAFT |
| FlowId |
string |
Flow ID。 |
92675332812643**** |
| FlowName |
string |
Flow 名稱。 |
flow_001 |
| Categories |
array |
目錄列表。 |
|
|
string |
目錄。 |
SIGN_UP |
|
| JSONVersion |
string |
JSON 版本資訊。 |
2.1 |
| DataApiVersion |
string |
API 版本資訊。 |
3.0 |
| PreviewUrl |
string |
臨時預覽連結。 |
https://pre-url |
| PreviewUrlExpires |
integer |
預覽 URL 的到期時間。 |
1700617436633 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "DAC72B08-3327-33EF-BEDC-8EC3E83A6575\n",
"Code": "OK",
"Message": "None",
"Data": {
"Status": "DRAFT",
"FlowId": "92675332812643****",
"FlowName": "flow_001",
"Categories": [
"SIGN_UP"
],
"JSONVersion": "2.1",
"DataApiVersion": "3.0",
"PreviewUrl": "https://pre-url",
"PreviewUrlExpires": 1700617436633
}
}錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | Product.Unsubscript | You have not subscribed to the specified product. | 您尚未訂閱指定的產品。 |
| 400 | Ram.PermissionDeny | You are not authorized to perform the operation. | 您無權執行該操作。 |
| 400 | System.LimitControl | The system is under flow control. | 系統處於流量控制之下。 |
| 400 | Unknown.ResourceOwnerId | The resource does not belong to the current user. | 資源不屬於目前使用者。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。