مستندات پوشفا

ارسال رویداد RetenX از Backend

ثبت Custom Event سروری برای شروع، خروج یا ادامه Wait Until در سفر مشتری.

POST
https://pushfa.com/api/webservices/retention/events
📥 دانلود کالکشن Postman

شناسایی مخاطب

رویداد می‌تواند با subscriber_id، external_id، یک alias مانند mobile یا fcm_token به پروفایل متصل شود. اگر پروفایل وجود نداشته باشد و alias یا external_id ارسال شود، پروفایل SMS-only به‌صورت خودکار ساخته می‌شود. idempotency_key از ثبت دوباره یک رویداد در retryهای سرور جلوگیری می‌کند.

پارامترها

فیلد توضیح الزام
api_public_key کلید عمومی سرویس پوشفا بله
api_private_key کلید خصوصی سرویس پوشفا بله
event_name نام event مطابق Start، Exit یا Wait Until سفر بله
subscriber_id Subscriber ID پایدار یکی از روش‌های شناسایی
external_id شناسه کاربر در سیستم شما یکی از روش‌های شناسایی
aliases[mobile] جستجو یا ساخت پروفایل بر اساس شماره موبایل یکی از روش‌های شناسایی
params[key] properties رویداد برای شرط و شخصی‌سازی خیر
event_time زمان ISO 8601 رویداد؛ پیش‌فرض زمان دریافت خیر
idempotency_key UUID یکتا برای جلوگیری از رویداد تکراری خیر ولی پیشنهادی

نمونه form-data

curl -X POST https://pushfa.com/api/webservices/retention/events \
  -F "api_public_key=YOUR_PUBLIC_KEY" \
  -F "api_private_key=YOUR_PRIVATE_KEY" \
  -F "event_name=add_to_cart" \
  -F "aliases[mobile]=09120000000" \
  -F "params[mobile]=09120000000" \
  -F "params[product_id]=123" \
  -F "idempotency_key=550e8400-e29b-41d4-a716-446655440000"

ارسال‌های Push و پروفایل بدون توکن

پروفایل‌های SMS-only در صفحه مشترکین و Segmentها قابل مشاهده‌اند، اما ارسال گروهی Push، Topic، ارسال API/پنل، A/B Test و هدف‌گیری alias یا Subscriber ID فقط پروفایل‌های دارای token معتبر را وارد صف FCM می‌کند.