API ของ PBX แบบโฮสต์: บันทึกแฟกซ์และการส่งแฟกซ์

ใช้ HTTPS และยืนยันตัวตนด้วย HTTP Basic ด้วยข้อมูลประจำตัว API ที่ได้รับอนุมัติ เก็บข้อมูลประจำตัวไว้บนเซิร์ฟเวอร์แอปพลิเคชันของคุณ ปลายทาง PBX แบบโฮสต์ เหล่านี้ใช้ /hpbx/ บน api.multitel.net ห้ามใส่ /v3 ตรวจสอบทั้งผลลัพธ์ HTTP และสถานะผลการทำงานระดับแอปพลิเคชันในการตอบกลับ JSON

อ่านบันทึกแฟกซ์

curl --request POST --user "USERNAME:PASSWORD" \
  "https://api.multitel.net/hpbx/fax/list/YOUR_BILLING_CODE"

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

การส่งพารามิเตอร์

endpoint สำหรับการส่งคือ POST /hpbx/fax/send/{billing_code} การส่งเป็นการดำเนินการจริง โปรดเตรียมไฟล์และปลายทางที่บัญชีของคุณได้รับอนุญาตก่อนส่ง และอย่าส่งซ้ำโดยไม่ตรวจสอบเมื่อไม่แน่ใจผลการส่ง

ฟิลด์ความหมาย
numberหมายเลขโทรสารปลายทาง
cidnumCaller ID ต้นทางที่ได้รับอนุมัติ
scheduleเวลาส่งที่กำหนดไว้ (เมื่อมีการใช้)
faxquality / pagesize / pagerotateตัวเลือกคุณภาพ ขนาดกระดาษ และการหมุนที่รองรับ
statusemailที่อยู่ที่ได้รับอนุญาตสำหรับการแจ้งผลการส่ง
deleteaftersendระบุว่าควรลบไฟล์ที่อัปโหลดไว้หลังจากส่งแล้วหรือไม่
filenameการอ้างอิงเอกสารที่เวิร์กโฟลว์โทรสารนี้คาดหวัง ไม่ใช่พาธไฟล์ภายในเครื่องโดยพลการ

ติดตามการดำเนินการจนเสร็จสิ้น

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

ค้นหาเอกสาร