API Gửi tin sử dụng hash phone

Lưu ý

Quyền cần có: Gửi tin qua số điện thoại

HTTP request

• URL: https://business.openapi.zalo.me/message/template/hashphone
• Method: POST
• Content Type: application/json
• Response Type: application/json

Example request

curl --location 'https://business.openapi.zalo.me/message/template/hashphone' \
--header 'Content-Type: application/json' \
--header 'access_token: your_access_token' \
--data '{
    "hash_phone": "544bcae26adc08abc55ec3db75887109eacf8bfe65a2150bc8db2802403d57f2",
    "template_id": "7895417a7d3f9461cd2e",
    "template_data": {
        "ky": "1",
        "thang": "4/2020",
        "start_date": "20/03/2020",
        "end_date": "20/04/2020",
        "customer": "Nguyễn Thị Hoàng Anh",
        "cid": "PE010299485",
        "address": "VNG Campus, TP.HCM",
        "amount": "100",
        "total": "100000",
     },
    "tracking_id":"tracking_id"
}'

Tham số header

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

Cấu trúc body của request

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
hash_phone	string	yes	Số điện thoại của người nhận. Lưu ý: Số điện thoại cần được mã hóa SHA-256 (hash) trước khi truyền vào.
template_id	string	yes	ID của template muốn sử dụng. template_id sẽ được phía Zalo cung cấp riêng cho từng đối tác.
template_data	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 template_data được quy định riêng ứng với từng template.
tracking_id	string	yes	Mã số đánh dấu lần gọi API của đối tác, do đối tác định nghĩa. Đối tác có thể dùng tracking_id để đối soát mà không phụ thuộc vào message_id của Zalo cung cấp. Lưu ý: Zalo khuyến khích sử dụng tham số có độ dài tối đa 48 ký tự và không chứa kí tự đặc biệt.

Ghi chú: API có hỗ trợ mã hoá AES/CBC/PKCS5Padding. Chi tiết sẽ được trao đổi cụ thể trong lúc thực thi tích hợp nếu doanh nghiệp có yêu cầu.

Example respond

{
    "error": 0,
    "message": "Success",
    "data": {
           "msg_id": "a4d0243feee163bd3af2",
             "sent_time": "1626926349402",
             "sending_mode": "1",
             "quota": {
                "dailyQuota": "500",
                "remainingQuota": "499"
             }
    }
}

Cấu trúc thuộc tính data

Thuộc tính	Kiểu dữ liệu	Mô tả
msg_id	string	ID của tin qua SĐT.
sent_time	string	Thời gian gửi tin qua SĐT (định dạng timestamp).
sending_mode	string	Bao gồm giá trị: 1: tin qua SĐT được gửi theo cơ chế thông thường.
quota	object	Thông tin quota tin qua SĐT của OA.

Cấu trúc thuộc tính data.quota

Thuộc tính	Kiểu dữ liệu	Mô tả
dailyQuota	string	Số lượng tin qua SĐT được gửi trong 1 ngày của OA. Lưu ý: Hạn mức gửi tin qua SĐT mỗi ngày của OA sẽ tự động được điều chỉnh dựa theo chất lượng và nhu cầu gửi. Xem thêm chi tiết về cơ chế đánh giá chất lượng và quyền lợi gửi tin qua SĐT tại đây.
remainingQuota	string	Số lượng tin qua SĐT còn lại trong ngày.