/outbound

Description

Api liệt kê danh sách các email đã gửi trong khoảng thời gian xác định hoặc trong vòng 7 ngày(một tuần) vừa qua.

  • Nếu người dùng cung cấp mốc thời gian date xác định thì hệ thống sẽ trả ra danh sách các email đã gửi trong vòng 7 ngày gần đây nhất bao gồm cả mốc thời gian cung cấp.
  • Nếu người dùng cung cấp tham số date nhưng bị sai định dạng, thì hệ thống sẽ lấy ra danh sách email đã gửi trong vòng 7 ngày gần đây nhất bao gồm cả mốc thời gian hiện tại
  • Nếu người dùng cung cấp khoảng thời gian định nghĩa bằng from_dateto_date thì sẽ trả về danh sách các email đã gửi trong khoảng thời gian đó bao gồm cả mốc thời gian from_dateto_date
  • Nếu người dùng cung cấp tham số from_date hoặc to_date nhưng sai định dạng, thì hệ thống sẽ lấy tham số from_date hoặc to_date bằng thời gian hiện tại.
  • Nếu người dùng không cung cấp bất kỳ thông tin nào về date, from_date, to_date thì hệ thống sẽ lấy ra danh sách đã gửi trong vòng 7 ngày gần đây nhất bao gồm cả ngày hiện tại

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 tham số không được truyền vào thì hệ thống sẽ xác định khoáng thời gian theo thuật toán định nghĩa ban trên.
from_date
  • Thời điểm bắt đầu tính thống kê.
  • Type: String
  • Valid values: date format(yyyy-mm-dd).
  • Required: No. Trong trường hợp không bình thường sẽ lấy khoảng thời gian định nghĩa theo thuật toán phía trên.
to_date
  • Thời điểm kết thúc 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 cung cấp thì sẽ lấy mặc định thời gian của hệ thống
status
  • Lọc dữ liệu trả về có trường status tương đương status được khai báo
  • Type: String
  • Valid values: “complaint” | “sent” | “bounced”
  • Required: No. Nếu dữ liệu không được cung cấp thì sẽ không áp dụng lọc kết quả trả về theo phương thức này
email
  • Lọc dữ liệu phù hợp với địa chỉ email của người nhận
  • Type: String
  • Valid values: No
  • Required: No. Nếu dữ liệu không được cung cấp thì sẽ không áp dụng lọc kết quả trả về theo phương thức này
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 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
from_date
  • Ngày bắt đầu được sử dụng làm mốc để thống kê
  • Type: String
  • Valid values: date format(yyyy-mm-dd).
to_date
  • Ngày kết thúc được sử dụng làm mốc để thống kê
  • Type: String
  • Valid values: date format(yyyy-mm-dd).
status
  • Trạng thái sử dụng để lọc dữ liệu trả về. Thông số được định nghĩa khi gọi api
  • Type: String
  • Valid values: No
email
  • Địa chỉ email sử dụng để lọc dữ liệu trả về. Thông số được định nghĩa khi gọi api
  • Type: String
  • Valid values: No
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
  • Valid values: No
  • Valid values: No
  • 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( status, sender_email, time, email, subject,...)
  • Type: Array
  • Valid values: Có thể chứa từ 0 tới nhiều phần tử.