すべてのプロダクト
Search

このプロダクト

    :GetFlow

    ドキュメントセンター

    :GetFlow

    最終更新日:Mar 30, 2026

    WhatsApp フローの詳細情報を取得します。

    操作説明

    • 本 API を呼び出す前に、事前に WhatsApp フローを作成する必要があります。

    • WhatsApp フローがまだ存在しない場合は、CreateFlow API を呼び出して作成してください。

    QPS 制限

    本 API の QPS 制限は、ユーザーあたり 1 秒あたり 5 回です。この制限を超える呼び出しはフローコントロールの対象となります。フローコントロールが発動しないよう、適切な頻度で本 API を呼び出してください。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    cams:GetFlow

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    FlowId

    string

    必須

    フローの ID。この値は、CreateFlow API によって FlowId として返されます。

    333993838***

    CustSpaceId

    string

    任意

    ISV サブカスタマーの Space ID、またはダイレクトカスタマーのインスタンス ID。Space ID は、以下のページで確認できます。 チャネル管理

    cams-kei****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    リクエストの応答データ。

    RequestId

    string

    リクエスト ID。

    DAC72B08-3327-33EF-BEDC-8EC3E83A6575

    Code

    string

    エラーコード。詳細については、「エラーコード」をご参照ください。

    OK
    Message

    string

    エラーメッセージ。

    None
    Data

    object

    フローの詳細情報。

    Status

    string

    フローのステータス。有効な値は以下のとおりです。

    • PUBLISHED：公開済み。

    • DRAFT：下書き。

    • DEPRECATED：非推奨。

    列挙値:

    • PUBLISHED :
    • DRAFT :
    • DEPRECATED :

    DRAFT
    FlowId

    string

    フローの ID。

    92675332812643****
    FlowName

    string

    フロー名。

    flow_001
    Categories

    array

    フローのカテゴリ。

    string

    カテゴリの 1 つ。

    SIGN_UP
    JSONVersion

    string

    JSON バージョン。

    2.1
    DataApiVersion

    string

    API バージョン。

    3.0
    PreviewUrl

    string

    一時的なプレビュー URL。

    https://pre-url
    PreviewUrlExpires

    integer

    プレビュー URL の有効期限を示す UNIX タイムスタンプ（ミリ秒単位）。

    1700617436633

    例

    成功レスポンス

    JSONJSON

    {
  "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 ステータスコード

    エラーコード

    エラーメッセージ

    説明
    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.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。