Hàm kiểm tra trạng thái tin nhắn theo khoảng thời gian

API cho phép đối tác lấy sản lượng tin nhắn trong một khoảng thời gian.

HTTP request

POST https://rest.esms.vn/MainService.svc/json/GetSmsSentData_V2

  • Content Type: application/json

  • Response Type: application/json

curl --location 'https://rest.esms.vn/MainService.svc/json/GetSmsSentData_V2' \
--header 'Content-Type: application/json' \
--data '{
    "ApiKey": "{{ApiKey}}",
    "SecretKey": "{{SecretKey}}",
    "SmsType": "2",
    "From": "2025-01-01 06:00:00",
    "To": "2025-01-02 18:00:00",
    "Page": 1,
    "PageSize": 500
}'

Cấu trúc body của request:

Tham số
Kiểu dữ liệu
Tính bắt buộc
Mô tả

ApiKey

string

ApiKey eSMS cung cấp.

SecretKey

string

SecretKey eSMS cung cấp.

From

string

Lấy dữ liệu từ ngày nào (theo ngày tạo tin) Định dạng: yyyy-MM-dd HH:mm:ss.

To

string

Lấy dữ liệu đến ngày nào (theo ngày tạo tin). Định dạng: yyyy-MM-dd HH:mm:ss.

Page

string

Lấy bắt đầu từ trang bao nhiêu.

PageSize

string

Số lượng tin nhắn cần xem (tối đa 500 tin nhắn).

SmsType

string

Loại tin nhắn 1: Tin quảng cáo. 2: Tin CSKH. 8: Tin Cố định giá rẻ. 23: Tin Viber. 24: Zalo ưu tiên. 25: Zalo bình thường.


  • Response:

{
    "CodeResult": "100",
    "CountTotal": 2
    "SentData": [
        {
            "Campaign": "Chiến dịch 02/10/2023",
            "Content": "Cam on quy khach da su dung dich vu cua chung toi. Chuc quy khach mot ngay tot lanh!",
            "Phone": "0901888484",
            "ReferenceId": "35781d6c25524e40a035c26663189549",
            "SellPrice": 345.0,
            "SendResult": 0,
            "SendStatus:5,
            "SentTime": "/Date(1705484048995+0700)/",
            "SmsId": 29028845,
            "SmsType": 2
        },
        {
            "Campaign": "Chiến dịch 02/10/2023",
            "Content": "Cam on quy khach da su dung dich vu cua chung toi. Chuc quy khach mot ngay tot lanh!",
            "Phone": "0901888484",
            "ReferenceId": "0aac72e0-ba9b-4348-8530-d18d105778db18",
            "SellPrice": 790.0000,
            "SendResult": 1,
            "SendStatus:5,
            "SentTime": "/Date(1705484048995+0700)/",
            "SmsId": 29028845,
            "SmsType": 2
        }
    ]

Request hợp lệ.

Cấu trúc body của response:

Thuộc tính
Kiểu dữ liệu
Mô tả

CodeResult

string

Mã trả về.

CountTotal

string

Tổng số tin nhắn.

SentData

array

Chi tiết tin nhắn.

Câu trúc thuộc tính từng object trong SentData

Thuộc tính
Kiểu dữ liệu
Mô tả

Campaign

string

Tên chiến dịch.

Lấy dữ liệu của tham số campaignid khi request gửi tin.

Content

string

Nội dung tin nhắn.

Phone

string

Số điện thoại nhận tin nhắn.

ReferenceId

string

SmsId trả về từ các hàm gửi tin nhắn.

SellPrice

string

Giá của tin.

SendResult

string

Kết quả cuối của tin nhắn

1: Tin đã được gửi thành công. 0: Tin thất bại. 2: Tin chưa xác định trạng thái.

SendStatus

string

Trạng thái tin nhắn: 0: Đang soạn thảo. 1: Chờ duyệt. 2: Chờ gửi. 4: Từ chối. 5: Đã gửi xong (Kiểm tra thêm SendResult để biết tin gửi thành công hay thất bại). 7: Đã gửi chờ báo cáo

SentTime

string

Thời gian gửi tin.

SmsId

string

Id của tin nhắn trên giao diện eSMS

SmsType

string

Loại tin nhắn 1: Tin quảng cáo. 2: Tin CSKH. 8: Tin Cố định giá rẻ. 23: Tin Viber. 24: Zalo ưu tiên. 25: Zalo bình thường.

  • Thông tin chi tiết mã lỗi xem ở bảng: Mã lỗi .

  • Lấy code mẫu các ngôn ngữ trên Postman: Link code mẫu.

Last updated