Bỏ qua để đến nội dung

Thông báo

~9 phút đọc

Cài đặt thông báo cá nhân và quy tắc định tuyến của tổ chức, push token, Web Push, liên kết Zalo, hộp thư trong app và widget.

MethodPathTóm tắtQuyềnNhóm tốc độTương tác
GET/v1/me/push-tokensDanh sách thiết bị nhận push của tôinotify.pref.selfreadScalar
POST/v1/me/push-tokensĐăng ký push token thiết bịnotify.pref.selfwriteScalar
DELETE/v1/me/push-tokens/{install_id}Thu hồi push token thiết bịnotify.pref.selfwriteScalar
GET/v1/me/widget-summaryTóm tắt dữ liệu cho Widget màn hình khoá / Homenotify.pref.selfreadScalar
GET/v1/me/zalo-linkTrạng thái liên kết Zalonotify.pref.selfreadScalar
POST/v1/me/zalo:linkLiên kết tài khoản Zalo OAnotify.pref.selfwriteScalar
POST/v1/me/zalo:verifyXác thực liên kết Zalonotify.pref.selfwriteScalar
GET/v1/notification-prefsCài đặt thông báo của cá nhânnotify.pref.selfreadScalar
PUT/v1/notification-prefsCập nhật cài đặt thông báo của cá nhânnotify.pref.selfwriteScalar
GET/v1/notification-rulesQuy tắc định tuyến thông báo của tổ chứcnotify.org_rule.managereadScalar
PUT/v1/notification-rulesCập nhật quy tắc định tuyến thông báo của tổ chứcnotify.org_rule.managewriteScalar
GET/v1/notificationsHộp thư thông báo trong appnotify.pref.selfreadScalar
POST/v1/notifications:mark-readĐánh dấu đã đọc thông báonotify.pref.selfwriteScalar
POST/v1/webpush/subscriptionsĐăng ký Web Push subscriptionnotify.pref.selfwriteScalar
GET/v1/webpush/vapid-keyLấy VAPID public key cho Web Pushnotify.pref.selfreadScalar

Danh sách thiết bị nhận push của tôi

Các cài đặt đang đăng ký push của chính người dùng (APNs, FCM, Web Push), chưa bị thu hồi. Token không bao giờ được trả lại: device_install_id là mã dùng cho DELETE /v1/me/push-tokens/{install_id}.

Quyền: notify.pref.self
  • Nhóm tốc độ: read
  • Phản hồi thành công 200: Danh sách push token của người dùng. — object, application/json
  • Mã lỗi: chỉ các mã lỗi chung ở Tổng quan
curl -sS -X GET "https://api.dongtien.pro/v1/me/push-tokens" \
-H "Authorization: Bearer $DT_API_KEY"

Mở trong tài liệu tương tác

Đăng ký push token thiết bị

Lưu token APNs, FCM hoặc WebPush cho tài khoản người dùng hiện tại (token được mã hoá trên server).

Quyền: notify.pref.self Idempotency-Key: tuỳ chọn
  • Nhóm tốc độ: write
  • Nội dung yêu cầu: object (application/json, bắt buộc)
  • Phản hồi thành công 200: Kết quả đăng ký token. — object, application/json
  • Mã lỗi riêng của endpoint: conflict, idempotency_in_flight, idempotency_key_reused
TênVị tríBắt buộcKiểuMô tả
idempotency-keyheaderKhôngstringKhoá chống gửi trùng (≤ 255 ký tự, nên là UUID). Giữ 24 giờ; gửi lại cùng khoá + cùng nội dung trả lại kết quả cũ.
curl -sS -X POST "https://api.dongtien.pro/v1/me/push-tokens" \
-H "Authorization: Bearer $DT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"device_install_id": "7b1f3c52-9d4e-4a6b-8e21-5c0f9a3d7e44",
"platform": "apns",
"environment": "production",
"token": "fcm:APA91bHun4MxP5kXz0sT3yQeLrVn8wAd2c",
"locale": "vi"
}'

Mở trong tài liệu tương tác

Thu hồi push token thiết bị

Huỷ đăng ký push token của thiết bị khi đăng xuất.

Quyền: notify.pref.self
  • Nhóm tốc độ: write
  • Phản hồi thành công 200: Đã thu hồi token. — object, application/json
  • Mã lỗi riêng của endpoint: resource_not_found, conflict
TênVị tríBắt buộcKiểuMô tả
install_idpathCóstring—
curl -sS -X DELETE "https://api.dongtien.pro/v1/me/push-tokens/$INSTALL_ID" \
-H "Authorization: Bearer $DT_API_KEY"

Mở trong tài liệu tương tác

Tóm tắt dữ liệu cho Widget màn hình khoá / Home

