Autentikasi & Header
Setiap permintaan ke Open API wajib menyertakan API Key akun Anda. Anda dapat menyertakannya melalui header HTTP atau query parameter:
- Header Rekomendasi:
X-API-Key: YOUR_API_KEY - Header Bearer:
Authorization: Bearer YOUR_API_KEY - Query Parameter:
?apikey=YOUR_API_KEY
Mengambil daftar layanan nomor virtual yang tersedia beserta jumlah nomor yang siap digunakan.
curl -X GET "/api/v1/services" \
-H "X-API-Key: YOUR_API_KEY"
{
"success": true,
"services": [
{ "name": "WhatsApp", "count": 18450 },
{ "name": "Telegram", "count": 9230 },
{ "name": "Google", "count": 12100 },
{ "name": "TikTok", "count": 6400 }
]
}
Mengambil daftar negara yang tersedia untuk layanan tertentu (misal: WhatsApp).
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
| service | String | Opsional | Nama layanan target. Default: WhatsApp |
curl -X GET "/api/v1/countries?service=WhatsApp" \
-H "X-API-Key: YOUR_API_KEY"
{
"success": true,
"service": "WhatsApp",
"countries": [
{ "name": "Indonesia", "count": 4200, "code": "62" },
{ "name": "Ukraine", "count": 1200, "code": "380" },
{ "name": "United States", "count": 3100, "code": "1" },
{ "name": "Malaysia", "count": 850, "code": "60" }
]
}
Meminta pembuatan nomor virtual baru untuk menerima verifikasi SMS OTP.
| Field | Tipe | Wajib | Keterangan |
|---|---|---|---|
| service | String | Ya | Nama layanan, contoh: WhatsApp |
| country | String | Ya | Negara, contoh: Indonesia |
curl -X POST "/api/v1/number/create" \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"service": "WhatsApp", "country": "Indonesia"}'
{
"success": true,
"id": "v1_1725451200000",
"number": "+6283123456789",
"service": "WhatsApp",
"country": "Indonesia",
"expires_in": 1200,
"created_at": "2026-09-04T12:00:00.000Z"
}
Memeriksa pesan SMS dan kode verifikasi OTP yang masuk untuk nomor yang telah dibuat.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
| number | String | Ya | Nomor telepon yang ingin dicek (dengan atau tanpa tanda +) |
curl -X GET "/api/v1/sms?number=6283123456789" \
-H "X-API-Key: YOUR_API_KEY"
{
"success": true,
"number": "+6283123456789",
"has_otp": true,
"otp": "492810",
"messages": [
{
"sender": "WhatsApp Official",
"code": "492810",
"message": "Kode verifikasi WhatsApp Anda adalah 492-810. Jangan bagikan kepada siapa pun.",
"time": "Baru saja"
}
]
}
Mengambil data profil, saldo reward, jumlah OTP, dan total saldo yang telah ditarik.
curl -X GET "/api/v1/user/me" \
-H "X-API-Key: YOUR_API_KEY"
{
"success": true,
"user": {
"id": "65e01234abcd...",
"name": "Budi Santoso",
"email": "budi@gmail.com",
"apiKey": "num_live_xxxxxxxxxxxxxxxx",
"rewardBalance": 12500,
"rewardBalanceUsd": "1.25",
"totalOtpReceived": 125,
"totalWithdrawn": 50000
}
}