Pagsusumite

Magpadala ng SMS gamit ang POST /v1/messages

POST/v1/messages

Magpadala ng isang text sa isang numero. Ang halaga ay ibabawas sa balance kapag tinanggap ang request.

Request body

  • tostringkailangan

    Ang numero sa international format, halimbawa +14155550123. Ang mga espasyo, gitling, bracket at 00 prefix ay nililinis.

  • textstringkailangan

    Ang mensahe. Hanggang 10 segments; tingnan ang Text and segments.

  • referencestringopsyonal

    Ang iyong sariling id, hanggang 100 characters. Ito ay babalik sa message object at sa bawat webhook.

  • send_atstringopsyonal

    ISO 8601 oras para ipadala, 2 minuto hanggang 45 araw sa hinaharap. Kung wala ito, ang mensahe ay maque-queue agad.

Magdagdag ng Idempotency-Key header para ligtas ang mga retry: tingnan ang 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"
  }'
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
}

Ang message object

Mga field

  • idstring

    Message id, msg_ na sinusundan ng 12 characters.

  • objectstring

    Laging message.

  • batch_idstring

    Ang batch na kinabibilangan ng mensahe (ang isang mensahe ay mayroon ding batch).

  • tostring

    Ang numero sa E.164 format, pagkatapos linisin.

  • countrystring

    ISO 3166 code ng bansa kung saan ang numero ay pinresyo.

  • textstring

    Ang text na ipinadala, ang mga merge field ay napunan.

  • segmentsinteger

    Bilang ng SMS segments na ginamit ng text.

  • pricestring

    Presyo ng mensaheng ito sa USD, 5 decimal (presyo kada segment times segments).

  • currencystring

    Laging USD.

  • statusstring

    scheduled, queued, sent, delivered, failed o canceled.

  • errorobject or null

    Para sa mga failed o canceled na mensahe: code at mensahe.

  • referencestring or null

    Ang iyong sariling reference mula sa request.

  • created_atstring

    Kung kailan tinanggap ang request (ISO 8601, UTC).

  • sent_atstring or null

    Kung kailan ang mensahe ay naibigay sa network.

  • done_atstring or null

    Kung kailan ang final status (delivered, failed o canceled) ay naitakda.

Kunin ang isang mensahe

GET/v1/messages/{id}

Isang mensahe gamit ang msg_ id nito. Ang mga mensahe ng ibang account ay magreresulta sa 404.

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

Ilista ang mga mensahe

GET/v1/messages

Mga mensahe ng account, pinakabago muna.

Mga parameter ng query

  • batch_idstringopsyonal

    Mga mensahe lamang ng bat_ batch na ito.

  • statusstringopsyonal

    scheduled, queued, sent, delivered, failed o canceled.

  • limitintegeropsyonal

    1 hanggang 100, default 20.

  • starting_afterstringopsyonal

    Isang msg_ id: ang pahina ay magsisimula pagkatapos nito. Gamitin ang huling id ng nakaraang pahina.

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
}
Magpadala ng SMS gamit ang POST /v1/messages | BulkSMSAPI Docs