API gửi tin qua UID

Lưu ý

Quyền cần có: Gửi tin nhắn

HTTP request

• URL: https://openapi.zalo.me/v3.0/oa/message/template
• Method: POST
• Content Type: application/json
• Response Type: application/json

Example request

curl --location 'https://openapi.zalo.me/v3.0/oa/message/template' \
--header 'Content-Type: application/json' \
--header 'access_token: your_access_token' \
--data '{
    "user_id": "3485904339058348590",
    "template_id": "433555",
    "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"
    }
}'

Tham số header

Tham số	Loại	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ố	Loại	Bắt buộc	Mô tả
user_id	string	yes	ID của người nhận Định danh người dùng theo OA (nhận được thông qua API truy xuất chi tiết người dùng, API truy xuất danh sách người dùng, các event liên quan đến người dùng).
template_id	string	yes	ID của template muốn sử dụng. Sử dụng API để lấy danh sách template thuộc sở hữu của OA. Tham khảo
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.

Example response

1. Tin gửi ra là tin nằm trong hạn mức gói tính năng lẻ

{
  "data": {
    "quota": {
      "quota_type": "purchase_quota",
      "owner_type": "OA",
      "owner_id": "4462152339089565647"
    },
    "message_id": "63ecf43f0df7dba892e6",
    "user_id": "2512523625412515"
  },
  "sent_time": "1626926349402",
  "error": 0,
  "message": "Success"
}

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

Tham số	Loại	Mô tả
message_id	string	ID của thông báo
user_id	string	ID của người nhận
quota_type	string	Nguồn quota sử dụng. Mang giá trị: purchase_quota
owner_type	string	Thực thể sở hữu Quota Package. Giá trị: - OA: Thực thể sở hữu là OA - App: Thực thể sở hữu là App
owner_id	string	ID thực thể sở hữu Quota Package. Giá trị: OA ID hoặc App ID
sent_time	string	Thời gian gửi tin UID (định dạng timestamp).

2. Tin gửi ra là tin nằm trong hạn mức Redeem code

{
  "data": {
    "quota": {
      "quota_type": "reward_quota",
      "owner_type": "OA",
      "owner_id": "4462152339089565647"
    },
    "message_id": "63ecf43f0df7dba892e6",
    "user_id": "2512523625412515"
  },
  "sent_time": "1626926349402",
  "error": 0,
  "message": "Success"
}

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

Tham số	Loại	Mô tả
message_id	string	ID của thông báo
user_id	string	ID của người nhận
quota_type	string	Nguồn quota sử dụng. Mang giá trị: reward_quota
owner_type	string	Thực thể sở hữu Quota Package. Giá trị: - OA: Thực thể sở hữu là OA - App: Thực thể sở hữu là App
owner_id	string	ID thực thể sở hữu Quota Package. Giá trị: OA ID hoặc App ID
sent_time	string	Thời gian gửi tin UID (định dạng timestamp).

3. Tin gửi ra là tin tính phí

{
  "data": {
    "message_id": "63ecf43f0df7dba892e6",
    "user_id": "2512523625412515"
  },
  "sent_time": "1626926349402",
  "error": 0,
  "message": "Success"
}

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

Tham số	Loại	Mô tả
message_id	string	ID của thông báo
user_id	string	ID của người nhận
sent_time	string	Thời gian gửi tin UID (định dạng timestamp).