Lấy danh sách template

HTTP request

URL: https://zns.api.gobysend.com/api/template/all Method: GET Content Type: application/json Response Type: application/json

Example request

curl
-X GET
-H "Content-Type: application/json" "https://zns.api.gobysend.com/api/template/all?offset=0&limit=100&status=2"

Tham số header

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
access_token	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

Tham số

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
offset	int	yes	Thứ tự của template đầu tiên trong danh sách trả về. Lưu ý: Template được tạo gần nhất sẽ có thứ tự là 0.
limit	int	yes	Số lượng template muốn lấy. Lưu ý: Mỗi request được lấy tối đa 100 template.
status	int	no	Trạng thái của template muốn lấy. Các giá trị nhận vào: status = 1: Lấy các template có trạng thái Enable. status = 2: Lấy các template có trạng thái Pending review. status = 3: Lấy các template có trạng thái Reject. status = 4: Lấy các template có trạng thái Disable. status = 5: Lấy các template có trạng thái Delete. Lưu ý: Trường hợp không truyền vào tham số status, API sẽ trả về danh sách template thuộc mọi trạng thái.

Example response

{
    "error": 0,
    "message": "Success",
    "data": [
        {
            "createdAt": 1634720490.000000000,
            "updatedAt": 1634720490.000000000,
            "price": 300.0,
            "oaId": 5,
            "zaloOaId": "3409209006176399066",
            "templateId": 214430,
            "templateName": "OTP Xác nhận giao dịch",
            "status": "ENABLE",
            "templateQuality": "HIGH",
            "listParams": [
                {
                    "name": "otp",
                    "require": true,
                    "type": "STRING",
                    "maxLength": 10,
                    "minLength": 0,
                    "acceptNull": false
                }
            ],
            "timeout": 15000,
            "previewUrl": "https://zns.oa.zalo.me/znspreview/BISvOFghnw9uv3XOU6iz3g==",
            "templateTag": "OTP",
            "applyTemplateQuota": false,
            "templateDailyQuota": 0,
            "templateRemainingQuota": 0
        }
    ],
    "metadata": {
        "total": 1,
        "page": 0,
        "size": 10
    }
}

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

Thuộc tính	Kiểu dữ liệu	Mô tả
templateId	int	ID của template.
templateName	string	Tên của template.
status	string	Trạng thái template.
listParams	object array	Danh sách các thuộc tính của template.
timeout	long	Thời gian timeout của template.
previewUrl	string	Đường dẫn đến bản xem trước của template.
templateQuality	string	Chất lượng gửi tin hiện tại của template. Các giá trị trả về: HIGH MEDIUM LOW UNDEFINED Lưu ý: Trường hợp chất lượng gửi tin hiện tại của template là Low thì template có khả năng bị khóa. 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.
templateTag	string	Loại nội dung của template. Các giá trị trả về: OTP – OTP IN_TRANSACTION – Xác nhận/Cập nhật thông tin giao dịch POST_TRANSACTION – Thông báo hoàn tất giao dịch và hỗ trợ có liên quan ACCOUNT_UPDATE – Cập nhật thông tin tài khoản GENERAL_UPDATE – Cập nhật thay đổi về sản phẩm, dịch vụ
price	string	Đơn giá của template.
applyTemplateQuota	boolean	Trường thông tin cho biết template có áp dụng hạn mức Daily Quota hay không. Chú thích: Hạn mức Daily Quota chỉ áp dụng cho một số template đặc biệt mang tính thử nghiệm và đã trực tiếp được đăng ký với Zalo. Các template bình thường sẽ không bị ảnh hưởng bởi giới hạn này.
templateDailyQuota	string	Số tin ZNS thuộc template này OA được gửi trong ngày. Lưu ý: Trường thông tin này chỉ được trả về khi applyTemplateQuota = true.
templateRemainingQuota	string	Số tin ZNS thuộc template này OA được gửi trong ngày còn lại. Lưu ý: Trường thông tin này chỉ được trả về khi applyTemplateQuota = true.

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

Thuộc tính	Kiểu dữ liệu	Mô tả
name	string	Tên thuộc tính.
require	boolean	Tính bắt buộc của thuộc tính.
type	string	Định dạng validate của thuộc tính.
maxLength	int	Số kí tự tối đa được truyền vào thuộc tính.
minLength	int	Số kí tự tối thiểu được truyền vào thuộc tính.
acceptNull	boolean	Thông tin cho biết thuộc tính có thể nhận giá trị rỗng hay không.

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

Thuộc tính	Kiểu dữ liệu	Mô tả
total	int	Tổng số lượng template ứng với trạng thái đã truyền vào ở request. Lưu ý: Trường hợp không truyền vào tham số status, API sẽ trả về tổng số lượng template thuộc mọi trạng thái của OA.

English version:

HTTP request

URL: https://zns.api.gobysend.com/api/template/all Method: GET Content Type: application/json Response Type: application/json

Example request

curl
-X GET
-H "Content-Type: application/json" "https://zns.api.gobysend.com/api/template/all?offset=0&limit=100&status=2"

Header param

Param	Data type	Compulsory	Description
access_token	string	yes	The code that needs to be passed in to verify the permission to use the API. Reference document

Param

Param	Data type	Compulsory	Description
offset
limit
status