All Products
Search

This Product

    Chat App Message Service:GetChatappTemplateDetail

    Document Center

    Chat App Message Service:GetChatappTemplateDetail

    Last Updated:Dec 22, 2025

    Mengambil informasi templat pesan.

    Deskripsi operasi

    Batas QPS

    Anda dapat memanggil Operasi API ini hingga lima kali per detik per akun. Jika jumlah panggilan per detik melebihi batas tersebut, Pembatasan kecepatan akan dipicu dan berpotensi mengganggu operasional bisnis Anda. Pastikan untuk memperhatikan batas ini saat melakukan pemanggilan.

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

    ****4b5c79c9432497a075bdfca36bf5
    Language

    string

    Yes

    Bahasa yang digunakan dalam templat pesan. Untuk informasi selengkapnya, lihat Kode bahasa.

    en_US
    CustWabaId deprecated

    string

    No

    ID akun WhatsApp Business (WABA) pengguna dalam akun independent software vendor (ISV).

    Catatan

    CustWabaId adalah parameter usang. Gunakan CustSpaceId sebagai gantinya.

    65921621816****

    IsvCode

    string

    No

    Kode verifikasi independent software vendor (ISV). Parameter ini digunakan untuk memverifikasi apakah pengguna telah diotorisasi oleh akun ISV.

    skdi3kksloslikdkkdk
    CustSpaceId

    string

    Yes

    ID ruang pengguna dalam akun ISV.

    28251486512358****
    TemplateType

    string

    No

    Jenis templat pesan. Nilai yang valid:

    • WHATSAPP

    • VIBER

    • LINE (sedang dikembangkan)

    WHATSAPP
    TemplateName

    string

    No

    Nama templat.

    test_name

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Parameter respons.

    RequestId

    string

    ID permintaan.

    744c4b5c79c9432497a075bdfca3****
    Code

    string

    Kode status HTTP.

    • Contoh: OK. Nilai ini menunjukkan bahwa permintaan berhasil.

    • Kode lainnya menunjukkan bahwa permintaan gagal. Untuk informasi selengkapnya, lihat Kode error.

    OK
    Message

    string

    Pesan error.

    User not authorized to operate on the specified resource.
    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 ketika nilai yang dikembalikan dari TemplateType adalah WHATSAPP. Nilai yang valid:

    • UTILITY: templat transaksional

    • MARKETING: templat pemasaran

    • AUTHENTICATION: templat otentikasi identitas

    Kategori templat ketika nilai parameter TemplateType adalah VIBER. Nilai yang valid:

    • text: templat yang hanya berisi teks

    • image: templat yang hanya berisi citra

    • text_image_button: templat yang berisi teks, citra, dan tombol

    • text_button: templat yang berisi teks dan tombol

    • document: templat yang hanya berisi file

    • video: templat yang hanya berisi video

    • text_video: templat yang berisi teks dan video

    • text_video_button: templat yang berisi teks, video, dan tombol

    • text_image: templat yang berisi teks dan citra

    Catatan

    Jika Category diatur ke text_video_button, pengguna tidak dapat membuka halaman web dengan mengklik tombol tersebut. Pengguna hanya dapat membuka video dalam pesan. Dalam kasus ini, Anda tidak perlu menentukan parameter Url untuk tombol URL dalam templat.

    UTILITY
    TemplateCode

    string

    Kode templat pesan.

    744c4b5c79c9432497a075bdfca3****
    Name

    string

    Nama templat pesan.

    hello_whatsapp
    Language

    string

    Bahasa yang digunakan dalam templat pesan. Untuk informasi selengkapnya, lihat Kode bahasa.

    en_US
    Example

    object

    Contoh variabel.

    string

    Nilai variabel yang disertakan dalam templat pesan. Nilai harus dalam format JSON.

    {\"textVariable\":\"text\",\"linkVariable\":\"https://image.developer.aliy\"}
    AuditStatus

    string

    Status tinjauan templat pesan. Nilai yang valid:

    • pass: Templat pesan disetujui.

    • fail: Templat pesan ditolak.

    • auditing: Templat pesan sedang ditinjau.

    • unaudit: Tinjauan dihentikan sementara.

    pass
    Components

    array<object>

    Komponen templat pesan.

    array<object>

    Informasi tentang objek array.

    Type

    string

    Jenis komponen. Nilai yang valid:

    • BODY

    • HEADER

    • FOOTER

    • BUTTONS

    • CAROUSEL

    • LIMITED_TIME_OFFER

    Catatan

    • Dalam templat pesan WhatsApp, komponen Body tidak boleh melebihi 1.024 karakter. Komponen HEADER atau FOOTER tidak boleh melebihi 60 karakter.

    • Komponen FOOTER, CAROUSEL, dan LIMITED_TIME_OFFER tidak didukung dalam templat pesan Viber.

    • Dalam templat pesan Viber, sumber daya media seperti citra, video, dan dokumen ditempatkan dalam komponen HEADER. Jika pesan Viber berisi teks dan citra, citra akan ditampilkan di bawah teks pada perangkat penerima.

    BODY
    Url

    string

    URL sumber daya media.

    https://image.developer.aliyundoc.com
    Text

    string

    Teks pesan yang ingin Anda kirimkan.

    你好
    Caption

    string

    Deskripsi dokumen.

    新文件已上传
    FileName

    string

    Nama dokumen.

    快递文件
    Format

    string

    Format.

    TEXT
    Buttons

    array<object>

    Tombol. Parameter ini dikembalikan hanya jika subparameter Type dari parameter Components diatur ke BUTTONS.

    Catatan

    • Templat pesan WhatsApp pemasaran atau transaksional dapat berisi hingga 10 tombol.

    • Templat pesan WhatsApp hanya dapat berisi satu tombol panggilan telepon.

    • Templat pesan WhatsApp dapat berisi hingga dua tombol URL.

    • Dalam templat pesan WhatsApp, tombol balasan cepat tidak dapat digunakan bersamaan dengan tombol panggilan telepon atau tombol URL.

    array<object>

    Informasi tentang objek array.

    Type

    string

    Jenis tombol. Nilai yang valid:

    • PHONE_NUMBER: tombol panggilan telepon

    • URL: tombol URL

    • QUICK_REPLY: tombol balasan cepat

    • COPY_CODE: tombol salin kode

    • ONE_TAP: tombol autofill sekali ketuk jika Category diatur ke AUTHENTICATION

    Catatan

    • Jika Category diatur ke AUTHENTICATION untuk templat pesan WhatsApp, Anda hanya dapat menambahkan satu tombol ke templat pesan WhatsApp tersebut dan harus mengatur subparameter Type dari parameter Buttons ke COPY_CODE atau ONE_TAP. Jika Type diatur ke COPY_CODE, subparameter Text dari parameter Buttons wajib diisi. Jika Type diatur ke ONE_TAP, subparameter Text, SignatureHash, PackageName, dan AutofillText dari parameter Buttons wajib diisi. Nilai Text akan ditampilkan jika aplikasi yang diinginkan tidak terinstal di perangkat. Nilai Text menunjukkan bahwa Anda harus menyalin kode verifikasi secara manual.

    • Anda hanya dapat menambahkan satu tombol ke templat pesan Viber, dan harus mengatur subparameter Type dari parameter Buttons ke URL.

    PHONE_NUMBER
    Text

    string

    Nama tampilan tombol.

    打电话
    PhoneNumber

    string

    Nomor telepon. Parameter ini hanya berlaku jika subparameter Type dari parameter Buttons diatur ke PHONE_NUMBER.

    +861398745****
    Url

    string

    URL tujuan saat Anda mengklik tombol URL.

    https://example.com

    UrlType

    string

    Jenis URL. Nilai yang valid:

    • static

    • dynamic

    static
    SignatureHash

    string

    Hash kunci penandatanganan aplikasi yang digunakan WhatsApp untuk memuat aplikasi Anda. Parameter ini wajib diisi jika Category diatur ke AUTHENTICATION dan subparameter Type dari parameter Buttons diatur ke ONE_TAP dalam templat pesan WhatsApp.

    2993839
    PackageName

    string

    Nama paket aplikasi yang digunakan WhatsApp untuk memuat aplikasi Anda. Parameter ini wajib diisi jika Category diatur ke AUTHENTICATION dan subparameter Type dari parameter Buttons diatur ke ONE_TAP dalam templat pesan WhatsApp.

    com.aliyun
    AutofillText

    string

    Teks tombol autofill sekali ketuk. Parameter ini wajib diisi jika Category diatur ke AUTHENTICATION dan subparameter Type dari parameter Buttons diatur ke ONE_TAP dalam templat pesan WhatsApp.

    Autofill
    IsOptOut

    boolean

    Tombol berhenti berlangganan. Parameter ini berlaku jika Category diatur ke MARKETING dan subparameter Type dari parameter Buttons diatur ke QUICK_REPLY untuk templat pesan WhatsApp. Pesan pemasaran tidak akan dikirim ke pelanggan jika Anda mengonfigurasi pengiriman pesan di Konsol Chat App Message Service dan pelanggan mengklik tombol ini.

    false
    ExtendAttrs

    object

    Bidang tambahan.

    NextTemplateCode

    string

    Kode templat berikutnya.

    20939920093993
    NextTemplateName

    string

    Nama templat berikutnya.

    abc
    NextLanguageCode

    string

    Bahasa templat berikutnya.

    en
    Action

    string

    Jenis event.

    nextCard
    IntentCode

    string

    Kode intent.

    test
    CouponCode

    string

    Kode kupon.

    202039ksjs
    FlowId

    string

    ID Flow.

    3838292983
    FlowAction

    string

    Aksi Flow. Nilai yang valid: NAVIGATE dan DATA_EXCHANGE.

    NAVIGATE
    NavigateScreen

    string

    Layar pertama dalam Flow. Parameter ini dikembalikan jika FlowAction diatur ke NAVIGATE.

    DETAILS
    SupportedApps

    array<object>

    Aplikasi yang mendukung autentikasi sekali ketuk dan autentikasi tanpa ketuk.

    object

    SignatureHash

    string

    Hash kunci penandatanganan aplikasi.

    29kdkeik939
    PackageName

    string

    Nama paket aplikasi.

    com.test
    ThumbUrl

    string

    URL gambar mini video dalam templat pesan Viber.

    https://img.png
    Duration

    integer

    Durasi video dalam templat pesan Viber. Satuan: detik. Nilai yang valid: 0 hingga 600.

    50
    FileType

    string

    Jenis dokumen yang dilampirkan dalam templat pesan Viber.

    docx
    Latitude

    string

    Lintang lokasi.

    28.001
    Longitude

    string

    Bujur lokasi.

    120.002
    LocationName

    string

    Nama lokasi.

    杭州
    LocationAddress

    string

    Alamat lokasi.

    杭州
    AddSecretRecommendation

    boolean

    Catatan yang menunjukkan bahwa pelanggan tidak boleh membagikan kode verifikasi kepada orang lain. Catatan ini ditampilkan dalam isi pesan. Parameter ini berlaku jika Category diatur ke AUTHENTICATION dan subparameter Type dari parameter Components diatur ke BODY untuk templat pesan WhatsApp.

    false
    CodeExpirationMinutes

    integer

    Periode validitas kode verifikasi dalam templat autentikasi WhatsApp. Satuan: menit. Parameter ini hanya berlaku ketika Category diatur ke AUTHENTICATION dan subparameter Type dari parameter Components diatur ke FOOTER untuk templat pesan WhatsApp. Periode validitas kode verifikasi ditampilkan di footer.

    5
    hasExpiration

    boolean

    Menunjukkan apakah kode kupon memiliki waktu kedaluwarsa dalam templat penawaran terbatas waktu.

    true
    OfferExpirationTimeMs

    string

    Variabel waktu kedaluwarsa kode kupon dalam templat penawaran terbatas waktu.

    $(offerExpirationTimeMs)
    Cards

    array<object>

    Kartu carousel.

    array<object>

    CardComponents

    array<object>

    Komponen kartu carousel.

    array<object>

    Type

    string

    Jenis komponen.

    HEADER
    Text

    string

    Teks kartu carousel.

    Body
    Url

    string

    URL.

    https://aliyun.com
    Format

    string

    Jenis header dalam templat carousel. Header hanya dapat berupa citra atau video. Header semua kartu carousel harus sama. Jenis sumber daya media yang disertakan dalam pesan. Nilai yang valid: IMGAGE dan VIDEO.

    HEADER
    Buttons

    array<object>

    Tombol kartu carousel.

    object

    Type

    string

    Jenis tombol dalam templat carousel. Nilai yang valid: URL, PHONE_NUMBER, dan QUICK_REQLY.

    URL
    Text

    string

    Teks tombol.

    按钮文本
    Url

    string

    URL tujuan saat Anda mengklik tombol URL.

    https://aliyun.com
    UrlType

    string

    Jenis URL. Nilai yang valid: static dan dynamic.

    static
    PhoneNumber

    string

    Nomor telepon.

    +861380005****
    TemplateType

    string

    Jenis templat pesan. Nilai yang valid:

    • WHATSAPP

    • VIBER

    • LINE (sedang dikembangkan)

    WHATSAPP
    QualityScore

    string

    Kualitas templat.

    Valid values:

    • RED :

      Kualitas rendah

    • YELLOW :

      Kualitas sedang

    • UNKNOWN :

      Kualitas tidak diketahui

    • GREEN :

      Kualitas tinggi

    GREEN
    MessageSendTtlSeconds

    integer

    Periode validitas pesan autentikasi WhatsApp.

    120
    Reason

    string

    Alasan penolakan templat.

    None
    AccessDeniedDetail

    string

    Detail akses ditolak.

    无

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "744c4b5c79c9432497a075bdfca3****",
  "Code": "OK",
  "Message": "User not authorized to operate on the specified resource.",
  "Data": {
    "Category": "UTILITY",
    "TemplateCode": "744c4b5c79c9432497a075bdfca3****",
    "Name": "hello_whatsapp",
    "Language": "en_US",
    "Example": {
      "key": "{\\\"textVariable\\\":\\\"text\\\",\\\"linkVariable\\\":\\\"https://image.developer.aliy\\\"}"
    },
    "AuditStatus": "pass",
    "Components": [
      {
        "Type": "BODY",
        "Url": "https://image.developer.aliyundoc.com",
        "Text": "你好",
        "Caption": "新文件已上传",
        "FileName": "快递文件",
        "Format": "TEXT",
        "Buttons": [
          {
            "Type": "PHONE_NUMBER",
            "Text": "打电话",
            "PhoneNumber": "+861398745****",
            "Url": "https://example.com\n",
            "UrlType": "static",
            "SignatureHash": "2993839",
            "PackageName": "com.aliyun",
            "AutofillText": "Autofill",
            "IsOptOut": false,
            "ExtendAttrs": {
              "NextTemplateCode": "20939920093993",
              "NextTemplateName": "abc",
              "NextLanguageCode": "en",
              "Action": "nextCard",
              "IntentCode": "test"
            },
            "CouponCode": "202039ksjs",
            "FlowId": "3838292983",
            "FlowAction": "NAVIGATE",
            "NavigateScreen": "DETAILS",
            "SupportedApps": [
              {
                "SignatureHash": "29kdkeik939",
                "PackageName": "com.test"
              }
            ]
          }
        ],
        "ThumbUrl": "https://img.png",
        "Duration": 50,
        "FileType": "docx",
        "Latitude": "28.001",
        "Longitude": "120.002",
        "LocationName": "杭州",
        "LocationAddress": "杭州",
        "AddSecretRecommendation": false,
        "CodeExpirationMinutes": 5,
        "hasExpiration": true,
        "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": "+861380005****"
                  }
                ]
              }
            ]
          }
        ]
      }
    ],
    "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.