SMS भेजने की सुविधा
अपनी सेवा से जोड़ें.

त्वरित शुरुआत

1. API कुंजी बनाएँ

   पंजीकरण, स्वीकृति और OTP लॉगिन के बादAPI कुंजी प्रबंधनमें कुंजी जारी करें।

2. क्रेडिट तैयार रखें

   API आपके खाते के क्रेडिट और कीमत का उपयोग करता है। अनुरोध कतार में जुड़ते ही राशि कटती है।

3. संदेश भेजें और परिणाम देखें

   कैंपेन ID सहेजें और स्थिति API से परिणाम देखें।

समर्थित देश

GET/api/v1/messages/countries

सक्रिय देश और लागू कीमत API से जाँचें। भेजने के अनुरोध में country से देश बताएँ और एक अनुरोध में एक ही देश के नंबर रखें। जिन देशों की कीमत सेट नहीं है, वहाँ भेजना स्वीकार नहीं होता।

{ "currency": "USDT", "countries": [{ "country": "US", "unitPrice": 0.02 }] }

API कुंजी से प्रमाणीकरण करें

हर बाहरी API अनुरोध में नीचे दिया गया हेडर जोड़ें। लॉगिन कुकी या OTP कोड की ज़रूरत नहीं है।

Authorization: Bearer hex_live_यहाँ_अपनी_जारी_कुंजी

कुंजी का मूल मान केवल जारी करते समय एक बार दिखाया जाता है। इसे सर्वर के एनवायरनमेंट वेरिएबल में रखें, फ़्रंटएंड कोड में कभी नहीं। रद्द की गई कुंजी या निलंबित खाते से API का उपयोग नहीं किया जा सकता। अधिकतम 5 कुंजियाँ बनाई जा सकती हैं।

एक बार में 1,000 नंबरों तक भेजें

एक ही संदेश कई नंबरों पर भेजें। अनुरोध की जाँच के बाद उसे कतार में जोड़कर तुरंत जवाब दिया जाता है। हर नंबर पर अलग सामग्री भेजने के लिए अलग अनुरोध और नया Idempotency-Key उपयोग करें।

एक भी अमान्य या डुप्लिकेट नंबर होने पर पूरा अनुरोध अस्वीकार होता है, और न कुछ भेजा जाता है न शुल्क कटता है। डुप्लिकेट की जाँच अंतरराष्ट्रीय फ़ॉर्मेट में बदले गए नंबरों पर होती है।

curl -X POST 'https://hexsms.com/api/v1/messages' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: notice-20261024-001' \
  -d '{
    "country": "US",
    "text": "Your verification code is 482913.",
    "recipients": ["+12025550123", "+12025550124"]
  }'

{
  "id": "35bed356-b84a-452a-8e94-98b538972ecd",
  "country": "US",
  "state": "RUNNING",
  "total": 2,
  "segments": 1,
  "unitPrice": 0.025,
  "cost": 0.05,
  "createdAt": 1792800000000,
  "note": null,
  "replayed": false
}

कीमत ऐसे तय होती है

नंबरों की संख्या × सेगमेंट (segments) × खाते की इकाई कीमतसे गणना होती है। UCS-2 में 70 अक्षर तक 1 सेगमेंट, उसके बाद 67 अक्षर प्रति सेगमेंट। GSM-7 के मूल अक्षरों में 160 अक्षर तक 1 सेगमेंट, उसके बाद 153 प्रति सेगमेंट। एक्सटेंशन अक्षर दो गिने जाते हैं, इमोजी UTF-16 लंबाई से। unitPrice और cost USDT में हैं। जवाब में दी गई कीमत ही लागू कीमत है; ऊपर 0.025 केवल उदाहरण है।

हर नंबर का परिणाम देखें

भेजने वाले API से मिला id उपयोग करें। केवल उसी खाते से API द्वारा भेजे गए कैंपेन देखे जा सकते हैं। यह सहेजे गए परिणाम लौटाता है। कैरियर के नवीनतम परिणाम चाहिए तो पहले नीचे दिया गया रीफ़्रेश API कॉल करें।

curl 'https://hexsms.com/api/v1/messages/35bed356-b84a-452a-8e94-98b538972ecd?limit=1&offset=0' \
  -H 'Authorization: Bearer YOUR_API_KEY'

