開始使用
Bulk SMS API 參考
BulkSMSAPI 是為開發者而設的群發 SMS API:透過 REST 每次請求可發送一則文字或最多 10,000 個號碼至 227 個國家,透過簽署的 webhooks 追蹤每則訊息,並從預付餘額按訊息付費。此參考涵蓋 API 的所有端點、欄位、事件及錯誤。每頁亦提供 Markdown 格式:在網址後加上 .md。
基礎 URL 及格式
所有請求均透過 HTTPS 發送至 https://bulksmsapi.cc/v1。請求主體為 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 | 餘額(美元) | 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(若含send_at則為scheduled)。隊列每2秒將訊息遞交網絡,每賬戶每分鐘上限1,200條,狀態轉為sent。最終狀態為delivered或failed;失敗訊息將即時退款至餘額。每項最終狀態會觸發附簽名事件的webhook。
限制一覽
| 限制 | 數值 |
|---|---|
| 每API請求收件人數 | 10,000 |
| 每控制台活動收件人數 | 50,000 |
| 每密鑰每分鐘請求數 | 600 |
| 每賬戶每分鐘遞交網絡訊息數 | 1,200 |
| 最長文字 | 10分段(1,530 GSM-7或670 UCS-2字符) |
| 排程時間範圍 | 提前2分鐘至45天 |
| 每事件webhook嘗試次數 | 10 |
| Idempotency-Key 記憶 | 24小時 |
| 每賬戶API密鑰數 | 10 |
機器可讀檔案
- OpenAPI 3.1 規格(供代碼生成器及API客戶端使用)
- llms-full.txt:完整參考文檔(純文字格式)
- 所有文檔頁面均提供Markdown格式,例如/en/docs/webhooks.md