Dokumentasyon ng Bulk SMS API

Quick start

1. Gumawa ng account at mag-top up ng balance sa console.
2. Buksan ang API keys at gumawa ng key. Magagawa ang mga key pagkatapos ma-credit ang unang top-up. Ang key ay ipapakita minsan; itago ito bilang lihim.
3. Magpadala ng POST request sa /sms kasama ang mga numero at text. Basahin ang ibinalik na campaign ID, pagkatapos sundan ang delivery sa console o sa pamamagitan ng webhooks.

Authentication

Bawat request maliban sa public rate list ay nagdadala ng iyong key sa Authorization header. Ang mga key ay nagsisimula sa sbk_live_. Ang bagong key ay papalit agad sa lumang key.

Authorization: Bearer sbk_live_YOUR_KEY

Magpadala ng SMS

POST/sms

Gumagawa ng kampanya, sisingilin ito mula sa balance at i-queue ang bawat mensahe. Nililinis at dine-duplicate ang mga numero; ang mga hindi magagamit ay ibabalik sa dropped kasama ang dahilan at hindi sisingilin.

curl -X POST https://sendbulksms.cc/api/v1/sms \
  -H "Authorization: Bearer sbk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": ["+447700900461", "+5511955550123"],
    "text": "Hi, your order 4821 ships today.",
    "client_ref": "orders-4821"
  }'

const res = await fetch("https://sendbulksms.cc/api/v1/sms", {
  method: "POST",
  headers: { Authorization: "Bearer " + process.env.SENDBULKSMS_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({ to: ["+447700900461", "+5511955550123"], text: "Hi, your order 4821 ships today.", client_ref: "orders-4821" }),
});
const campaign = await res.json();
console.log(res.status, campaign.id, campaign.cost);

import os, requests

r = requests.post(
    "https://sendbulksms.cc/api/v1/sms",
    headers={"Authorization": "Bearer " + os.environ["SENDBULKSMS_KEY"]},
    json={"to": ["+447700900461", "+5511955550123"], "text": "Hi, your order 4821 ships today.", "client_ref": "orders-4821"},
    timeout=30,
)
print(r.status_code, r.json()["id"])

<?php
$ch = curl_init("https://sendbulksms.cc/api/v1/sms");
curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("SENDBULKSMS_KEY"), "Content-Type: application/json"],
  CURLOPT_POSTFIELDS => json_encode(["to" => ["+447700900461", "+5511955550123"], "text" => "Hi, your order 4821 ships today.", "client_ref" => "orders-4821"]),
]);
$campaign = json_decode(curl_exec($ch), true);
echo $campaign["id"];

Response: ang kampanya kasama ang gastos nito at ang unang 1,000 mensahe. Kumuha pa gamit ang campaign messages.

HTTP/1.1 201 Created
{
  "id": "CP-7KQ2-M9XA-4HTD",
  "status": "sending",
  "source": "api",
  "recipients": 2,
  "segments": 1,
  "encoding": "GSM-7",
  "cost": "0.01078",
  "refunded": "0.00000",
  "client_ref": "orders-4821",
  "scheduled_at": null,
  "created_at": "2026-11-07T10:32:04.118Z",
  "done_at": null,
  "counts": { "queued": 2, "sent": 0, "delivered": 0, "failed": 0, "canceled": 0 },
  "dropped": [],
  "balance": "248.30422",
  "messages": [
    { "id": "SM-2RBW-8MZN-QF6K", "campaign_id": "CP-7KQ2-M9XA-4HTD", "to": "+447700900461", "country": "GB", "parts": 1, "price": "0.00819", "status": "queued", "error": null, "created_at": "2026-11-07T10:32:04.118Z", "sent_at": null, "done_at": null }
  ]
}

Tantyahin ang pagpapadala

POST/estimate

Tumanggap ng parehong body tulad ng /sms at ibalik ang mga recipient, segment, encoding, kabuuang gastos at gastos bawat bansa nang walang singil o pagpapadala.

{ "recipients": 2, "dropped": [], "segments": 1, "encoding": "GSM-7", "cost": "0.01078", "balance": "248.31500",
  "countries": [ { "country": "GB", "recipients": 1, "cost": "0.00819" }, { "country": "BR", "recipients": 1, "cost": "0.00259" } ] }

Status ng mensahe

GET/sms/{message_id}

Nagbabalik ng isang mensahe: numero, bansa, segment, presyo, status, error para sa mga nabigong mensahe at oras ng bawat hakbang.

Mga kampanya

GET/campaigns/{campaign_id}

