API ارسال پوش تکی؛ پارامترها و نمونه درخواست

کاربرد

برای ارسال اعلان به یک کاربر خاص با توکن مشخص استفاده کنید. امکان درخواست گزارش تحویل، گزارش کلیک و تعریف دکمه‌های عملیاتی وجود دارد.

پارامترهای ورودی

نمونه درخواست

curl -X POST https://pushfa.com/api/webservices/send-single-message \
  -H "Content-Type: application/json" \
  -d '{
    "subscriber_id": "SUBSCRIBER_UUID",
    "api_public_key": "YOUR_PUBLIC_KEY",
    "api_private_key": "YOUR_PRIVATE_KEY",
    "title": "عنوان نوتیفیکیشن",
    "body": "متن نوتیفیکیشن",
    "link_url": "https://example.com",
    "silent": true,
    "collapse_id": "order_42",
    "additional_data": { "order_id": 42, "type": "order_update" },
    "send_time": "current"
  }'

ساختار پاسخ موفق

{
  "status": "success",
  "data": {
    "notification_id": "uuid-of-message-receptor"
  }
}

شرط اختیاری آخرین بازدید (last_visit)

با پارامتر اختیاری last_visit پیام فقط برای مخاطبانی ارسال می‌شود که روز آخرین بازدیدشان از سایت یا اپ (به وقت تهران) با شرط شما بخواند. نمونه زیر فقط برای کسانی ارسال می‌شود که امروز بازدید داشته‌اند. اگر مخاطب شرط را نداشته باشد، پیامی ساخته نمی‌شود، هزینه‌ای کسر نمی‌شود و خطای 422 با کد LAST_VISIT_CONDITION_NOT_MET برمی‌گردد.

{
  "api_public_key": "YOUR_PUBLIC_KEY",
  "api_private_key": "YOUR_PRIVATE_KEY",
  "subscriber_id": "SUBSCRIBER_UUID",
  "title": "پیشنهاد امروز",
  "body": "ویژه کاربرانی که امروز به ما سر زده‌اند",
  "last_visit": { "operator": ">=", "date": "today" },
  "send_time": "current"
}

خطاها و کدهای پاسخ

خطاهای عمومی مانند INVALID_API_KEYS، VALIDATION_ERROR و INSUFFICIENT_BALANCE در همه وب‌سرویس‌های ارسال مشترک‌اند. اگر مخاطب قابل ارسال نباشد، درخواست با یکی از کدهای SUBSCRIBER_NOT_FOUND، FCM_TOKEN_NOT_FOUND، PUSH_TOKEN_EXPIRED یا PUSH_NOT_SUBSCRIBED رد می‌شود و شناسه مشکل‌دار همراه نوع آن در data برمی‌گردد. اگر شرط اختیاری last_visit را بفرستید، LAST_VISIT_TRACKING_DISABLED و LAST_VISIT_CONDITION_NOT_MET هم ممکن است برگردند. معنی هر کد و اینکه چه زمانی باید توکن یا شناسه را حذف کنید در صفحه خطاها آمده است.