کلید‌های اعلان

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

app_ids

iOS

Android

app_ids

استفاده: اجباری در همه نوع اعلان
کلید پدر: -
نوع مقدار: رشته string
توضیحات: این کلید بیانگر شناسه اپلیکیشن می‌باشد که برای همه انواع اعلان اجباری می‌باشد

data

iOS

Android

data

استفاده: در صورت عدم استفاده از کلید custom_content استفاده از این کلید در همه انواع اعلان اجباری است
کلید پدر: -
نوع مقدار: دیکشنری
توضیحات: این کلید که از نوع دیکشنری می‌باشد برای نگه داری مقادیر محتوایی که قرار است در اعلان نمایش داده شوند نظیر عنوان، متن، آیکن و ... به کار می‌رود. در صورت استفاده از این کلید ، حتما باید مقدار داشته باشد.

title

iOS

Android

data.title

استفاده: (در صورت استفاده از کلید data) اجباری
کلید پدر: کلید data
نوع مقدار: رشته string
توضیحات: عنوان اعلانی که در دستگاه نمایش داده می‌شود

content

iOS

Android

data.content

استفاده: (در صورت استفاده از کلید data) اجباری
کلید پدر: کلید data
نوع مقدار: رشته string
توضیحات: متن اعلانی که در دستگاه نمایش داده می‌شود

icon

iOS

Android

data.icon

استفاده: اختیاری
کلید پدر: کلید data
نوع مقدار: رشته string
توضیحات: آیکن اعلانی که در دستگاه نمایش داده می‌شود
توصیه می‌شود که حتما از https برای آدرس آیکن استفاده شود.

big_title

Android

data.big_title

استفاده: اختیاری
کلید پدر: کلید data
نوع مقدار: رشته string
توضیحات: عنوان اعلانی که در دستگاه نمایش داده می‌شود در حالتی که اعلان باز شده می‌باشد.

big_content

Android

data.big_content

استفاده: اختیاری
کلید پدر: کلید data
نوع مقدار: رشته string
توضیحات: متن اعلانی که در دستگاه نمایش داده می‌شود در حالتی که اعلان باز شده می‌باشد.

summary

Android

data.summary

استفاده: اختیاری
کلید پدر: کلید data
نوع مقدار: رشته string
توضیحات: نمایش خلاصه اعلان در حالتی که اعلان‌ها بسته می‌باشند.

image

iOS

Android

data.image

استفاده: اختیاری
کلید پدر: کلید data
نوع مقدار: رشته string
توضیحات: عکس اعلانی که در دستگاه نمایش داده می‌شود.
توصیه می‌شود که حتما از https برای آدرس عکس استفاده شود

ticker

Android

data.ticker

استفاده: اختیاری
کلید پدر: کلید data
نوع مقدار: رشته string
توضیحات: متن خلاصه ای که در نوار بالای صفحه نمایش داده میشود.
این مورد در اندروید ۵ و ماقبل کار میکند.

notif_icon

Android

data.notif_icon

استفاده: اختیاری
کلید پدر: کلید data
نوع مقدار: رشته string
توضیحات: آیکون جایگزین آیکون اپ
مشاهده لیست آیکن‌های اعلان

wake_screen

Android

data.wake_screen

استفاده: اختیاری
کلید پدر: کلید data
نوع مقدار: بولین true/false
توضیحات: روشن شدن صفحه نمایش به هنگام دریافت پیام

sound_url

Android

data.sound_url

استفاده: اختیاری
کلید پدر: کلید data
نوع مقدار: رشته string (url صدا)
توضیحات: تغییر صدای هشدار به هنگام دریافت اعلان

notif_channel_id

Android

data.notif_channel_id

استفاده: اختیاری
کلید پدر: کلید data
نوع مقدار: رشته‌ای که حاوی شناسه کانال می‌باشد
توضیحات: ارسال به کاربران کانال خاص

visibility

Android

data.visibility

استفاده: اختیاری
کلید پدر: کلید data
نوع مقدار: بولین true/false
توضیحات: اعلان نمایش داده شود یا خیر

led_color

Android

data.led_color

استفاده: اختیاری
کلید پدر: کلید data
نوع مقدار: رشته string
توضیحات: led تعیین رنگ
مشاهده لیست رنگ‌های LED

led_on

Android

data.led_on

استفاده: اختیاری
کلید پدر: کلید data
نوع مقدار: زمان به میلی ثانیه
توضیحات: led زمان روشن ماندن

led_off

Android

data.led_off

استفاده: اختیاری
کلید پدر: کلید data
نوع مقدار: زمان به میلی ثانیه
توضیحات: led زمان خاموش ماندن

action

iOS

Android

data.action

استفاده: اختیاری
کلید پدر: کلید data
نوع مقدار: دیکشنری
توضیحات: این کلید یک دیکشنری می‌باشد که مقادیر مربوط به اکشن اعلان نظیر باز کردن اپلیکیشن و یا باز کردن یه آدرس و ... را نگه می‌دارد

action_type

iOS

Android

data.action.action_type

استفاده: اختیاری
کلید پدر: کلید action
نوع مقدار: رشته string
توضیحات: نوع عملکرد اعلان
مشاهده لیست تمامی عملکرد‌های اعلان

url

iOS

Android

data.action.url

استفاده: اختیاری
کلید پدر: کلید action
نوع مقدار: رشته string
توضیحات: مقدار یا عملکردی است که اکشن اعلان انجام می‌دهد
مشاهده لیست تمامی عملکرد‌های اعلان و url های مرتبط

buttons

Android

data.buttons

استفاده: اختیاری
کلید پدر: کلید data
نوع مقدار: لیست
توضیحات: لیستی از button ها می باشد
هر button یک دیکشنری می‌باشد که کلید‌هایی نظیر btn_action, btn_order , ... را در برمیگیرد

