Gửi SMS

API sử dụng để gửi tin nhắn SMS đến người dùng thông qua số điện thoại

HTTP request

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": "1",
    "templateData": {
        "otp_code": "123123",
        "expire_time": 10
    },
    "trackingId": "13d1d775-3f65-4149-91a7-f6e4fd805ee7"
}'

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 viết ở định dạng chuẩn hóa theo mã quốc gia. (VD: SĐT 0987654321 viết theo định dạng chuẩn hóa của Việt Nam là 84987654321 hoặc +84987654321)

templateId

string

yes

ID của template muốn sử dụng. templateId sẽ được phía InfiniX 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ý ứng với template. Lưu ý: Cấu trúc templateData được quy định riêng ứng với từng template.

trackingId

string

no

ID tuỳ chỉnh từ phía đối tác để theo dõi tin nhắn. Nếu như đối tác không truyền trackingId, hệ thống InfiniX sẽ tự sinh ra một trackingId Lưu ý: Chỉ hỗ trợ UUID hoặc MongoDB ObjectId

sync

boolean

no

Sử dụng api ở cơ chế đồng bộ hoặc bất đồng bộ - True: Đồng bộ - sẽ chờ đợi để trả về kết quả của request ZNS qua Zalo - False: Bất đồng bộ - sẽ trả về ngay requestId và sử dụng api Get Result để lấy kết quả request ZNS

Example response

{
    "success": true,
    "code": 0,
    "data": {
        "phone": "84963197515",
        "createdAt": "2025-08-05T08:33:09.886Z",
        "status": "PENDING",
        "trackingId": "6178d622-edfa-4b7b-9d38-9b3b3e9c58a8"
    },
    "meta": {
        "sessionId": "7dfe21f7-9f66-4374-ac85-86322da3c384"
    }
}

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

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

trackingId

String

ID định danh được truyền từ phía khách hàng hoặc được sinh ra từ hệ thống InfiniX

Last updated