Gửi tin
Gửi SMS với POST /v1/messages
/v1/messagesGửi một tin nhắn tới một số. Chi phí được trừ từ số dư khi yêu cầu được chấp nhận.
Nội dung yêu cầu
- tostringbắt buộc
Số điện thoại định dạng quốc tế, ví dụ +14155550123. Khoảng trắng, gạch ngang, ngoặc và tiền tố 00 sẽ được làm sạch.
- textstringbắt buộc
Nội dung tin nhắn. Tối đa 10 segments; xem phần Văn bản và segments.
- referencestringtùy chọn
ID riêng của bạn, tối đa 100 ký tự. Sẽ xuất hiện trong đối tượng tin nhắn và mọi webhook.
- send_atstringtùy chọn
Thời gian gửi theo chuẩn ISO 8601, từ 2 phút đến 45 ngày sau. Nếu không có, tin nhắn sẽ được xếp hàng ngay lập tức.
Thêm tiêu đề Idempotency-Key để đảm bảo an toàn khi thử lại: xem Tính bất biến.
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
}Đối tượng tin nhắn
Các trường
- idstring
ID tin nhắn, msg_ theo sau là 12 ký tự.
- objectstring
Luôn là message.
- batch_idstring
Batch mà tin nhắn thuộc về (một tin nhắn đơn lẻ cũng có batch riêng).
- tostring
Số điện thoại định dạng E.164, sau khi làm sạch.
- countrystring
Mã ISO 3166 của quốc gia được tính giá.
- textstring
Văn bản đã gửi, các trường merge đã được điền.
- segmentsinteger
Số segments SMS mà văn bản sử dụng.
- pricestring
Giá tin nhắn này bằng USD, 5 chữ số thập phân (giá mỗi segment nhân với số segments).
- currencystring
Luôn là USD.
- statusstring
scheduled, queued, sent, delivered, failed hoặc canceled.
- errorobject or null
Với tin nhắn failed hoặc canceled: mã và thông báo lỗi.
- referencestring or null
Tham chiếu riêng của bạn từ yêu cầu.
- created_atstring
Thời điểm yêu cầu được chấp nhận (ISO 8601, UTC).
- sent_atstring or null
Thời điểm tin nhắn được chuyển tới mạng.
- done_atstring or null
Thời điểm trạng thái cuối (delivered, failed hoặc canceled) được thiết lập.
Lấy thông tin tin nhắn
/v1/messages/{id}Một tin nhắn theo ID msg_ của nó. Tin nhắn từ tài khoản khác sẽ trả về 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"])
}Danh sách tin nhắn
/v1/messagesTin nhắn của tài khoản, mới nhất trước.
Tham số truy vấn
- batch_idstringtùy chọn
Chỉ tin nhắn thuộc lô bat_ này.
- statusstringtùy chọn
scheduled, queued, sent, delivered, failed hoặc canceled.
- limitintegertùy chọn
1 đến 100, mặc định 20.
- starting_afterstringtùy chọn
Một msg_ id: trang bắt đầu sau id này. Dùng id cuối cùng của trang trước.
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
}