کریڈنشلز ملنے کے پانچ منٹ بعد اپنا پہلا ٹیسٹ SMS بھیجیں۔
ٹیسٹ رسائی کی درخواست کریں اور ہم ایک کاروباری دن کے اندر آپ کے ٹیسٹ کریڈنشلز کے ساتھ جواب دیتے ہیں۔ پھر ٹوکن لیں، TypeScript SDK انسٹال کریں اور کال کریں smsSendsmsPost۔ کریڈنشلز ملنے کے تقریباً پانچ منٹ بعد آپ کا پہلا ٹیسٹ میسج آپ کے اپنے تصدیق شدہ نمبر پر پہنچ جاتا ہے۔ نیچے دی گئی ہر مثال کاپی کرنے کے لیے تیار ہے، اور مرحلہ 5 میں وہ چیزیں شامل ہیں جو پروڈکشن سے پہلے چیک کرنی ہوتی ہیں۔
آپ کے پہلے میسج تک کا ایک راستہ، جس میں ہر مرحلے کا وقت درج ہے۔
- 01
ٹیسٹ رسائی کی درخواست کریں
ہم ایک کاروباری دن کے اندر جواب دیتے ہیںایک میسجنگ انجینئر آپ کے ٹیسٹ کریڈنشلز کے ساتھ جواب دیتا ہے اور آپ کے ممالک، حجم اور استعمال کی صورت کے بارے میں 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 کے پاس ایک آفیشل SDK ہے، TypeScript اور Node.js کے لیے: npm install @broadnet/cpaas-sdk axios۔ یہ BroadNet OpenAPI اسپیسیفیکیشن سے تیار کیا گیا ہے۔ کسی بھی دوسری زبان میں، اپنی عام HTTP لائبریری کے ساتھ REST API کو کال کریں، یا OpenAPI اسپیسیفیکیشن سے کلائنٹ تیار کریں۔
npm install @broadnet/cpaas-sdk axios
export BROADNET_TOKEN=your_access_token@broadnet/cpaas-sdk سے Configuration اور SMSSMSApi امپورٹ کریں۔ اگر امپورٹ مکمل ہو جاتا ہے اور ٹائپ چیک ہو جاتا ہے، تو آپ بھیجنے کے لیے تیار ہیں۔
اپنا پہلا پیغام بھیجیں۔
اپنے بیس URL اور ٹوکن کے ساتھ ایک SMSSMSApi بنائیں، senderId، ڈیسٹینیشن نمبر، میسج اور میسج ٹائپ کے ساتھ 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 پر ڈیلیوری اسٹیٹس بھیجتا ہے: وہ چینلز جو ریڈ (read) رپورٹ کرتے ہیں ان پر SUBMITTED، SENT، DELIVERED، READ، یا پھر FAILED اور REJECTED۔ ہر اپ ڈیٹ کو محفوظ کریں، تیزی سے 2xx کے ساتھ جواب دیں، اور اسے asynchronous طریقے سے پروسیس کریں۔
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 اسٹیٹس اپ ڈیٹ کے لیے اپنے سرور لاگ چیک کریں۔
پروڈکشن سے پہلے۔
منظوری ملتے ہی پروڈکشن کا آغاز ہو جاتا ہے: سینڈر آئیڈنٹیٹی، ٹریفک کا مقصد اور سینڈر IDs، 3 سے 10 کاروباری دن، جو آپ کے انٹیگریشن کے ساتھ ساتھ مکمل ہوں گے۔ ایک بار منظور ہو جانے کے بعد، وہی کوڈ پروڈکشن ٹریفک بھیجے گا۔ اس سے پہلے، ٹوکن کو سورس کنٹرول سے دور رکھیں، ڈیلیوری سٹیٹس webhooks کو کنیکٹ کریں اور اپنی ری ٹرائی پالیسی طے کریں۔
- 01خفیہ معلومات کو اپنے ماحول میں منتقل کریں
BROADNET_TOKEN کو ان ویری ایبل یا اپنے سیکریٹس منیجر میں رکھیں، اسے کبھی بھی سورس کنٹرول یا کلائنٹ سائیڈ کوڈ میں نہ رکھیں۔ اگر یہ کبھی لیک ہو جائے تو اسے فوری طور پر تبدیل کریں۔
- 02محفوظ طریقے سے دوبارہ کوشش کریں اور اپنا بیلنس دیکھیں
ایکسپونینشل بیک آف کے ساتھ نیٹ ورک ایررز اور 5xx رسپونسز کو ری ٹرائی کریں۔ ہر قبول شدہ سینڈ کے بدلے ایک میسج ID واپس ملتی ہے، لہذا اندھا دھند دوبارہ بھیجنے کے بجائے اسے اسٹور کریں اور ڈیلیوری اسٹیٹس چیک کریں۔ بلک سینڈز کے ہر رسپانس میں آپ کے باقی ماندہ کریڈٹس کی رپورٹ دی جاتی ہے۔
- 03SDK ورژن پن کریں
package.json میں @broadnet/cpaas-sdk کو ایک مخصوص ورژن پر پن کریں اور سوچ سمجھ کر اپ گریڈ کریں۔ API راستوں میں کوئی ورژن پری فکس نہیں ہوتا، اس لیے چینج لاگ اور OpenAPI اسپیک میں ہونے والی تبدیلیوں پر نظر رکھیں۔
- 04اسٹیٹس کوڈ کے ذریعے غلطیوں کو سنبھالیں
غلطیاں HTTP اسٹیٹس کوڈ اور ExceptionResponse باڈی کے ساتھ واپس آتی ہیں جس میں status، error، message، errorCode اور requestUri شامل ہوتے ہیں۔ 400 اور 401 غلطیوں کو درست کریں؛ 5xx غلطیوں کو بیک آف کے ساتھ ری ٹرائی کریں۔
- 05اپنی ری ٹرائی پالیسی کا فیصلہ کریں
ڈیفالٹ: 5xx اور نیٹ ورک کی غلطیوں پر ایکسپونینشل بیک آف، 4xx پر کبھی نہیں۔ ٹائم آؤٹ کے بعد، دوبارہ بھیجنے سے پہلے ڈیلیوری اسٹیٹس چیک کریں، کیونکہ ہو سکتا ہے کہ پہلی درخواست پہلے ہی قبول ہو چکی ہو۔
اپنے کوڈ کے لیے نیچے دی گئی چیک لسٹ کا استعمال کریں۔ جب ہر باکس پر ٹک لگ جائے، تو منظوری مکمل ہوتے ہی آپ کی انٹیگریشن پروڈکشن کے لیے تیار ہو جاتی ہے۔
وہی کوڈ پاتھ روزانہ 300 ملین سے زائد میسجز کو ہینڈل کرتے ہیں۔
آپ کا ٹیسٹ ٹریفک محض ایک نمونہ نہیں ہے۔ اوپر دیے گئے مراحل میں آپ نے جو بھی request، 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 ملین سے زائد میسجز کو ہینڈل کرتے ہیں۔