Hàm lấy thông tin chi tiết template Zalo

HTTP request

GET https://rest.esms.vn/MainService.svc/json/GetZnsTemplateInfo?TemplateId={{TemplateId}}&ApiKey={{ApiKey}}&SecretKey={{SecretKey}}&OAId={{OAId}}

• Response Type: application/json

curl --location -g 'https://rest.esms.vn/MainService.svc/json/GetZnsTemplateInfo?TemplateId={{TemplateId}}&ApiKey={{ApiKey}}&SecretKey={{SecretKey}}&OAId={{OAId}}'

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

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
TemplateId	string		Template của Zalo OA mà khách hàng đăng kí với eSMS.
ApiKey	string		ApiKey của tài khoản
SecretKey	string		SecretKey của tài khoản
OAId	string		Zalo OA ID, là ID của trang Zalo Offical Account của doanh nghiệp. Doanh nghiệp cần đăng nhập vào trang quản trị của Zalo OA để lấy phần Zalo OA ID này. Chú ý: sẽ phải đăng ký trước khi sử dụng.

---

• Response:

100

{
    "Data": {
        "ListButtons": [
            {
                "Content": "https://oa.zalo.me/4097311281936189049",
                "Title": "Quan tâm OA",
                "Type": 2
            }
        ],
        "ListParams": [
            {
                "AcceptNull": false,
                "MaxLength": 100,
                "MinLength": 0,
                "Name": "customer_name",
                "Require": true,
                "Type": "STRING"
            },
            {
                "AcceptNull": false,
                "MaxLength": 100,
                "MinLength": 0,
                "Name": "product_name",
                "Require": true,
                "Type": "STRING"
            },
            {
                "AcceptNull": false,
                "MaxLength": 30,
                "MinLength": 0,
                "Name": "order_code",
                "Require": true,
                "Type": "STRING"
            },
            {
                "AcceptNull": false,
                "MaxLength": 30,
                "MinLength": 0,
                "Name": "date",
                "Require": true,
                "Type": "STRING"
            }
        ],
        "PreviewUrl": "https://account.zalo.cloud/znspreview/NqFkYJ14yilzdlAXteG_rQ==",
        "Reason": "Template đã được duyệt",
        "Status": "ENABLE",
        "TemplateId": 267247,
        "TemplateName": "Đánh giá dịch vụ - text",
        "TemplateQuality": "null",
        "TemplateTag": "TRANSACTION",
        "Timeout": 7200000
    },
    "Error": 0,
    "Message": "Success"
}

Request lợp lệ.

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

Thuộc tính	Kiểu dữ liệu	Định nghĩa
Data	object	Thông tin chi tiết template.
Error	string	Mã trả về.
Message	string	Thông tin lỗi trả về (nếu có lỗi).

Cấu trúc thuộc tính từng object trong Data

Thuộc tính	Kiểu dữ liệu	Định nghĩa
PreviewUrl	string	Đường dẫn đến bản xem trước của template.
Reason	string	Lý do template có trạng thái hiện tại: - DISABLE/REJECT: Chi tiết lý do khi template ở trạng thái Disable hoặc Reject. - ENABLE: Template đã được duyệt. - DELETE: Template đã bị xóa. - PENDING_REVIEW: Template đang được kiểm duyệt.
Status	string	Trạng thái template. Các trạng thái bao gồm: - ENABLE: Trạng thái template được kích hoạt, có thể sử dụng để gửi thông báo ZNS. - PENDING_REVIEW: Trạng thái template chờ kiểm duyệt. - DELETE: Trạng thái template bị xóa. - REJECT: Trạng thái template bị từ chối. - DISABLE: Trạng thái template bị hủy kích hoạt.
TemplateId	string	ID của template.
TemplateName	string	Tên của template.
TemplateQuality	string	Trả về giá trị null cho trường thông tin này.
TemplateTag	string	Loại nội dung của template. Các giá trị trả về: - TRANSACTION: Giao dịch - CUSTOMER_CARE: Chăm sóc khách hàng - PROMOTION: Hậu mãi
Timeout	long	Thời gian timeout của template.
ListButtons	array	Danh sách các buttons/CTAs của template Chỉ áp dụng với 2 loại CTA: primary và secondary. Không hiển thị các CTA từ image module và response button.
ListParams	array	Danh sách các thuộc tính của template.

Cấu trúc thuộc tính từng object trong ListButtons

Thuộc tính	Kiểu dữ liệu	Định nghĩa
Content	string	Đường dẫn liên kết/số điện thoại.
Title	string	Nội dung Button.
Type	integer	Danh sách button: 1: Đến trang của doanh nghiệp 2: Gọi điện 3: Đến trang thông tin OA 4: Đến ứng dụng Zalo Mini App của doanh nghiệp 5: Đến trang tải ứng dụng 6: Đến trang phân phối sản phẩm 7: Đến trang web/Zalo Mini App khác 8: Đến ứng dụng khác

Cấu trúc thuộc tính từng object trong ListParams

Thuộc tính	Kiểu dữ liệu	Định nghĩa
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	integer	Số kí tự tối đa được truyền vào thuộc tính.
MinLength	integer	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.

• 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.