REST API دستاویزات
اپنی پہلی MultiTEL API درخواست بھیجیں
صرف پڑھنے والی درخواست سے آغاز کریں، رسپانس کو سمجھیں، پھر اس سروس کا ریفرنس منتخب کریں جو آپ بنانا چاہتے ہیں۔
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 انضمام کی سیٹنگز میں کیا جاتا ہے۔
پہلی درخواست: اپنا بیلنس پڑھیں
یہ پڑھنے کا عمل کوئی سروس نہیں خریدتا اور نہ ہی کوئی کال یا پیغام شروع کرتا ہے۔
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getbalance"communications v3 API ایپلیکیشن کا نتیجہ JSON باڈی کے اندر واپس کرتی ہے۔ response پڑھنے سے پہلے HTTP اسٹیٹس اور status.code چیک کریں؛ مسترد شدہ درخواست میں response آبجیکٹ موجود نہیں بھی ہو سکتا۔ کوڈ کی قدریں اسٹرنگ یا نمبر ہو سکتی ہیں۔
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "25.0000",
"currency": "USD",
"terms": "Prepaid"
}
}یہ ایک فرضی مثال ہے، اکاؤنٹ کا اصل بیلنس نہیں۔ مالی قدروں کو اعشاری رقم کے طور پر لیں۔ مسترد شدہ درخواست کی تشخیص کے لیے سرور کا جوابی پیغام محفوظ رکھیں، اور اس میں سے اسناد (credentials) ہٹا دیں۔
بلنگ ڈیٹا کو درست طریقے سے استعمال کریں
بیلنس کے جواب میں موجودہ بیلنس، کرنسی اور ادائیگی کی شرائط شامل ہوتی ہیں۔ اس سے مستقبل کی کال کی لاگت یا مکمل انوائس معلوم نہیں ہوتی۔ ان سوالات کے لیے متعلقہ ریٹ اور استعمال کے آپریشنز استعمال کریں۔ موجودہ نمبروں کے پلان آج کے کیٹلاگ سے مختلف ہو سکتے ہیں۔
اپنا اگلا انٹیگریشن منتخب کریں
LRN روٹنگ لُک اپ REST API
شمالی امریکہ کے ٹیلی فون نمبر کا روٹنگ نمبر اور دستیاب کیریئر کی معلومات ایک مقررہ قیمت پر معلوم کریں۔
انٹیگریشن گائیڈ پڑھیں ←فون نمبر REST APIs
دستیاب ممالک اور نمبر تلاش کریں، مکمل پیشکش کا جائزہ لیں اور اپنے ملکیتی نمبروں کا انتظام کریں۔
انٹیگریشن گائیڈ پڑھیں ←SMS اور MMS REST APIs
منظور شدہ ایپلیکیشن پیغامات بھیجیں اور قبولیت، ڈیلیوری ایونٹس، سیگمنٹیشن اور چارجز کو سنبھالیں۔
انٹیگریشن گائیڈ پڑھیں ←ہنگامی کالنگ REST APIs
کوئی نمبر اور سروس ایڈریس رجسٹر کریں، اس کی ایکٹیویشن کی صورتحال دیکھیں اور مقام بدلنے پر ریکارڈ کو اپ ڈیٹ رکھیں۔
انٹیگریشن گائیڈ پڑھیں ←اکاؤنٹ اور بلنگ REST APIs
آپ کے منظور شدہ انضمام کے لیے دستیاب بیلنس اور بلنگ کی معلومات پڑھیں۔
انٹیگریشن گائیڈ پڑھیں ←CNAM اور روٹنگ لُک اپس
کالر کے نام پڑھیں، لُک اپ ٹائرز کو سمجھیں اور نمبر روٹنگ کی معلومات استعمال کریں۔
CNAM REST ریفرنس ←ہوسٹڈ PBX
دستیاب سروس پلانز اور اس ٹیننٹ سے آغاز کریں جسے آپ کنفیگر کرنا چاہتے ہیں۔
ہوسٹڈ PBX سروس پلان API ←غلطیوں اور دوبارہ کوششوں کو سنبھالیں
- تصدیق یا اجازت کی ناکامی
- API اسناد کی فعال حالت، اجازت یافتہ سروس اور سورس IP کی پابندی چیک کریں۔ پورٹل سیشن کوکی انضمام کی اسناد نہیں ہے۔
- ناکافی کریڈٹ یا نامکمل منظوری
- آپریشن دوبارہ کرنے سے پہلے اکاؤنٹ بیلنس، بھیجنے کی منظوری یا دستاویز کی شرط کو پورا کریں۔
- کوئی نتیجہ نہیں
- خالی انوینٹری یا کالر کے نام کی عدم موجودگی کو ایک عام نتیجہ سمجھ کر سنبھالیں۔ یہ فرض نہ کریں کہ نحوی طور پر درست نمبر پر ہر سروس دستیاب ہے۔
- نیٹ ورک ٹائم آؤٹ یا سروس کی ناکامی
- پڑھنے (read) کے آپریشنز کے لیے backoff کے ساتھ محدود دوبارہ کوششیں استعمال کریں۔ خریداری، بھیجنے یا رجسٹریشن کے لیے پہلے آپریشن کی حالت دیکھیں؛ قبول شدہ درخواست کو دوبارہ بھیجنے سے قابلِ بل عمل دہرایا جا سکتا ہے۔
Idempotency کی سہولت ہر API فیملی کی اپنی ہوتی ہے۔ Emergency API دوبارہ کوشش کی کلیدیں (retry keys) سپورٹ کرتی ہے؛ اس کا مطلب یہ نہیں کہ کوئی بھی v3 درخواست idempotent ہے۔ سپورٹ کے لیے ٹائم اسٹیمپ، واپس آنے والی IDs اور حساس معلومات ہٹائے ہوئے جوابات محفوظ رکھیں۔
اپنے اکاؤنٹ کے ریفرنس کے ساتھ آگے بڑھیں
سائن اِن ریفرنس آپریشنز کو آپ کی اجازتوں اور فعال سروسز کے مطابق فلٹر کرتا ہے۔ اس کا درست ہوسٹ، اسناد کی قسم، درخواست کے فیلڈز اور رسپانس اسکیما استعمال کریں۔ کنسولز لائیو آپریشنز چلا سکتے ہیں، جن میں خریداریاں اور پیغامات بھی شامل ہیں۔