API SMS OTP untuk kode verifikasi
Kirim OTP (kode verifikasi) dari backend Anda dengan satu permintaan HTTPS ke REST API BroadNet. Aplikasi Anda membuat dan memeriksa kodenya. Kami mengirimkannya dari Sender ID terdaftar lewat jalur langsung ke operator, lalu melaporkan setiap status ke webhook Anda.
curl -X POST https://api.broadnet.me/sms/sendSms \
-H "Authorization: Bearer $BROADNET_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"senderId": "OmniDemo",
"destinationNumber": "971500000000",
"message": "482913 is your OmniDemo code. It expires in 5 minutes. Do not share it.",
"messageType": "TEXT",
"campaignName": "login-otp"
}'
# 200 OK
2603121407537573731Mengirim OTP dengan API SMS. Token, Sender ID, dan nomor hanyalah placeholder.
Jawaban singkat
Diperbarui
Untuk mengirim OTP lewat SMS dengan OmniChannels.ai, backend Anda membuat kodenya, lalu memanggil POST /sms/sendSms di https://api.broadnet.me dengan bearer token, Sender ID, nomor tujuan, dan isi pesan. API mengembalikan message ID, dan status pengiriman masuk ke webhook Anda. Unicode dan bahasa Arab didukung, dan WhatsApp atau panggilan suara dapat menjadi fallback (kanal cadangan).
Yang didapat developer dari API SMS OTP
Satu panggilan REST per kode
POST /sms/sendSms dengan body JSON dan bearer token. Responsnya adalah message ID yang Anda simpan untuk setiap percobaan verifikasi.
Status pengiriman via webhook
Terima SUBMITTED, SENT, DELIVERED, FAILED, dan REJECTED dalam satu format yang seragam, sehingga Anda tahu kapan harus menawarkan kirim ulang atau pindah kanal.
Kode dalam Unicode dan bahasa Arab
Atur messageType ke UNICODE untuk aksara Arab atau aksara lainnya. POST /sms/identify mengembalikan encoding dan jumlah segmen sebelum Anda mengirim.
Sender ID terdaftar
Kirim dari Sender ID alfanumerik yang didaftarkan untuk trafik transaksional di pasar yang mewajibkannya, seperti Uni Emirat Arab (UEA) dan Arab Saudi.
Pengecekan nomor sebelum kirim
POST /sms/lookup memeriksa nomor ke jaringan (HLR dan MNP), sehingga Anda dapat menolak nomor yang tidak valid sebelum membayar untuk mengirim kode.
Fallback WhatsApp dan voice
Beralih ke template autentikasi WhatsApp atau panggilan suara saat SMS tidak terkirim atau kode tidak dimasukkan.
SMPP untuk volume sangat tinggi
Jika Anda sudah menjalankan klien SMPP, kirim OTP lewat SMPP 3.4 dengan TLS di jalur yang sama dan terima laporan pada sesi yang sama.
SDK dan MCP server
Gunakan SDK TypeScript @broadnet/cpaas-sdk, spesifikasi OpenAPI 3.1, atau MCP server untuk agen AI.
Tugas sistem Anda dan tugas API
Pembagian peran yang jelas menjaga verifikasi tetap aman: sistem Anda memegang kodenya, platform menangani pengiriman.
| Item | Detail |
|---|---|
| Membuat kode | Backend Anda membuat kode acak, menyimpan hash beserta waktu kedaluwarsa, dan membatasi jumlah percobaan per nomor, perangkat, dan alamat IP. |
| Mengirim SMS | POST /sms/sendSms dengan senderId, destinationNumber (kode negara ditambah nomor, hanya angka), message, dan messageType. |
| Memantau pengiriman | Simpan message ID yang dikembalikan dan cocokkan status webhook dengannya. Jika DELIVERED tidak muncul dalam batas waktu Anda, fallback dapat dipicu. |
| Memverifikasi kode | Backend Anda membandingkan kode yang diketik pengguna dengan hash yang tersimpan. Platform tidak pernah memeriksa atau menyimpan status verifikasi Anda. |
| Fallback | Kirim ulang lewat WhatsApp dengan template autentikasi, atau lewat panggilan suara yang disiapkan tim kami bersama Anda. |
| Harga | Dikenakan per segmen SMS menurut negara tujuan sesuai daftar harga BroadNet yang dipublikasikan, tanpa biaya setup dan tanpa minimum bulanan. Lihat harga SMS per negara. |
Cara mengintegrasikan API SMS OTP
- 1
Dapatkan token Anda
Ajukan akses; bearer token diterbitkan untuk akun Anda dan pesan uji dikirim ke nomor Anda sendiri yang sudah terverifikasi.
- 2
Daftarkan Sender ID
Pilih Sender ID transaksional dan daftarkan di negara yang mewajibkannya sebelum go live.
- 3
Tulis pesannya
Letakkan kode di awal, sebutkan nama brand Anda, cantumkan masa berlaku, dan tambahkan peringatan agar kode tidak dibagikan. Usahakan tetap satu segmen.
- 4
Kirim dan pantau
Panggil POST /sms/sendSms, simpan message ID, dan tangani status webhook secara idempoten.
- 5
Tambahkan fallback dan pembatasan
Tambahkan WhatsApp atau panggilan suara sebagai langkah berikutnya, dan batasi laju permintaan (rate limit) untuk menahan SMS pumping sebelum peluncuran.
Kapan API SMS OTP cocok untuk Anda
Cocok jika
- Anda membangun verifikasi pendaftaran, login, atau pembayaran ke dalam aplikasi sendiri dan ingin mengendalikan kodenya sepenuhnya.
- Anda membutuhkan OTP ke UEA, Arab Saudi, dan pasar negara Teluk (GCC) serta MENA lainnya, dalam bahasa Arab dan Inggris.
- Anda menginginkan satu API untuk SMS sekarang dan fallback WhatsApp, RCS, atau voice nanti.
- Anda lebih memilih REST dan webhook, dengan SMPP tersedia saat volume bertambah.
Hal yang perlu diketahui sebelum memulai
- Tidak ada endpoint verify yang di-hosting: aplikasi Anda yang membuat, menyimpan, dan memeriksa kodenya.
- Akses produksi ditinjau oleh tim kami; tidak ada pendaftaran mandiri instan.
- Pendaftaran Sender ID memerlukan beberapa hari di sejumlah negara, jadi mulailah sebelum tanggal peluncuran.
- Endpoint OTP menjadi target penipuan SMS pumping; daftar negara yang diizinkan, pembatasan laju, dan pemeriksaan bot menjadi tanggung jawab Anda di dalam aplikasi.
Fallback kanal, langkah demi langkah
Kirim sekali lewat platform atau API. Jika suatu langkah tidak terkirim tepat waktu, kanal berikutnya mengambil alih secara otomatis, dan setiap status kembali dalam satu format webhook.
- 01
WhatsApp
Template kaya dengan tombol, tanda baca, dan balasan di kotak masuk
- 02
RCS
Kartu kaya bermerek jika ponsel dan operator mendukung RCS
- 03
SMS
Menjangkau setiap ponsel lewat jalur langsung ke operator
- 04
Voice
Kode atau pesan lisan saat pesan teks tidak sampai
Pertanyaan seputar API SMS OTP
Bagaimana cara mengirim SMS OTP dengan API?
Buat kode di backend Anda, lalu panggil POST https://api.broadnet.me/sms/sendSms dengan header Authorization: Bearer dan body JSON berisi senderId, destinationNumber, message, dan messageType. Responsnya adalah message ID, dan status pengiriman masuk ke webhook Anda.
Apakah API membuat dan memverifikasi kode untuk saya?
Tidak. Aplikasi Anda membuat kode, menyimpan hash beserta masa berlakunya, dan memeriksa kode yang dimasukkan pengguna. Dengan verifikasi di sistem Anda sendiri, logika kode, batas percobaan, dan jejak audit tetap berada dalam kendali Anda.
Bisakah saya mengirim SMS OTP dalam bahasa Arab?
Bisa. Atur messageType ke UNICODE. SMS berbahasa Arab memuat 70 karakter per segmen, jadi usahakan pesan tetap singkat. Anda dapat memanggil POST /sms/identify terlebih dahulu untuk mengetahui encoding dan jumlah segmen.
Seperti apa format pesan SMS OTP terbaik?
Mulai dengan kode, sebutkan nama brand Anda, cantumkan waktu kedaluwarsa, dan ingatkan pengguna agar tidak membagikan kode, semuanya dalam satu segmen. Gunakan Sender ID transaksional dan jangan sisipkan penawaran, agar jaringan tidak menyaring pesan sebagai pemasaran.
Apa yang harus dilakukan jika SMS OTP tidak terkirim?
Pantau status webhook untuk message ID tersebut. Jika DELIVERED tidak muncul, atau pengguna tidak memasukkan kode dalam batas waktu Anda, tawarkan kirim ulang atau beralih ke WhatsApp atau panggilan suara. Jangan mencoba ulang terus-menerus ke nomor yang sama.
Bagaimana cara melindungi endpoint OTP dari SMS pumping?
Izinkan hanya negara yang Anda layani, batasi laju per nomor, perangkat, dan alamat IP, tambahkan pemeriksaan bot pada formulir publik, dan pasang peringatan untuk lonjakan permintaan ke prefiks yang tidak biasa. Pengecekan nomor sebelum kirim juga membantu menolak nomor yang tidak valid.
Berapa biaya satu SMS OTP?
SMS OTP dikenakan per segmen sesuai harga negara tujuan. Daftar harga indikatif BroadNet per negara tersedia di halaman harga SMS, misalnya mulai dari US$0.0123 per segmen ke UEA. Tidak ada biaya setup maupun minimum bulanan; penawaran harga Anda akan mengonfirmasi harganya.
Apakah ada sandbox?
Akses uji mengirim ke nomor Anda sendiri yang sudah terverifikasi melalui API yang sama, sehingga Anda menguji pengiriman dan status yang nyata sebelum produksi. Tidak ada sandbox publik terpisah dan tidak ada pendaftaran mandiri instan.
Panduan tentang topik ini
- SMS & OTPOTP di WhatsApp dan SMS: Keamanan, Pengiriman, dan Fraud9 menit baca
- SMS & OTPSMS Pumping Fraud: Cara Kerja AIT dan Cara Mencegahnya9 menit baca
- IntegrasiPanduan Integrasi API Messaging: REST, SMPP, dan Webhook9 menit baca
Jelajahi lebih banyak platform
Dapatkan akses API untuk SMS OTP
Beri tahu kami negara tujuan, perkiraan volume verifikasi, dan Sender ID Anda. Kami akan menerbitkan token untuk pengujian ke nomor Anda sendiri dan membantu Anda mendaftarkan Sender ID.
Bagikan stack Anda dan apa yang ingin Anda hubungkan. Seorang solutions engineer akan menindaklanjuti.