क्रेडेंशियल्स मिलने के पाँच मिनट बाद अपना पहला टेस्ट SMS भेजें।
टेस्ट एक्सेस का अनुरोध करें, हम एक कार्य दिवस के भीतर आपके टेस्ट क्रेडेंशियल्स के साथ जवाब देते हैं। फिर टोकन लें, TypeScript SDK इंस्टॉल करें और इसे कॉल करें: smsSendsmsPost। क्रेडेंशियल्स मिलने के लगभग पाँच मिनट बाद आपका पहला टेस्ट मैसेज आपके अपने वेरिफ़ाइड नंबर पर पहुँच जाता है। नीचे दिया गया हर सैंपल कॉपी करने के लिए तैयार है, और स्टेप 5 में प्रोडक्शन से पहले जाँचने योग्य चीज़ों को कवर किया गया है।
आपके पहले मैसेज का एक ही रास्ता, जिसमें हर कदम पर समय की जानकारी दी गई है।
- 01
टेस्ट एक्सेस का अनुरोध करें
हम 1 कार्य दिवस के भीतर जवाब देते हैंएक मैसेजिंग इंजीनियर आपके टेस्ट क्रेडेंशियल्स के साथ जवाब देगा और आपके देशों, वॉल्यूम और यूज़ केस पर 30-मिनट की कॉल बुक करेगा।
- 02
पहला टेस्ट मैसेज
क्रेडेंशियल्स मिलने के लगभग 5 मिनट बादquickstart कोड के साथ अपने स्वयं के वेरिफ़ाइड नंबर पर एक टेस्ट मैसेज भेजें। डिलीवरी रिपोर्ट आपके webhook पर वापस आ जाती है।
- 03
इंटीग्रेशन
2–5 कार्य दिवसकोड सैम्पल्स के समान ही एंडपॉइंट के विरुद्ध अपने टेस्ट क्रेडेंशियल्स के साथ बिल्ड और टेस्ट करें। एक BroadNet इंजीनियर REST या SMPP पर आपके साथ मिलकर काम करता है।
- 04
अनुमोदन
3–10 कार्य दिवससेंडर आइडेंटिटी, ट्रैफिक उद्देश्य और डेस्टिनेशन नियमों की समीक्षा की जाती है, और आपके इंटीग्रेशन के साथ-साथ प्रत्येक रेगुलेटर के पास सेंडर ID रजिस्टर किए जाते हैं।
- 05
प्रोडक्शन
कटओवर का दिनआपके अकाउंट के लिए प्रोडक्शन एक्सेस और रूट्स चालू कर दिए गए हैं। आपका इंटीग्रेशन पहले से ही https://api.broadnet.me को कॉल कर रहा है।
कुल मिलाकर: अधिकांश मार्केट में अनुरोध से प्रोडक्शन तक 5–15 कार्य दिवस; जहाँ रेगुलेटर के पास सेंडर ID रजिस्ट्रेशन में ज़्यादा समय लगता है, वहाँ इससे अधिक।
- आपका एप्लिकेशनREST API या SMPP के माध्यम से भेजता है
- BroadNet प्लेटफ़ॉर्मप्रत्येक मैसेज को वैलिडेट, रूट और बिल करता है
- ऑपरेटर का SMSCऑपरेटर से सीधा कनेक्शन
- सब्सक्राइबर हैंडसेटमैसेज डिलीवर हो जाता है
अपना एक्सेस टोकन प्राप्त करें।
आपके एक्सेस टोकन के साथ आपके टेस्ट क्रेडेंशियल्स मिलते हैं: टेस्ट एक्सेस का अनुरोध करें और हम एक कार्य दिवस के भीतर जवाब देते हैं। इसे BROADNET_TOKEN एनवायरनमेंट वेरिएबल में स्टोर करें और हर कॉल पर Authorization: Bearer हेडर में भेजें। इस पेज पर दिया गया हर सैंपल प्रोडक्शन बेस URL, https://api.broadnet.me का उपयोग करता है।
POST /sms/sendSms के साथ अपने स्वयं के वेरिफ़ाइड नंबर पर एक टेस्ट SMS भेजें। 200 OK, जिसका बॉडी एक मैसेज ID है, यह पुष्टि करता है कि कोई भी अन्य कोड लिखने से पहले आपका टोकन काम कर रहा है।
SDK इंस्टॉल करें।
BroadNet के पास TypeScript और Node.js के लिए एक आधिकारिक SDK है: npm install @broadnet/cpaas-sdk axios। यह BroadNet OpenAPI स्पेसिफिकेशन से जनरेट किया गया है। किसी भी अन्य भाषा में, अपनी सामान्य HTTP लाइब्रेरी के साथ REST API को कॉल करें, या OpenAPI spec से क्लाइंट जनरेट करें।
npm install @broadnet/cpaas-sdk axios
export BROADNET_TOKEN=your_access_token@broadnet/cpaas-sdk से Configuration और SMSSMSApi इम्पोर्ट करें। यदि इम्पोर्ट रिज़ॉल्व और टाइप-चेक हो जाता है, तो आप भेजने के लिए तैयार हैं।
अपना पहला मैसेज भेजें।
अपने बेस URL और टोकन के साथ एक SMSSMSApi बनाएं, senderId, destinationNumber, message और messageType के साथ smsSendsmsPost को कॉल करें, और परिणाम को लॉग करें। रिस्पॉन्स बॉडी मैसेज ID है; बाद में डिलीवरी स्टेटस से मिलान करने के लिए इसे सुरक्षित रखें।
// npm install @broadnet/cpaas-sdk axios
import { Configuration, SMSSMSApi } from "@broadnet/cpaas-sdk";
const sms = new SMSSMSApi(
new Configuration({
basePath: "https://api.broadnet.me",
accessToken: process.env.BROADNET_TOKEN!,
}),
);
const res = await sms.smsSendsmsPost({
sMSSmsRequest: {
senderId: "BroadNet",
destinationNumber: "447700900123",
message: "Your verification code is 482913",
messageType: "TEXT",
},
});
console.log(res.data); // message IDHTTP/1.1 200 OK
2603121407537573731अपने हाथ में मौजूद फ़ोन चेक करें। यदि आपको SMS मिल गया है, तो आपने सबसे कठिन काम पूरा कर लिया है — इसके नीचे सब कुछ केवल ऑपरेशनल पॉलिश है।
डिलीवरी स्टेटस प्राप्त करें।
BroadNet आपके अकाउंट पर कॉन्फ़िगर किए गए webhook URL पर डिलीवरी स्टेटस भेजता है: उन चैनलों पर जो रीड रिपोर्ट करते हैं वहां SUBMITTED, SENT, DELIVERED, READ, या FAILED और REJECTED। प्रत्येक अपडेट को स्टोर करें, जल्दी से 2xx के साथ जवाब दें, और इसे एसिंक्रोनसली प्रोसेस करें।
import express from "express";
const app = express();
app.post("/webhooks/broadnet", express.json(), async (req, res) => {
// Store the status update first, then acknowledge with a 2xx.
// Statuses: SUBMITTED, SENT, DELIVERED, READ, FAILED, REJECTED.
await db.statusUpdates.insert({ receivedAt: new Date(), body: req.body });
res.sendStatus(200);
});हैंडसेट पर कन्फर्म किया गया। इससे पहले के अपडेट्स, SUBMITTED और SENT, तब आते हैं जब मैसेज नेटवर्क के माध्यम से आगे बढ़ता है।
प्राप्तकर्ता द्वारा खोला गया, उन चैनल्स पर जो रीड रिपोर्ट देते हैं, जैसे कि WhatsApp।
डिलीवर नहीं हुआ। दोबारा भेजने से पहले नंबर फॉर्मेट और अपनी सेंडर ID की जाँच करें।
अपने फ़ोन पर एक मैसेज भेजें, फिर DELIVERED स्टेटस अपडेट के लिए अपने सर्वर लॉग की जाँच करें।
प्रोडक्शन से पहले।
अनुमोदन (approval) पूरा होने के बाद प्रोडक्शन शुरू हो जाता है: सेंडर आइडेंटिटी, ट्रैफ़िक का उद्देश्य और सेंडर IDs, आपके इंटीग्रेशन के साथ-साथ 3–10 कार्य दिवसों में। एक बार स्वीकृत होने के बाद, वही कोड प्रोडक्शन ट्रैफ़िक भेजता है। उससे पहले, टोकन को सोर्स कंट्रोल से बाहर रखें, डिलीवरी-स्टेटस webhook सेटअप करें और अपनी रिट्राय पॉलिसी तय करें।
- 01सीक्रेट्स को अपने एनवायरनमेंट में ले जाएँ
BROADNET_TOKEN को एनवायरमेंट वेरिएबल या अपने सीक्रेट्स मैनेजर में रखें, इसे कभी भी सोर्स कंट्रोल या क्लाइंट-साइड कोड में न रखें। यदि यह कभी लीक होता है, तो इसे तुरंत बदल दें।
- 02सुरक्षित रूप से पुनः प्रयास करें और अपना बैलेंस देखें
एक्सपोनेंशियल बैकऑफ़ के साथ रिट्राय नेटवर्क एरर और 5xx रिस्पॉन्स। प्रत्येक स्वीकृत सेंड एक मैसेज ID लौटाता है, इसलिए इसे स्टोर करें और अंधे होकर दोबारा भेजने के बजाय डिलीवरी स्टेटस चेक करें। बल्क सेंड्स हर रिस्पॉन्स में आपके शेष क्रेडिट की रिपोर्ट देते हैं।
- 03SDK वर्शन को पिन करें
package.json में @broadnet/cpaas-sdk को एक सटीक वर्जन पर पिन करें और सोच-समझकर अपग्रेड करें। API पाथ में कोई वर्जन प्रीफ़िक्स नहीं होता है, इसलिए changelog और OpenAPI spec में होने वाले बदलावों का पालन करें।
- 04स्टेटस कोड द्वारा एरर हैंडल करें
त्रुटियों के लिए HTTP स्टेटस कोड और status, error, message, errorCode और requestUri के साथ एक ExceptionResponse बॉडी मिलती है। 400 और 401 त्रुटियों को ठीक करें; 5xx त्रुटियों को backoff के साथ फिर से प्रयास करें।
- 05अपनी रिट्राय पॉलिसी तय करें
डिफ़ॉल्ट: 5xx और नेटवर्क एरर पर एक्सपोनेंशियल बैकऑफ़, 4xx पर कभी नहीं। टाइमआउट के बाद, दोबारा भेजने से पहले डिलीवरी स्टेटस चेक करें, क्योंकि पहला अनुरोध पहले ही स्वीकार किया जा चुका हो सकता है।
अपने कोड के लिए नीचे दी गई चेकलिस्ट चलाएँ। जब हर बॉक्स टिक हो जाए, तो अप्रूवल होते ही आपका इंटीग्रेशन प्रोडक्शन के लिए तैयार है।
वही कोड पाथ हर दिन 300 मिलियन से अधिक मैसेज हैंडल करते हैं।
आपका टेस्ट ट्रैफिक कोई मॉक नहीं है। ऊपर दिए गए चरणों में आपने जो भी प्रत्येक रिक्वेस्ट, की (key) और webhook सेटअप किया है, वह उसी रूटिंग, बिलिंग और कंप्लायंस स्टैक के माध्यम से चलता है जो हमारे एंटरप्राइज ट्रैफिक को संभालता है — जिसका नीचे दिए गए सर्टिफिकेशन्स के तहत सालाना ऑडिट किया जाता है।
क्विकस्टार्ट प्रश्न
Authorization: Bearer हेडर और senderId, destinationNumber, message और messageType (TEXT या UNICODE) वाली JSON बॉडी के साथ POST https://api.broadnet.me/sms/sendSms भेजें। रिस्पॉन्स में मैसेज ID मिलता है। /websmpp के तहत लेगेसी HTTP API अभी भी SMPP-युग के इंटीग्रेशन के लिए उपलब्ध है।
/signup पर टेस्ट एक्सेस का अनुरोध करें, और एक BroadNet इंजीनियर एक कार्य दिवस के भीतर आपके टेस्ट क्रेडेंशियल्स के साथ जवाब देगा: वह access token जिसे आप Authorization: Bearer हेडर में भेजते हैं, और टेस्ट ट्रैफिक कहाँ भेजना है। आपके क्रेडेंशियल्स मिलने के लगभग पाँच मिनट बाद आपका पहला टेस्ट मैसेज भेजा जा सकता है।
आधिकारिक SDK केवल एक है: npm पर TypeScript और Node.js के लिए @broadnet/cpaas-sdk। किसी भी अन्य भाषा में, HTTPS के माध्यम से सीधे REST API को कॉल करें, या OpenAPI spec (/developers/openapi.yaml) से क्लाइंट जनरेट करें।
आपका प्रश्न यहाँ नहीं है? हमारी इंजीनियरिंग टीम से पूछें
पाँच चरण पूरे हुए।
बस एक key और आप तैयार हैं।
अपने स्वयं के वेरिफ़ाइड नंबरों पर टेस्ट करें, इंटीग्रेशन शिप करें, और फिर उसी कंसोल से लाइव ट्रैफ़िक पर प्रमोट करें। वही SDK, वही एंडपॉइंट्स, और वही SLAs जो हर दिन 300 मिलियन से अधिक मैसेज संभालते हैं।