Надсилання
Надішліть SMS за допомогою POST /v1/messages
/v1/messagesНадішліть один текст на один номер. Вартість знімається з балансу, коли запит приймається.
Тіло запиту
- tostringобов'язково
Номер у міжнародному форматі, наприклад +14155550123. Пробіли, тире, дужки та префікс 00 видаляються.
- textstringобов'язково
Повідомлення. До 10 сегментів; див. Текст і сегменти.
- referencestringнеобов'язково
Ваш власний ідентифікатор, до 100 символів. Він повертається в об'єкті повідомлення та в кожному вебхуку.
- send_atstringнеобов'язково
Час відправлення у форматі ISO 8601, від 2 хвилин до 45 днів вперед. Без цього повідомлення ставиться в чергу одразу.
Додайте заголовок Idempotency-Key, щоб зробити повторні спроби безпечними: див. Ідемпотентність.
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
}Об'єкт повідомлення
Поля
- idstring
Ідентифікатор повідомлення, msg_ з подальшими 12 символами.
- objectstring
Завжди повідомлення.
- batch_idstring
Пакет, до якого належить повідомлення (одиночне повідомлення також отримує пакет).
- tostring
Номер у форматі E.164 після очищення.
- countrystring
Код ISO 3166 країни, за якою було розцінено номер.
- textstring
Текст, як відправлено, з заповненими полями злиття.
- segmentsinteger
Кількість сегментів SMS, які використовує текст.
- pricestring
Вартість цього повідомлення в USD, 5 десяткових знаків (ціна за сегмент помножена на кількість сегментів).
- currencystring
Завжди USD.
- statusstring
заплановано, в черзі, відправлено, доставлено, не вдалося або скасовано.
- errorobject or null
Для невдалих або скасованих повідомлень: код і повідомлення.
- referencestring or null
Ваш власний посилання з запиту.
- created_atstring
Коли запит було прийнято (ISO 8601, UTC).
- sent_atstring or null
Коли повідомлення було передано в мережу.
- done_atstring or null
Коли було встановлено остаточний статус (доставлено, не вдалося або скасовано).
Отримати повідомлення
/v1/messages/{id}Одне повідомлення за його msg_ ідентифікатором. Повідомлення інших облікових записів відповідають 404.
curl https://bulksmsapi.cc/v1/messages/msg_8F3K2Q9TZ1MX \
-H "Authorization: Bearer $BULKSMSAPI_KEY"const res = await fetch("https://bulksmsapi.cc/v1/messages/msg_8F3K2Q9TZ1MX", {
headers: { Authorization: `Bearer ${process.env.BULKSMSAPI_KEY}` },
});
const message = await res.json();
console.log(message.status, message.error);import json, os, urllib.request
req = urllib.request.Request(
"https://bulksmsapi.cc/v1/messages/msg_8F3K2Q9TZ1MX",
headers={"Authorization": "Bearer " + os.environ["BULKSMSAPI_KEY"], "User-Agent": "northwind-app/1.0"},
)
with urllib.request.urlopen(req) as res:
message = json.load(res)
print(message["status"], message["error"])<?php
$ch = curl_init("https://bulksmsapi.cc/v1/messages/msg_8F3K2Q9TZ1MX");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("BULKSMSAPI_KEY")],
]);
$message = json_decode(curl_exec($ch), true);
echo $message["status"], "\n";package main
import (
"encoding/json"
"fmt"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://bulksmsapi.cc/v1/messages/msg_8F3K2Q9TZ1MX", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("BULKSMSAPI_KEY"))
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(message["status"], message["error"])
}Список повідомлень
/v1/messagesПовідомлення облікового запису, від найновіших до найстаріших.
Параметри запиту
- batch_idstringнеобов'язково
Лише повідомлення цього пакету bat_.
- statusstringнеобов'язково
заплановано, в черзі, відправлено, доставлено, не вдалося або скасовано.
- limitintegerнеобов'язково
Від 1 до 100, за замовчуванням 20.
- starting_afterstringнеобов'язково
Ідентифікатор msg_: сторінка починається після нього. Використовуйте останній ідентифікатор з попередньої сторінки.
curl "https://bulksmsapi.cc/v1/messages?status=failed&limit=50" \
-H "Authorization: Bearer $BULKSMSAPI_KEY"{
"object": "list",
"data": [ { "id": "msg_8F3K2Q9TZ1MX", "object": "message", "status": "failed", "...": "..." } ],
"has_more": false
}