موصولہ یا بھیجی جانے والی دستاویز منتخب کریں
مطابقت کے لیے فراہم کردہ یہ اینڈ پوائنٹ آپ کے اکاؤنٹ سے تعلق رکھنے والی فیکس دستاویز حاصل کرتا ہے۔ MultiTEL کا فعال API اکاؤنٹ، اس کے مقرر کردہ اسناد اور آئی پی پابندیوں کے ساتھ، HTTPS کے ذریعے استعمال کریں۔ یہ فیکس نہیں بھیجتا اور نہ ہی اسے دوبارہ بھیجتا ہے۔
| پیرامیٹر | لازمی | مطلب |
|---|---|---|
type | ہاں | inbound یا outbound بالکل اسی طرح استعمال کریں جیسے دکھایا گیا ہے۔ |
id | ہاں | inbound کے لیے fax_inbox سے واپس ملنے والا hash استعمال کریں۔ outbound کے لیے fax_outbox سے واپس ملنے والا uuid استعمال کریں۔ |
یہ قدریں پاتھ میں شامل کی جاتی ہیں۔ روٹ یہ ہے: /v3/fax_file/{type}/{id}, اضافی پاتھ حصوں کے ساتھ fax_download نہیں۔ موصولہ فیکس کا ہیش نہ تو ریکارڈ کی عددی شناخت ہے اور نہ ہی باہر بھیجے جانے والے فیکس کے کام کی شناخت۔ شناخت کنندہ متعلقہ میل باکس کی فہرست سے نقل کریں؛ یہ توثیق کا متبادل نہیں ہے۔
موصولہ فیکس ڈاؤن لوڈ کریں
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
--dump-header fax-response.headers --output fax-response.bin \
https://api.multitel.net/v3/fax_file/inbound/c20ad4d76fe97759aa27a0c99bff6710مثال میں دیا گیا ہیش ان باکس کے فرضی ریکارڈ 12 کی نمائندگی کرتا ہے۔ اپنی قدر یہاں سے حاصل کریں: fax_inbox۔ موجودہ موصولہ ریکارڈ ڈاؤن لوڈ کرنے سے اسے دیکھا گیا نشان زد کر دیا جاتا ہے۔ یہ عمل فائل کی دستیابی جانچنے سے پہلے ہوتا ہے، اس لیے فائل دستیاب نہ ہونے کی خرابی کے باوجود viewed کی قدر true رہ سکتی ہے۔ اگر آپ چاہتے ہیں کہ موصولہ فیکس کی دیکھے جانے کی حالت برقرار رہے تو یہ اینڈ پوائنٹ محض اس کا وجود جانچنے کے لیے استعمال نہ کریں۔
درخواست پر کارروائی کرنے والا جزو محفوظ شدہ PDF کو ترجیح دیتا ہے۔ بصورت دیگر یہ محفوظ شدہ TIFF استعمال کرتا ہے اور کنورٹر دستیاب ہونے پر اسے PDF میں تبدیل کرنے کی کوشش کرتا ہے۔ اگر تبدیلی دستیاب نہ ہو یا ایسا استثنا پیدا ہو جسے کوڈ سنبھال لیتا ہے، تو یہ اس کے بجائے TIFF واپس کرتا ہے۔ PDF فرض کرنے کے بجائے ہمیشہ واپس ملنے والا Content-Type جانچیں۔
باہر بھیجے جانے والے فیکس کو ڈاؤن لوڈ کریں
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
--dump-header fax-response.headers --output fax-response.bin \
https://api.multitel.net/v3/fax_file/outbound/0123456789abcdef0123456789abcdefuuid استعمال کریں، جو یہاں سے ملتا ہے: fax_outbox۔ مطابقت کے لیے فراہم کردہ یہ ڈاؤن لوڈ پہلے محفوظ شدہ PDF بائنری ڈیٹا، پھر TIFF بائنری ڈیٹا، اور اس کے بعد دستیاب PDF فائل، TIFF فائل یا اصل ماخذ فائل کو ترجیح دیتا ہے۔ اس کی ترجیحی ترتیب باہر بھیجے جانے والے فیکس کے موجودہ جزو fax_download کی ترتیب سے مختلف ہے۔ نئے انضمام میں اگر آپ send_fax استعمال کرتے ہیں، تو اس کے لیے موجودہ ڈاؤن لوڈ طریقۂ کار کو اس کے job_id پیرامیٹر کے ساتھ استعمال کریں۔
اصل ماخذ فائل PDF یا TIFF کے بجائے application/octet-stream کے طور پر واپس مل سکتی ہے۔ منسلک فائل کے نام میں ماخذ کی توسیع برقرار رہ سکتی ہے۔ مطابقت کے لیے فراہم کردہ باہر بھیجے جانے والے فیکس کا ڈاؤن لوڈ نہ ان باکس ریکارڈ کو دیکھا گیا نشان زد کرتا ہے، نہ کام کی حالت بدلتا ہے اور نہ ہی کوئی ترسیل شروع کرتا ہے۔
بائٹس اور خرابیوں کو الگ الگ سنبھالیں
کامیابی کی صورت میں دستاویز کی خام بائٹس، Content-Type، منسلک فائل ظاہر کرنے والے Content-Disposition اور Content-Length ہیڈرز کے ساتھ واپس ملتی ہیں۔ یہ Base64 میں انکوڈ کردہ مواد پر مشتمل JSON لفافہ نہیں ہے۔ دکھائے گئے طریقے کے مطابق ہیڈرز اور بائٹس الگ الگ محفوظ کریں، جواب کی قسم جانچیں، اور اس کے بعد ہی فائل کو مناسب نام دیں یا اس پر کارروائی کریں۔ ماخذ کی توسیع کی اجازت ہونا درست یا تبدیل شدہ دستاویز کی ضمانت نہیں ہے۔
API کوڈ 400 کا مطلب ہے کہ پاتھ کی کوئی لازمی قدر موجود نہیں یا type درست نہیں ہے۔ API کوڈ 404 کا مطلب ہے کہ متعلقہ اکاؤنٹ کا ریکارڈ یا اس کی فائل دستیاب نہیں ہے۔ خرابیاں معمول کا JSON status/response لفافہ استعمال کرتی ہیں اور HTTP 200 بھی استعمال کر سکتی ہیں۔ جواب کا Content-Type اور JSON میں status.code جانچیں تاکہ خرابی کے جواب کا متن دستاویز سمجھ کر نہ کھولا جائے۔
رازداری اور دستیابی
فیکس کے مواد میں حساس معلومات ہو سکتی ہیں۔ ڈاؤن لوڈ کی گئی فائلیں صرف ایسی جگہ محفوظ کریں جہاں آپ کے مطلوبہ وصول کنندگان ان تک رسائی حاصل کر سکیں، اور لاگز میں دستاویز کی تمام بائٹس شامل کرنے سے گریز کریں۔ میل باکس میں ریکارڈ موجود ہونا اس کی فائل کے دستیاب رہنے کی ضمانت نہیں ہے۔ فائلیں محفوظ رکھنے کی کوئی مدت مقرر نہیں کی گئی اور نہ ہی ہر پرانی محفوظ شدہ دستاویز کی مطابقت کی ضمانت دی گئی ہے۔