Cung cấp số dư tài khoản (tách xác thực và tạm tính), thu/chi hôm nay và số việc chờ duyệt mà không lộ STK hay PII.

Quyền: notify.pref.self
  • Nhóm tốc độ: read
  • Phản hồi thành công 200: Dữ liệu tóm tắt widget. — object, application/json
  • Mã lỗi: chỉ các mã lỗi chung ở Tổng quan
curl -sS -X GET "https://api.dongtien.pro/v1/me/widget-summary" \
-H "Authorization: Bearer $DT_API_KEY"

Mở trong tài liệu tương tác

Trạng thái liên kết Zalo

Trạng thái liên kết Zalo của người dùng hiện tại: chưa liên kết, đang chờ mã hay đã xác thực.

Quyền: notify.pref.self
  • Nhóm tốc độ: read
  • Phản hồi thành công 200: Trạng thái liên kết Zalo. — object, application/json
  • Mã lỗi: chỉ các mã lỗi chung ở Tổng quan
curl -sS -X GET "https://api.dongtien.pro/v1/me/zalo-link" \
-H "Authorization: Bearer $DT_API_KEY"

Mở trong tài liệu tương tác

Liên kết tài khoản Zalo OA

Tạo liên kết với Zalo ID để nhận thông báo ZBS.

Quyền: notify.pref.self
  • Nhóm tốc độ: write
  • Nội dung yêu cầu: object (application/json, bắt buộc)
  • Phản hồi thành công 200: Đã tạo liên kết Zalo. — object, application/json
  • Mã lỗi riêng của endpoint: conflict
curl -sS -X POST "https://api.dongtien.pro/v1/me/zalo:link" \
-H "Authorization: Bearer $DT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"zalo_user_id": "2512345678901234567"
}'

Mở trong tài liệu tương tác

Xác thực liên kết Zalo

Xác nhận mã OTP hoặc callback xác thực Zalo OA.

Quyền: notify.pref.self
  • Nhóm tốc độ: write
  • Nội dung yêu cầu: object (application/json, bắt buộc)
  • Phản hồi thành công 200: Xác thực hoàn tất. — object, application/json
  • Mã lỗi riêng của endpoint: conflict
curl -sS -X POST "https://api.dongtien.pro/v1/me/zalo:verify" \
-H "Authorization: Bearer $DT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"code": "482913"
}'

Mở trong tài liệu tương tác

Cài đặt thông báo của cá nhân

Lấy tuỳ chọn kênh, ngưỡng tiền vào, giờ yên lặng theo từng loại sự kiện của người dùng đang đăng nhập.

Quyền: notify.pref.self
  • Nhóm tốc độ: read
  • Phản hồi thành công 200: Danh sách thiết lập thông báo. — object, application/json
  • Mã lỗi: chỉ các mã lỗi chung ở Tổng quan
curl -sS -X GET "https://api.dongtien.pro/v1/notification-prefs" \
-H "Authorization: Bearer $DT_API_KEY"

Mở trong tài liệu tương tác

Cập nhật cài đặt thông báo của cá nhân

Lưu tuỳ chọn kênh, ngưỡng số tiền, giờ yên lặng của người dùng.

Quyền: notify.pref.self Idempotency-Key: tuỳ chọn
  • Nhóm tốc độ: write
  • Nội dung yêu cầu: object (application/json, bắt buộc)
  • Phản hồi thành công 200: Thiết lập sau khi lưu. — object, application/json
  • Mã lỗi riêng của endpoint: conflict, idempotency_in_flight, idempotency_key_reused
TênVị tríBắt buộcKiểuMô tả
idempotency-keyheaderKhôngstringKhoá chống gửi trùng (≤ 255 ký tự, nên là UUID). Giữ 24 giờ; gửi lại cùng khoá + cùng nội dung trả lại kết quả cũ.
curl -sS -X PUT "https://api.dongtien.pro/v1/notification-prefs" \
-H "Authorization: Bearer $DT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"prefs": [
{
"zalo": false,
"email": true,
"push": true,
"min_amount": "10000000",
"include_provisional": true,
"quiet_start": "22:00",
"quiet_end": "06:00",
"timezone": "Asia/Ho_Chi_Minh",
"params": {}
}
]
}'

Mở trong tài liệu tương tác

Quy tắc định tuyến thông báo của tổ chức

Lấy người nhận thông báo theo loại sự kiện và quyền của tổ chức.

Quyền: notify.org_rule.manage
  • Nhóm tốc độ: read
  • Phản hồi thành công 200: Danh sách quy tắc. — object, application/json
  • Mã lỗi: chỉ các mã lỗi chung ở Tổng quan
TênVị tríBắt buộcKiểuMô tả
company_idqueryCóOrgIdMã công ty / tổ chức (org_…).
curl -sS -X GET "https://api.dongtien.pro/v1/notification-rules?company_id=org_0f5k2m9q4h7t3n8r6v1w0x5yz0" \
-H "Authorization: Bearer $DT_API_KEY"

