محفوظ کردہ پروفائل اور نمبر تیار کریں
اس طریقۂ کار سے محفوظ کردہ اندراجی پروفائل کو خریدے گئے نمبر سے منسلک کریں اور، آپریٹر کے ذریعے کارروائی کے لیے معاونت یافتہ نمبروں کے لیے، اندراج کے جائزے کی درخواست کریں۔ یہ ہر نمبر فراہم کنندہ کے لیے فعالیت کا عمومی API نہیں ہے۔ درخواست کی کامیابی اس بات کا ثبوت نہیں کہ دستاویزات منظور ہو گئی ہیں یا نمبر فعال ہے۔
فعال MultiTEL API اکاؤنٹ کو HTTPS کے ذریعے استعمال کریں، اور اس کے مقرر کردہ اسناد اور IP پابندیوں کی پیروی کریں۔ حذف نہ کیا گیا پروفائل اور خریدا گیا، منسوخ نہ کیا گیا نمبر، دونوں آپ کے اکاؤنٹ کی ملکیت ہونے چاہییں۔
- بنائیں ایک اندراجی پروفائل یا موجودہ پروفائل منتخب کریں۔ create_document سے حاصل ہونے والا مقامی پروفائل کا uuid محفوظ رکھیں؛ get_document وہی مقامی حوالہ id کے طور پر واپس کرتا ہے۔
- آپریٹر کے ذریعے جمع کرانے کے لیے پروفائل میں شناخت اور پتے کے محفوظ کردہ حوالے درکار ہیں۔ منسلک کریں مطلوبہ ثبوت اور معاون دستاویزات جمع کرانے سے پہلے ان کے متعلقہ طریقۂ کار کے ذریعے۔
- یقینی بنائیں کہ نمبر اور پروفائل متعلقہ ملک اور نمبر کی قابل اطلاق شرائط پوری کرتے ہیں۔ یہ فرض نہ کریں کہ محفوظ کردہ پروفائل ہر نمبر کے لیے منظور شدہ ہے۔
منسلک کرنے کی درخواست جمع کرائیں
curl --silent --show-error --request POST \
--user "$API_USER:$API_PASSWORD" \
--form-string document_uuid="$PROFILE_UUID" \
--form-string service_description="Example customer support line" \
https://api.multitel.net/v3/number_identity/12125550123پاتھ میں خریدا گیا ٹیلی فون نمبر شامل ہوتا ہے، اس کا UUID، کوئی PBX ایکسٹینشن یا شناختی آئی ڈی نہیں۔ ہینڈلر نمبر سے ہندسوں کے علاوہ تمام حروف و علامات ہٹا دیتا ہے۔ ملکی کوڈ سمیت مکمل بین الاقوامی نمبر استعمال کریں۔ مثال فرضی ہے اور اس میں اپنا نمبر اور محفوظ کردہ مقامی پروفائل کا حوالہ درج کرنا ضروری ہے۔
| خانہ | لازمی | مطلب |
|---|---|---|
document_uuid | ہاں | محفوظ کردہ مقامی پروفائل کا عین uuid۔ اس کی جگہ مخفی کردہ دور دراز identity_id، address_id، اپ لوڈ آئی ڈی یا واپس ملنے والی registration_details_id کی قدر استعمال نہ کریں۔ |
service_description | نہیں | مطلوبہ خدمت کی تفصیل، جو آپریٹر کے ذریعے تصدیق کے لیے آگے بھیجی جاتی ہے۔ شروع اور آخر کی خالی جگہیں ہٹا دی جاتی ہیں۔ |
onetime_files | طریقۂ کار پر منحصر | آپریٹر کی ایک بار استعمال ہونے والی دستاویزات کے لیے قبول کی جانے والی صف۔ موجودہ ہینڈلر مقامی اپ لوڈ حوالوں کو حل کیے بغیر اس کی متنی قدروں کے شروع اور آخر کی خالی جگہیں ہٹاتا ہے اور انہیں آگے بھیج دیتا ہے۔ create_encrypt_files سے واپس ملنے والی مخفی کردہ آئی ڈیز کے ساتھ مطابقت ثابت نہیں ہوئی؛ اس خانے کو استعمال کرنے سے پہلے ذیل میں ایک بار استعمال ہونے والی دستاویزات کی پابندی دیکھیں۔ |
کثیر حصوں والی درخواستوں میں صف کے لیے onetime_files[] کے خانے بار بار استعمال کیے جاتے ہیں۔ Content-Type: application/json کے ساتھ JSON درخواست بھی قبول کی جاتی ہے؛ اس کی خصوصیات فارم کے ارسال کردہ ڈیٹا میں ضم کر دی جاتی ہیں۔ جب پاتھ میں نمبر شامل نہ ہو تو ارسال کردہ ڈیٹا میں number دیا جا سکتا ہے۔ ابہام سے بچنے کے لیے اوپر دکھایا گیا واضح پاتھ ترجیحاً استعمال کریں۔
منسلک ہونے اور منظوری میں فرق سمجھیں
HTTP نتیجہ اور JSON کا status.code، دونوں پڑھیں۔ JSON کی خرابیاں HTTP 200 کے ساتھ بھی آ سکتی ہیں۔ آپریٹر کے ذریعے کارروائی کی کامیابی پر Address verification task created; awaiting carrier review. کی اطلاع ملتی ہے۔ اس مثال میں فرضی حوالے استعمال کیے گئے ہیں۔
{
"status": {
"code": 200,
"msg": "Address verification task created; awaiting carrier review."
},
"response": {
"number": "+12125550123",
"did_id": "11111111111111111111111111111111",
"document_uuid": "0123456789abcdef0123456789abcdef",
"identity_id": "22222222222222222222222222222222",
"address_id": "33333333333333333333333333333333",
"address_verification_id": "44444444444444444444444444444444",
"verification_status": "pending",
"verification_reference": null,
"requirement_id": "55555555555555555555555555555555",
"registration_details_id": "8516ac99dc60603295de7bdb6a153530"
}
}فراہم کنندہ سے متعلق شناخت کنندگان مخفی کردہ حوالے ہیں، مقامی پروفائل کی ایسی آئی ڈیز نہیں جنہیں ایک دوسرے کی جگہ استعمال کیا جا سکے۔ document_uuid وہی مقامی پروفائل حوالہ رہتا ہے جو آپ نے جمع کرایا تھا۔ اس ہینڈلر کے آپریٹر کے ذریعے چلنے والے راستے میں registration_details_id اس مقامی حوالے کا مزید ہیش ہوتا ہے؛ بعد کی پروفائل یا جمع کرانے کی درخواستوں میں اسے document_uuid کی جگہ استعمال نہ کریں۔
بعض مختص کردہ نمبروں کے لیے آپریٹر کی تصدیق بنانے کے بجائے مقامی شناخت منسلک کی جاتی ہے۔ ان کی کامیابی کا نتیجہ Identity associated. ہوتا ہے، جس کے ساتھ response کی صف خالی ہوتی ہے۔ اس سے نہ آپریٹر کے جائزے کا کام بنتا ہے اور نہ منظوری ثابت ہوتی ہے۔ پورٹل میں منسلک کرنے کا ایک نیا طریقۂ کار موجود ہے جس میں فراہم کنندہ سے متعلق کارروائی اور دوبارہ جمع کرانے کی جانچ اس اینڈ پوائنٹ سے مختلف ہیں۔
نقل کام بنائے بغیر خرابیوں سے نمٹیں
API کوڈ 400 نمبر یا پروفائل کا حوالہ موجود نہ ہونے کی نشاندہی کرتا ہے۔ کوڈ 404 اس وقت لاگو ہوتا ہے جب پروفائل یا نمبر اکاؤنٹ کے لیے دستیاب نہ ہو، یا نمبر آپریٹر کی فہرست میں موجود نہ ہو۔ کوڈ 422 شناخت یا پتے کے حوالے موجود نہ ہونے، فروخت کنندہ کی شرائط یا آپریٹر کی توثیق میں مسترد ہونے کی اطلاع دے سکتا ہے۔ کال بیک کی ترتیب موجود نہ ہونے سے 503، اور تخلیق کے دوران ترسیل کی ناکامی سے 502 آ سکتا ہے۔ ہر ناکامی سے ایک ہی طرح نمٹنے کے بجائے پیغام اور فراہم کردہ requirement_diagnostics پڑھیں۔
آپریٹر کے ذریعے چلنے والا راستہ شرائط کی توثیق، کال بیک کی ترتیب کی جانچ یا کام کی تخلیق مکمل ہونے سے پہلے اندراج زیر التوا ہونے کے مقامی اشارے اپ ڈیٹ کر سکتا ہے۔ لہٰذا خرابی کا مطلب یہ نہیں کہ مقامی حالت میں کوئی تبدیلی نہیں ہوئی، اور صرف زیر التوا ہونے کا اشارہ کسی کام کے موجود ہونے کا ثبوت نہیں۔ ان اشاروں کو منظوری یا درخواست پہنچنے کی تصدیق نہ سمجھیں۔
فراہم کنندہ کسی کام کو قبول کر سکتا ہے خواہ بعد میں مقامی ڈیٹابیس کی کوئی کارروائی ناکام ہو جائے، اور یہ معاون فنکشن کامیابی کی اطلاع دینے سے پہلے ہر مقامی تحریری کارروائی کا نتیجہ نہیں جانچتا۔ اس ہینڈلر میں کلائنٹ کی جانب سے یکساں درخواست دہرانے پر ایک ہی نتیجہ یقینی بنانے کا پیرامیٹر یا نقل درخواست سے بچاؤ موجود نہیں۔ وقت کی حد ختم ہونے، خرابی یا غیر یقینی نتیجے کے بعد نمبر کے اندراج کی سابقہ کارروائیاں دیکھیں، جو درج ہیں پورٹل میں، یا دوبارہ جمع کرانے سے پہلے معاونت سے رابطہ کریں۔ مقامی ریکارڈ موجود نہ ہونا بذات خود اس بات کا ثبوت نہیں کہ فراہم کنندہ کو کچھ موصول نہیں ہوا۔
ایک بار استعمال ہونے والی دستاویزات کی پابندی
ہینڈلر onetime_files قبول کرتا ہے اور ہر غیر خالی متنی قدر کو آپریٹر کے رمز شدہ فائلوں کے تعلق میں آگے بھیجتا ہے۔ یہ متعلقہ مالک اکاؤنٹ کے اپ لوڈ ریکارڈ تلاش نہیں کرتا اور نہ بیرونی مخفی کردہ اپ لوڈ آئی ڈیز کو فراہم کنندہ کی فائل آئی ڈیز میں تبدیل کرتا ہے۔ آف لائن جانچ نے آگے بھیجنے کے برتاؤ کی تصدیق کی تھی، آپریٹر کے پاس فائلیں کامیابی سے منسلک ہونے کی نہیں۔
یہ فرض نہ کریں کہ create_encrypt_files سے حاصل کردہ فائل آئی ڈی اس خانے میں نقل کر کے ایک بار کے معاہدے کا طریقۂ کار مکمل کیا جا سکتا ہے۔ جب کسی نمبر کے لیے یہ دستاویزات درکار ہوں تو پورٹل استعمال کریں یا MultiTEL سے شناخت کنندگان کے معاونت یافتہ طریقۂ کار کی تصدیق کریں۔ یہ API کے جائزے کا ایک غیر حل شدہ حصہ ہے، ابتدا سے انتہا تک تصدیق شدہ مثال نہیں۔
اندراج کی معلومات محفوظ رکھیں
صرف وہ معلومات اور دستاویزات جمع کرائیں جنہیں اس نمبر کے لیے استعمال کرنے کا آپ کو اختیار ہے۔ پروفائل اور تصدیق کے حوالے درست اکاؤنٹ سے منسلک رکھیں، اور اندراج کے مکمل ارسال کردہ ڈیٹا کو لاگز میں درج کرنے سے گریز کریں۔ یہ درخواست پہلے کے ہر ثبوت یا تصدیق کو حذف یا تبدیل نہیں کرتی۔ آپریٹر کا جائزہ، فعالیت اور ڈیٹا محفوظ رکھنے کے عمل الگ الگ ہیں۔