เลือกเอกสารขาเข้าหรือขาออก
ปลายทางสำหรับความเข้ากันได้นี้ใช้เรียกดูเอกสารแฟกซ์ที่เป็นของบัญชีคุณ ใช้บัญชี API ของ MultiTEL ที่เปิดใช้งานแล้วผ่าน HTTPS พร้อมข้อมูลรับรองและข้อจำกัดด้าน IP ที่กำหนดไว้สำหรับบัญชีนั้น ปลายทางนี้ไม่ได้ส่งหรือส่งแฟกซ์ซ้ำ
| พารามิเตอร์ | จำเป็น | ความหมาย |
|---|---|---|
type | ใช่ | ใช้ inbound หรือ outbound โดยสะกดให้ตรงตามที่แสดงทุกตัวอักษร |
id | ใช่ | สำหรับ inbound ให้ใช้ค่า hash ที่ fax_inbox ส่งกลับมา สำหรับ outbound ให้ใช้ค่า uuid ที่ fax_outbox ส่งกลับมา |
ต้องระบุค่าเหล่านี้ไว้ในพาธ เส้นทางคือ /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 กลับมาแทน ตรวจสอบ Content-Type ที่ส่งกลับมาทุกครั้ง แทนการสันนิษฐานว่าเป็น PDF
ดาวน์โหลดแฟกซ์ขาออก
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/0123456789abcdef0123456789abcdefใช้ค่า uuid จาก fax_outbox. การดาวน์โหลดเพื่อความเข้ากันได้นี้จะเลือกใช้ก้อนข้อมูลไบนารี PDF ที่จัดเก็บไว้ก่อน ตามด้วยก้อนข้อมูลไบนารี TIFF แล้วจึงเลือกไฟล์ PDF ไฟล์ TIFF หรือไฟล์ต้นฉบับที่พร้อมใช้งาน ลำดับการเลือกนี้แตกต่างจากตัวจัดการดาวน์โหลดขาออกปัจจุบัน fax_download สำหรับการเชื่อมต่อระบบใหม่ที่ใช้ send_fax, ให้ใช้ขั้นตอนการดาวน์โหลดปัจจุบันดังกล่าวพร้อมพารามิเตอร์ job_id ของขั้นตอนนั้น
ไฟล์ต้นฉบับอาจถูกส่งกลับมาเป็น application/octet-stream แทน PDF หรือ TIFF ชื่อไฟล์แนบอาจยังคงใช้นามสกุลของไฟล์ต้นฉบับ การดาวน์โหลดขาออกเพื่อความเข้ากันได้นี้จะไม่ทำเครื่องหมายระเบียนในกล่องขาเข้าว่าอ่านแล้ว ไม่เปลี่ยนสถานะงาน และไม่สร้างการส่งแฟกซ์
จัดการข้อมูลไบต์และข้อผิดพลาดแยกกัน
เมื่อสำเร็จ ระบบจะส่งข้อมูลไบต์ดิบของเอกสารกลับมาพร้อมส่วนหัว Content-Type, Content-Disposition ที่ระบุว่าเป็นไฟล์แนบ และ Content-Length ผลลัพธ์นี้ไม่ใช่โครงสร้างห่อหุ้มข้อมูล Base64 ในรูปแบบ JSON ให้บันทึกส่วนหัวและข้อมูลไบต์แยกกันตามตัวอย่าง ตรวจสอบชนิดของการตอบกลับ แล้วจึงตั้งชื่อไฟล์ให้เหมาะสมหรือประมวลผลไฟล์ การที่นามสกุลไฟล์ต้นฉบับได้รับอนุญาตไม่ได้รับประกันว่าเอกสารถูกต้องหรือผ่านการแปลงแล้ว
รหัส API 400 หมายถึงไม่มีค่าที่จำเป็นในพาธ หรือค่า type ไม่ถูกต้อง รหัส API 404 หมายถึงระเบียนภายใต้ขอบเขตของบัญชีหรือไฟล์ของระเบียนนั้นไม่พร้อมใช้งาน ข้อผิดพลาดใช้โครงสร้างห่อหุ้ม JSON status/response ตามปกติ และอาจใช้ HTTP 200 ให้ตรวจสอบ Content-Type ของการตอบกลับและค่า status.code ใน JSON เพื่อไม่ให้เปิดเนื้อหาข้อผิดพลาดเป็นเอกสาร
ความเป็นส่วนตัวและความพร้อมใช้งาน
เนื้อหาแฟกซ์อาจมีข้อมูลที่ละเอียดอ่อน จัดเก็บไฟล์ที่ดาวน์โหลดไว้เฉพาะในตำแหน่งที่ผู้รับที่คุณตั้งใจให้รับสามารถเข้าถึงได้ และหลีกเลี่ยงการบันทึกข้อมูลไบต์ทั้งหมดของเอกสารลงในบันทึกเหตุการณ์ การมีระเบียนในกล่องแฟกซ์ไม่ได้รับประกันว่าไฟล์ของระเบียนนั้นจะยังพร้อมใช้งานต่อไป ยังไม่มีการกำหนดระยะเวลาเก็บรักษาไฟล์หรือการรับประกันความเข้ากันได้สำหรับเอกสารเก่าทุกฉบับที่จัดเก็บไว้