भेजना

POST /v1/messages के साथ एक SMS भेजें

POST/v1/messages

एक नंबर पर एक टेक्स्ट भेजें। अनुरोध स्वीकार होने पर लागत बैलेंस से काटी जाती है।

अनुरोध बॉडी

  • tostringआवश्यक

    अंतरराष्ट्रीय प्रारूप में नंबर, उदाहरण के लिए +14155550123। स्पेस, डैश, ब्रैकेट और 00 प्रीफिक्स हटा दिए जाते हैं।

  • textstringआवश्यक

    संदेश। अधिकतम 10 सेगमेंट; टेक्स्ट और सेगमेंट देखें।

  • referencestringवैकल्पिक

    आपका अपना आईडी, अधिकतम 100 वर्ण। यह संदेश ऑब्जेक्ट और हर webhook में वापस आता है।

  • send_atstringवैकल्पिक

    भेजने का ISO 8601 समय, 2 मिनट से 45 दिन आगे। इसके बिना संदेश तुरंत कतारबद्ध हो जाता है।

रीट्राय को सुरक्षित बनाने के लिए Idempotency-Key हेडर जोड़ें: 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
}

संदेश ऑब्जेक्ट

फ़ील्ड्स

  • idstring

    संदेश आईडी, msg_ के बाद 12 वर्ण।

  • objectstring

    हमेशा message.

  • batch_idstring

    वह बैच जिससे संदेश संबंधित है (एकल संदेश को भी बैच मिलता है)।

  • tostring

    साफ करने के बाद E.164 प्रारूप में नंबर।

  • countrystring

    उस देश का ISO 3166 कोड जिसके रूप में नंबर की कीमत तय की गई थी।

  • textstring

    भेजा गया टेक्स्ट, मर्ज फ़ील्ड्स भरे हुए।

  • segmentsinteger

    टेक्स्ट द्वारा उपयोग किए गए SMS सेगमेंट की संख्या।

  • pricestring

    इस संदेश की कीमत USD में, 5 दशमलव (प्रति सेगमेंट कीमत गुणा सेगमेंट)।

  • 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

    जब अंतिम स्थिति (delivered, failed या canceled) सेट की गई।

एक संदेश प्राप्त करें

GET/v1/messages/{id}

msg_ आईडी द्वारा एक संदेश। अन्य खातों के संदेश 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 का उपयोग करें।

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 दस्तावेज़