Mở trong tài liệu tương tác

Cập nhật quy tắc định tuyến thông báo của tổ chức

Chỉ Admin và Owner có quyền thay đổi danh sách người nhận thông báo theo sự kiện.

Quyền: notify.org_rule.manage Idempotency-Key: tuỳ chọn
  • Nhóm tốc độ: write
  • Nội dung yêu cầu: object (application/json, bắt buộc)
  • Phản hồi thành công 200: Quy tắc sau khi cập nhật. — object, application/json
  • Mã lỗi riêng của endpoint: conflict, idempotency_in_flight, idempotency_key_reused
TênVị tríBắt buộcKiểuMô tả
idempotency-keyheaderKhôngstringKhoá chống gửi trùng (≤ 255 ký tự, nên là UUID). Giữ 24 giờ; gửi lại cùng khoá + cùng nội dung trả lại kết quả cũ.
curl -sS -X PUT "https://api.dongtien.pro/v1/notification-rules" \
-H "Authorization: Bearer $DT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"company_id": "org_0f5k2m9q4h7t3n8r6v1w0x5yz0",
"rules": [
{
"enabled": true
}
]
}'

Mở trong tài liệu tương tác

Hộp thư thông báo trong app

Lấy danh sách thông báo in-app của người dùng, hỗ trợ lọc chưa đọc và phân trang cursor.

Quyền: notify.pref.self
  • Nhóm tốc độ: read
  • Phản hồi thành công 200: Danh sách thông báo. — object, application/json
  • Mã lỗi riêng của endpoint: invalid_cursor
TênVị tríBắt buộcKiểuMô tả
unreadqueryKhôngstring—
cursorqueryKhôngstring—
limitqueryKhônginteger—
curl -sS -X GET "https://api.dongtien.pro/v1/notifications" \
-H "Authorization: Bearer $DT_API_KEY"

Mở trong tài liệu tương tác

Đánh dấu đã đọc thông báo

Đánh dấu một số ID hoặc tất cả thông báo của người dùng là đã đọc.

Quyền: notify.pref.self
  • Nhóm tốc độ: write
  • Nội dung yêu cầu: object (application/json)
  • Phản hồi thành công 200: Số lượng thông báo đã cập nhật. — object, application/json
  • Mã lỗi riêng của endpoint: conflict
curl -sS -X POST "https://api.dongtien.pro/v1/notifications:mark-read" \
-H "Authorization: Bearer $DT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"ids": [
"0199f564-b530-734b-834b-cd5cb38fe3f7",
"0199f564-b531-7a2c-9f10-2d6e8a41b3c5"
]
}'

Mở trong tài liệu tương tác

Đăng ký Web Push subscription

Lưu thông tin PushSubscription từ trình duyệt web.

Quyền: notify.pref.self Idempotency-Key: tuỳ chọn
  • Nhóm tốc độ: write
  • Nội dung yêu cầu: object (application/json, bắt buộc)
  • Phản hồi thành công 200: Đã đăng ký Web Push. — object, application/json
  • Mã lỗi riêng của endpoint: conflict, idempotency_in_flight, idempotency_key_reused
TênVị tríBắt buộcKiểuMô tả
idempotency-keyheaderKhôngstringKhoá chống gửi trùng (≤ 255 ký tự, nên là UUID). Giữ 24 giờ; gửi lại cùng khoá + cùng nội dung trả lại kết quả cũ.
curl -sS -X POST "https://api.dongtien.pro/v1/webpush/subscriptions" \
-H "Authorization: Bearer $DT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"endpoint": "https://fcm.googleapis.com/fcm/send/dQw4w9WgXcQ:APA91bHun4MxP5",
"keys": {
"p256dh": "BNcRdreALRFXTkOOUHK1EtK2wtaz5Ry4YfYCA_0QTpQtUbVlUls0VJXg7A8u-Ts1XbjhazAkj7I99e8QcYP7DkM",
"auth": "tBHItJI5svbpez7KI4CCXg"
}
}'

Mở trong tài liệu tương tác

Lấy VAPID public key cho Web Push

Client web dùng public key này để đăng ký pushManager subscription.

Quyền: notify.pref.self
  • Nhóm tốc độ: read
  • Phản hồi thành công 200: VAPID key. — object, application/json
  • Mã lỗi: chỉ các mã lỗi chung ở Tổng quan
curl -sS -X GET "https://api.dongtien.pro/v1/webpush/vapid-key" \
-H "Authorization: Bearer $DT_API_KEY"

Mở trong tài liệu tương tác

Lưu ý về từ "đã xác thực": đây là xác thực nguồn, không phải ngân hàng xác nhận quyết toán.