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żkaCo robiKey
POST /v1/messagesWyślij jeden tekst na jeden numerYes
POST /v1/batchesWyślij do 10 000 numerów, jeden tekst lub jeden na numerYes
GET /v1/messages/{id}Jedna wiadomość z jej statusem i cenąYes
GET /v1/messagesWiadomości, najnowsze na początku, filtruj według partii lub statusuYes
GET /v1/batches/{id}Jedna partia z liczbą wiadomości według statusuYes
GET /v1/batchesPartie, najnowsze na początkuYes
POST /v1/batches/{id}/cancelAnuluj zaplanowaną partię, pełny zwrot kosztówYes
POST /v1/estimatesWyceń żądanie bez wysyłaniaYes
GET /v1/balanceSaldo w USDYes
GET /v1/pricingCena za segment dla każdego krajuNo
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"
  }'
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
}

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

LimitWartość
Odbiorcy na żądanie API10,000
Odbiorcy na kampanię w konsoli50,000
Żądań na minutę na klucz600
Wiadomości przekazanych do sieci na minutę na konto1,200
Maksymalna długość tekstu10 segmentów (1530 znaków GSM-7 lub 670 znaków UCS-2)
Okno harmonogramuOd 2 minut do 45 dni w przód
Próby webhooka na zdarzenie10
Pamięć Idempotency-Key24 godziny
Klucze API na konto10

Pliki maszynowo-czytelne

Referencja API BulkSMSAPI | Dokumentacja BulkSMSAPI