送信

POST /v1/messagesでSMSを送信する

POST/v1/messages

1つの番号に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"
  }'
202 AcceptedJSON
{
  "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

    最終ステータス(配信済み/失敗/キャンセル)確定時刻。

メッセージを取得

GET/v1/messages/{id}

msg_ IDで特定のメッセージを取得。他アカウントのメッセージは404を返します。

curl https://bulksmsapi.cc/v1/messages/msg_8F3K2Q9TZ1MX \
  -H "Authorization: Bearer $BULKSMSAPI_KEY"

メッセージ一覧

GET/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"
200 OKJSON
{
  "object": "list",
  "data": [ { "id": "msg_8F3K2Q9TZ1MX", "object": "message", "status": "failed", "...": "..." } ],
  "has_more": false
}
POST /v1/messagesでSMSを送信する | BulkSMSAPI ドキュメント