送信
POST /v1/messagesでSMSを送信する
/v1/messages1つの番号に1つのテキストを送信。リクエストが受理されると残高から料金が差し引かれます。
リクエストボディ
- tostring必須
国際形式の電話番号(例: +14155550123)。スペース、ダッシュ、括弧、00プレフィックスは自動で除去されます。
- textstring必須
メッセージ本文。最大10セグメントまで。詳細は「テキストとセグメント」を参照。
- referencestring任意
最大100文字の独自ID。メッセージオブジェクトとすべてのwebhookで返されます。
- 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
メッセージID(msg_で始まる12文字)。
- objectstring
常にmessage。
- batch_idstring
メッセージが属するバッチ(単一メッセージにもバッチが割り当てられます)。
- tostring
整形後のE.164形式の電話番号。
- countrystring
番号の料金計算に使用された国コード(ISO 3166)。
- textstring
送信されたテキスト(マージフィールド展開済み)。
- segmentsinteger
テキストが使用するSMSセグメント数。
- pricestring
メッセージ料金(USD、小数点以下5桁、1セグメントあたり単価×セグメント数)。
- currencystring
常にUSD。
- statusstring
scheduled(予約済み)、queued(キュー待機)、sent(送信済み)、delivered(配信済み)、failed(失敗)、canceled(キャンセル)。
- errorobject or null
失敗/キャンセル時のエラーコードとメッセージ。
- referencestring or null
リクエスト時に指定した独自リファレンス。
- created_atstring
リクエスト受理時刻(ISO 8601、UTC)。
- sent_atstring or null
キャリアへの引き渡し時刻。
- done_atstring or null
最終ステータス(配信済み/失敗/キャンセル)確定時刻。
メッセージを取得
/v1/messages/{id}msg_ IDで特定のメッセージを取得。他アカウントのメッセージは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任意
scheduled(予約済み)、queued(キュー待機)、sent(送信済み)、delivered(配信済み)、failed(失敗)、canceled(キャンセル)。
- limitinteger任意
1から100、デフォルトは20。
- starting_afterstring任意
msg_ id: このID以降のメッセージからページが始まります。前のページの最後のIDを使用してください。
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
}