[button]

Android

data.buttons

استفاده: اختیاری
کلید پدر: کلید buttons
نوع مقدار: دیکشنری
توضیحات:
(این کلید وجود ندارد) ، صرفا بیانگر این است که button یک دیکشنری درون کلید buttons می باشد که کلیدهایی که در ادامه توضیح داده می‌شود را نگه می‌دارد.

btn_order

Android

data.buttons.button.btn_order

استفاده: در صورت استفاده از button(s) این کلید اجباری می‌باشد
کلید پدر: کلید button
نوع مقدار: نوع عددی integer
توضیحات: ترتیب قرار گیری buttons در اعلان

btn_content

Android

data.buttons.button.btn_content

استفاده: اختیاری
کلید پدر: کلید button
نوع مقدار: رشته string
توضیحات: متن button

btn_icon

Android

data.buttons.button.btn_icon

استفاده: اختیاری
کلید پدر: کلید button
نوع مقدار: رشته string
توضیحات: آیکن button
مشاهده لیست آیکن‌های اعلان

btn_action

Android

data.buttons.button.btn_action

استفاده: اختیاری
کلید پدر: کلید button
نوع مقدار: دیکشنری
توضیحات: همانند کلید action می‌باشد و دو کلید action_type , url قبول می‌کند که مقادیر آنها را می توانید در قسمت اکشن‌های اعلان مشاهده کنید.

collapse_key

Android

collapse_key

استفاده: اختیاری
کلید پدر: -
نوع مقدار: رشته string
توضیحات: کلید حایگزینی اعلان‌های خوانده نشده
مقادیر: key1, key2, key3, key4

نکته

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

time_to_live

Android

time_to_live

استفاده: اختیاری
کلید پدر: -
نوع مقدار: زمان به ثانیه
توضیحات: زمان ماندگاری

filters

Android

filters

استفاده: اختیاری
کلید پدر: -
نوع مقدار: دیکشنری
توضیحات: یک دیکشنری است که کلید‌های مربوط به انواع فیلتر و شناسه های یکتا اعلان را نگه می‌دارد.

operator

Android

filters.operator

استفاده: اختیاری
کلید پدر: کلید filters
نوع مقدار: لیستی از رشته string
توضیحات: فیلتر اعلان برای مشخص کردن نوع اپراتور
مقادیر: ir-mci , irancell , rightel

brand

Android

filters.brand

استفاده: اختیاری
کلید پدر: کلید filters
نوع مقدار: لیستی از رشته string
توضیحات: فیلتر اعلان برای مشخص کردن نوع برند دستگاه
مقادیر: samsung , LGE , asus , htc , lenovo , sony , huawei

mobile_net

Android

filters.mobile_net

استفاده: اختیاری
کلید پدر: کلید filters
نوع مقدار: لیستی از رشته string
توضیحات: فیلتر اعلان برای مشخص کردن نوع اینترنت
مقادیر: lte , wifi‍‍

state

Android

filters.mobile_net

استفاده: اختیاری
کلید پدر: کلید filters
نوع مقدار: لیستی از رشته string
توضیحات: فیلتر اعلان برای مشخص کردن استان
مقادیر: East Azerbaijan , Azarbayjan-e Gharbi , Ardabil , Isfahan , Alborz , Ilam , Bushehr , Tehran , Chahar Mahall va Bakhtiari, Khorasan-e Jonubi , Razavi Khorasan , Khorasan-e Shomali , Khuzestan , Zanjan , Semnan , Sistan and Baluchestan , Fars, Qazvin , Qom , Kordestan , Kerman , Kermanshah , Kohgiluyeh va Buyer Ahmad , Golestan , Gilan , Lorestan , Mazandaran, Markazi , Hormozgan , Hamadan , Yazd

app_version

Android

filters.app_version

استفاده: اختیاری
کلید پدر: کلید filters
نوع مقدار: لیستی از رشته string
توضیحات: فیلتر اعلان برای مشخص کردن ورژن اپلیکیشن

phone_number

Android

filters.phone_number

استفاده: اختیاری
کلید پدر: کلید filters
نوع مقدار: لیستی از رشته string
توضیحات: فیلتر اعلان بر اساس شماره تلفن کاربر

email

Android

filters.email

استفاده: اختیاری
کلید پدر: کلید filters
نوع مقدار: لیستی از رشته string
توضیحات: فیلتر اعلان بر اساس آدرس ایمیل کاربر

custom_id

Android

filters.custom_id

استفاده: اختیاری
کلید پدر: کلید filters
نوع مقدار: لیستی از رشته string
توضیحات: فیلتر اعلان بر اساس شناسه دلخواه

topics

Android

topics

استفاده: اختیاری
کلید پدر: -
نوع مقدار: لیستی از رشته string
توضیحات: تعیین تاپیک‌ها که پیام ارسال شود

unique

Android

unique

استفاده: اختیاری
کلید پدر: -
نوع مقدار: بولین true/false
توضیحات: به کاربران مشترک اپها یک پیام ارسال شود

eta

Android

eta

استفاده: اختیاری
کلید پدر: -
نوع مقدار: تاریخ و زمان به صورت iso string
توضیحات: تعیین زمان ارسال برای نمونه به شکل ‍"2016-10-18T13:28:00+03:30"

priority

iOS

Android

priority

استفاده: اختیاری
کلید پدر: -
نوع مقدار: عدد integer
توضیحات: مشحص کننده اولویت اعلان ساخته است.
یکی از اعداد : ۱ برای اولویت کم - ۲ برای اولویت متوسط -۳ برای اولویت زیاد