แสดงรายการแฟกซ์ที่ได้รับ

แสดงรายการแฟกซ์ที่ได้รับ

ใช้บัญชี API ของ MultiTEL ที่เปิดใช้งานแล้วผ่าน HTTPS โดยใช้ข้อมูลรับรองและข้อจำกัดที่อยู่ IP ที่กำหนดไว้สำหรับบัญชีนั้น จุดปลายทางนี้แสดงรายการแฟกซ์ที่ได้รับซึ่งเป็นของบัญชีที่ยืนยันตัวตนแล้ว โดยไม่ได้ส่งแฟกซ์หรือดาวน์โหลดเอกสารของแฟกซ์

curl --silent --show-error --get --user "$API_USER:$API_PASSWORD" \
  --data-urlencode page=1 \
  --data-urlencode limit=25 \
  --data-urlencode date_from=2026-10-01 \
  --data-urlencode date_to=2026-10-02 \
  https://api.multitel.net/v3/fax_inbox

ขอบเขตวันที่รวมทั้งวันเริ่มต้นและวันสิ้นสุด และใช้การตีความวันที่ของเซิร์ฟเวอร์ API ไม่ใช่เขตเวลาของผู้ใช้ที่ร้องขอ สตริงวันที่ที่ไม่ถูกต้องอาจถูกละเลยแทนที่จะถูกปฏิเสธ จึงควรตรวจสอบความถูกต้องก่อนส่ง หากไม่มีตัวกรองวันที่ ตัวจัดการจะไม่กำหนดช่วงวันที่เริ่มต้นให้ ผลลัพธ์เรียงตามเวลาที่ได้รับ โดยรายการใหม่ที่สุดอยู่ก่อน จุดปลายทางนี้ไม่ได้ให้ภาพรวมข้อมูลที่คงที่ตลอดทุกหน้า แฟกซ์ที่เข้ามาใหม่อาจทำให้ระเบียนย้ายไปอยู่หน้าอื่นได้

อ่านข้อมูลกล่องแฟกซ์แต่ละหน้า

อ่านผลลัพธ์ HTTP และค่า status.code ใน JSON ความล้มเหลวในส่วนอื่นของ API อาจใช้โครงสร้างห่อหุ้มข้อผิดพลาดแบบ JSON แม้ว่าสถานะ HTTP จะเป็น 200 การตอบกลับที่สำเร็จมี response.faxes และ response.pagination ตัวอย่างนี้ใช้ค่าที่สมมติขึ้น

{
  "status": {"code": 200, "msg": ""},
  "response": {
    "faxes": [{
      "id": 12,
      "hash": "c20ad4d76fe97759aa27a0c99bff6710",
      "from_number": "+12125550123",
      "to_number": "+12125550124",
      "remote_station_id": "Example sender",
      "pages": 2,
      "cost": 0.05,
      "received_at": "2026-10-01 12:00:00",
      "received_timestamp": 1790856000,
      "status": "success",
      "status_text": "OK",
      "emailed": "yes",
      "viewed": false
    }],
    "pagination": {"page": 1, "limit": 25, "total": 1, "total_pages": 1}
  }
}

id คือรหัสระเบียนในกล่องขาเข้าที่เป็นตัวเลข hash คือรูปแบบ MD5 ของรหัสดังกล่าวสำหรับขั้นตอนจัดการเอกสารขาเข้าแบบเดิม ไม่ใช่รหัสงาน send_fax หรือข้อมูลรับรองการอนุญาต ห้ามใช้ค่านี้กับจุดปลายทางขาออก fax_status ดังกล่าว

received_timestamp คือค่าประทับเวลา Unix ที่จัดเก็บไว้ received_at คือค่าประทับเวลาที่เซิร์ฟเวอร์จัดรูปแบบโดยไม่มีค่าชดเชยเขตเวลา หรือเป็น null หากไม่มีการบันทึกเวลาที่ได้รับ ให้ใช้ค่า Unix เมื่อแสดงเวลาตามเขตเวลาของคุณเอง cost เป็นตัวเลขใน JSON ไม่ใช่ใบเสนอราคาหรือหลักฐานว่ามีการเรียกเก็บเงินแยกต่างหากเสร็จสมบูรณ์แล้ว

status มีค่าเป็น success เฉพาะเมื่อรหัสสถานะที่จัดเก็บไว้มีค่าเป็นศูนย์เท่านั้น ค่าอื่นจะกลายเป็น failed status_text มีข้อความการประมวลผลที่จัดเก็บไว้ โดยใช้ OK หรือ Failed เป็นค่าสำรอง emailed คงค่าที่จัดเก็บไว้โดยไม่แปลงเป็นค่าตรรกะ viewed เป็นค่าตรรกะ อย่าสรุปว่าส่งอีเมลสำเร็จโดยอาศัยเพียงสถานะแฟกซ์

จัดการรายการว่างและรายการที่เปลี่ยนแปลง

กล่องแฟกซ์ที่ว่างจะส่งคืนอาร์เรย์ faxes ที่ว่าง ค่า total เป็น 0 และค่า total_pages เป็น 0 หน้าที่อยู่ถัดจากหน้าสุดท้ายก็อาจส่งคืนอาร์เรย์ว่างได้เช่นกัน ให้หยุดตามฟิลด์การแบ่งหน้า แทนที่จะถือว่าต้องมีอย่างน้อยหนึ่งหน้าเสมอ ไม่มีเคอร์เซอร์หรือการเรียงลำดับรองตามรหัสระเบียนให้ใช้งาน เก็บรหัสระเบียนไว้เมื่อกระทบยอดข้อมูลจากหน้าที่มีรายการซ้ำกัน

การเข้าถึงเอกสารและความเป็นส่วนตัว

รายการในกล่องแฟกซ์มีข้อมูลเมตาส่วนตัวเกี่ยวกับโทรศัพท์และเอกสาร จำกัดการเข้าถึงในแอปพลิเคชันของคุณและหลีกเลี่ยงการบันทึกการตอบกลับทั้งหมดลงในบันทึกเหตุการณ์ การแสดงรายการไม่ได้ทำเครื่องหมายว่าเอกสารถูกดูแล้ว ใช้ fax_file สำหรับการดาวน์โหลดเอกสารขาเข้าผ่านกลไกความเข้ากันได้ โดยโปรดทราบว่าจะทำเครื่องหมายระเบียนขาเข้าที่มีอยู่แล้วว่าถูกดูแล้ว แม้จะไม่มีไฟล์ของระเบียนนั้นให้ใช้งานก็ตาม นอกจากนี้ยังสามารถเข้าถึงเอกสารผ่านกล่องขาเข้าบนพอร์ทัลได้ ยังไม่มีการกำหนดการรับประกันการเก็บรักษาไฟล์