Rozpocznij
Referencja API BulkSMSAPI
BulkSMSAPI to API do masowej wysyłki SMS dla programistów: wyślij jeden tekst lub partię do 10 000 numerów na żądanie do 227 krajów przez REST, śledź każdą wiadomość za pomocą podpisanych webhooków i płac za każdą wiadomość z przedpłaconego salda. Ta referencja obejmuje każdy endpoint, pole, zdarzenie i błąd, które posiada API. Każda strona jest również dostępna jako Markdown: dodaj .md do jej adresu.
Podstawowy URL i format
Wszystkie żądania są wysyłane do https://bulksmsapi.cc/v1 przez HTTPS. Treści są w formacie JSON (Content-Type: application/json, UTF-8), a każda odpowiedź jest w formacie JSON, w tym błędy. Czasy są w formacie ISO 8601 w UTC. Pieniądze są ciągiem znaków w dolarach amerykańskich z pięcioma miejscami po przecinku ("0.00507"), więc ceny poniżej centa są dokładne.
Endpointy
| Metoda i ścieżka | Co robi | Key |
|---|---|---|
| POST /v1/messages | Wyślij jeden tekst na jeden numer | Yes |
| POST /v1/batches | Wyślij do 10 000 numerów, jeden tekst lub jeden na numer | Yes |
| GET /v1/messages/{id} | Jedna wiadomość z jej statusem i ceną | Yes |
| GET /v1/messages | Wiadomości, najnowsze na początku, filtruj według partii lub statusu | Yes |
| GET /v1/batches/{id} | Jedna partia z liczbą wiadomości według statusu | Yes |
| GET /v1/batches | Partie, najnowsze na początku | Yes |
| POST /v1/batches/{id}/cancel | Anuluj zaplanowaną partię, pełny zwrot kosztów | Yes |
| POST /v1/estimates | Wyceń żądanie bez wysyłania | Yes |
| GET /v1/balance | Saldo w USD | Yes |
| GET /v1/pricing | Cena za segment dla każdego kraju | No |
| GET /v1/pricing/{country} | Cena dla jednego kraju (kod ISO) | No |
Pierwsze zapytanie
Utwórz klucz API w konsoli, wyeksportuj go i wyślij wiadomość. Odpowiedź to 202 z obiektem wiadomości: koszt jest pobierany z salda, a wiadomość trafia do kolejki.
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"
}'// Node.js 18 or newer (built-in fetch)
const res = await fetch("https://bulksmsapi.cc/v1/messages", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.BULKSMSAPI_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
to: "+14155550123",
text: "Your Northwind code is 482913. It expires in 10 minutes.",
reference: "login-7781",
}),
});
const message = await res.json();
console.log(res.status, message.id, message.status, message.price);# Python 3, standard library only
import json, os, urllib.request
req = urllib.request.Request(
"https://bulksmsapi.cc/v1/messages",
data=json.dumps({
"to": "+14155550123",
"text": "Your Northwind code is 482913. It expires in 10 minutes.",
"reference": "login-7781",
}).encode(),
headers={
"Authorization": "Bearer " + os.environ["BULKSMSAPI_KEY"],
"Content-Type": "application/json",
"User-Agent": "northwind-app/1.0",
},
method="POST",
)
with urllib.request.urlopen(req) as res:
message = json.load(res)
print(res.status, message["id"], message["status"], message["price"])<?php
// PHP 7.4 or newer with the curl extension
$ch = curl_init("https://bulksmsapi.cc/v1/messages");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("BULKSMSAPI_KEY"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"to" => "+14155550123",
"text" => "Your Northwind code is 482913. It expires in 10 minutes.",
"reference" => "login-7781",
]),
]);
$message = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), " ", $message["id"], " ", $message["status"], "\n";// Go 1.20 or newer, standard library only
package main
import (
"bytes"
"encoding/json"
"fmt"
"net/http"
"os"
)
func main() {
body, _ := json.Marshal(map[string]any{
"to": "+14155550123",
"text": "Your Northwind code is 482913. It expires in 10 minutes.",
"reference": "login-7781",
})
req, _ := http.NewRequest("POST", "https://bulksmsapi.cc/v1/messages", bytes.NewReader(body))
req.Header.Set("Authorization", "Bearer "+os.Getenv("BULKSMSAPI_KEY"))
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
var message map[string]any
json.NewDecoder(res.Body).Decode(&message)
fmt.Println(res.StatusCode, message["id"], message["status"], message["price"])
}{
"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
}Jak porusza się wiadomość
Zaakceptowane wiadomości mają status queued (lub scheduled, jeśli żądanie zawiera send_at). Kolejka przekazuje je do sieci co dwie sekundy, maksymalnie 1200 na minutę na konto, a ich status zmienia się na sent. Ostateczny status to delivered lub failed; w przypadku niepowodzenia koszt wiadomości jest natychmiast zwracany na saldo. Każdy ostateczny status wywołuje Twój webhook z podpisanym zdarzeniem.
Limity w skrócie
| Limit | Wartość |
|---|---|
| Odbiorcy na żądanie API | 10,000 |
| Odbiorcy na kampanię w konsoli | 50,000 |
| Żądań na minutę na klucz | 600 |
| Wiadomości przekazanych do sieci na minutę na konto | 1,200 |
| Maksymalna długość tekstu | 10 segmentów (1530 znaków GSM-7 lub 670 znaków UCS-2) |
| Okno harmonogramu | Od 2 minut do 45 dni w przód |
| Próby webhooka na zdarzenie | 10 |
| Pamięć Idempotency-Key | 24 godziny |
| Klucze API na konto | 10 |
Pliki maszynowo-czytelne
- Specyfikacja OpenAPI 3.1 dla generatorów kodu i klientów API.
- llms-full.txt: cała dokumentacja w jednym pliku tekstowym.
- Każda strona dokumentacji w formacie Markdown, np. /en/docs/webhooks.md.