Links
Comment on page

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

  • HTTP request URL: http://rest.esms.vn/MainService.svc/json/GetZnsTemplateInfo?TemplateId={{TemplateId}}&ApiKey={{ApiKey}}&SecretKey={{SecretKey}}&OAId={{OAId}} Method: GET
curl --location 'http://rest.esms.vn/MainService.svc/json/GetZnsTemplateInfo?TemplateId={{TemplateId}}&ApiKey={{ApiKey}}&SecretKey={{SecretKey}}&OAId={{OAId}}' \
  • Thông tin request
Biến
Định nghĩa
TemplateId
Template của Zalo OA mà khách hàng đăng kí với eSMS.
ApiKey
ApiKey của tài khoản
SecretKey
SecretKey của tài khoản
OAId
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.
  • Mẫu kết quả trả về
{
"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"
}
  • Thông tin kết quả trả về
Biến
Định nghĩa
ApplyTemplateQuota
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
Đường dẫn đến bản xem trước của template.
Status
Trạng thái template.
TemplateDailyQuota
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
ID của template.
TemplateName
Tên của template.
TemplateQuality
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
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
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
Thời gian timeout của template.
AcceptNull
Thông tin cho biết thuộc tính có thể nhận giá trị rỗng hay không.
MaxLength
Số kí tự tối đa được truyền vào thuộc tính.
MinLength
Số kí tự tối thiểu được truyền vào thuộc tính.
Name
Tên thuộc tính.
Require
Tính bắt buộc của thuộc tính.
Type
Đị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