全部產品
Search

搜尋本產品

    Chat App Message Service：GetFlow

    文件中心

    Chat App Message Service：GetFlow

    更新時間：Jul 30, 2026

    取得 Flow 詳細資訊。

    介面說明

    • 在呼叫此介面前，請確保您已有成功建立的 WhatsApp Flow。

    • 若您沒有已成功建立的 WhatsApp Flow，可呼叫 CreateFlow 介面建立 WhatsApp Flow。

    QPS 限制

    本介面的單一使用者 QPS 限制為每秒 5 次。超過限制時，API 呼叫會被限流，這可能會影響您的業務，請合理呼叫。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    cams:GetFlow

    get

    *All Resource

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    FlowId

    string

    是

    流程 ID，即在建立 WhatsApp Flow 時透過 CreateFlow 介面傳回的 FlowId。

    333993838***

    CustSpaceId

    string

    否

    ISV 子客戶的 SpaceId／直客客戶執行個體 ID。在 通道管理 介面檢視 Space ID。

    cams-kei****

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    傳回參數。

    AccessDeniedDetail

    string

    存取被拒絕詳細資訊。

    None
    RequestId

    string

    請求 ID。

    DAC72B08-3327-33EF-BEDC-8EC3E83A6575

    Message

    string

    錯誤描述資訊。

    None
    Data

    object

    傳回資料。

    Status

    string

    Flow 的狀態。取值：

    • PUBLISHED：已發佈。

    • DRAFT：草稿。

    • DEPRECATED：已棄用。

    枚舉值：

    • PUBLISHED :

      PUBLISHED

    • DRAFT :

      DRAFT

    • DEPRECATED :

      DEPRECATED

    DRAFT
    FlowId

    string

    Flow ID。

    92675332812643****
    PreviewUrl

    string

    臨時預覽連結。

    https://pre-url
    EndpointUri

    string

    The URL of the WA Flow Endpoint

    http://abc.com
    JSONVersion

    string

    JSON 版本資訊。

    2.1
    Categories

    array

    目錄清單。

    string

    目錄。

    SIGN_UP
    FlowName

    string

    Flow 名稱。

    flow_001
    DataApiVersion

    string

    API 版本資訊。

    3.0
    PreviewUrlExpires

    integer

    預覽 URL 的過期時間。

    1700617436633

    Code

    string

    錯誤碼。更多詳情請參閱錯誤碼。

    OK

    樣本

    正常返回樣本

    JSON格式

    {
  "AccessDeniedDetail": "",
  "RequestId": "DAC72B08-3327-33EF-BEDC-8EC3E83A6575\n",
  "Message": "None",
  "Data": {
    "Status": "DRAFT",
    "FlowId": "92675332812643****",
    "PreviewUrl": "https://pre-url",
    "EndpointUri": "http://abc.com",
    "JSONVersion": "2.1",
    "Categories": [
      "SIGN_UP"
    ],
    "FlowName": "flow_001",
    "DataApiVersion": "3.0",
    "PreviewUrlExpires": 1700617436633
  },
  "Code": "OK"
}

    錯誤碼

    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.

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。