ارسال با شناسه سفارشی (شناسه سفارشی (Custom Alias))
ارسال اعلان پوش به همه مشترکینی که یک شناسه سفارشی با برچسب و مقدار مشخص دارند.
POST
https://pushfa.com/api/webservices/send-via-alias
کاربرد
اگر با addAlias مشترکین را برچسبگذاری کردهاید، میتوانید پیام را به همه مشترکینی که برچسب label برابر یکی از مقادیر values داشته باشند بفرستید. بهشکل هوشمندانه، پیام فقط به بهترین دستگاه این شناسه ارسال میشود؛ بنابراین پیام تنها به یک دستگاه خواهد رسید.
پارامترهای ورودی
| پارامتر | مقدار | اجباری |
|---|---|---|
| label | نام برچسب (مثل crm_id، tier) | بله |
| values[] | آرایه مقادیری که میخواهید هدف باشند | بله |
| only_last_device | اگر true باشد، برای هر مشترک منطبق فقط به آخرین دستگاه استفادهشده ارسال میشود. اولویتبندی بر اساس visit_at و در صورت برابری، updated_at (جدیدتر = برتر). پیشفرض: false | خیر |
| smart_targeting | بهشکل هوشمندانه، پیام فقط به بهترین دستگاه این شناسه ارسال میشود؛ بنابراین پیام تنها به یک دستگاه خواهد رسید. | خیر |
| device | محدودیت دستگاه: all، mobile یا desktop | خیر |
| api_public_key | کلید عمومی سرویس پوشفا | بله |
| api_private_key | کلید خصوصی سرویس پوشفا | بله |
| title | عنوانی که بالای اعلان نمایش داده میشود | بله |
| body | متن اصلی که زیر عنوان اعلان نمایش داده میشود | بله |
| link_url | لینک مقصد پس از کلیک روی اعلان (مثال: https://example.com) | خیر |
| image_url | آدرس تصویر ضمیمه اعلان | خیر |
| use_brackets | برای شخصیسازی پیام، مقدار true را بفرستید. در این حالت بخشهای متغیر عنوان (title) و متن (body) با اطلاعات پروفایل هر گیرنده پر میشوند. مقدار پیشفرض false است. | خیر |
| throttle_rate_per_minute | نرخ ارسال این پیام بر حسب پیام در دقیقه. فقط وقتی Push Throttling سرویس فعال و اجازه Override روشن باشد مقدار ارسالی جایگزین نرخ پیشفرض میشود. | خیر |
| silentپوش بیصدا | مقدار true اعلان را بدون صدا و لرزش نمایش میدهد؛ این گزینه اعلان را پنهان نمیکند. | خیر |
| collapse_idCollapse IDPro | Collapse ID — رشته متنی حداکثر ۱۰۰ کاراکتر برای جایگزینی اعلان قبلی با اعلان جدید دارای همان شناسه. | خیر - فقط Pro |
| additional_dataAdditional DataPro | Additional Data (JSON) — شیء JSON دلخواه که همراه پیام ارسال میشود و در SDK/Service Worker قابل خواندن است. | خیر - فقط Pro |
| send_time | زمان ارسال؛ current برای ارسال فوری و delay برای زمانبندیشده. اختیاری و پیشفرض current است. نام قدیمی sendTime فعلاً پشتیبانی میشود، اما نباید هر دو نام همزمان ارسال شوند. | خیر |
| time | تاریخ و ساعت ارسال را با قالب Y-m-d H:i وارد کنید. این فیلد فقط برای ارسال زمانبندیشده استفاده میشود. | اگر send_time برابر delay باشد، الزامی است |
| ttl | مدت اعتبار پیام برای تحویل، بر حسب ثانیه. مقدار پیشفرض 86400 ثانیه، یعنی ۲۴ ساعت است. | خیر |
نمونه درخواست
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"],
"smart_targeting": true,
"title": "پیام برای مشتریان خاص",
"body": "{name:کاربر} عزیز، سفارش {custom_alias:order_id:شما} آماده است.",
"use_brackets": true,
"send_time": "current"
}'