Ang kampanya kasama ang gastos nito, mga refund at bilang ng mga mensahe bawat status.

GET/campaigns/{campaign_id}/messages?offset=0&limit=100

Mga mensahe sa pagkakasunud-sunod na na-queue, hanggang 1,000 bawat pahina.

POST/campaigns/{campaign_id}/cancel

Kinakansela ang isang naka-schedule na kampanya na hindi pa nagsisimula at ibabalik ang buong gastos nito sa balance.

Balance at mga rate

GET/balance

{ "balance": "248.31500", "currency": "USD" }

GET/rates

Public, hindi kailangan ng key. Bawat bansa kasama ang calling code at presyo bawat segment. /rates/GB ay nagbabalik ng isang bansa.

{ "updated": "2026-11-07", "rates": [ { "country": "GB", "name": "United Kingdom", "calling_code": "+44", "price": "0.00819", "currency": "USD", "unit": "SMS segment" } ] }

Mga webhook ng delivery

Itakda ang isang webhook URL sa console sa ilalim ng API keys. Kapag ang isang mensahe ay umabot sa final status (delivered o failed) ay mag-POST kami ng report dito. Sagutin ng kahit anong 2xx status sa loob ng 8 segundo; kung hindi, ang tawag ay uulitin hanggang 8 beses sa loob ng 11 oras. Gamitin ang id para huwag pansinin ang report na naproseso mo na.

POST https://your-server.example/sms-status
Content-Type: application/json
X-SendBulkSMS-Signature: t=1794047524,v1=5f0c3b9e...

{
  "event": "message.status",
  "id": "evt_8c1d2e4f6a7b9c0d1e2f",
  "created_at": "2026-11-07T10:32:09.004Z",
  "data": {
    "message_id": "SM-2RBW-8MZN-QF6K",
    "campaign_id": "CP-7KQ2-M9XA-4HTD",
    "to": "+447700900461",
    "country": "GB",
    "status": "delivered",
    "error": null,
    "parts": 1,
    "price": "0.00819",
    "client_ref": "orders-4821",
    "done_at": "2026-11-07T10:32:08.912Z"
  }
}

Suriin ang signature bago magtiwala sa report: HMAC-SHA256 ng t + "." + raw body gamit ang iyong webhook secret, ikumpara sa constant time, at tanggihan ang mga oras na mas matanda sa 5 minuto.

import { createHmac, timingSafeEqual } from "node:crypto";

// raw = the request body exactly as received (string), header = X-SendBulkSMS-Signature
export function verify(raw, header, secret) {
  const m = /^t=(\d+),v1=([0-9a-f]{64})$/.exec(header || "");
  if (!m || Math.abs(Date.now() / 1000 - Number(m[1])) > 300) return false;
  const want = Buffer.from(createHmac("sha256", secret).update(m[1] + "." + raw).digest("hex"));
  const got = Buffer.from(m[2]);
  return want.length === got.length && timingSafeEqual(want, got);
}

import hmac, hashlib, re, time

def verify(raw: bytes, header: str, secret: str) -> bool:
    m = re.fullmatch(r"t=(\d+),v1=([0-9a-f]{64})", header or "")
    if not m or abs(time.time() - int(m.group(1))) > 300:
        return False
    want = hmac.new(secret.encode(), m.group(1).encode() + b"." + raw, hashlib.sha256).hexdigest()
    return hmac.compare_digest(want, m.group(2))

<?php
function verify(string $raw, string $header, string $secret): bool {
  if (!preg_match('/^t=(\d+),v1=([0-9a-f]{64})$/', $header, $m) || abs(time() - (int)$m[1]) > 300) return false;
  $want = hash_hmac('sha256', $m[1] . '.' . $raw, $secret);
  return hash_equals($want, $m[2]);
}

Mga status

Mga error

Ang mga error ay gumagamit ng HTTP status codes at JSON body: { "error": { "code": "insufficient_balance", "message": "..." } }. Ang isang request na nagbabalik ng error ay hindi sisingilin sa balance.

Mga limitasyon

• 300 na request kada minuto bawat API key.
• 10,000 na numero bawat send request; 10 segment bawat mensahe.
• Ang mga mensahe ay umaalis hanggang sa 200 kada minuto bawat pila, sa pagkakasunud-sunod na tinanggap.
• Pag-schedule mula 5 minuto hanggang 60 araw nang maaga.
• Ang mga numero sa iyong do-not-send list ay lalaktawan at ibabalik sa dropped na may code na suppressed; hindi sila sisingilin.