Начать
Справочник по Bulk SMS API
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). Очередь передаёт их в сеть каждые две секунды, до 1200 в минуту на аккаунт, и они становятся sent. Финальный статус, delivered или failed; при неудаче средства сразу возвращаются на баланс. Каждый финальный статус вызывает ваш вебхук с подписанным событием.
Лимиты вкратце
| Лимит | Значение |
|---|---|
| Получателей на API-запрос | 10,000 |
| Получателей на кампанию в консоли | 50,000 |
| Запросов в минуту на ключ | 600 |
| Сообщений в сеть в минуту на аккаунт | 1,200 |
| Максимальная длина текста | 10 сегментов (1530 GSM-7 или 670 UCS-2 символов) |
| Окно планирования | От 2 минут до 45 дней вперёд |
| Попыток вебхука на событие | 10 |
| Хранение Idempotency-Key | 24 часа |
| API-ключей на аккаунт | 10 |
Машиночитаемые файлы
- Спецификация OpenAPI 3.1 для генераторов кода и API-клиентов.
- llms-full.txt: вся документация в одном текстовом файле.
- Каждая страница документации в Markdown, например /en/docs/webhooks.md.