Chat App Message Service menyediakan API untuk membuat templat, mengirim pesan tunggal, dan mengirim pesan secara massal. Topik ini menggunakan WhatsApp sebagai contoh; channel lain mengikuti proses serupa.
Anda dapat memanggil API Chat App Message Service dengan cara berikut:
Portal OpenAPI Alibaba Cloud
Debug API dan dapatkan contoh permintaan SDK melalui antarmuka interaktif—ideal untuk developer yang baru menggunakan Alibaba Cloud.
SDK tersedia untuk berbagai bahasa pemrograman, seperti Java, Go, PHP, dan Python. Menggunakan SDK untuk mengintegrasikan Chat App Message Service meningkatkan efisiensi pengembangan.
Enkapsulasi kustom (tidak disarankan)
SDK Alibaba Cloud menangani penandatanganan permintaan, timeout, dan retry. Kami menyarankan menggunakan SDK untuk mengurangi biaya pengembangan. Jika Anda harus melakukan panggilan API mentah, lihat SendChatappMessage dan Sintaks permintaan dan metode signature V3.
Untuk mengintegrasikan Chat App Message Service dengan SDK, tinjau API di Portal OpenAPI, lalu ikuti langkah-langkah berikut untuk mengintegrasikan Chat App Message Service:
Persiapan
Persiapan | Deskripsi | Referensi |
Daftarkan Akun Alibaba Cloud Lengkapi verifikasi identitas perusahaan |
| |
Aktifkan layanan | Login ke Konsol Chat App Message Service, lalu aktifkan layanan. | - |
Konfigurasikan izin pengguna | Akun Alibaba Cloud memiliki izin yang luas. Gunakan Pengguna RAM untuk panggilan API dan operasi harian. Anda dapat memeriksa izin pengguna dengan login ke Konsol RAM lalu klik nama Pengguna RAM tersebut. Pastikan Pengguna RAM yang melakukan panggilan API memiliki izin yang diperlukan untuk Chat App Message Service:
| |
ID AccessKey | Login ke Konsol RAM, lalu klik nama Pengguna RAM untuk melihat ID AccessKey. | |
Rahasia AccessKey | Rahasia AccessKey hanya ditampilkan saat pembuatan. Jika Anda tidak memiliki cadangan lokal, buat pasangan AccessKey baru. |
Konfigurasi lingkungan
Contoh ini menggunakan Java. Untuk bahasa lain dan instruksi instalasi SDK, lihat Metode Instalasi.
Pastikan Java 8+ telah terinstal. Untuk instruksi detail, lihat Siapkan lingkungan pengembangan Java di Windows.
Instal SDK dengan mengonfigurasi dependensi Maven.
Pada file
pom.xmlproyek Maven Anda, tambahkan kode berikut ke dalam elemen<dependencies>dan gantithe-latest-versiondengan nomor versi terbaru. Kemudian muat ulang dependensi Maven.<dependency> <groupId>com.aliyun</groupId> <artifactId>alibabacloud-cams20200606</artifactId> <!-- Ganti 'the-latest-version' dengan nomor versi terbaru: https://mvnrepository.com/artifact/com.aliyun/alibabacloud-cams20200606 --> <version>the-latest-version</version> </dependency>Konfigurasikan variabel lingkungan: Untuk menghindari hardcoding pasangan AccessKey Anda dalam kode, simpan kredensial dalam variabel lingkungan. Setelah dikonfigurasi, restart IDE, command-line interface, dan aplikasi lainnya agar memuat variabel baru.
Konfigurasikan proxy (opsional). Untuk mengarahkan permintaan melalui proxy, konfigurasikan di SDK. Konfigurasi proxy.
Informasi dasar API
Versi API | |
RPC | |
(Endpoint) | Titik akhir publik: cams.ap-southeast-1.aliyuncs.com |
Tinjau parameter API sebelum melakukan panggilan. Debug Online | Ikhtisar API
Alur kerja
Buat channel: Buka halaman Manajemen Channel.
Channel adalah jenis jalur yang digunakan untuk mengirim pesan. Channel yang didukung: WhatsApp, Viber, Messenger, Instagram, dan Email.
Setiap channel hanya mendukung jenis pesan yang sesuai.
Daftarkan dan ikat WABA: Panggil API ChatappBindWaba untuk mengikat WhatsApp Business Account (WABA).
Anda harus memiliki WABA yang telah terdaftar sebelum memanggil API ini. WABA tidak dapat didaftarkan melalui API—daftarkan melalui Konsol Chat App Messaging Service.
WABA (WhatsApp Business Account) diperlukan untuk mengirim pesan komersial WhatsApp. WABA yang telah diverifikasi menampilkan lencana yang meningkatkan kepercayaan pelanggan dan memperkuat citra merek sekaligus mengurangi gangguan dari pesan penipuan.
Tambahkan nomor: Panggil API AddChatappPhoneNumber untuk menambahkan nomor. Nomor telepon ini akan digunakan untuk mengirim pesan WhatsApp.
Anda dapat menyinkronkan nomor di bawah WABA yang telah di-bind dan disetujui dengan platform Business Manager (BM) menggunakan API ChatappSyncPhoneNumber.
Anda dapat memigrasikan nomor telepon dari BSP lain ke Alibaba Cloud. Nomor yang dimigrasikan mempertahankan nama tampilan, peringkat kualitas, batas pengiriman pesan, status akun bisnis resmi, dan semua templat pesan berkualitas tinggi yang sebelumnya telah disetujui. Gunakan API CreateChatappMigrationInitiate untuk memulai migrasi.
Verifikasi nomor: Panggil API GetChatappVerifyCode untuk mendapatkan kode verifikasi nomor tersebut. Lalu, gunakan operasi API ChatappVerifyAndRegistr untuk memverifikasi nomor. Setelah diverifikasi, gunakan operasi API GetPhoneNumberVerificationStatus untuk memeriksa status verifikasi.
Jika Anda menggunakan nomor telepon yang dimigrasikan, panggil API GetMigrationVerifyCode untuk mendapatkan kode verifikasi. Lalu, panggil API ChatappMigrationVerified untuk memverifikasi nomor yang dimigrasikan.
Buat dan desain templat: Panggil API CreateChatappTemplate untuk membuat templat. Setelah templat dibuat, templat tersebut secara otomatis diajukan untuk ditinjau. Lalu, gunakan API GetChatappTemplateDetail untuk menanyakan detail peninjauan templat.
Monitor status peninjauan setelah pengajuan. Peninjauan biasanya selesai dalam lima menit tetapi bisa memakan waktu lebih dari 24 jam.
Kategori templat pesan WhatsApp dapat berubah secara otomatis selama peninjauan. Saat memanggil API CreateChatappTemplate, atur CategoryChangePaused ke true untuk menjeda pengiriman ketika kategori berubah. Perubahan kategori templat pesan WhatsApp dan kontrol pengiriman.
Kirim pesan: Panggil API SendChatappMessage atau SendChatappMassMessage untuk mengirim pesan.
Pastikan akun Anda memiliki saldo yang cukup sebelum mengirim. Harga.
Lihat detail pengiriman pesan: Terima laporan untuk pesan yang telah dikirim melalui callback ChatAppStatus (Simple Message Queue | URL HTTP).
Terima pesan mobile originated (MO): Terima pesan inbound melalui callback ChatAppInbound (Simple Message Queue | URL HTTP).
Untuk informasi lebih lanjut tentang operasi API, lihat Ikhtisar API.
Kode contoh
Contoh berikut mengirim pesan dengan memanggil API SendChatappMessage. Isi parameter sesuai petunjuk pada komentar.
// File ini di-generate secara otomatis, jangan diedit. Terima kasih.
package com.aliyun.sample;
import com.aliyun.tea.*;
public class Sample {
/**
* deskripsi :
* <p>Inisialisasi client menggunakan kredensial.</p>
* @return Client
*
* @throws Exception
*/
public static com.aliyun.cams20200606.Client createClient() throws Exception {
// Untuk lingkungan produksi, kami sarankan metode yang lebih aman yang tidak melakukan hardcoding AccessKey. Untuk detailnya, kunjungi https://www.alibabacloud.com/help/doc-detail/2542825.html.
com.aliyun.credentials.Client credential = new com.aliyun.credentials.Client();
com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
.setCredential(credential);
// Titik akhir layanan. Untuk detailnya, kunjungi https://api.alibabacloud.com/product/cams.
config.endpoint = "cams.ap-southeast-1.aliyuncs.com";
return new com.aliyun.cams20200606.Client(config);
}
public static void main(String[] args_) throws Exception {
com.aliyun.cams20200606.Client client = Sample.createClient();
java.util.Map<String, String> templateParams = TeaConverter.buildMap(
//Ganti ini dengan nama variabel dan nilai dari templat Anda
new TeaPair("name", "Bob"),
new TeaPair("sex", "Male")
);
com.aliyun.cams20200606.models.SendChatappMessageRequest sendChatappMessageRequest = new com.aliyun.cams20200606.models.SendChatappMessageRequest()
//Parameter untuk mengirim pesan.
.setTemplateParams(templateParams)
.setTemplateCode("XXXXXXXXXXX")
.setChannelType("whatsapp")
.setType("template")
.setLanguage("en")
.setFrom("XXXXXXXX")
.setTo("XXXXXXXX")
.setCustSpaceId("XXXXXXXXXXX");
com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();
try {
// Jika Anda menyalin kode ini untuk dijalankan, cetak nilai kembali API sendiri.
client.sendChatappMessageWithOptions(sendChatappMessageRequest, runtime);
} catch (TeaException error) {
// Ini hanya untuk pencetakan dan demonstrasi. Tangani exception dengan hati-hati dan jangan mengabaikannya dalam proyek Anda.
// Pesan error.
System.out.println(error.getMessage());
// Alamat diagnostik.
System.out.println(error.getData().get("Recommend"));
com.aliyun.teautil.Common.assertAsString(error.message);
} catch (Exception _error) {
TeaException error = new TeaException(_error.getMessage(), _error);
// Ini hanya untuk pencetakan dan demonstrasi. Tangani exception dengan hati-hati dan jangan mengabaikannya dalam proyek Anda.
// Pesan error.
System.out.println(error.getMessage());
// Alamat diagnostik
System.out.println(error.getData().get("Recommend"));
com.aliyun.teautil.Common.assertAsString(error.message);
}
}
}
Kunjungi Portal OpenAPI untuk contoh lengkap SDK dalam bahasa lain. Untuk melakukan panggilan API mentah, lihat SendChatappMessage dan Sintaks permintaan dan metode signature V3.
FAQ
Mengapa tombol registrasi pada halaman registrasi WABA berwarna abu-abu dan tidak dapat diklik?
Bagaimana cara melihat pesan yang dikirim oleh pengguna akhir ke bisnis saya?
Mengapa saya tidak dapat menyelesaikan Verifikasi Bisnis Meta saat membuat WABA?
Dapatkah saya mengedit templat pesan WhatsApp setelah disetujui?
Apa yang harus saya lakukan jika akun Facebook saya diblokir?
Bagaimana cara menambahkan nomor telepon internasional di WhatsApp?
Apa saja aturan atau batasan bagi bisnis yang mengirim pesan dari nomor telepon WhatsApp bisnis?