Standar API dan SDK siap pakai dalam berbagai bahasa
Spesifikasi OpenAPI produk ini (cams/2020-06-06) mematuhi standar RPC. Alibaba Cloud menyediakan SDK siap pakai untuk berbagai bahasa pemrograman populer guna mengabstraksi kompleksitas tingkat rendah seperti request signing. Hal ini memungkinkan developer untuk memanggil API menggunakan sintaks khusus tanpa perlu menangani detail HTTP secara langsung.
Signature kustom
Jika SDK tidak mendukung kebutuhan spesifik Anda, seperti signature kustom, Anda harus menandatangani request secara manual menggunakan signature mechanism. Perhatikan bahwa proses penandatanganan manual memerlukan upaya yang signifikan (estimasi 5 hari kerja). Untuk mendapatkan dukungan, bergabunglah dengan grup DingTalk kami (ID: 147535001692).
Sebelum Anda mulai
Akun Alibaba Cloud memiliki hak administratif penuh. Jika pasangan AccessKey dikompromikan, semua resource terkait dapat terekspos terhadap akses tidak sah, sehingga menimbulkan risiko keamanan yang signifikan. Buat Resource Access Management (RAM) user dengan akses khusus API dan gunakan kebijakan RAM untuk menerapkan principle of least privilege (PoLP). Gunakan akun Alibaba Cloud hanya jika benar-benar diperlukan.
Untuk memanggil API secara aman, konfigurasikan hal berikut:
Akun RAM user
Pasangan AccessKey untuk akun tersebut
Manajemen Grup Audiens
|
API |
Judul |
Deskripsi |
| AddChatGroup | AddChatGroup | Membuat grup IM. |
| AddChatGroupInviteLink | AddChatGroupInviteLink | Menambahkan tautan undangan untuk kelompok Instant Messaging (IM). |
| DeleteChatGroupInviteLink | DeleteChatGroupInviteLink | Menghapus tautan undangan grup IM. |
| DeleteChatGroupParticipants | DeleteChatGroupParticipants | Menghapus anggota dari kelompok IM. |
| ListChatGroup | ListChatGroup | Mengambil daftar grup IM. |
| UpdateChatGroup | UpdateChatGroup | Memperbarui informasi kelompok Instant Messaging (IM). |
| DeleteChatGroup | DeleteChatGroup | Menghapus kelompok Instant Messaging (IM). |
Pesan Pemasaran Messenger
|
API |
Judul |
Deskripsi |
| SyncMessengerSubscriptionToken | Sinkronisasi Token Langganan Messenger | Mengambil token langganan Messenger. |
| SyncMessageCampaign | SyncMessageCampaign | Mengkueri anggaran secara sinkron. |
| ListMessengerSubscriptionToken | ListMessengerSubscriptionToken | Mengkueri audiens kustom dan token langganan. |
| ListMessageCampaign | ListMessageCampaign | Mengambil daftar anggaran. |
| ListCustomAudience | ListCustomAudience | Menanyakan daftar audiens kustom. |
| ListChatGroupParticipants | Daftar Anggota Kelompok IM | Menampilkan daftar anggota kelompok IM. |
| GetMessageCampaignInsights | GetMessageCampaignInsights | Mengambil metrik kampanye. |
| DeleteMessageCampaign | Hapus Kampanye Pesan | Menghapus anggaran untuk kampanye pemasaran. |
| CreateMessageCampaign | CreateMessageCampaign | Membuat anggaran. |
| CreateCustomAudience | CreateCustomAudience | Membuat audiens kustom. |
| AddCustomAudienceUser | AddCustomAudienceUser | Menambahkan pengguna ke audiens kustom. |
Alur WhatsApp
|
API |
Judul |
Deskripsi |
| CreateInstance | CreateInstance | Membuat instans. |
| DeleteInstance | DeleteInstance | Menghapus instans tertentu. |
| ListInstance | ListInstance | Queries a list of instances. |
| QueryInstance | QueryInstance | Mengambil detail instans tertentu. |
| UpdateInstance | UpdateInstance | Memperbarui instance yang ditentukan. |
API Terkait Pendaftaran Tertanam
|
API |
Judul |
Deskripsi |
| TriggerChatFlow | Memicu Alur Online | Memicu alur chat online yang memiliki pemicu manual. |
Manajemen Telepon
|
API |
Judul |
Deskripsi |
| CreateFlow | CreateFlow | Membuat flow. |
| ListFlow | ListFlow | Mengambil daftar flow WhatsApp. |
| GetFlow | GetFlow | Mengkueri detail flow WhatsApp, termasuk status, nama, kategori, dan URL Tampilan. |
| ModifyFlow | ModifyFlow | Memodifikasi sebuah flow. |
| UpdateFlowJSONAsset | UpdateFlowJSONAsset | Memperbarui konten alur WhatsApp menggunakan definisi JSON. |
| GetFlowJSONAssest | GetFlowJSONAssest | Retrieves the content of a flow in JSON format. |
| GetFlowPreviewUrl | GetFlowPreviewUrl | Menghasilkan URL Tampilan sementara untuk alur WhatsApp. |
| PublishFlow | PublishFlow | Mempublikasikan alur WhatsApp. |
| DeprecateFlow | DeprecateFlow | Menonaktifkan alur WhatsApp. |
| DeleteFlow | DeleteFlow | Menghapus alur WhatsApp. Hanya alur dalam status draf yang dapat dihapus. |
Pengiriman Pesan
|
API |
Judul |
Deskripsi |
| IsvGetAppId | IsvGetAppId | Mendapatkan App ID untuk Independent Software Vendor (ISV). |
| ChatappBindWaba | Mengaitkan Akun WhatsApp Business | Mengaitkan akun WhatsApp Business (WABA). |
| GetPermissionByCode | GetPermissionByCode | Mengambil izin menggunakan kode yang diperoleh dari alur pendaftaran yang disematkan. |
| ChatappSyncPhoneNumber | ChatappSyncPhoneNumber | Menyinkronkan nomor telepon. |
| AddChatappPhoneNumber | AddChatappPhoneNumber | Menambahkan nomor telepon ke WhatsApp Business Account (WABA). |
| GetPhoneNumberVerificationStatus | GetPhoneNumberVerificationStatus | Mengambil status verifikasi nomor telepon. |
| GetChatappVerifyCode | GetChatappVerifyCode | Meminta kode verifikasi untuk dikirim ke nomor telepon yang ditentukan. |
| ChatappVerifyAndRegister | ChatappVerifyAndRegister | Mengaitkan nomor telepon dengan akun WhatsApp Business (WABA). |
| ChatappPhoneNumberRegister | ChatappPhoneNumberRegister | Mendaftarkan nomor telepon. |
| ChatappPhoneNumberDeregister | ChatappPhoneNumberDeregister | Membatalkan pendaftaran nomor telepon dari WhatsApp Business Account (WABA). |
| QueryWabaBusinessInfo | QueryWabaBusinessInfo | Mengkueri informasi bisnis akun WhatsApp Business (WABA). |
| UpdatePhoneWebhook | UpdatePhoneWebhook | Kode status HTTP yang dikembalikan. * Nilai OK menunjukkan bahwa panggilan berhasil. * Nilai lain menunjukkan bahwa panggilan gagal. Untuk informasi lebih lanjut, lihat [Kode error](~~196974~~). |
| UpdateAccountWebhook | UpdateAccountWebhook | Memodifikasi URL callback dari sebuah akun. |
| QueryPhoneBusinessProfile | QueryPhoneBusinessProfile | Mengkueri informasi bisnis dari nomor telepon. |
| ModifyPhoneBusinessProfile | ModifyPhoneBusinessProfile | ID permintaan. |
| CreateChatappMigrationInitiate | CreateChatappMigrationInitiate | Memulai migrasi nomor telepon. |
| GetMigrationVerifyCode | GetMigrationVerifyCode | Mengambil kode verifikasi untuk migrasi nomor telepon. |
| ChatappMigrationVerified | ChatappMigrationVerified | Memverifikasi nomor telepon untuk migrasi. |
| ChatappMigrationRegister | Mendaftarkan nomor telepon untuk migrasi | Mendaftarkan nomor telepon untuk migrasi. |
| GetChatappUploadAuthorization | Dapatkan otorisasi unggah chatApp | Memperoleh informasi autentikasi yang digunakan untuk mengunggah berkas. |
| GetCommerceSetting | GetCommerceSetting | Mengkueri pengaturan bisnis nomor telepon. |
| UpdateCommerceSetting | UpdateCommerceSetting | Memperbarui pengaturan perdagangan untuk nomor telepon. |
Manajemen Templat
|
API |
Judul |
Deskripsi |
| GetWhatsappHealthStatus | Dapatkan status kesehatan pengiriman pesan WhatsApp | Mengkueri status kesehatan pengiriman pesan dari berbagai jenis node. |
| UpdateConversationalAutomation | Mengubah pesan sambutan nomor, sambutan pembuka, dan perintah | Memodifikasi pesan sambutan, sambutan pembuka, dan perintah untuk nomor telepon. |
| GetConversationalAutomation | Dapatkan pesan sambutan nomor, sambutan pembuka, dan perintah | Menanyakan pengaturan otomatisasi percakapan untuk nomor telepon. |
| GetPhoneEncryptionPublicKey | Obtain the encrypted public key of the number | Retrieves the public key for a phone number. |
| UpdatePhoneEncryptionPublicKey | Memperbarui kunci publik enkripsi nomor telepon | Memperbarui kunci publik enkripsi nomor telepon. |
| UpdatePhoneMessageQrdl | Ubah Kode QR Paket | Memperbarui kode QR Paket. |
| ListPhoneMessageQrdl | Mengkueri Daftar Kode QR Paket | Mengkueri kode QR Paket. |
| DeletePhoneMessageQrdl | Hapus kode QR pesan | Menghapus kode QR pesan. |
| CreatePhoneMessageQrdl | Buat Kode QR Paket | Membuat kode QR Paket. |
| QueryChatappPhoneNumbers | QueryChatappPhoneNumbers | Mengkueri semua nomor telepon yang digunakan untuk mengirim Paket dan statusnya untuk pelanggan. |
| QueryChatappBindWaba | QueryChatappBindWaba | Mengkueri WhatsApp Business Account (WABA) yang terhubung dengan akun pelanggan. |
Katalog Produk
|
API |
Judul |
Deskripsi |
| SendChatappMassMessage | SendChatappMassMessage | Mengirim pesan massal ke beberapa penerima. |
| SendChatappMessage | SendChatappMessage | Sends a message to a specified recipient. |
| WhatsappCall | WhatsappCall | Melakukan, menjawab, atau mengakhiri panggilan suara WhatsApp. |
Metrik Statistik
|
API |
Judul |
Deskripsi |
| CreateChatappTemplate | CreateChatappTemplate | Membuat Templat Paket. Setelah Templat disetujui, Anda dapat menggunakannya untuk mengirim Paket. |
| ModifyChatappTemplate | ModifyChatappTemplate | Mengubah templat Paket. Anda hanya dapat mengubah templat yang belum ditinjau atau telah ditolak. |
| ListChatappTemplate | ListChatappTemplate | Mengkueri templat Paket. |
| GetChatappTemplateDetail | GetChatappTemplateDetail | Mengkueri detail templat pesan. |
| DeleteChatappTemplate | DeleteChatappTemplate | Menghapus templat Paket. |
Lainnya
|
API |
Judul |
Deskripsi |
| ListProductCatalog | ListProductCatalog | Menanyakan katalog produk di platform Business Manager Meta. |
| GetWhatsappConnectionCatalog | GetWhatsappConnectionCatalog | Mengkueri katalog produk yang terkait dengan akun WhatsApp Business (WABA). |
| ListProduct | ListProduct | Mengambil produk dalam katalog. |
Lainnya
|
API |
Judul |
Deskripsi |
| GetChatappPhoneNumberMetric | GetChatappPhoneNumberMetric | Queries the message sending metrics for a phone number in a WhatsApp channel. |
| EnableWhatsappROIMetric | EnableWhatsappROIMetric | Mengaktifkan statistik untuk metrik WhatsApp. |
| GetChatappTemplateMetric | GetChatappTemplateMetric | Queries the metrics for a marketing template. |
其他
|
API |
Judul |
Deskripsi |
| GetPreValidatePhoneId | GetPreValidatePhoneId | Mendapatkan ID untuk nomor telepon yang telah divalidasi sebelumnya. Gunakan ID ini untuk memilih nomor tersebut dalam alur Embedded Signup tanpa mendapatkan kode verifikasi baru. |
| BeeBotAssociate | BeeBotAssociate | Associates FAQs in the knowledge base. |
| BeeBotChat | BeeBotChat | Conducts sessions with the bot based on its unique identifier (ID). |
| ChatappEmbedSignUp | ChatappEmbedSignUp | This embedded API is not required if you use v2 of the embedded software development kit (SDK). |
| SubmitIsvCustomerTerms | SubmitIsvCustomerTerms | Mengirimkan informasi perjanjian untuk pelanggan independent software vendor (ISV). |
| AddAuditViberOpen | AddAuditViberOpen | Mendaftarkan akun Viber. |
| GetViberByRequestNo | GetViberByRequestNo | Mengambil aplikasi berdasarkan requestNo-nya. |
| UpdateAuditRequest | UpdateAuditRequest | Memodifikasi aplikasi Viber. |
| ListWhatAppTemplate | ListWhatAppTemplate | Mencantumkan templat pesan. |