Lấy thông tin quota ZNS

API cho phép đối tác truy xuất thông tin quota (số lượng) thông báo ZNS OA được gửi mỗi ngày.

HTTP request

URL: https://zns.api.gobysend.com/api/message/quota Method: GET Content Type: application/json Response Type: text/json

Example request

curl
-X GET
-H "Content-Type: application/json" "https://zns.api.gobysend.com/api/message/quota"

Tham số header

Tham số

Kiểu dữ liệu

Tính bắt buộc

Mô tả

string

yes

Đoạn mã cần truyền vào để xác minh quyền sử dụng API. Xem thêm tài liệu tham khảo

Example response

{
    "data": {
               "dailyQuota": 500,
               "remainingQuota": 499
    },
    "error": 0,
    "message": "success"
}

Cấu trúc thuộc tính data

Thuộc tính

Kiểu dữ liệu

Mô tả

dailyQuota

string

Số thông báo ZNS OA được gửi trong 1 ngày.

Lưu ý: Hạn mức gửi ZNS mỗi ngày của OA sẽ tự động được điều chỉnh dựa theo chất lượng và nhu cầu gửi. Xem thêm chi tiết về cơ chế đánh giá chất lượng và quyền lợi gửi ZNS tại đây.

remainingQuota

string

Số thông báo ZNS OA được gửi trong ngày còn lại.

English version:

HTTP request

URL: https://zns.api.gobysend.com/api/message/quota Method: GET Content Type: application/json Response Type: text/json

Example request

curl
-X GET
-H "Content-Type: application/json" "https://zns.api.gobysend.com/api/message/quota"

Header param

Param

Data type

Compulsory

Description

string

yes

The code that needs to be passed in to verify the permission to use the API. Reference document

Example response

{
    "data": {
               "dailyQuota": 500,
               "remainingQuota": 499
    },
    "error": 0,
    "message": "success"
}

Data attribute structure

Attribute

Data type

Description

dailyQuota

string

The zns message is allowed to be sent in one day. Note: OA's daily ZNS sending limit will automatically be adjusted based on sending quality and demand. See more details about the quality evaluation mechanism and benefits sent to ZNS here.

remainingQuota

string

The remaining ZNS message is allowed to be sent on the day.

Last updated