REST API دستاویزات

ہنگامی کالنگ 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 انضمام کی سیٹنگز میں کیا جاتا ہے۔

نمبر رجسٹر کیے بغیر کوریج پڑھیں

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multi.tel/emergency/coverage?environment=production"

https://api.multitel.net/emergency بھی سپورٹڈ ہے۔ ایمرجنسی کے دونوں بنیادی URLs میں /v3 شامل نہیں ہے۔ کوریج میں بین الاقوامی سروس کے سپورٹ کردہ ممالک، نمبر کی اقسام اور قیمتیں درج ہوتی ہیں؛ شمالی امریکی E911 کی اہلیت رجسٹریشن کے دوران جانچی جاتی ہے۔

{
  "code": 200,
  "message": "",
  "environment": "production",
  "requestId": "EXAMPLE_REQUEST_ID",
  "data": {}
}

یہ صرف جواب کی بیرونی ساخت کی وضاحت کرتا ہے۔ ہر آپریشن کا data اسکیما شائع شدہ Emergency API گائیڈ میں پڑھیں۔

رجسٹر کریں، اسٹیٹس دیکھیں، پھر کالنگ کنفیگر کریں

امریکہ/کینیڈا اور شمالی امریکہ کے دیگر سپورٹ کردہ E911 علاقوں کے لیے نمبر، E911 پتہ اور مطلوبہ رضامندی کی تصدیقات فراہم کریں۔ شمالی امریکی E911 صرف حقیقی استعمال کے پروڈکشن ماحول میں دستیاب ہے۔
کسی معاون، ملکیتی بین الاقوامی نمبر کے لیے یا تو محفوظ شدہ Document ریفرنس یا اینڈ یوزر کی شناخت اور پتہ فراہم کریں۔ پہلے ملک اور نمبر کی قسم کی شرائط کا جائزہ لیں۔
ایک POST /registrations درخواست بھیجیں۔ ایک اختیاری Idempotency-Key ایک منطقی تبدیلی کی شناخت کرتی ہے؛ دوبارہ کوششوں میں اسے اور بالکل وہی payload محفوظ رکھیں۔
GET /registrations/:number پڑھیں۔ لائف سائیکل، pending اور actionRequired کا جائزہ لیں؛ مطلوبہ اصلاحات حل کریں۔ قبولیت یا زیرِ التوا ہونا فعال سروس نہیں ہے۔
ایکٹیویشن کے بعد درست ایمرجنسی کالر ID اور ملک کے مطابق ڈائلنگ روٹ کنفیگر کریں۔ سروس کا غیر ہنگامی verification طریقہ استعمال کریں۔

بین الاقوامی sandbox رجسٹریشنز الگ تھلگ ہوتی ہیں اور اصل ایمرجنسی کالنگ کو فعال نہیں کرتیں۔ شمالی امریکی E911 کے لیے مرکزی اکاؤنٹ کی اسناد درکار ہیں؛ گائیڈ بین الاقوامی ذیلی اکاؤنٹس کی محدود سپورٹ کی وضاحت کرتی ہے۔

پورٹل سیٹ اپ اور تصدیق ملک کی کوریج اور ہنگامی فون نمبر عوامی درخواستوں، فیلڈز، اسٹیٹس اور دوبارہ کوشش کی مکمل گائیڈ

غلطیوں اور دوبارہ کوششوں کو سنبھالیں

تصدیق یا اجازت کی ناکامی: API اسناد کی فعال حالت، اجازت یافتہ سروس اور سورس IP کی پابندی چیک کریں۔ پورٹل سیشن کوکی انضمام کی اسناد نہیں ہے۔
ناکافی کریڈٹ یا نامکمل منظوری: آپریشن دوبارہ کرنے سے پہلے اکاؤنٹ بیلنس، بھیجنے کی منظوری یا دستاویز کی شرط کو پورا کریں۔
کوئی نتیجہ نہیں: خالی انوینٹری یا کالر کے نام کی عدم موجودگی کو ایک عام نتیجہ سمجھ کر سنبھالیں۔ یہ فرض نہ کریں کہ نحوی طور پر درست نمبر پر ہر سروس دستیاب ہے۔
نیٹ ورک ٹائم آؤٹ یا سروس کی ناکامی: پڑھنے (read) کے آپریشنز کے لیے backoff کے ساتھ محدود دوبارہ کوششیں استعمال کریں۔ خریداری، بھیجنے یا رجسٹریشن کے لیے پہلے آپریشن کی حالت دیکھیں؛ قبول شدہ درخواست کو دوبارہ بھیجنے سے قابلِ بل عمل دہرایا جا سکتا ہے۔

Idempotency کی سہولت ہر API فیملی کی اپنی ہوتی ہے۔ Emergency API دوبارہ کوشش کی کلیدیں (retry keys) سپورٹ کرتی ہے؛ اس کا مطلب یہ نہیں کہ کوئی بھی v3 درخواست idempotent ہے۔ سپورٹ کے لیے ٹائم اسٹیمپ، واپس آنے والی IDs اور حساس معلومات ہٹائے ہوئے جوابات محفوظ رکھیں۔

اپنے اکاؤنٹ کے ریفرنس کے ساتھ آگے بڑھیں

سائن اِن ریفرنس آپریشنز کو آپ کی اجازتوں اور فعال سروسز کے مطابق فلٹر کرتا ہے۔ اس کا درست ہوسٹ، اسناد کی قسم، درخواست کے فیلڈز اور رسپانس اسکیما استعمال کریں۔ کنسولز لائیو آپریشنز چلا سکتے ہیں، جن میں خریداریاں اور پیغامات بھی شامل ہیں۔

اکاؤنٹ کے مخصوص اینڈ پوائنٹس کی فہرست کمیونیکیشنز REST کنسول عوامی کمیونیکیشنز OpenAPI دستاویز OAuth انضمام کی گائیڈ