/get/bounce

Description

Api liệt kê danh sách các email không gửi được trong ngày với trạng thái lỗi là “bounced”. Nếu người dùng cung cấp thời gian date xác định thì api sẽ trả ra danh sách các email bị lỗi trong ngày tương ứng. Nếu không định nghĩa tham số date thì api sẽ lấy mặc định ngày hiện tại.

Chú ý: api này có thể/sẽ được thay thế (deprecated) bởi api /outbound

Method

  • POST

Parameters

api_key
  • Api key của người dùng.
  • Type: String
  • Required: Yes
date
  • Ngày tính thống kê
  • Type: String
  • Valid values: date format(yyyy-mm-dd).
  • Required: No. Nếu thời gian truyền vào bị sai format hoặc không được cung cấp thì sẽ lấy mặc định ngày hiện tại của hệ thống
skip
  • Số lượng document bỏ qua ko trả về, giúp cho hệ thống phân trang.
  • Type: Integer
  • Required: No. Nếu không cung cấp thì sẽ lấy giá trị mặc định là 0,tức là trả về trang kết quả đầu tiên
limit
  • Giới hạn số lượng dữ liệu trả về
  • Type: Integer
  • Valid values: Number
  • Required: No. Nếu tham số giới hạn truyền vào bị sai format hoặc không được cung cấp thì sẽ không xác định giới hạn cho kết quả trả về(Lấy tất cả)

Response

result
  • Định nghĩa trạng thái kết quả trả về. Trong trường hợp giá trị là false thì kết quả trả ra bao gồm trường error định nghĩa lỗi. Ngược lại thì response sẽ bao gồm các trường dữ liệu khác bên dưới.
  • Type: Boolean
  • Valid values: true | false
error
  • Định nghĩa lỗi sảy ra trong quá trình truy vấn api
  • Type: String
  • Valid values: No
date
  • Ngày sử dụng làm mốc để thống kê
  • Type: String
  • Valid values: date format(yyyy-mm-dd).
total
  • Tổng số document có thể trả về của hệ thống
  • Type: Integer
  • Valid values: No
skip
  • Số lượng document bỏ qua không trả về
  • Type: Integer
  • Valid values: No
limit
  • Giới hạn số lượng tối đa dữ liệu trả về
  • Type: Integer
  • Valid values: No
data
  • Mảng dữ liệu trả về, mỗi phần tử là một thông tin trạng thái gửi email(sender_email, time, email, subject, diagnosticCode)
  • Type: Array
  • Valid values: Có thể chứa từ 0 tới nhiều phần tử.