ส่งแฟกซ์

ก่อนส่ง

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

ใช้บัญชี API ของ MultiTEL ที่เปิดใช้งานแล้ว ส่งข้อมูลรับรอง HTTP Basic สำหรับบัญชีที่ใช้รหัสผ่าน หรือโทเค็น Bearer สำหรับบัญชีที่ใช้โทเค็น สิทธิ์ของบัญชีและข้อจำกัดที่อยู่ IP ยังคงมีผล ห้ามใช้ข้อมูลรับรองภายในของตัวประมวลผลงานเบื้องหลัง

อัปโหลดเอกสาร

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --form-string from_number=+12125550123 \
  --form-string to_number=+12125550124 \
  --form fax_file=@./document.pdf \
  https://api.multitel.net/v3/send_fax

ฟิลด์ของคำขอ
ฟิลด์	จำเป็นต้องระบุ	ความหมาย
`from_number`	ใช่	หมายเลขผู้ส่งที่คุณมีสิทธิ์ใช้ ระบุในรูปแบบสากลโดยขึ้นต้นด้วย + ตามด้วยรหัสประเทศ
`to_number`	ใช่	หมายเลขแฟกซ์ปลายทางในรูปแบบสากล
`fax_file`	จำเป็นสำหรับคำขอแบบหลายส่วน	เอกสารที่อัปโหลด ให้ curl กำหนด Content-Type และตัวคั่นระหว่างส่วนของคำขอแบบหลายส่วนให้เอง
`webhook_url`	ไม่	ที่อยู่ URL สำหรับรับการแจ้งกลับผ่าน HTTP หรือ HTTPS ซึ่งไม่จำเป็นต้องระบุ โดยแนะนำให้ใช้ HTTPS เนื้อหาข้อมูลที่ส่งกลับและการรับประกันการส่งการแจ้งกลับยังอยู่ระหว่างการตรวจทาน ให้เรียกตรวจสอบ fax_status เป็นระยะเพื่อติดตามสถานะตามขั้นตอนที่ระบุไว้ในเอกสาร

รองรับ JSON เช่นกัน โดยระบุ Content-Type: application/json, ใช้ฟิลด์หมายเลขเดียวกันและระบุ webhook_url ได้ตามต้องการ พร้อมทั้ง file_name และ file_b64 โดย file_b64 ต้องมีไบต์ของเอกสารที่เข้ารหัสตามรูปแบบ Base64 อย่างเคร่งครัด และไม่มีคำนำหน้า data: หากมี fax_file ที่ถูกต้องในคำขอแบบหลายส่วน ระบบจะเลือกใช้ค่านั้นก่อน นี่ไม่ใช่ API สำหรับดึงไฟล์จาก URL

ข้อจำกัดของเอกสารและการส่งคำขอ

แอปพลิเคชันรับเอกสารที่มีขนาดหลังถอดรหัสไม่เกิน 15,728,640 ไบต์ (15 MiB) โดยมีนามสกุล pdf, tif, tiff, jpg, jpeg, png, doc, docx หรือ txt การใช้นามสกุลที่อนุญาตไม่ได้รับประกันว่าบริการจะนับหรือแปลงหน้าเอกสารได้ ข้อจำกัดขนาดคำขอของโครงสร้างพื้นฐานอาจต่ำกว่านี้ และ Base64 ทำให้ขนาดคำขอเพิ่มขึ้น

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

เก็บรหัสงานไว้

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

{
  "status": {
    "code": 200,
    "msg": "Fax queued"
  },
  "response": {
    "job_id": "0123456789abcdef0123456789abcdef"
  }
}

เรียกตรวจสอบเป็นระยะที่ fax_status โดยใช้ response.job_id หากการตอบกลับคำขอส่งสูญหาย ให้ตรวจสอบกล่องขาออกในพอร์ทัลก่อนส่งอีกครั้ง เพราะคำขอที่ส่งซ้ำอาจทำให้เกิดการส่งแฟกซ์แยกกัน ตัวจัดการคำขอนี้ไม่ได้เปิดให้ไคลเอนต์ใช้พารามิเตอร์ที่รับประกันว่าคำขอซ้ำจะมีผลเพียงครั้งเดียว

ข้อผิดพลาดและการตรวจสอบยอดเงิน

รหัส API ได้แก่ 400 เมื่อระบุฟิลด์ไม่ครบ ที่อยู่ URL สำหรับรับการแจ้งกลับไม่ถูกต้อง เอกสารถูกปฏิเสธ หรือตรวจหาหน้าเอกสารไม่สำเร็จ; 401 เมื่อไม่มีข้อมูลยืนยันตัวตน; 402 เมื่อค่าบริการแฟกซ์โดยประมาณรวมกับค่าบริการโดยประมาณของงานที่อยู่ในคิวหรือกำลังส่งเกินยอดเงินที่ใช้ได้ในบัญชี; 429 เมื่อเกินอัตราที่จำกัด; และ 500 เมื่อเกิดข้อผิดพลาดในขั้นตอนเตรียมข้อมูลสำหรับส่ง อ่าน status.msg เพื่อทราบสาเหตุที่เจาะจง

คิวจะบันทึกค่าบริการโดยประมาณก่อนส่ง อย่าถือว่าการรับคำขอ การตรวจสอบยอดเงิน หรือค่าประมาณนี้เป็นการยืนยันว่าเรียกเก็บเงินเรียบร้อยแล้ว รายละเอียดการคิดค่าบริการขั้นสุดท้ายและการแจ้งกลับยังต้องได้รับการตรวจสอบยืนยัน