Початок роботи
Довідка API BulkSMSAPI
BulkSMSAPI, це API для розробників для масової розсилки SMS: надсилайте один текст або пакет до 10 000 номерів за один запит до 227 країн через REST, відстежуйте кожне повідомлення за допомогою підписаних вебхуків і оплачуйте кожне повідомлення з попередньо оплаченого балансу. Ця довідка охоплює кожен ендпоінт, поле, подію та помилку, які має API. Кожна сторінка також доступна у форматі Markdown: додайте .md до її адреси.
Базова URL-адреса та формат
Усі запити надсилаються на https://bulksmsapi.cc/v1 через HTTPS. Тіла запитів, це JSON (Content-Type: application/json, UTF-8), і кожна відповідь, це JSON, включаючи помилки. Час вказується у форматі ISO 8601 в UTC. Гроші, це рядок у доларах США з п’ятьма знаками після коми ("0.00507"), тому ціни менші за цент є точними.
Ендпоінти
| Метод та шлях | Що робить | Key |
|---|---|---|
| POST /v1/messages | Надіслати один текст на один номер | Yes |
| POST /v1/batches | Надіслати до 10 000 номерів, один текст або окремий текст для кожного номера | Yes |
| GET /v1/messages/{id} | Одне повідомлення зі статусом та ціною | Yes |
| GET /v1/messages | Повідомлення, спочатку новіші, фільтр за пакетом або статусом | Yes |
| GET /v1/batches/{id} | Один пакет із кількістю за статусами | Yes |
| GET /v1/batches | Пакети, спочатку новіші | Yes |
| POST /v1/batches/{id}/cancel | Скасувати запланований пакет, повне повернення коштів | Yes |
| POST /v1/estimates | Оцінити запит без відправки | Yes |
| GET /v1/balance | Баланс у USD | Yes |
| GET /v1/pricing | Ціна за сегмент для кожної країни | No |
| GET /v1/pricing/{country} | Ціна для однієї країни (ISO код) | No |
Перший запит
Створіть API ключ у консолі, експортуйте його та відправте повідомлення. Відповідь, 202 із об’єктом повідомлення: вартість знімається з балансу, а повідомлення стає в чергу.
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
}Як рухається повідомлення
Прийняті повідомлення мають статус queued (або scheduled, якщо в запиті є send_at). Черга передає їх у мережу кожні дві секунди, до 1,200 на хвилину для одного акаунта, і вони стають sent. Фінальний статус: delivered або failed; невдале повідомлення одразу повертається на баланс. Кожен фінальний статус викликає ваш вебхук із підписаною подією.
Ліміти в огляді
| Ліміт | Значення |
|---|---|
| Одержувачі на один API запит | 10,000 |
| Одержувачі на одну кампанію в консолі | 50,000 |
| Запитів на хвилину на один ключ | 600 |
| Повідомлень, переданих до мережі на хвилину для одного акаунта | 1,200 |
| Найдовший текст | 10 сегментів (1,530 GSM-7 або 670 UCS-2 символів) |
| Вікно планування | Від 2 хвилин до 45 днів вперед |
| Спроби вебхука на одну подію | 10 |
| Пам’ять Idempotency-Key | 24 години |
| API ключів на один акаунт | 10 |
Машиночитані файли
- OpenAPI 3.1 spec для генераторів коду та API клієнтів.
- llms-full.txt: весь цей довідник у вигляді одного текстового файлу.
- Кожна сторінка документації у форматі Markdown, наприклад /en/docs/webhooks.md.