Gửi ZNS Journey

Khi có nhu cầu gửi ZNS theo hành trình cho hành trình giao vận hoặc vé xe khách, bạn có thể sử dụng chuỗi tin ZNS Journey tương ứng với 1 trong 2 hành trình để tối ưu chi phí.

Mô hình ZNS Journey

• Một ZNS Journey được định nghĩa là một chuỗi các tin ZNS gửi đến 1 khách hàng, tính phí theo một mô hình riêng (thay vì theo từng tin).

• ZNS Journey hiện tại được chia theo 2 industries chính:

  • Logistics: Hành trình giao vận

  • Coach bus: Hành trình xe khách

• Các mẫu tin ZNS trong bộ ZNS Journey cần phải được khai báo trước khi sử dụng.

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": "84962938734",
    "type": "JORNEY",
    "templateId": "369217",
    "templateData": {
        "date": "01/01/1970",
        "name": "name_sample",
        "price": 1000,
        "status": "status_sample",
        "order_code": "order_code_sample",
        "phone_number": "phone_number_sample"
    }
}'

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])
type	string	yes	JORNEY : Đối với tin Journey. NORMAL : Đối các tin thông thường
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.
tokenType	string	no	Loại Journey token muốn khởi tạo, bao gồm token_logistics_7 token_logistics_30 token_coach_bus_7 token_coach_bus_30

⚠️ Lưu ý Journey token gồm 4 loại chính, bao gồm:

Industry	Token type	Journey token
Giao vận	token_logistics_7	Token hành trình giao vận 7 ngày
Giao vận	token_logistics_30	Token hành trình giao vận 30 ngày
Xe khách	token_coach_bus_7	Token hành trình xe khách 7 ngày
Xe khách	token_coach_bus_30	Token hành trình xe khách 30 ngày

• Nếu tham số tokenType không được truyền, mặc định tokenType = token_logistics_7.

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