{
  "id": "35bed356-b84a-452a-8e94-98b538972ecd",
  "country": "US",
  "state": "DONE",
  "total": 2, "segments": 1,
  "unitPrice": 0.025, "cost": 0.05,
  "createdAt": 1792800000000, "note": null,
  "summary": { "DELIVERED": 1, "PENDING": 1 },
  "messages": [
    {
      "id": "d2787184-d8b8-49c6-9c15-1db90a6d5516",
      "to": "12025550123",
      "status": "DELIVERED",
      "statusName": "DELIVERED_TO_HANDSET",
      "description": "Message delivered to handset",
      "error": null,
      "updatedAt": 1792800005000
    }
  ],
  "pagination": { "limit": 1, "offset": 0, "nextOffset": 1 }
}

limit 1–1,000 (डिफ़ॉल्ट 100) और offset 0–1,000 (डिफ़ॉल्ट 0) है। nextOffset null हो तो यह अंतिम पेज है। summary सभी नंबरों की स्थिति-वार गिनती है। to बिना + के अंतरराष्ट्रीय अंकों में, और समय Unix मिलीसेकंड में लौटाया जाता है। परिणाम का क्रम मूल भेजने के क्रम से अलग हो सकता है; हर message को उसके id से पहचानें।

नवीनतम डिलीवरी स्थिति लाएँ

कैरियर लॉग से सहेजे गए परिणाम अपडेट करें। अनुरोध बॉडी की ज़रूरत नहीं है। अपडेट के बाद GET से परिणाम फिर पढ़ें। एक कैंपेन 30 सेकंड में एक बार रीफ़्रेश हो सकता है। कैरियर लॉग भेजने के 48 घंटे तक उपलब्ध रहते हैं। वेबहुक सेट हो तो परिणाम अपने-आप भी अपडेट हो सकते हैं।

curl -X POST 'https://hexsms.com/api/v1/messages/35bed356-b84a-452a-8e94-98b538972ecd/refresh' \
  -H 'Authorization: Bearer YOUR_API_KEY'

{ "id": "35bed356-b84a-452a-8e94-98b538972ecd", "updated": 2 }

updated अपडेट की गई पंक्तियों की संख्या है। संदेश अभी कतार में हों या नए परिणाम न हों तो यह 0 हो सकता है। कम से कम 10 सेकंड के अंतराल पर GET कॉल करें और ज़रूरत होने पर ही refresh करें।

स्थिति कोड समझें

कैंपेन state

PREPARING तैयारी · RUNNING प्रोसेसिंग · PAUSED रोका गया · DONE कतार प्रोसेस पूरी · CANCELED रद्द

कैरियर नए स्थिति कोड जोड़ सकते हैं, इसलिए अज्ञात status को भी संभालें। विफलता का कारण statusName, description और error में देखें।

त्रुटियाँ कैसे संभालें

{ "error": "पर्याप्त क्रेडिट नहीं है। टॉप-अप करके फिर अनुरोध करें।", "code": "INSUFFICIENT_CREDITS" }

भेजना, स्थिति और रीफ़्रेश मिलाकर प्रति API कुंजी प्रति मिनट 120 अनुरोध तक किए जा सकते हैं। सीमा लगने पर Retry-After हेडर देखें। यह API सर्वर-से-सर्वर उपयोग के लिए है; ब्राउज़र CORS कॉल समर्थित नहीं हैं।

Node.js से जोड़ें

const response = await fetch('https://hexsms.com/api/v1/messages', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer ' + process.env.HEXSMS_API_KEY,
    'Content-Type': 'application/json',
    'Idempotency-Key': 'notice-20261024-001'
  },
  body: JSON.stringify({
    country: 'US',
    text: 'Your order is on its way.',
    recipients: ['+12025550123', '+12025550124']
  })
});
const result = await response.json();
if (!response.ok) throw new Error(result.code + ': ' + result.error);
console.log(result.id); // Use this ID to check delivery status.

हर कार्य के लिए एक बार अनुरोध कुंजी बनाएँ और जवाब न मिलने पर दोबारा भेजते समय भी वही मान उपयोग करें। सफल कार्य को नई कुंजी से फिर भेजने पर वह अलग भेजना माना जाएगा।