Mulakan

Rujukan API Bulk SMS

BulkSMSAPI adalah API SMS pukal untuk pembangun: hantar satu teks atau batch sehingga 10,000 nombor setiap permintaan ke 227 negara melalui REST, ikuti setiap mesej dengan webhook yang ditandatangani, dan bayar setiap mesej dari baki prabayar. Rujukan ini merangkumi setiap endpoint, medan, acara dan ralat yang dimiliki oleh API. Setiap halaman juga tersedia sebagai Markdown: tambahkan .md pada alamatnya.

URL asas dan format

Semua permintaan dihantar ke https://bulksmsapi.cc/v1 melalui HTTPS. Badan adalah JSON (Content-Type: application/json, UTF-8), dan setiap jawapan adalah JSON, termasuk ralat. Masa adalah ISO 8601 dalam UTC. Wang adalah rentetan dalam dolar AS dengan lima perpuluhan ("0.00507"), jadi harga di bawah satu sen adalah tepat.

Endpoint

Kaedah dan laluanApa yang dilakukannyaKey
POST /v1/messagesHantar satu teks ke satu nomborYes
POST /v1/batchesHantar sehingga 10,000 nombor, satu teks atau satu setiap nomborYes
GET /v1/messages/{id}Satu mesej dengan status dan harganyaYes
GET /v1/messagesMesej, terkini dahulu, tapis mengikut batch atau statusYes
GET /v1/batches/{id}Satu batch dengan kiraan setiap statusYes
GET /v1/batchesBatch, terkini dahuluYes
POST /v1/batches/{id}/cancelBatal batch yang dijadualkan, bayaran balik penuhYes
POST /v1/estimatesHarga permintaan tanpa menghantarnyaYes
GET /v1/balanceBaki dalam USDYes
GET /v1/pricingHarga setiap segmen untuk setiap negaraNo
GET /v1/pricing/{country}Harga untuk satu negara (kod ISO)No

Permintaan pertama

Buat kunci API dalam konsol, eksportnya, dan hantar mesej. Jawapannya ialah 202 dengan objek mesej: kos diambil dari baki dan mesej disenaraikan dalam barisan.

curl https://bulksmsapi.cc/v1/messages \
  -H "Authorization: Bearer $BULKSMSAPI_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+14155550123",
    "text": "Your Northwind code is 482913. It expires in 10 minutes.",
    "reference": "login-7781"
  }'
202 AcceptedJSON
{
  "id": "msg_8F3K2Q9TZ1MX",
  "object": "message",
  "batch_id": "bat_4M7Q1X0PK2RS",
  "to": "+14155550123",
  "country": "US",
  "text": "Your Northwind code is 482913. It expires in 10 minutes.",
  "segments": 1,
  "price": "0.00507",
  "currency": "USD",
  "status": "queued",
  "error": null,
  "reference": "login-7781",
  "created_at": "2026-11-07T09:30:12.418Z",
  "sent_at": null,
  "done_at": null
}

Bagaimana mesej bergerak

Mesej yang diterima adalah queued (atau scheduled apabila permintaan mempunyai send_at). Barisan menyerahkannya kepada rangkaian setiap dua saat, sehingga 1,200 seminit setiap akaun, dan ia menjadi sent. Status akhir adalah delivered atau failed; mesej yang gagal dibayar balik ke baki dengan segera. Setiap status akhir memanggil webhook anda dengan acara yang ditandatangani.

Had sekilas

HadNilai
Penerima setiap permintaan API10,000
Penerima setiap kempen konsol50,000
Permintaan seminit setiap kunci600
Mesej diserahkan kepada rangkaian seminit setiap akaun1,200
Teks terpanjang10 segmen (1,530 GSM-7 atau 670 UCS-2 aksara)
Tetingkap jadual2 minit hingga 45 hari ke hadapan
Percubaan webhook setiap acara10
Memori Idempotency-Key24 jam
Kunci API setiap akaun10

Fail yang boleh dibaca mesin

Rujukan API Bulk SMS | Dokumen BulkSMSAPI