Panduan ini menjelaskan cara memanggil API Layanan Pesan Singkat (SMS) menggunakan OpenAPI Explorer atau SDK untuk melakukan operasi inti seperti mengirim pesan dan menanyakan status pengiriman.
Sebelum Anda mulai
Sebelum memanggil API SMS, selesaikan langkah-langkah persiapan berikut:
Buat Akun dan Selesaikan Verifikasi Identitas Perusahaan: SMS hanya tersedia untuk akun perusahaan. Anda harus menyelesaikan verifikasi identitas perusahaan.
Aktifkan SMS: Masuk ke Konsol SMS dan ikuti petunjuk untuk mengaktifkan layanan tersebut.
Beli Paket Sumber Daya: Secara default, SMS ditagih melalui paket sumber daya prabayar. Beli paket sumber daya sebelum menggunakan layanan ini.
Pastikan kartu kredit atau akun PayPal terhubung ke Akun Alibaba Cloud Anda.
Beli paket yang sesuai berdasarkan tujuan dan spesifikasi paket. Jika Anda lebih memilih model bayar sesuai penggunaan, hubungi penjualan untuk mengaktifkannya.
Siapkan Lingkungan Pengembangan: Ini melibatkan pembuatan Pengguna RAM, pemberian izin, dan mendapatkan Pasangan Kunci Akses. Untuk detailnya, lihat Konfigurasi Kredensial.
Persyaratan kepatuhan operator untuk mengirim pesan bervariasi berdasarkan negara dan wilayah. Untuk memastikan kemampuan pengiriman, selesaikan semua prosedur yang diperlukan untuk tujuan Anda:
Untuk mengirim pesan ke Daratan Tiongkok (Go China), buat tanda tangan SMS dan templat pesan. Mereka harus disetujui sebelum digunakan.
Untuk mengirim pesan ke wilayah di luar daratan Tiongkok (Go Globe), periksa apakah negara atau wilayah tujuan memerlukan pendaftaran ID pengirim.
Gunakan OpenAPI Explorer
OpenAPI Explorer adalah alat interaktif untuk men-debug panggilan API. Alat ini ideal untuk pengembang baru di Alibaba Cloud atau mereka yang lebih suka antarmuka visual. OpenAPI Explorer menyediakan pratinjau respons waktu nyata, validasi parameter otomatis, serta menghasilkan kode contoh multi-bahasa untuk mempermudah integrasi.

