Gửi ZNS OTP

ZNS OTP (Zalo Notification Service One Time Password) là mã xác thực một lần (OTP) được gửi đến người dùng Zalo thông qua dịch vụ Zalo Notification Service (ZNS).

HTTP request

• URL: https://apis.infinix.vn/v1/zns/<slug-api-key>/send-message-template

• Method: POST

• Content Type: application/json

• Response Type: application/json

Example request

curl --location 'https://apis.infinix.vn/v1/zns/vng-oa-key-0a65/send-message-template'
--header 'api-key: 6829c1b8a87b979819a760d908fa8a0' \
--header 'Content-Type: application/json' \
--data '{
    "phone": "84962938733",
    "templateId": "369222",
    "templateData": {
        "otp:"44231"
    },
    "fallbackList": [
        {
            "method": "SMS",
            "templateId": "1",
            "templateData": {
                "otp_code": "843176",
                "expire_time": "20"
            }
        }
    ],
    "fallbackSLA": 15
}'

Tham số header

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
api-key	string	yes	Đoạn mã cần truyền vào để xác minh quyền sử dụng API

Cấu trúc body request

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
phone	string	yes	SĐT của người nhận. Lưu ý: SĐT phải được liên kết với tài khoản Zalo và được viết ở định dạng chuẩn hóa theo mã quốc gia. (VD: SĐT [phone] viết theo định dạng chuẩn hóa của Việt Nam là 84987654321 hoặc [phone])
templateId	string	yes	ID của template muốn sử dụng. templateId sẽ được phía Zalo cung cấp riêng cho từng đối tác.
templateData	JSON Object	yes	Các thuộc tính của template mà đối tác đã đăng ký với Zalo. Lưu ý: Cấu trúc templateData được quy định riêng ứng với từng template.
fallbackList	Array Object	no	Danh sách fallback
fallbackSLA	number	yes if fallbackList	Require khi có sử dụng fallback. Sẽ fallback nếu như người dùng chưa nhận được thông báo sau một khoảng thời gian, tuỳ thuộc vào nhu cầu của khách hàng

• Cấu trúc fallbackList

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
method	enum string - ZNS - SMS	yes	Phương thức fallback tin nhắn
templateId	string	yes	ID của template muốn fallback
templateData	JSON Object	yes	Các thuộc tính của template mà đối tác đã đăng ký với InfiniX. Lưu ý: Cấu trúc templateData được quy định riêng ứng với từng template.

Example response

{
    "success": true,
    "data": {
        "phone": "84962938734",
        "type": "NORMAL",
        "createdAt": "2024-10-07T09:13:10.351Z",
        "status": "PENDING"
    },
    "meta": {
        "sessionId": "e7202e25-6605-4efe-9856-7c9d8e0b7516"
    }
}

Cấu trúc các thuộc tính response

Tham số	Kiểu dữ liệu
phone	string	Số điện thoại người nhận
type	string	Loại tin ZNS được gửi
sessionId	string	Mỗi request sẽ sinh ra 1 sessionId để nhận diện
createdAt	Date	Thời gian khởi tạo request
status	string	Trạng thái của request