Tải xuống bản fax trong hộp thư đến hoặc hộp thư đi

Chọn tài liệu nhận vào hoặc gửi đi

Điểm cuối tương thích này truy xuất tài liệu fax thuộc tài khoản của bạn. Hãy sử dụng tài khoản API MultiTEL đã được kích hoạt qua HTTPS, với thông tin xác thực và các giới hạn địa chỉ IP đã cấu hình cho tài khoản đó. Điểm cuối này không gửi hoặc gửi lại bản fax.

Các tham số trong đường dẫn tải xuống
Tham số	Bắt buộc	Ý nghĩa
`type`	Có	Sử dụng inbound hoặc outbound, đúng như cách viết ở đây.
`id`	Có	Đối với inbound, sử dụng hash do fax_inbox trả về. Đối với outbound, sử dụng uuid do fax_outbox trả về.

Các giá trị này phải được đặt trong đường dẫn. Tuyến truy cập là /v3/fax_file/{type}/{id}, không phải fax_download có thêm các đoạn đường dẫn. Mã băm của bản fax nhận vào không phải mã định danh bản ghi dạng số và cũng không phải mã định danh tác vụ gửi đi. Hãy sao chép mã định danh từ danh sách của hộp thư tương ứng; mã này không thay thế việc xác thực.

Tải xuống bản fax đã nhận

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

Mã băm trong ví dụ đại diện cho bản ghi giả định 12 trong hộp thư đến. Hãy lấy giá trị của chính bạn từ fax_inbox. Việc tải xuống một bản ghi nhận vào hiện có sẽ đánh dấu bản ghi đó là đã xem. Thao tác này diễn ra trước khi kiểm tra xem tệp có sẵn hay không, nên ngay cả khi xảy ra lỗi tệp không có sẵn, viewed vẫn có thể được đặt thành true. Không dùng điểm cuối này chỉ để kiểm tra xem bản fax đã nhận có tồn tại hay không nếu bạn muốn giữ nguyên trạng thái đã xem của bản fax.

Bộ xử lý ưu tiên PDF đã lưu. Nếu không có, bộ xử lý dùng TIFF đã lưu và thử chuyển đổi sang PDF khi có công cụ chuyển đổi. Nếu không thể chuyển đổi hoặc quá trình chuyển đổi phát sinh ngoại lệ được xử lý, bộ xử lý sẽ trả về TIFF thay thế. Luôn kiểm tra Content-Type được trả về thay vì mặc định cho rằng đó là PDF.

Tải xuống bản fax gửi đi

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

Sử dụng uuid từ fax_outbox. Cơ chế tải xuống tương thích này ưu tiên khối dữ liệu nhị phân PDF đã lưu, tiếp đến là khối dữ liệu nhị phân TIFF, rồi đến tệp PDF, tệp TIFF hoặc tệp nguồn gốc có sẵn. Thứ tự ưu tiên này khác với thứ tự của bộ xử lý tải xuống bản fax gửi đi hiện tại fax_download. Đối với các tích hợp mới sử dụng send_fax, hãy sử dụng quy trình tải xuống hiện tại đó với tham số job_id của quy trình.

Tệp nguồn gốc có thể được trả về dưới dạng application/octet-stream thay vì PDF hoặc TIFF. Tên tệp đính kèm có thể giữ nguyên phần mở rộng của tệp nguồn. Việc tải xuống bản fax gửi đi qua cơ chế tương thích không đánh dấu bản ghi trong hộp thư đến là đã xem, không thay đổi trạng thái tác vụ và không tạo lượt truyền fax.

Xử lý dữ liệu byte và lỗi riêng biệt

Khi thành công, hệ thống trả về các byte thô của tài liệu cùng các tiêu đề Content-Type, Content-Disposition chỉ định tệp đính kèm và Content-Length. Đây không phải cấu trúc bao chứa dữ liệu Base64 ở định dạng JSON. Hãy lưu riêng các tiêu đề và dữ liệu byte như minh họa, kiểm tra loại phản hồi, rồi mới đặt tên phù hợp cho tệp hoặc xử lý tệp. Phần mở rộng của tệp nguồn được cho phép không bảo đảm rằng tài liệu hợp lệ hoặc đã được chuyển đổi.

Mã API 400 có nghĩa là thiếu giá trị bắt buộc trong đường dẫn hoặc type không hợp lệ. Mã API 404 có nghĩa là bản ghi thuộc phạm vi tài khoản hoặc tệp của bản ghi đó không có sẵn. Lỗi sử dụng cấu trúc bao JSON status/response thông thường và có thể dùng HTTP 200. Hãy kiểm tra Content-Type của phản hồi và trường status.code trong JSON để tránh mở nội dung lỗi như một tài liệu.

Quyền riêng tư và tính sẵn có

Nội dung fax có thể chứa thông tin nhạy cảm. Chỉ lưu các tệp đã tải xuống ở nơi những người nhận mà bạn dự định chia sẻ có thể truy cập, đồng thời tránh ghi toàn bộ dữ liệu byte của tài liệu vào nhật ký. Việc có bản ghi trong hộp thư không bảo đảm rằng tệp của bản ghi đó sẽ tiếp tục có sẵn. Chưa có thời hạn lưu giữ tệp hoặc cam kết tương thích nào được xác lập cho mọi tài liệu đã lưu từ trước.