Anda dapat membuka OpenAPI Explorer dengan mengklik tombol Test pada halaman referensi API.
Go Globe
SendMessageToGlobe: Mengirim pesan ke wilayah di luar daratan Tiongkok, termasuk Hong Kong (Tiongkok), Macao (Tiongkok), dan Taiwan (Tiongkok).
BatchSendMessageToGlobe: Mengirim pesan dalam batch ke wilayah di luar daratan Tiongkok, termasuk Hong Kong (Tiongkok), Macao (Tiongkok), dan Taiwan (Tiongkok).
QueryMessage: Menanyakan status pesan yang telah dikirim.
Go China
SendMessageWithTemplate: Mengirim pesan ke daratan Tiongkok.
QueryMessage: Menanyakan status pesan yang telah dikirim.
Integrasi SDK SMS
Cara termudah dan paling andal untuk memanggil API SMS adalah dengan menggunakan SDK resmi. Contoh ini menggunakan Java SDK untuk memanggil operasi SendMessageToGlobe. Untuk bahasa lainnya, lihat Referensi SDK.
Periksa Lingkungan Java Anda: Pastikan Anda memiliki Java 8 atau versi lebih baru terpasang. Untuk instruksi, lihat Bangun Lingkungan Pengembangan Java di Windows.
Instal SDK: Instal SDK dengan mengonfigurasi dependensi Maven.
Dalam file
pom.xmlproyek Maven Anda, tambahkan dependensi berikut di dalam tag<dependencies>. Gantithe-latest-versiondengan nomor versi terbaru. Setelah menyimpan file, muat ulang dependensi Maven Anda.<dependency> <groupId>com.aliyun</groupId> <artifactId>dysmsapi20180501</artifactId> <!-- Ganti 'the-latest-version' dengan nomor versi terbaru: https://mvnrepository.com/artifact/com.aliyun/dysmsapi20180501 --> <version>the-latest-version</version> </dependency>Lihat Kode Contoh: Contoh berikut menunjukkan cara memanggil operasi
SendMessageToGlobemenggunakan Java SDK. Isi parameter sesuai dengan komentar.package com.aliyun.sample; import com.aliyun.teaopenapi.models.Config; import com.aliyun.dysmsapi20180501.Client; import com.aliyun.dysmsapi20180501.models.SendMessageToGlobeRequest; import com.aliyun.dysmsapi20180501.models.SendMessageToGlobeResponse; import static com.aliyun.teautil.Common.toJSONString; public class Sample { public static Client createClient() throws Exception { Config config = new Config() // Konfigurasikan ID AccessKey. Pastikan variabel lingkungan ALIBABA_CLOUD_ACCESS_KEY_ID diatur. .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")) // Konfigurasikan rahasia AccessKey. Pastikan variabel lingkungan ALIBABA_CLOUD_ACCESS_KEY_SECRET diatur. .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")); // Konfigurasikan titik akhir. config.endpoint = "dysmsapi.ap-southeast-1.aliyuncs.com"; return new Client(config); } public static void main(String[] args) throws Exception { // Inisialisasi klien permintaan. Client client = Sample.createClient(); // Bangun objek permintaan. Isi nilai parameter. SendMessageToGlobeRequest sendSmsRequest = new SendMessageToGlobeRequest() .setTo("<YOUR_VALUE>") .setMessage("<YOUR_VALUE>"); // Dapatkan objek tanggapan. SendMessageToGlobeResponse sendSmsResponse = client.sendMessageToGlobe(sendSmsRequest); // Tanggapan berisi body dan header dari server. System.out.println(toJSONString(sendSmsResponse)); } }Anda juga bisa unduh kode contoh dan jalankan langsung.
Pada tab Parameters, masukkan nilai parameter yang diperlukan.
Pada tab SDK Sample Code di sebelah kanan, pilih V2.0 untuk versi SDK dan Java untuk bahasa, lalu klik Download Project untuk mengunduh paket kode contoh.
Setelah membongkar paket, buka proyek di IDE Anda. Setelah dependensi dimuat, buka
src/main/java/com/aliyun/sample/Sample.java.
Tinjau Tanggapan: Setelah proyek dijalankan, Anda akan melihat keluaran serupa dengan tanggapan contoh berikut.
{ "headers": { "date": "Tue, 24 Oct 2023 07:47:17 GMT", "content-type": "application/json;charset=utf-8", "content-length": "263", "connection": "keep-alive", "keep-alive": "timeout=25", "access-control-allow-origin": "*", "access-control-expose-headers": "*", "x-acs-request-id": "97B1D7B6-F2F6-3A50-97BC-A90B43EC962F", "x-acs-trace-id": "29c11fe4c778b74774d5f5602f0e7975", "etag": "2a+mcDRTDkXqx9VF7b6U57Q3" }, "statusCode": 200, "body": { "ResponseCode": "OK", "NumberDetail": { "Region": "Taiwan", "Country": "Taiwan, Province of China", "Carrier": "FarEasTone" }, "RequestId": "97B1D7B6-F2F6-3A50-97BC-A90B43EC962F", "Segments": "1", "ResponseDescription": "OK", "To": "88691567****", "MessageId": "191921698133637273" } }
Tanda terima pengiriman
Untuk menerima laporan pengiriman dan balasan pengguna, Anda dapat menyiapkan konsumen untuk Simple Message Queue (sebelumnya MNS) atau menyediakan titik akhir webhook untuk menerima dorongan HTTP yang dibatch. Ini memungkinkan Anda memantau tingkat keberhasilan pengiriman dan mengaktifkan komunikasi dua arah dalam aplikasi Anda.
Untuk informasi lebih lanjut, lihat Konfigurasi Tanda Terima Pengiriman.
Referensi
Ikhtisar API: Menjelaskan operasi API, termasuk catatan penggunaan, detail parameter, dan batasan.
Kode Kesalahan: Menyebutkan kode kesalahan yang mungkin dikembalikan saat memanggil API atau menerima tanda terima pengiriman dan memberikan solusi.
Mulai Menggunakan API SMS: Memberikan informasi rinci tentang konfigurasi lingkungan, proses untuk membuat panggilan, dan kode contoh terkait.
Tutorial video
Tutorial video tentang cara mengaktifkan SMS.