Gönderim
POST /v1/messages ile bir SMS gönderin
/v1/messagesBir numaraya bir metin gönderin. Maliyet, istek kabul edildiğinde bakiyeden alınır.
İstek gövdesi
- tostringgerekli
Uluslararası formatta numara, örneğin +14155550123. Boşluklar, tireler, parantezler ve 00 ön eki temizlenir.
- textstringgerekli
Mesaj. En fazla 10 segment; bkz. Metin ve segmentler.
- referencestringisteğe bağlı
Kendi kimliğiniz, en fazla 100 karakter. Mesaj nesnesinde ve her webhook'ta geri döner.
- send_atstringisteğe bağlı
Gönderme zamanı ISO 8601, 2 dakika ile 45 gün öncesi. Olmadan mesaj hemen sıraya alınır.
Yeniden denemeleri güvenli hale getirmek için bir Idempotency-Key başlığı ekleyin: bkz. Idempotency.
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
}Mesaj nesnesi
Alanlar
- idstring
Mesaj kimliği, msg_ ardından 12 karakter.
- objectstring
Her zaman mesaj.
- batch_idstring
Mesajın ait olduğu batch (tek bir mesaj da bir batch alır).
- tostring
Temizlendikten sonra E.164 formatında numara.
- countrystring
Numaranın fiyatlandırıldığı ülkenin ISO 3166 kodu.
- textstring
Gönderilen metin, birleştirme alanları doldurulmuş.
- segmentsinteger
Metnin kullandığı SMS segment sayısı.
- pricestring
Bu mesajın fiyatı USD, 5 ondalık (segment başına fiyat çarpı segmentler).
- currencystring
Her zaman USD.
- statusstring
planlanmış, sıraya alınmış, gönderilmiş, teslim edilmiş, başarısız veya iptal edilmiş.
- errorobject or null
Başarısız veya iptal edilen mesajlar için: kod ve mesaj.
- referencestring or null
İstekten gelen kendi referansınız.
- created_atstring
İsteğin kabul edildiği zaman (ISO 8601, UTC).
- sent_atstring or null
Mesajın ağa teslim edildiği zaman.
- done_atstring or null
Son durumun (teslim edildi, başarısız veya iptal edildi) belirlendiği zaman.
Bir mesajı al
/v1/messages/{id}msg_ kimliği ile bir mesaj. Diğer hesapların mesajları 404 yanıtı verir.
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"])
}Mesajları listele
/v1/messagesHesabın mesajları, en yeni başta.
Sorgu parametreleri
- batch_idstringisteğe bağlı
Sadece bu bat_ partisine ait mesajlar.
- statusstringisteğe bağlı
planlanmış, sıraya alınmış, gönderilmiş, teslim edilmiş, başarısız veya iptal edilmiş.
- limitintegeristeğe bağlı
1 ile 100 arası, varsayılan 20.
- starting_afterstringisteğe bağlı
Bir msg_ id: sayfa bundan sonra başlar. Önceki sayfanın son id'sini kullanın.
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
}