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

ارسال با شناسه سفارشی (Custom Alias)

ارسال پوش نوتیفیکیشن به همه مشترکینی که یک شناسه سفارشی با برچسب و مقدار مشخص دارند.

POST
https://pushfa.com/api/webservices/send-via-alias
📥 دانلود کالکشن Postman

کاربرد

اگر با addAlias مشترکین را برچسب‌گذاری کرده‌اید، می‌توانید پیام را به همه مشترکینی که برچسب label برابر یکی از مقادیر values داشته باشند بفرستید.

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

پارامتر مقدار اجباری
label نام برچسب (مثل crm_id، tier) بله
values[] آرایه مقادیری که می‌خواهید هدف باشند بله
only_last_device اگر true باشد، برای هر مشترک منطبق فقط به آخرین دستگاه استفاده‌شده ارسال می‌شود. اولویت‌بندی بر اساس visit_at و در صورت برابری، updated_at (جدیدتر = برتر). پیش‌فرض: false خیر
device محدودیت دستگاه: all، mobile یا desktop خیر
api_public_key کلید عمومی سرویس پوشفا بله
api_private_key کلید خصوصی سرویس پوشفا بله
title عنوان پوش نوتیفیکیشن بله
body متن اصلی پوش نوتیفیکیشن بله
link_url لینک مقصد پس از کلیک روی نوتیفیکیشن (مثال: https://example.com) خیر
image_url آدرس تصویر ضمیمه نوتیفیکیشن خیر
sendTime زمان ارسال؛ مقدار current برای ارسال فوری و delay برای زمان‌بندی‌شده بله
time زمان ارسال با فرمت Y-m-d H:i — فقط اگر sendTime برابر delay باشد اجباری اگر sendTime = delay
ttl عمر نوتیفیکیشن به ثانیه (پیش‌فرض 86400 = 24 ساعت) خیر

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

curl -X POST https://pushfa.com/api/webservices/send-via-alias \
  -H "Content-Type: application/json" \
  -d '{
    "api_public_key": "YOUR_PUBLIC_KEY",
    "api_private_key": "YOUR_PRIVATE_KEY",
    "label": "crm_id",
    "values": ["CRM-123", "CRM-456"],
    "only_last_device": true,
    "title": "پیام برای مشتریان خاص",
    "body": "متن پیام",
    "sendTime": "current"
  }'