All Products
Search

This Product

    Chat App Message Service:GetChatappTemplateDetail

    Document Center

    Chat App Message Service:GetChatappTemplateDetail

    Last Updated:Jun 25, 2026

    Mengambil detail Templat Paket.

    Deskripsi operasi

    Batas QPS

    Batas QPS per pengguna untuk operasi ini adalah 5 panggilan per detik. Jika batas ini terlampaui, panggilan API akan dibatasi, yang dapat memengaruhi bisnis Anda. Panggil operasi ini sesuai kebutuhan.

    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:GetChatappTemplateDetail

    get

    *全部资源

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    TemplateCode

    string

    No

    Kode templat.

    744c4b5c79c9432497a075bdfca36bf5
    Language

    string

    Yes

    Bahasa templat. Untuk kode bahasa yang detail, lihat Kode bahasa.

    en
    CustWabaId deprecated

    string

    No

    WabaId pelanggan ISV.

    Catatan

    Parameter yang sudah dihapus. Gunakan CustSpaceId sebagai gantinya.

    659216218162179
    IsvCode

    string

    No

    Kode verifikasi ISV, yang digunakan untuk memverifikasi apakah subakun telah diotorisasi oleh ISV.

    skdi3kksloslikdkkdk
    CustSpaceId

    string

    No

    SpaceId subpelanggan ISV atau ID instans pelanggan langsung.

    293483938849493
    TemplateType

    string

    No

    Tipe templat. Nilai valid:

    • WHATSAPP

    • VIBER.

    WHATSAPP
    TemplateName

    string

    No

    Nama templat.

    test_name

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Parameter tanggapan.

    RequestId

    string

    ID permintaan.

    Code

    string

    Kode status.

    • Nilai OK menunjukkan bahwa permintaan berhasil.

    • Untuk kode error lainnya, lihat Kode error.

    Message

    string

    Paket error.

    Data

    object

    Data yang dikembalikan.

    { "category": "ACCOUNT_UPDATE", "name": "account_notice", "language": "en_US", "templateCode": "744c4b5c79c9432497a075bdfca3****", "auditStatus": "APPROVED", "components": "[{\"type\":\"BODY\",\"text\":\"body_text$(textVariable)\"},{\"type\":\"HEADER\",\"formate\":\"IMAGE\",\"url\":\"$(linkVariable)\"},{\"type\":\"FOOTER\",\"text\":\"footer-text\"},{\"type\":\"BUTTONS\",\"buttons\":[{\"type\":\"PHONE_NUMBER\",\"text\":\"phone-button-text\",\"phone_number\":\"+861388888****\"},{\"type\":\"URL\",\"text\":\"url-button-text\",\"url\":\"https://www.website.com/\"}]}]", "example": "{\"textVariable\": \"text\", \"linkVariable\": \"link\"}" }
    Category

    string

    Kategori Templat WhatsApp. Nilai valid:

    • UTILITY: terkait transaksi.

    • MARKETING: Templat pemasaran.

    • AUTHENTICATION: verifikasi identitas.

    Kategori Templat Viber. Nilai valid:

    • text: hanya teks

    • image: hanya gambar

    • text_image_button: teks + gambar + tombol

    • text_button: teks + tombol

    • document: file

    • video: video

    • text_video: teks + video

    • text_video_button: teks + video + tombol

    • text_image: teks + gambar

    Catatan

    Ketika kategori Templat Viber diatur ke text_video_button, tombol tidak membuka halaman web. Sebaliknya, tombol membuka video dari Paket saat ini di dalam halaman web. Oleh karena itu, Anda tidak perlu menentukan URL apa pun di URL tombol.

    OTP
    TemplateCode

    string

    Kode templat.

    20399299388*****
    Name

    string

    Nama templat.

    ticket
    Language

    string

    Bahasa templat. Untuk kode bahasa yang detail, lihat Kode bahasa.

    zh_CN
    Example

    object

    Contoh variabel.

    string

    The actual value corresponding to the template variable. The parameter format is JSON.

    AuditStatus

    string

    Status tinjauan. Nilai valid:

    • pass: Disetujui.

    • fail: Ditolak.

    • auditing: Sedang ditinjau.

    • unaudit: Tinjauan ditangguhkan.

    pass
    Components

    array<object>

    Daftar komponen Templat Paket.

    array<object>

    Komponen Templat Paket.

    Type

    string

    Tipe komponen.

    • BODY

    • HEADER

    • FOOTER

    • BUTTONS

    • CAROUSEL

    • LIMITED_TIME_OFFER

    Catatan

    • Untuk template WhatsApp, komponen BODY mendukung hingga 1024 karakter. Komponen HEADER dan FOOTER mendukung hingga 60 karakter.

    • Untuk template Viber, tipe FOOTER, CAROUSEL, dan LIMITED_TIME_OFFER tidak didukung.

    • Untuk template Viber, gambar, video, dan file ditempatkan di komponen HEADER. Perangkat menampilkan gambar di bawah teks.

    URL
    Url

    string

    URL sumber daya media.

    https://aliyun.com
    Text

    string

    Teks pesan yang akan dikirim.

    button
    Caption

    string

    Deskripsi file.

    FileName

    string

    Nama file.

    Format

    string

    Format.

    TEXT
    Buttons

    array<object>

    Daftar tombol. Parameter ini hanya berlaku untuk komponen BUTTONS.

    Catatan

    Aturan jumlah tombol WhatsApp:

    • Ketika kategori adalah MARKETING atau UTILITY, maksimum 10 tombol diizinkan.

    • Hanya satu tombol PHONE_NUMBER yang diizinkan.

    • Maksimum dua tombol URL diizinkan.

    • Tombol QUICK_REPLY tidak dapat dicampur secara acak dengan tombol PHONE_NUMBER atau URL.

    array<object>

    Daftar komponen.

    Type

    string

    Tipe tombol.

    • PHONE_NUMBER: tombol panggilan telepon

    • URL: tombol halaman web

    • QUICK_REPLY: tombol balasan cepat

    • COPY_CODE: salin kode verifikasi atau kode kupon

    • ONE_TAP: tombol isi otomatis untuk template AUTHENTICATION

    • ZERO_TAP: tombol isi otomatis untuk template AUTHENTICATION

    • MPM: katalog multi-produk

    • CATALOG: katalog

    • FLOW: buka WhatsApp flow

    Catatan

    • Untuk template WhatsApp dengan kategori AUTHENTICATION, hanya satu tombol yang diizinkan, dan tipenya harus COPY_CODE atau ONE_TAP. Jika tipenya adalah COPY_CODE, Text wajib diisi. Jika tipenya adalah ONE_TAP, Text (ditampilkan ketika aplikasi target tidak terinstal di perangkat, menunjukkan nama tombol salin kode verifikasi), SignatureHash, PackageName, dan AutofillText wajib diisi.

    • Template Viber hanya mengizinkan satu tombol, dan tipenya harus URL.

    Text

    string

    Nama tampilan tombol.

    PhoneNumber

    string

    Nomor telepon. Parameter ini hanya berlaku ketika tipe tombol adalah PHONE_NUMBER.

    Url

    string

    URL yang diakses ketika tombol tautan diklik.

    UrlType

    string

    Tipe URL.

    • static: Statis.

    • dynamic: Dinamis.

    SignatureHash

    string

    Nilai hash tanda tangan untuk WhatsApp meluncurkan aplikasi. Parameter ini wajib diisi ketika kategori template WhatsApp adalah Authentication dan tipe tombol adalah ONE_TAP.

    2993839
    PackageName

    string

    Nama paket aplikasi yang diluncurkan oleh WhatsApp. Parameter ini wajib diisi ketika kategori template WhatsApp adalah Authentication dan tipe tombol adalah ONE_TAP.

    com.aliyun
    AutofillText

    string

    Teks tombol untuk operasi isi otomatis WhatsApp. Parameter ini wajib diisi ketika kategori template WhatsApp adalah Authentication dan tipe tombol adalah ONE_TAP.

    Autofill
    IsOptOut

    boolean

    Menunjukkan apakah tombol adalah tombol berhenti berlangganan pemasaran. Parameter ini berlaku ketika kategori template WhatsApp adalah Marketing dan tipe tombol adalah QUICK_REPLY. Jika pelanggan mengklik tombol ini dan operasi kontrol pengiriman dikonfigurasi di platform Chat App Message Service, pesan pemasaran berikutnya tidak akan dikirim ke pelanggan.

    ExtendAttrs

    object

    Field tambahan.

    NextTemplateCode

    string

    Kode template berikutnya.

    20939920093993
    NextTemplateName

    string

    Nama template berikutnya.

    abc
    NextLanguageCode

    string

    Bahasa template berikutnya.

    en
    Action

    string

    Tipe event.

    nextCard
    IntentCode

    string

    Kode intent.

    test
    CouponCode

    string

    Kode kupon.

    202039ksjs
    FlowId

    string

    ID flow.

    FlowAction

    string

    Tipe event data flow. Nilai yang valid:

    • NAVIGATE: navigasi.

    • DATA_EXCHANGE: pertukaran data.

    NavigateScreen

    string

    Layar navigasi. Parameter ini wajib diisi ketika FlowAction diatur ke NAVIGATE.

    SupportedApps

    array<object>

    Aplikasi yang didukung oleh tombol kode verifikasi ONE_TAP atau ZERO_TAP.

    object

    Aplikasi yang didukung oleh tombol kode verifikasi ONE_TAP atau ZERO_TAP.

    SignatureHash

    string

    Hash tanda tangan paket.

    PackageName

    string

    Nama paket.

    ThumbUrl

    string

    Thumbnail untuk pesan video Viber.

    https://img.png
    Duration

    integer

    Durasi video pesan video Viber. Nilai yang valid: 0 hingga 600.

    50
    FileType

    string

    Tipe file pesan file Viber.

    docx
    Latitude

    string

    Lintang lokasi.

    28.001
    Longitude

    string

    Bujur lokasi.

    120.002
    LocationName

    string

    Nama lokasi.

    杭州
    LocationAddress

    string

    Alamat lokasi.

    杭州
    AddSecretRecommendation

    boolean

    Menentukan apakah akan menampilkan rekomendasi keamanan di body yang menyarankan pengguna untuk tidak membagikan kode verifikasi. Parameter ini berlaku ketika kategori template WhatsApp adalah Authentication dan tipe komponen adalah Body.

    CodeExpirationMinutes

    integer

    Masa berlaku kode verifikasi dalam menit untuk template WhatsApp Authentication. Parameter ini hanya berlaku ketika tipe template adalah WhatsApp, kategorinya adalah Authentication, dan tipe komponen adalah Footer. Informasi ini ditampilkan di bagian Footer.

    5
    hasExpiration

    boolean

    Menunjukkan apakah kode kupon memiliki waktu kedaluwarsa dalam template Limited Time Offer (LTO).

    OfferExpirationTimeMs

    string

    Variabel waktu kedaluwarsa kode kupon dalam template LTO.

    $(offerExpirationTimeMs)
    Cards

    array<object>

    Daftar kartu carousel.

    array<object>

    Daftar kartu dalam template carousel.

    CardComponents

    array<object>

    Daftar komponen kartu.

    array<object>

    Daftar komponen dalam kartu carousel.

    Type

    string

    Tipe komponen.

    HEADER
    Text

    string

    Konten teks kartu.

    Body
    Url

    string

    URL.

    https://aliyun.com
    Format

    string

    Tipe header dalam template carousel. Hanya IMAGE dan VIDEO yang didukung. Tipe header harus sama di semua kartu.

    HEADER
    Buttons

    array<object>

    Daftar tombol kartu.

    object

    Objek tombol.

    Type

    string

    Tipe tombol untuk template carousel. Nilai yang valid: URL, PHONE_NUMBER, dan QUICK_REPLY.

    URL
    Text

    string

    Teks tombol.

    按钮文本
    Url

    string

    URL yang diakses ketika tombol diklik.

    https://aliyun.com
    UrlType

    string

    Tipe URL. Nilai yang valid:

    • static

    • dynamic.

    static
    PhoneNumber

    string

    Nomor telepon.

    +86138000
    TemplateType

    string

    Tipe templat.

    • WHATSAPP

    • VIBER.

    WHATSAPP
    QualityScore

    string

    Kualitas templat. Nilai valid:

    • RED: kualitas rendah

    • YELLOW: kualitas menengah

    • UNKNOWN: kualitas tidak diketahui

    • GREEN: kualitas tinggi.

    GREEN
    MessageSendTtlSeconds

    integer

    Periode validitas Paket dalam detik saat mengirim Paket menggunakan Templat WhatsApp Authentication.

    120
    Reason

    string

    Alasan templat ditolak selama tinjauan.

    None
    AccessDeniedDetail

    string

    Detail tentang penolakan akses.

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "",
  "Code": "",
  "Message": "",
  "Data": {
    "Category": "OTP",
    "TemplateCode": "20399299388*****",
    "Name": "ticket",
    "Language": "zh_CN",
    "Example": {
      "key": ""
    },
    "AuditStatus": "pass",
    "Components": [
      {
        "Type": "URL",
        "Url": "https://aliyun.com",
        "Text": "button",
        "Caption": "",
        "FileName": "",
        "Format": "TEXT",
        "Buttons": [
          {
            "Type": "",
            "Text": "",
            "PhoneNumber": "",
            "Url": "",
            "UrlType": "",
            "SignatureHash": "2993839",
            "PackageName": "com.aliyun",
            "AutofillText": "Autofill",
            "IsOptOut": false,
            "ExtendAttrs": {
              "NextTemplateCode": "20939920093993",
              "NextTemplateName": "abc",
              "NextLanguageCode": "en",
              "Action": "nextCard",
              "IntentCode": "test"
            },
            "CouponCode": "202039ksjs",
            "FlowId": "",
            "FlowAction": "",
            "NavigateScreen": "",
            "SupportedApps": [
              {
                "SignatureHash": "",
                "PackageName": ""
              }
            ]
          }
        ],
        "ThumbUrl": "https://img.png",
        "Duration": 50,
        "FileType": "docx",
        "Latitude": "28.001",
        "Longitude": "120.002",
        "LocationName": "杭州",
        "LocationAddress": "杭州",
        "AddSecretRecommendation": false,
        "CodeExpirationMinutes": 5,
        "hasExpiration": false,
        "OfferExpirationTimeMs": "$(offerExpirationTimeMs)",
        "Cards": [
          {
            "CardComponents": [
              {
                "Type": "HEADER",
                "Text": "Body",
                "Url": "https://aliyun.com",
                "Format": "HEADER",
                "Buttons": [
                  {
                    "Type": "URL",
                    "Text": "按钮文本",
                    "Url": "https://aliyun.com",
                    "UrlType": "static",
                    "PhoneNumber": "+86138000"
                  }
                ]
              }
            ]
          }
        ]
      }
    ],
    "TemplateType": "WHATSAPP",
    "QualityScore": "GREEN",
    "MessageSendTtlSeconds": 120,
    "Reason": "None"
  },
  "AccessDeniedDetail": ""
}

    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.