Nhà phát triển

GET/v3/fax_inbox

Liệt kê fax đã nhận

Đọc hộp thư fax đến với chức năng phân trang, tìm kiếm số điện thoại và lọc theo ngày nhận.

Trên trang này
  1. Liệt kê fax đã nhận
  2. Đọc một trang hộp thư
  3. Xử lý danh sách trống và danh sách thay đổi
  4. Truy cập tài liệu và quyền riêng tư

Liệt kê fax đã nhận

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 liệt kê các fax đã nhận thuộc tài khoản đã xác thực. Nó không gửi fax hoặc tải xuống tài liệu của fax.

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
Các tham số truy vấn hộp thư đến
Tham sốBắt buộcÝ nghĩa
pageKhôngSố trang, bắt đầu từ 1. Mặc định: 1.
limitKhôngSố bản ghi trên mỗi trang. Mặc định: 25; tối đa: 100. Sử dụng số nguyên dương.
searchKhôngTìm kiếm trong số điện thoại gửi, số fax nhận và mã định danh trạm từ xa. Khoảng trắng ở đầu và cuối được loại bỏ. Việc phân biệt chữ hoa và chữ thường phụ thuộc vào quy tắc đối chiếu của cơ sở dữ liệu.
date_fromKhôngBao gồm các fax từ đầu ngày này theo giờ địa phương của máy chủ. Sử dụng định dạng YYYY-MM-DD.
date_toKhôngBao gồm các fax cho đến hết ngày này theo giờ địa phương của máy chủ. Sử dụng định dạng YYYY-MM-DD.

Các giới hạn ngày bao gồm cả hai đầu mốc và sử dụng cách diễn giải ngày của máy chủ API, không theo múi giờ người dùng yêu cầu. Chuỗi ngày không hợp lệ có thể bị bỏ qua thay vì bị từ chối; hãy kiểm tra tính hợp lệ trước khi gửi. Khi không có bộ lọc ngày, trình xử lý không áp dụng khoảng ngày mặc định. Kết quả được sắp xếp theo thời gian nhận, mới nhất trước. Điểm cuối không cung cấp ảnh chụp dữ liệu ổn định xuyên suốt các trang: fax mới đến có thể khiến bản ghi chuyển từ trang này sang trang khác.

Đọc một trang hộp thư

Đọc kết quả HTTP và trường status.code trong JSON. Lỗi ở các phần khác của API có thể được trả về trong cấu trúc bao lỗi JSON ngay cả khi trạng thái HTTP là 200. Phản hồi thành công chứa response.faxes và response.pagination. Ví dụ này sử dụng các giá trị hư cấu.

{
  "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 là mã định danh dạng số của bản ghi trong hộp thư đến. hash là dạng biểu diễn MD5 của mã đó, dùng cho quy trình tài liệu fax đến kiểu cũ; đây không phải mã định danh tác vụ send_fax hay thông tin xác thực cấp quyền. Không sử dụng giá trị này với điểm cuối fax đi fax_status.

received_timestamp là dấu thời gian Unix đã lưu. received_at là dấu thời gian do máy chủ định dạng, không kèm độ lệch múi giờ, hoặc là null nếu không ghi nhận thời gian nhận; hãy sử dụng giá trị Unix khi hiển thị thời gian theo múi giờ của bạn. cost là một số trong JSON, không phải báo giá hoặc bằng chứng cho một khoản phí riêng biệt đã được thu.

status chỉ có giá trị success khi mã trạng thái đã lưu bằng không; các giá trị khác trở thành failed. status_text chứa thông báo xử lý đã lưu, với OK hoặc Failed làm giá trị dự phòng. emailed giữ nguyên giá trị đã lưu thay vì chuyển thành giá trị luận lý. viewed là một giá trị luận lý. Không suy ra rằng email đã được chuyển thành công chỉ dựa vào trạng thái fax.

Xử lý danh sách trống và danh sách thay đổi

Hộp thư trống trả về mảng faxes trống, total bằng 0 và total_pages bằng 0. Trang nằm sau trang cuối cũng có thể trả về mảng trống. Hãy dừng theo các trường phân trang thay vì giả định rằng luôn có ít nhất một trang. Không có con trỏ phân trang hoặc tiêu chí sắp xếp phụ theo mã định danh bản ghi được cung cấp. Hãy lưu giữ mã định danh bản ghi khi đối soát các trang có bản ghi trùng nhau.

Truy cập tài liệu và quyền riêng tư

Các mục trong hộp thư chứa siêu dữ liệu riêng tư về điện thoại và tài liệu. Hãy hạn chế quyền truy cập trong ứng dụng và tránh ghi toàn bộ phản hồi vào nhật ký. Việc liệt kê không đánh dấu tài liệu là đã xem. Sử dụng fax_file để tải xuống tài liệu fax đến qua cơ chế tương thích; lưu ý rằng thao tác này đánh dấu bản ghi fax đến hiện có là đã xem ngay cả khi tệp của bản ghi đó không khả dụng. Bạn cũng có thể truy cập tài liệu qua hộp thư đến trên cổng thông tin. Chưa có cam kết bảo đảm nào về việc lưu giữ tệp.