Lấy danh sách mẫu tin

Lưu ý:

• Đối với các API sử dụng cho Shop thì API key:<api_key>.Thông tin base_url của Shop

• Đối với các API sử dụng cho Partner thì API key:<shop_key>.Thông tin base_url của Partner

ListTemplates

POST$BASE_URL.Zalo/ListTemplates

Body

application/json

filtermrFilterListTemplates (object)

pagingktCursorPaging (object)

Response

200

A successful response

Body

application/json

pagingktCursorPageInfo (object)

templatesarray of mrZlOATemplate (object)

Request

JavaScriptCurlPython

const response = await fetch('$BASE_URL.Zalo/ListTemplates', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "paging": {
    "after": "text",
    "before": "text",
    "limit": 0,
    "next": "text",
    "prev": "text",
    "sort": "text"
  },
  "templates": [
    {
      "apply_template_quota": false,
      "created_at": "2025-01-07T01:33:14.085Z",
      "preview_url": "text",
      "price": 0,
      "template_daily_quota": 0,
      "template_id": 0,
      "template_name": "text",
      "template_params": [
        {
          "accept_null": false,
          "max_length": 0,
          "min_length": 0,
          "name": "text",
          "require": false,
          "type": "text"
        }
      ],
      "template_quality": "unknown",
      "template_remaining_quota": 0,
      "template_status": "unknown",
      "template_tag": "unknown",
      "timeout": 0,
      "type": "unknown",
      "updated_at": "2025-01-07T01:33:14.085Z"
    }
  ]
}

Request:

curl --location '$BASE_URL.Zalo/ListTemplates' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer $API_KEY' \
--data '{
  "filter": {
    "date_from": "2023-07-24T14:15:22Z",
    "date_to": "2023-08-02T14:15:22Z"
  },
  "paging": {
    "limit": 50
  }
}'

Response:

{
  "paging": {
    "after": "string",
    "before": "string",
    "limit": 0,
    "next": "string",
    "prev": "string",
    "sort": "string"
  },
  "templates": [
    {
      "apply_template_quota": true,
      "created_at": "2019-08-24T14:15:22Z",
      "price": 0,
      "template_daily_quota": 0,
      "template_id": 0,
      "template_name": "string",
      "template_params": [
        {
          "accept_null": true,
          "max_length": 0,
          "min_length": 0,
          "name": "string",
          "require": true,
          "type": "string"
        }
      ],
      "template_quality": "unknown",
      "template_remaining_quota": 0,
      "template_status": "unknown",
      "template_tag": "unknown",
      "timeout": 0,
      "type": "unknown",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Cấu trúc body của request

Tham số	Kiểu dữ liệu	Mô tả
oa_id	int64	ID của OA
type	string	Enum: "unknown" "text" "otp" "table" "rating"
template_id	integer	ID của mẫu tin
template_name	string	Tên mẫu tin
date_from	string<date-time>	Ngày bắt đầu
date_to	string<date-time>	Ngày kết thúc

Cấu trúc thuộc tính dữ liệu trả về

Tham số	Kiểu dữ liệu	Mô tả
template_id	integer	ID của mẫu tin
template_name	string	Tên của mẫu tin
price	integer	Đơn giá của mẫu tin
timeout	integer	Thời gian tính phí của mẫu tin
apply_template_quota	boolean	True False
template_daily_quota	integer	Số lượng tin ZNS có thể gửi trong 1 ngày
template_quality	string	unknown: Không xác định UNDEFINED: Mức độ chất lượng OA chưa được xác định (trường hợp OA không gửi thông báo ZNS nào trong khung thời gian đánh giá) LOW: Mức độ chất lượng kém MEDIUM: Mức độ chất lượng trung bình HIGH: Mức độ chất lượng cao
template_remaining_quota	integer	Số lượng tin ZNS có thể gửi còn lại trong 1 ngày
template_status	string	Trạng thái mẫu tin unknown: Không xác định PENDING_REVIEW: Đang duyệt DISABLE: Bị khóa ENABLE: Đã duyệt REJECT: Bị từ chối
template_tag	string	Cấp độ mẫu tin unknown: Không xác định OTP: Tin OTP (tag 0) IN_TRANSACTION: Xác nhận/Cập nhật thông tin giao dịch (Tag 1) POST_TRANSACTION: Hỗ trợ dịch vụ liên quan sau giao dịch (Tag 2) ACCOUNT_UPDATE: Cập nhật thông tin tài khoản (Tag 3) GENERAL_UPDATE: Thay đổi thông tin dịch vụ (Tag 4) FOLLOW_UP: Thông báo ưu đãi đến khách hàng cũ (Tag 5)
template_params	array object	Danh sách các thuộc tính của mẫu tin
updated_at	string<date-time>	Thời gian cập nhật
created_at	string<date-time>	Thời gian tạo