API của PBX được lưu trữ: bản ghi fax và gửi fax

Sử dụng HTTPS và xác thực HTTP Basic với thông tin xác thực API đã được phê duyệt. Hãy giữ thông tin xác thực trên máy chủ ứng dụng của bạn. Các điểm cuối PBX được lưu trữ này dùng /hpbx/ trên api.multitel.net; không chèn /v3. Hãy kiểm tra cả kết quả HTTP và trạng thái kết quả xử lý ở cấp ứng dụng trong phản hồi JSON.

Đọc bản ghi fax

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

Hãy thay mã thanh toán bằng mã PBX của bạn. Các bản ghi trả về bao gồm thời gian fax, hướng, nguồn, đích, trạng thái gửi, số lần thử, lỗi và số trang. Việc gửi vẫn có thể ở trạng thái đang chờ khi yêu cầu gửi đã được chấp nhận.

Các tham số gửi

Endpoint gửi là POST /hpbx/fax/send/{billing_code}. Thao tác này thực sự gửi dữ liệu. Trước khi gửi, hãy chuẩn bị tệp và đích đã được tài khoản cho phép; đừng gửi lại khi chưa kiểm tra kết quả của lần gửi trước đang chưa rõ.

TrườngÝ nghĩa
numberSố fax đích.
cidnumSố định danh người gọi đã được phê duyệt để dùng khi gửi.
scheduleThời gian gửi theo lịch, khi được sử dụng.
faxquality / pagesize / pagerotateCác tùy chọn chất lượng, khổ giấy và xoay trang được hỗ trợ.
statusemailĐịa chỉ được phép dùng cho thông báo kết quả gửi.
deleteaftersendCho biết có nên xóa tệp đã tải lên được lưu trữ sau khi gửi hay không.
filenameTham chiếu tài liệu mà quy trình fax này mong đợi; không phải là đường dẫn tệp cục bộ tùy ý.

Theo dõi việc hoàn thành

Sau khi yêu cầu gửi, hãy kiểm tra trạng thái, số lần thử và lỗi trong bản ghi fax. Xác nhận fax đã được gửi đến đích; đừng coi việc hệ thống chấp nhận yêu cầu là bằng chứng fax đã được gửi đến nơi. Tài liệu tham khảo fax của cổng thông tin mô tả quy trình tải lên và gửi hiện tại; đường dẫn và cơ chế xác thực của quy trình này tách biệt với điểm cuối ở trên.

Tìm kiếm tài liệu