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": {
        "ApplyTemplateQuota": false,
        "ListParams": [
            {
                "AcceptNull": false,
                "MaxLength": 10,
                "MinLength": 0,
                "Name": "otp",
                "Require": true,
                "Type": "STRING"
            }
        ],
        "PreviewUrl": "https://zns.oa.zalo.me/znspreview/SZk01CLsjXTYpn_B4agO0g==",
        "Status": "ENABLE",
        "TemplateDailyQuota": null,
        "TemplateId": 205644,
        "TemplateName": "Xác nhận đăng ký dịch vụ",
        "TemplateQuality": "UNDEFINED",
        "TemplateRemainingQuota": null,
        "TemplateTag": "OTP",
        "Timeout": 15000
    },
    "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
ApplyTemplateQuota	string	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.
PreviewUrl	string	Đường dẫn đến bản xem trước của template.
Status	string	Trạng thái template.
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.
TemplateId	string	ID của template.
TemplateName	string	Tên 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
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.
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 giao dịch POST_TRANSACTION – Hỗ trợ dịch vụ liên quan sau giao dịch ACCOUNT_UPDATE – Cập nhật thông tin tài khoản GENERAL_UPDATE – Thay đổi thông tin dịch vụ FOLLOW_UP – Thông báo ưu đãi đến khách hàng cũ
Timeout	string	Thời gian timeout của template.
AcceptNull	string	Thông tin cho biết thuộc tính có thể nhận giá trị rỗng hay không.
MaxLength	string	Số kí tự tối đa được truyền vào thuộc tính.
MinLength	string	Số kí tự tối thiểu được truyền vào thuộc tính.
Name	string	Tên thuộc tính.
Require	string	Tính bắt buộc của thuộc tính.
Type	string	Định dạng validate của thuộc tính.

• Hiện tại số lần request là 1s cho 1 lần request

• Số ReferenceId tối đa cho 1 lần request là 100

• Thời gian request là vào lúc 01:00 đến 02:00 AM mỗi ngày

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