All Products
Search

This Product

    Chat App Message Service:CreateChatappTemplate

    Document Center

    Chat App Message Service:CreateChatappTemplate

    Last Updated:Dec 22, 2025

    Membuat templat pesan. Setelah disetujui, templat tersebut dapat digunakan untuk mengirim pesan.

    Deskripsi operasi

    Batas QPS

    Batas permintaan per detik (QPS) untuk operasi ini adalah 50 per pengguna. Jika batas tersebut dilampaui, panggilan API akan dikenai pengendalian aliran (throttled), yang dapat memengaruhi bisnis Anda. Disarankan untuk memanggil operasi ini dengan frekuensi yang wajar.

    Perubahan status

    Anda dapat memantau perubahan status dan kualitas templat melalui Message Service (MNS) atau HTTP. Untuk informasi selengkapnya, lihat Message receipts.

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

    create

    *全部资源

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    Category

    string

    Yes

    Kategori templat WhatsApp:

    • UTILITY: Transaksional.

    • MARKETING: Pemasaran.

    • AUTHENTICATION: Autentikasi.

    Kategori templat Viber:

    • text: Teks biasa

    • image: Hanya citra

    • text_image_button: Teks, citra, dan tombol

    • text_button: Teks dan tombol

    • document: File

    • video: Video

    • text_video: Teks dan video

    • text_video_button: Teks, video, dan tombol

    • text_image: Teks dan citra

    UTILITY
    Components

    array<object>

    Yes

    Daftar komponen templat pesan.

    Catatan

    Jika Category diatur ke AUTHENTICATION, larik Components tidak boleh berisi komponen HEADER. Jika tipe komponen adalah BODY atau FOOTER, parameter Text harus kosong.

    array<object>

    No

    Daftar komponen.

    Type

    string

    Yes

    Tipe komponen. Nilai yang valid:

    • BODY

    • HEADER

    • FOOTER

    • BUTTONS

    • CAROUSEL

    • LIMITED_TIME_OFFER

    Catatan

    • Untuk templat WhatsApp, komponen BODY tidak boleh melebihi 1.024 karakter. Komponen HEADER dan FOOTER tidak boleh melebihi 60 karakter.

    • Untuk templat Viber, tipe FOOTER, CAROUSEL, dan LIMITED_TIME_OFFER tidak valid.

    • Untuk templat Viber, citra, video, dan file ditempatkan di HEADER. Klien menampilkan citra di bawah teks.

    BODY
    Text

    string

    No

    Teks pesan.

    Catatan

    Jika Category diatur ke AUTHENTICATION, parameter ini harus kosong.

    hello whatsapp
    Format

    string

    No

    Tipe resource media.

    • TEXT: Teks

    • IMAGE: Citra

    • DOCUMENT: Dokumen

    • VIDEO: Video

    TEXT
    Url

    string

    No

    Jalur resource media.

    Catatan

    Untuk templat Viber, ukuran citra yang direkomendasikan adalah 800 × 800 piksel.

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

    string

    No

    Deskripsi file.

    这是一个视频
    FileName

    string

    No

    Nama file.

    快递视频
    Buttons

    array<object>

    No

    Daftar tombol. Parameter ini hanya berlaku untuk komponen BUTTONS.

    Catatan

    Jumlah tombol untuk templat WhatsApp

    • Untuk templat MARKETING atau UTILITY, maksimal 10 tombol diperbolehkan.

    • Hanya satu tombol PHONE_NUMBER yang diperbolehkan.

    • Maksimal dua tombol URL diperbolehkan.

    • Tombol QUICK_REPLY tidak boleh dicampur dengan tombol PHONE_NUMBER atau URL.

    array<object>

    No

    Definisi tombol.

    Type

    string

    Yes

    Tipe tombol.

    • PHONE_NUMBER: Tombol panggil

    • URL: Tombol URL

    • QUICK_REPLY: Tombol balasan cepat

    • COPY_CODE: Tombol salin kode untuk kode verifikasi atau Kode kupon.

    • ONE_TAP: Tombol autofill untuk templat AUTHENTICATION.

    • ZERO_TAP: Tombol autofill untuk templat AUTHENTICATION.

    • MPM: Pesan multi-produk.

    • CATALOG: Katalog.

    • FLOW: Membuka alur WhatsApp.

    Catatan

    • Untuk templat WhatsApp dengan Category AUTHENTICATION, hanya satu tombol yang diperbolehkan, dan tipenya harus COPY_CODE atau ONE_TAP. Jika tipe adalah COPY_CODE, Text wajib diisi. Jika tipe adalah ONE_TAP, Text (nama tombol salin kode yang ditampilkan jika aplikasi target tidak terinstal pada klien), SignatureHash, PackageName, dan AutofillText wajib diisi.

    • Untuk templat Viber, hanya satu tombol yang diperbolehkan, dan tipenya harus URL.

    PHONE_NUMBER
    Text

    string

    No

    Nama yang ditampilkan pada tombol.

    Call Me
    PhoneNumber

    string

    No

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

    +861368897****
    Url

    string

    No

    URL yang diakses saat tombol URL diklik.

    https://example.com
    UrlType

    string

    No

    Tipe URL.

    • static: Statis

    • dynamic: Dinamis

    static
    SignatureHash deprecated

    string

    No

    Gunakan parameter di bawah SupportedApps sebagai gantinya.

    wi299382
    PackageName deprecated

    string

    No

    Gunakan parameter di bawah SupportedApps sebagai gantinya.

    com.demo
    AutofillText

    string

    No

    Teks tombol untuk aksi autofill WhatsApp. Parameter ini wajib diisi untuk templat WhatsApp ketika Category adalah AUTHENTICATION dan tipe tombol adalah ONE_TAP atau ZERO_TAP.

    Autofill
    IsOptOut

    boolean

    No

    Parameter ini berlaku untuk templat WhatsApp ketika Category adalah Marketing dan tipe tombol adalah QUICK_REPLY. Parameter ini menunjukkan bahwa tombol tersebut merupakan tombol opt-out pemasaran. Jika pelanggan mengklik tombol ini dan Anda telah mengonfigurasi kontrol pengiriman di ChatApp, pesan pemasaran selanjutnya tidak akan dikirim ke pelanggan tersebut.

    false
    CouponCode

    string

    No

    Nilai Kode kupon. Hanya boleh berisi huruf dan angka. Anda dapat meneruskan variabel seperti $(couponCode) lalu memberikan Kode kupon aktual saat mengirim pesan.

    120293
    FlowId

    string

    No

    ID alur.

    479884093605****
    FlowAction

    string

    No

    Tipe peristiwa data alur. Nilai yang valid:

    • DATA_EXCHANGE: Pertukaran data.

    • NAVIGATE: Navigasi.

    NAVIGATE
    NavigateScreen

    string

    No

    Layar yang akan dinavigasi. Parameter ini wajib diisi ketika FlowAction diatur ke NAVIGATE.

    DETAILS
    SupportedApps

    array<object>

    No

    Daftar aplikasi yang didukung.

    object

    No

    SignatureHash

    string

    No

    Hash signature dari aplikasi yang diluncurkan WhatsApp. Parameter ini wajib diisi untuk templat WhatsApp ketika Category adalah AUTHENTICATION dan tipe tombol adalah ONE_TAP atau ZERO_TAP.

    ieid83kdiek
    PackageName

    string

    No

    Nama paket aplikasi yang diluncurkan WhatsApp. Parameter ini wajib diisi untuk templat WhatsApp ketika Category adalah AUTHENTICATION dan tipe tombol adalah ONE_TAP atau ZERO_TAP.

    com.kuaidian.waimaistaff
    ThumbUrl

    string

    No

    Gambar mini pesan Viber yang berisi video.

    https://cdn.multiplymall.mobiapp.cloud/yunmall/B-LM-LMALL202207130001/20220730/d712a057-a6af-4513-bbe6-7ee57ea60983.png?x-oss-process=image/resize,w_100
    Duration

    integer

    No

    Durasi video dalam pesan video Viber, dalam satuan detik. Nilainya berkisar antara 0 hingga 600.

    120
    FileType

    string

    No

    Tipe file pesan file Viber.

    docx
    CodeExpirationMinutes

    integer

    No

    Periode validitas kode verifikasi dalam templat AUTHENTICATION WhatsApp, dalam satuan menit. Parameter ini hanya berlaku untuk pesan WhatsApp ketika Category adalah AUTHENTICATION dan tipe komponen adalah Footer. Informasi ini ditampilkan di footer.

    5
    AddSecretRecommendation

    boolean

    No

    Parameter ini berlaku untuk templat WhatsApp ketika Category adalah AUTHENTICATION dan tipe komponen adalah Body. Parameter ini menunjukkan bahwa pesan ditampilkan di atas body, mengingatkan pengguna agar tidak membagikan kode verifikasi mereka kepada orang lain.

    true
    HasExpiration

    boolean

    No

    Menunjukkan apakah Kode kupon memiliki waktu kedaluwarsa. Parameter ini digunakan ketika tipe adalah LIMITED_TIME_OFFER.

    true
    Cards

    array<object>

    No

    Daftar kartu untuk templat Carousel.

    array<object>

    No

    Objek kartu untuk templat Carousel.

    CardComponents

    array<object>

    Yes

    Daftar komponen dalam kartu Carousel.

    array<object>

    No

    Objek kartu dalam templat Carousel.

    Type

    string

    Yes

    Tipe komponen. Nilai yang valid:

    • BODY

    • HEADER

    • BUTTONS

    BODY
    Format

    string

    No

    Tipe resource media. Parameter ini berlaku ketika Type adalah HEADER.

    • IMAGE: Citra

    • VIDEO: Video

    IMAGE
    Text

    string

    No

    Konten BODY dalam kartu Carousel.

    Who is the very powerful team
    Url

    string

    No

    Jalur resource media.

    https://alibaba.com/img.png
    Buttons

    array<object>

    No

    Daftar tombol. Parameter ini hanya berlaku untuk komponen BUTTONS. Setiap kartu dalam templat Carousel dapat memiliki maksimal dua tombol.

    object

    No

    Objek tombol.

    Text

    string

    No

    Teks tombol.

    Call me
    Type

    string

    Yes

    Tipe tombol.

    • PHONE_NUMBER: Tombol panggil

    • URL: Tombol URL

    • QUICK_REPLY: Tombol balasan cepat

    PHONE_NUMBER
    Url

    string

    No

    URL yang diakses saat tombol diklik.

    https://alibaba.com/xx
    UrlType

    string

    No

    Tipe URL.

    • static: Statis

    • dynamic: Dinamis

    static
    PhoneNumber

    string

    No

    Nomor telepon.

    +86138007****
    Name

    string

    Yes

    Nama templat.

    hello_whatsapp
    Language

    string

    Yes

    Bahasa templat. Untuk informasi lebih lanjut tentang kode bahasa, lihat Language codes.

    en
    Example

    object

    No

    Contoh templat.

    hello_whatsapp

    string

    No

    Contoh templat.

    StringConcat('a', 'b', 'c')
    TemplateType

    string

    Yes

    Tipe templat.

    • WHATSAPP

    • VIBER

    WHATSAPP
    CustWabaId deprecated

    string

    No

    ID WABA pelanggan ISV.

    Catatan

    Parameter ini sudah tidak digunakan lagi. Gunakan CustSpaceId sebagai gantinya.

    65921621816****
    IsvCode

    string

    No

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

    skdi3kksloslikdkkdk
    CustSpaceId

    string

    Yes

    ID Space pelanggan sub-ISV atau ID instans pelanggan langsung.

    293483938849493
    AllowCategoryChange deprecated

    boolean

    No

    Menentukan apakah Facebook diizinkan untuk mengubah kategori templat secara otomatis. Hal ini dapat meningkatkan tingkat persetujuan templat. Parameter ini hanya berlaku ketika TemplateType adalah WHATSAPP.

    Penting Parameter ini sudah tidak digunakan lagi. WhatsApp tidak lagi mendukung parameter ini.

    true
    MessageSendTtlSeconds

    integer

    No

    Periode validitas pesan templat di WhatsApp.

    • Untuk templat AUTHENTICATION, nilainya berkisar antara 30 hingga 900.

    • Untuk templat UTILITY, nilainya berkisar antara 30 hingga 43200.

    120

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Data yang dikembalikan.

    RequestId

    string

    ID permintaan.

    90E63D28-E31D-1EB2-8939-A94866411B2D
    Code

    string

    Kode status permintaan.

    • Nilai OK menunjukkan bahwa permintaan berhasil.

    • Untuk daftar kode kesalahan lainnya, lihat API error codes.

    OK
    Message

    string

    Pesan kesalahan.

    User not authorized to operate on the specified resource.
    Data

    object

    Data yang dikembalikan.

    {"templateCode": "****4b5c79c9432497a075bdfca36bf5"，"templateName": "hello_whatsapp"}
    TemplateCode

    string

    Kode templat.

    SMS_232907****
    TemplateName

    string

    Nama templat.

    hello_whatsapp
    AccessDeniedDetail

    string

    Detail penolakan akses.

    None

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2D",
  "Code": "OK",
  "Message": "User not authorized to operate on the specified resource.",
  "Data": {
    "TemplateCode": "SMS_232907****",
    "TemplateName": "hello_whatsapp"
  },
  "AccessDeniedDetail": "None"
}

    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.