All Products
Search

This Product

    Chat App Message Service:GetFlow

    Document Center

    Chat App Message Service:GetFlow

    Last Updated:Jun 10, 2026

    Mengkueri detail flow WhatsApp, termasuk status, nama, kategori, dan URL Tampilan.

    Deskripsi operasi

    • Before calling this operation, make sure that you have created a WhatsApp flow.

    • If you have not created a WhatsApp flow, call the CreateFlow API to create one.

    QPS limit

    This operation allows a maximum of 5 requests per second per account. Excess requests are throttled and may result in service interruptions.

    Coba sekarang

    Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

    Test

    RAM authorization

    Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

    • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

    • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

    • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

    • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

      • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

      • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

    • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

    • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    cams:GetFlow

    get

    *全部资源

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    FlowId

    string

    Yes

    ID flow. Ini adalah FlowId yang dikembalikan saat Anda memanggil CreateFlow untuk membuat flow WhatsApp.

    333993838***

    CustSpaceId

    string

    No

    ID Space sub-pelanggan ISV, atau ID instans pelanggan langsung. Lihat ID Space di halaman Channel Management.

    cams-kei****

    Elemen respons

    Element

    Type

    Description

    Example

    object

    The returned parameters.

    RequestId

    string

    The request ID.

    DAC72B08-3327-33EF-BEDC-8EC3E83A6575

    Code

    string

    The error code. For more information, see Error codes.

    OK
    Message

    string

    The error message.

    None
    Data

    object

    The returned data.

    Status

    string

    The status of the flow.

    DRAFT
    FlowId

    string

    The flow ID.

    92675332812643****
    FlowName

    string

    The flow name.

    flow_001
    Categories

    array

    The list of categories.

    string

    The category.

    SIGN_UP
    JSONVersion

    string

    The JSON version.

    2.1
    DataApiVersion

    string

    The API version.

    3.0
    PreviewUrl

    string

    The temporary preview URL.

    https://pre-url
    PreviewUrlExpires

    integer

    The expiration time of the preview URL.

    1700617436633

    Contoh

    Respons sukses

    JSONformat

    {
  "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
  }
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    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.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.