REST API دستاویزات
SMS اور MMS REST APIs
منظور شدہ ایپلیکیشن پیغامات بھیجیں اور قبولیت، ڈیلیوری ایونٹس، سیگمنٹیشن اور چارجز کو سنبھالیں۔

API اور اسناد کا انتخاب ایک ساتھ کریں
ڈیولپر اور آٹومیشن، کاروبار اور کمیونیکیشنز فراہم کنندگان کے منظور شدہ اکاؤنٹس فعال سروسز کو انٹیگریٹ کر سکتے ہیں۔ انفرادی ڈیولپر کو خود کو کمپنی ظاہر کرنے کی ضرورت نہیں۔ ایپلیکیشن SMS/MMS کے لیے متعلقہ بھیجنے کی منظوری اور رجسٹریشن درکار ہے۔ افراد اور خاندان کی سروس میں صارفین کے لیے پیغامات بھیجنے کا عمل شروع کرنے والا کوئی API موجود نہیں۔
| API فیملی | بنیادی URL | تصدیق اور نتیجہ |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | منظور شدہ Basic اسناد؛ اہل اور فراہم کردہ ٹوکن صرف ان آپریشنز کے لیے جو انہیں سپورٹ کرتے ہوں۔ JSON status اور response۔ |
| ہنگامی کالنگ کے لیے رجسٹریشن | https://api.multi.tel/emergency | منظور شدہ Basic اسناد یا خاص طور پر فراہم کی گئی bearer رسائی۔ JSON code، message اور data۔ |
| پورٹل REST انٹیگریشنز | ہوسٹ اور آپریشن، جیسا کہ آپ کے اکاؤنٹ کے ڈویلپر ریفرنس میں دکھایا گیا ہے | اس آپریشن کی دستاویزات میں درج اسناد، اجازت کے دائرے اور اسکیما استعمال کریں۔ براؤزر سیشن کی درخواستیں ایک الگ انٹرفیس استعمال کرتی ہیں۔ |
مثالیں استعمال کرنے سے پہلے MULTITEL_API_USERNAME اور MULTITEL_API_PASSWORD کو اپنے سرور کی خفیہ کنفیگریشن کے ذریعے سیٹ کریں۔ انہیں کبھی بھی عوامی براؤزر JavaScript، URLs یا سورس کنٹرول میں شامل نہ کریں۔ مخصوص اسناد کا انتظام API انضمام کی سیٹنگز میں کیا جاتا ہے۔
SMS درخواست تیار کریں
اکاؤنٹ کی ملکیت والا منظور شدہ، SMS کے لیے فعال بھیجنے والا نمبر اور ایسا وصول کنندہ استعمال کریں جس نے پیغام کے لیے رضامندی دی ہو؛ ساتھ ہی مطلوبہ Brand/Campaign رجسٹریشن یا ٹول فری نمبر کی تصدیق مکمل کریں۔ نیچے دی گئی مثال کارآمد اسناد اور نمبروں کے ساتھ چلانے پر اصل پیغام بھیجتی ہے؛ یہ sandbox نہیں ہے۔
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
--request POST \
--header "Content-Type: application/json" \
--data '{"from":"YOUR_APPROVED_NUMBER","to":"YOUR_CONSENTED_RECIPIENT","text":"Your requested update is ready."}' \
"https://api.multitel.net/v3/sendsms"بھیجنے والے اور وصول کنندہ کی علامتی جگہوں پر ملک کے کوڈ سمیت بین الاقوامی فارمیٹ کے فون نمبر صرف ہندسوں میں لکھیں۔ MMS کے لیے media میں سپورٹ کردہ اور عوامی طور پر قابلِ حصول میڈیا URL دیں، اور پہلے MMS کی اہلیت اور قیمت کی تصدیق کریں۔
قبولیت کا مطلب ڈیلیوری نہیں
بیرونی ایپلیکیشن اسٹیٹس اور واپس آنے والے میسجنگ نتیجے، دونوں کا جائزہ لیں۔ سروس کا دیا ہوا پیغام شناخت کنندہ ریکارڈ کریں، اور ڈیلیوری اسٹیٹس اور webhook ایونٹس کی پیروی کریں۔ کامیاب submission اس بات کا ثبوت نہیں کہ وصول کنندہ کے ہینڈسیٹ کو پیغام مل گیا۔
SMS کی بلنگ فی segment ہوتی ہے۔ انکوڈنگ اور پیغام کی لمبائی کئی segments بنا سکتی ہے؛ میڈیا اور کیریئر سے متعلق چارجز SMS سے مختلف ہو سکتے ہیں۔ بھیجنے سے پہلے اکاؤنٹ کی موجودہ فروخت کی قیمت پڑھیں۔ ٹائم آؤٹ ہونے والے send کو آنکھیں بند کر کے دوبارہ نہ بھیجیں: پہلے اس کا ریکارڈ شدہ نتیجہ دیکھیں۔
غلطیوں اور دوبارہ کوششوں کو سنبھالیں
- تصدیق یا اجازت کی ناکامی
- API اسناد کی فعال حالت، اجازت یافتہ سروس اور سورس IP کی پابندی چیک کریں۔ پورٹل سیشن کوکی انضمام کی اسناد نہیں ہے۔
- ناکافی کریڈٹ یا نامکمل منظوری
- آپریشن دوبارہ کرنے سے پہلے اکاؤنٹ بیلنس، بھیجنے کی منظوری یا دستاویز کی شرط کو پورا کریں۔
- کوئی نتیجہ نہیں
- خالی انوینٹری یا کالر کے نام کی عدم موجودگی کو ایک عام نتیجہ سمجھ کر سنبھالیں۔ یہ فرض نہ کریں کہ نحوی طور پر درست نمبر پر ہر سروس دستیاب ہے۔
- نیٹ ورک ٹائم آؤٹ یا سروس کی ناکامی
- پڑھنے (read) کے آپریشنز کے لیے backoff کے ساتھ محدود دوبارہ کوششیں استعمال کریں۔ خریداری، بھیجنے یا رجسٹریشن کے لیے پہلے آپریشن کی حالت دیکھیں؛ قبول شدہ درخواست کو دوبارہ بھیجنے سے قابلِ بل عمل دہرایا جا سکتا ہے۔
Idempotency کی سہولت ہر API فیملی کی اپنی ہوتی ہے۔ Emergency API دوبارہ کوشش کی کلیدیں (retry keys) سپورٹ کرتی ہے؛ اس کا مطلب یہ نہیں کہ کوئی بھی v3 درخواست idempotent ہے۔ سپورٹ کے لیے ٹائم اسٹیمپ، واپس آنے والی IDs اور حساس معلومات ہٹائے ہوئے جوابات محفوظ رکھیں۔
اپنے اکاؤنٹ کے ریفرنس کے ساتھ آگے بڑھیں
سائن اِن ریفرنس آپریشنز کو آپ کی اجازتوں اور فعال سروسز کے مطابق فلٹر کرتا ہے۔ اس کا درست ہوسٹ، اسناد کی قسم، درخواست کے فیلڈز اور رسپانس اسکیما استعمال کریں۔ کنسولز لائیو آپریشنز چلا سکتے ہیں، جن میں خریداریاں اور پیغامات بھی شامل ہیں۔