onesignal pushe.co s-3.664-0.699-5.062-2.099c-1.397-1.398-2.097-3.087-2.097-5.065s0.699-3.667,2.097-5.065c1.397-1.399,3.085-2.099,5.062-2.099 s3.664,0.699,5.062,2.099C223.888,120.556,224.587,122.244,224.587,124.223z"/>

برای مهاجرت از وان سیگنال به پوشه کلیک کنید.

راهنمای استفاده از API پوشه

برای مشاهده api نسخه v1 اینجا کلیک نمایید


امکانات پوشه از طریق پنل پوشه در اختیار شما هستند. اما اگر می خواهید با کدنویسی و بصورت مستقیم از سرور یا اپ خود ارسال پوش را انجام بدهید، می توانید از API پوشه استفاده کنید. آدرس ‍‍API با توجه به پلتفرمی که از آن استفاده می‌کنید متفاوت است لذا در صورتی که قصد استفاده از پلتفرم اندروید را دارید از کلید android و در صورتی که که قصد استفاده از پلتفرم آی او اس را دارید از کلید ios بجای کلید واژه platform در داک استفاده کنید.

احراز هویت

در نسخه دوم API پوشه شما می‌توانید با استفاده از سیستم‌ احراز هویت Session درخواست‌های خود را ارسال کنید.

برای دریافت Token دائمی خود می‌توانید از قسمت حساب کاربری در کنسول پوشه، توکن خود را دریافت کرده و و به جای کلمه‌ی YOUR_SESSION_TOKEN از آن استفاده کنید.

ایجاد اپلیکیشن با استفاده از API پوشه

برای ایجاد اپلیکیشن می‌توانید از آدرس http://api.pushe.co/v2/applications/{platform}/ بصورت زیر استفاده کنید:

curl -X POST http://api.pushe.co/v2/applications/{platform}/ -H 'authorization: Token YOUR_TOKEN' -H 'content-type:application/json' -d '{"package_name": "com.example.app", "name": "example", "framework": 2}'

مقادیر مجاز برای platform می‌تواند android و ios باشد.

کلید فرمت کلید توضیحات
name(اختیاری) رشته(String) نام اپلیکیشن شما
package_name(اجباری) رشته(String) اسم پکیج اپلیکیشن شما
framework(اجباری) عدد(int) چارچوبی که با آن اپلیکیشن خود را ایجاد کرده‌اید. برای مشاهده لیست چارچوب‌ها به جدول شماره ۵ مراجعه نمایید.
client_key(اختیاری) عدد(int) کلید سمت کاربر که از FCM دریافت میکنید.
server_key(اختیاری) رشته(String) کلید سمت سرور که از FCM دریافت میکنید.

پاسخ دریافتی برای درخواست‌‌ ایجاد اپلیکیشن(اندروید و ios) بدین فرمت خواهد بود:

‍‍‍

{
    "name": "APP_NAME",
    "package_name": "PACKAGE_NAME",
    "app_id": "UNIQUE_IDENTIFIER_GENERATED_BY_PUSHE",
    "created_at": "UTC TIMEZONE",
    "framework": "SMALL INTEGER NUMBER",
    "aggregator": "USER INSTANCE",
    "has_one_signal_user": "BOOLEAN FIELD",
    "type": "SMALL INTEGER NUMBER",
    "provider": "PROVIDER INTANCE",
    "credential": {
        "server_key": "SERVER_KEY",
        "client_key": "CLIENT_KEY"
    },
    "active_users": "NUMBER OF ACTIVE USERS"
}
کلید توضیح
name نام اپلیکیشنی که انتخاب کردید، در صورتی که نامی برای اپلیکیشن خود انتخاب نکرده باشید، app_id به عنوان name قرار خواهد گرفت.
app_id شناسه اپلیکیشن شما در پوشه.
package_name اسم پکیج اپلیکیشن شما.
create_at زمانی که اپلیکیشن شما ساخته شده است.
framework مشخص کننده چارچوبی است که با آن اپلیکیشن خود را ایجاد کرده‌اید.
aggregator در صورتی که اپلیکیشن شما در اجاره پوشه باشد این فیلد برای شما ‌‌True خواهد بود.
has_one_signal_user درصورتی که اپلیکیشن شما از onesingal وارد شده باشد این فیلد برای شما ‌true خواهد بود.
type مشخص کننده توع اپلیکیشن شما می‌باشد. برای مشاهده تمام تایپ‌ها میتوانید به جدول ۲ مراجعه کنید.
provider در صورتی که از اپلیکیشن ساز استفاده کرده باشید، این فیلد برای شما به نمایش در خواهد آمد.
credential در صورتی که client_key و server_key را وارد نکرده باشید، فقط client_key را دریافت خواهید کرد.
active_users تعداد کاربران فعالی که اپلیکیشن شما دارد.

چرا در صورتی که از client_key و server_key خود استفاده نکنید، فقط client_key را دریافت می‌کنیم؟
چون پوشه از client_key و server_key خود برای ارسال اعلان‌‌ها استفاده می‌کند، لذا فقط client_key به شما نمایش داده می‌شود.

در صورتی که از client_key و server_key خود برای ارسال اعلان استفاده کنید، می‌توانید با سرور اختصاصی خود نیز برای کاربرانتان اعلان ارسال کنید.

در قرار دادن کلید Authorization به فاصله بین Token و YOUR_TOKEN توجه کنید.

دریافت لیست اپلیکیشن‌ها استفاده از API پوشه

برای دریافت لیست اپلیکیشن‌های خود می‌توانید از آدرس http://api.pushe.co/v2/applications/{platform}/ بصورت زیر استفاده نمایید:

curl -X GET http://api.pushe.co/v2/applications/{platform}/ -H 'authorization: Token YOUR_TOKEN' -H 'content-type: application/json'

مقادیر مجاز برای platform می‌تواند android و ios باشد.

پاسخ دریافتی برای درخواست‌‌ مشاهده لیست اپلیکیشن‌‌ها(اندروید و ios) بدین فرمت خواهد بود:

[
    {
        "name": "APP_NAME",
        "package_name": "PACKAGE_NAME",
        "app_id": "UNIQUE IDENTIFIER",
        "created_at": "2018-10-13T05:49:28.292622Z",
        "framework": 1,
        "aggregator": null,
        "has_one_signal_user": false,
        "type": 1,
        "provider": null,
        "credential": {
            "server_key": "server_key",
            "client_key": "client_key"
        },
        "active_users": 0,
        "installation_count": 0,
        "owner": "YOUR_EMAIL_ADDRESS",
        "welcome_template": null,
        "update_template": null,
        "welcome_template_v2": null,
        "update_template_v2": null,
        "welcome_active": false,
        "icon_url": "ICON_URL"
    }
]
کلید توضیح
name نام اپلیکیشنی که انتخاب کردید، در صورتی که نامی برای اپلیکیشن خود انتخاب نکرده باشید، app_id به عنوان name قرار خواهد گرفت.
package_name اسم پکیج اپلیکیشن شما.
app_id شناسه‌ای که برای اپلیکیشن خود انتخاب کرده‌اید.
create_at زمانی که اپلیکیشن شما ساخته شده است.
framework مشخص کننده چارچوبی است که با آن اپلیکیشن خود را ایجاد کرده‌اید.
aggregator در صورتی که اپلیکیشن شما در اجاره پوشه باشد این فیلد برای شما ‌‌True خواهد بود.
has_one_signal_user درصورتی که اپلیکیشن شما از onesingal وارد شده باشد این فیلد برای شما ‌true ه=خواهد بود.
type مشخص کننده توع پلتفرم اپلیکیشن شما می‌باشد.
provider در صورتی که از اپلیکیشن ساز استفاده کرده باشید، این فیلد برای شما به نمایش در خواهد آمد.
credential در صورتی که client_key و server_key را وارد نکرده باشید، فقط client_key را دریافت خواهید کرد.
active_users تعداد کاربران فعالی که اپلیکیشن شما دارد.
installation_count تعداد نصب‌‌های این اپلیکیشن
welcome_template شناسه اعلان خوش آمد برای این اپلیکشین در v1
update_template شناسه اعلان آپدیت برای این اپلیکیشن در v1
welcome_template_v2 شناسه اعلان خوش آمد برای این اپلیکشین در v2
update_template_v2 شناسه اعلان آپدیت برای این اپلیکیشن در v2
welcome_active تعداد نصب‌‌های این اپلیکیشن
icon_url آدرس url آیکون اپلیکیشن شما

تغیر نام اپلیکیشن با استفاده از API در پوشه

در پوشه بصورت کلی برای تغیر نام اپلیکیشن خود می‌توانید از آدرس http://api.pushe.co/v2/applications/{platform}/YOUR_APPLICATION_ID/ بصورت زیر استفاده نمایید:

curl -X PATCH http://api.pushe.co/v2/applications/{platform}/YOUR_APPLICATION_ID/ -H 'authorization: Token YOUR_TOKEN' -H 'content-type: application/json' -d '{"name": "YOUR_APPLICATION_NAME"}'

مقادیر مجاز برای platform می‌تواند android و ios باشد.

کلید فرمت کلید توضیحات
YOUR_APPLICATION_ID(‌اجباری) رشته(String) کلید YOUR_APPLICATION_ID در url اجباری می‌باشد.
name(اجباری) رشته(String) اسم جدید پکیج اپلیکیشن شما

فرمت پاسخ دریافتی بدین صورت خواهد بود:

 {
     "name": "NEW_APP_NAME",
     "package_name": "PACKAGE_NAME",
     "app_id": "UNIQUE IDENTIFIER",
     "created_at": "2018-10-11T13:25:31.050004Z",
     "framework": 4,
     "aggregator": null,
     "has_one_signal_user": false,
     "type": 1,
     "provider": null,
     "credential": {
         "server_key": "server_key",
         "client_key": "client_key"
     },
     "active_users": 0,
     "installation_count": 0,
     "owner": "YOUR_EMAIL_ADDRESS",
     "welcome_template": null,
     "update_template": null,
     "welcome_template_v2": null,
     "update_template_v2": null,
     "welcome_active": false,
     "icon_url": null
 }

حذف اپلیکیشن با استفاده از API در پوشه

در پوشه بصورت کلی برای حذف نام اپلیکیشن خود می‌توانید از آدرس http://api.pushe.co/v2/applications/{platform}/YOUR_APPLICATION_ID/ بصورت زیر استفاده نمایید:

curl -X DELETE http://api.pushe.co/v2/applications/{platform}/YOUR_APPLICATION_ID/ -H 'authorization: Token YOUR_TOKEN' -H 'content-type: application/json'

مقادیر مجاز برای platform می‌تواند android و ios باشد.

کلید فرمت کلید توضیحات
YOUR_APPLICATION_ID(‌اجباری) رشته(String) کلید YOUR_APPLICATION_ID در url اجباری می‌باشد.

دریافت تاریخچه نصب‌های یک اپلیکیشن با استفاده از API در پوشه

برای دریافت تاریخچه نصب‌های یک اپلیکیشن می‌توانید از آدرس http://api.pushe.co/v2/applications/{platform}/YOUR_APPLICATION_ID/export/ بصورت زیر استفاده کنید:

curl -X POST http://api.pushe.co/v2/applications/{platform}/YOUR_APPLICATION_ID/export/ -H 'authorization: Token YOUR_TOKEN' -H 'content-type: application/json' 

مقادیر مجاز برای platform می‌تواند android و ios باشد.

کلید فرمت کلید توضیحات
YOUR_APPLICATION_ID(‌اجباری) رشته(String) کلید YOUR_APPLICATION_ID در url اجباری می‌باشد.

فرمت پاسخ دریافتی بدین صورت خواهد بود:

{
   "result": true
}

انتقال اپلیکیشن با استفاده از API در پوشه

برای انتقال اپلیکیشن می‌توانید از آدرس http://api.pushe.co/v2/user_applications_transfer/ بصورت زیر استفاده کنید:

curl -X POST http://api.pushe.co/v2/user_applications_transfer/ -H 'authorization: Token YOUR_TOKEN' -H 'content-type: application/json' -d '{"app_ids": ["APPLICATION_ID1","APPLICATION_ID2"], "to_user": "GIVER_EMAIL_ADDRESS"}'
کلید فرمت کلید توضیحات
app_ids(‌اجباری) لیست(List) لیستی از app_idهایی که قصد انتقال آنها را دارید
to_user(‌اجباری) رشته(String) ایمیل فردی که قرار است اپلیکیشن‌ها به او انتقال بابد.

فرمت پاسخ دریافتی بدین صورت خواهد بود:

{
    "app_ids": [
        "com.example.app"
    ],
    "to_user": "example@pushe.co",
    "id": null,
    "from_user": null
}

ارسال اعلان

ارسال پوش ساده به همه کاربران

برای ارسال یک پوش ساده به همه کاربرانتان میتوانبد از آدرس http://api.pushe.co/v2/messaging/notifications/ بصورت زیر استفاده کنید:

curl -X POST http://api.pushe.co/v2/messaging/notifications/ -H 'authorization: Token YOUR_Session_TOKEN' -H 'content-type: application/json' -d '{"app_ids":["com.exmaple.app"], "data" : {"title":"عنوان اعلان", "content":"محتوای اعلان"}}

فرمت داده‌های ارسالی بدین صورت می‌باشد:

{
  "app_ids": ["com.example.app"],
  "data": {
    "title": "عنوان پیام",
    "content": "محتوای پیام"
  }
}
کلید فرمت کلید توضیحات
app_ids(‌اجباری) لیست(List) لیستی از app_idهایی که قصد ارسال اعلان به آنها را دارید.
title(‌اجباری) رشته(String) عنوان اعلانی که قصد ارسال آن را دارید.
content(‌اجباری) رشته(String) محتوای اعلانی که قصد ارسال آن را دارید.

پاسخ دریافتی برای تمامی درخواست‌های ساخت اعلان به صورت زیر خواهد بود:

{
    "wrapper_id": "UNIQUE IDENTIFIER",
    "hashed_id": "SHARE_URL",
    "app_ids": [
        "com.example.app"
    ],
    "data": {
        "title": "عنوان اعلان",
        "content": "محتوای اعلان"
    },
    "data_type": 1,
    "custom_content": {},
    "abt_ids": null,
    "topics": null,
    "filters": null,
    "rate_limit": null,
    "max_recipients": null,
    "unique": false,
    "statistics": {
        "recipient_count": 0,
        "delivered": 0,
        "clicked": 0,
        "dismissed": 0,
        "nacked": 0,
        "acked": 0
    },
    "type": 2,
    "platform": 1,
    "content_type": 1,
    "priority": null,
    "created_at": "DateTime",
    "dispatch_started_at": null,
    "dispatch_ended_at": null,
    "updated_at": null,
    "time_to_live": 604800,
    "collapse_key": null,
    "eta": null,
    "update_av_code": null,
    "status": 1
}
کلید توضیح
wrapper_id شناسه اعلان
hashed_id کلید یکتایی که در لینک اشتراک گذاری مورد استفاده قرار می‌گیرد..
app_ids لیستی از شناسه‌های اپلیکیشن‌هایی که قرار است به آنها اعلان ارسال شود.
data_type مشخص کتتده توع اعلان می‌باشد.
custom_content مشخص کننده jsonهای ارسالی .
abt_ids(بزودی) شناسه‌ای که برای A/B test مورد استفاده قرار می‌گیرد.
topics فیلد jsonای که مشخص کننده تاپیک‌هایی است که اعلان برای آنها ارسال شده است.
filters فیلد jsonای که مشخص کننده فیلترهایی است که برای اعلان اعمال شده است.
rate_limit (بزودی) زمانی که مشخص می‌کند در طول چه بازه‌ای اعلان‌ها ارسال شود.
max_recipients مشخص کننده بیشترین تعداد کاربرانی که اعلان را باید دریافت کنند.
unique در صورتی که بیش از ۱ اپلیکیشن شما بر روی دستگاهی نصب باشد، در صورتی که این کلید را برابر true قرار دهید یک اعلان دریافت می‌کند.
statistics فیلد jsonای که مشخص کننده آمار اعلان ارسالی می‌باشد.
type شناسه نوع اعلان ارسالی می‌باشد.
platform شناسه پلتفرمی که اعلان برای آن ارسال شده است.
content_type اعلان ارسالی با استفاده از sdk پوشه اجرا شود.
priority شخص کنند اولیت ارسال است.
created_at زمان ساخت اعلان
dispatch_started_at زمان شروع ارسال
dispatch_ended_at زمان پایان ارسال
updated_at زمانی که اعلان آپدیت شده است.
time_to_live مدت زمان زنده ماندن ارسال به ثانیه
collapse_key کلید جابه‌جایی
eta تعیین زمان ارسال
update_av_code نسخه اپلیکیشن
status وضعیت اعلان

ارسال تک پیام برای یک کاربر بر اساس PusheId

شما می توانید با استفاده از آدرس http://api.pushe.co/v2/messaging/notifications/ به روش زیر به دو کاربر براساس PusheId پیام ارسال کنید. دو راه برای دریافت PusheId یک دستگاه وجود دارد. یکی در صفحه نصب ها PusheId همه نصب ها وجود دارند و شما می توانید PusheId دستگاه مورد نظر خود را بیابید. یکی هم در کد سمت کلاینت با فراخوانی متد Pushe.getPusheId می توانید این کار را انجام دهید. ‍‍‍‍

curl -X POST http://api.pushe.co/v2/messaging/notifications/ -H 'authorization: Token YOUR_Session_TOKEN' -H 'content-type: application/json' -d '{"app_ids": ["com.package_name_34"], "filters": {"pushe_id": ["pid_20aa-ba40-a0","pid_39ca-ee30-d9"]}, "data": {"title": "عنوان پیام", "content": "محتوای پیام"}}'

فرمت داده‌های ارسالی بدین صورت می‌باشد:

{
  "app_ids": ["com.example.app"],
  "filters": {
  "pushe_id": ["pid_20aa-ba40-a0","pid_39ca-ee30-d9"]
  },
  "data": {
    "title": "عنوان پیام",
    "content": "محتوای پیام"
  }
}
کلید فرمت کلید توضیحات
app_ids(‌اجباری) لیست(List) لیستی از app_idهایی که قصد ارسال اعلان به آنها را دارید.
pushe_id(‌اجباری) لیست(List) لیستی از pushe_idهایی که قصد ارسال اعلان به آنها را دارید.
title(‌اجباری) رشته(String) عنوان اعلانی که قصد ارسال آن را دارید.
content(‌اجباری) رشته(String) محتوای اعلانی که قصد ارسال آن را دارید.

ارسال تک پیام برای یک کاربر بر اساس device-id

شما می توانید با استفاده از آدرس http://api.pushe.co/v2/messaging/notifications/ به روش زیر به یک کاربر با device-id خاص پیام ارسال کنید:

curl -X POST http://api.pushe.co/v2/messaging/notifications/ -H 'authorization: Token YOUR_Session_TOKEN' -H 'content-type: application/json' -d '{"app_ids": ["com.package_name_34"], "filters": {"device_id": ["com.package_name"]}, "data": {"title": "عنوان پیام", "content": "محتوای پیام"}}'

فرمت داده‌های ارسالی بدین صورت می‌باشد:

{
  "app_ids": ["com.example.app"],
  "filters": {
    "device_id": ["1234567890"]
  },
  "data": {
    "title": "عنوان پیام",
    "content": "محتوای پیام"
  }
}
کلید فرمت کلید توضیحات
app_ids(‌اجباری) لیست(List) لیستی از app_idهایی که قصد ارسال اعلان به آنها را دارید.
device_id(‌اجباری) لیست(List) لیستی از device_idهایی که قصد ارسال اعلان به آنها را دارید.
title(‌اجباری) رشته(String) عنوان اعلانی که قصد ارسال آن را دارید.
content(‌اجباری) رشته(String) محتوای اعلانی که قصد ارسال آن را دارید.

ارسال یک JSON بدون نمایش اعلان

ممکن است شما بخواهید تنها اطلاعاتی را به اپ منتقل کنید ولی چیزی به کاربر نمایش داده نشود. برای این کار شما باید در اپ خود یک کلاس برای دریافت json اضافه کنید. نحوه انجام این کار در آموزش های ابتدای این صفحه توضیح داده شده است. کلید "Show_app" در data قرار دارد.کاربرد این کلید زمانی است که می خواهید داده ای را به اپلیکیشن منتقل کنید اما به کاربر پوش نمایش داده نشود. اگر مقدار این کلید true (پیش فرض) باشد پوش به کاربر نمایش داده می شود و اگر false باشد فقط داده منتقل می شود و به کاربر پوش نمایش داده نمی شود. برای استفاده از این قابلیت می توانید از آدرس http://api.pushe.co/v2/messaging/notifications/ بصورت زیر برای ارسال داده استفاده کنید:

curl -X POST http://api.pushe.co/v2/messaging/notifications/ -H 'authorization: Token YOUR_Session_TOKEN' -H 'content-type: application/json' -d '{"app_ids": ["com.package_name"], "data": {"show_app": false}, "custom_content": {"key_1": "Value_1","Key_2": "Value_2"}}'

فرمت داده‌های ارسالی بدین صورت می‌باشد:

{
  "app_ids": ["com.example.app"],
  "data": {
    "show_app": false
  },
  "custom_content": {
    "key_1": "Value_1",
    "Key_2": "Value_2", 
    .......
  }
}

ارسال اعلان تراکنشی (API چابک)

در صورتی که نیازی به ثبت اعلان در پنل و مشاهده‌ی آمار آن ندارید و نیازمندی شما ارسال اعلان به صورت حجیم و سریع است، می‌توانید از روش ارسال اعلان چابک (Rapid APIs) پوشه استفاده کنید. برای استفاده از این ویژگی بایستی درخواست‌های خود را با استفاده از متود POST به درگاه‌های ارسال چابک پوشه در آدرس https://api.pushe.co/v2/messaging/rapid ارسال کنید. فرمت داده‌ی ارسالی شما بایستی از قالب زیر پیروی کنند.

  • در هر درخواست بایستی تنها یک اپلیکیشن آی‌دی مشخص شود.
  • گیرندگان اعلان در هر درخواست توسط یکی از سه روش شناسه‌ی تبلیغاتی گوگل (Google Advertisement ID)، شناسه‌ی پوشه (Pushe ID) و یا شناسه‌ی اندروید (Android ID) مشخص می‌شوند. دقت کنید که در هر درخواست تنها از یکی از این سه روش برای شناسایی گیرندگان اعلان استفاده می‌شود.
  • حداکثر دریافت‌کنندگان یک اعلان در هر درخواست (اندازه‌ی لیست گیرندگان، aids، pids یا gaids) برابر با ۵۰ نصب است.
  • در کلید data، مقادیری که توسط کتابخانه‌ی پوشه پذیرفته می‌شوند را قرار دهید. در واقع این کلید رزرو شده برای زمانی است که می‌خواهید اعلانی را با استفاده از امکانات کتابخانه به کاربرانتان نمایش دهید.
  • در کلید custom_content می‌توانید هر محتوایی را قرار دهید که به شکل json به دریافت‌کنندای که در برنامه‌ی خود نوشته‌اید تحویل داده می‌شود.

به طور کلی قالب نهایی ارسال این نوع اعلان را در زیر مشاهده می‌کنید.

curl -X POST "https://api.pushe.co/v2/messaging/rapid/"  -i -H "Authorization: Token 7fb1………………………………29b464c "  -H "Content-Type: application/json" -H "Accept: application/json" --data 'Payload'
{
    "app_id": "com.test.pushe",

    // One of the following identifiers, use either only G_AID, PusheID, or AndroidID

    "gaids": [
        "Google Advertisement ID 1",
        "Google Advertisement ID 2",
        "Google Advertisement ID 3",
        "Google Advertisement ID 4"
    ],
    "pids": [
        "Pushe ID 1",
        "Pushe ID 2"
    ],
    "aids": [
        "Android ID 1",
        "Android ID 2"
    ],
    // One of the following, use either data (to use Pushe's SDK features) or custom_content to provide your own JSON

    "data": {
        "title": "Title",
        "content": "Content"
    },
    "custom_content": {
        "1": "2"
    },

    "ttl": 3600 // [int: seconds] Optional, span of time the notification stays alive before being delivered to the user
}

ارسال اعلان پیشرفته

همه ی امکاناتی که در اعلان پیشرفته از طریق پنل قابل انتخاب است را می توانید از طریق API هم استفاده کنید. فرمت یک اعلان پیشرفته که حاوی همه ی امکانات پنل باشد به صورت زیر است:

{
  "app_ids": [
    "com.example.app"
  ],
  "data": {
    "title": "عنوان",
    "content": "تیتر",
    "big_title": "تیتر کامل",
    "big_content": "متن بزرگ",
    "summary": "چکیده ",
    "image": "http://url/name.png",
    "icon": "http://url/name.png",
    "ticker": "متن نوار اعلان",
    "notif_icon": "file_download",
    "wake_screen": true,
    "sound_url": "http://static.pushe.co/mp3/2.mp3",
    "visibility": true,
    "led_color": "-8206336",
    "show_app": true,
    "led_on": 300,
    "led_off": 500,
    "delay_until": true,
    "collapse_key": "key1",
    "time_to_live": 172800,
    "action": {
      "url": "tg://join?invite=sdfdsfdsfds",
      "action_type": "U"
    },
    "buttons": [
      {
        "btn_icon": "file download",
        "btn_order": 1,
        "btn_content": "متن دکمه",
        "btn_id": 1,
        "btn_action": {
          "url": "tg://join?invite=fdsfdsfds",
          "action_type": "U"
        }
      },
      {
        "btn_icon": "local cafe",
        "btn_order": 2,
        "btn_content": "متن دکمه",
        "btn_id": 2,
        "btn_action": {
          "url": "http://fgfdgfdg.com",
          "action_type": "U"
        }
      },
      {
        "btn_icon": "phone android",
        "btn_order": 3,
        "btn_content": "متن دکمه",
        "btn_id": 3,
        "btn_action": {
          "url": "call:dddd",
          "action_type": "U"
        }
      }
    ]
  },
  "filters": {
    "operator": [
      "ir-mci", "irancell", "rightel"
    ],
    "brand": [
      "samsung", "LGE", "asus", "htc", "lenovo", "sony", "huawei"
    ],
    "mobile_net": [
      "lte", "wifi" 
    ],
    "state": [
      "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":[
      "1.0", "2.0"
    ],
    "visits":[
      {
        "type":"created_at",
        "op":"lt",
        "value":"number of days(string)"
      },
      {
        "type":"created_at",
        "op":"gt",
        "value":"number of days(string)"
      },
      {
        "type":"created_at",
        "op":"eq",
        "value":"number of days(string)"
      }
    ],
    "events":[
      {
        "type":"created_at",
        "op":"lt",
        "value":"number of days(string)",
        "name":"name_of_events"
      },
      {
        "type":"updated_at",
        "op":"gt",
        "value":"number of days(string)",
        "name":"name_of_events"
      },
      {
        "type":"freq",
        "op":"eq",
        "value":"number of days(string)",
        "name":"name_of_events"
      }
    ]
  },
  "topics":["topic_name1", ...],
  "unique": true,
  "eta":"2016-10-18T13:28:00+03:30",
  "rate_limit": "بزودی",
  "platform": 1,
  "priority": 1,
  "abt_ids": ["notification_wrapper_id", ...] 
}

همه ی کلیدهای استفاده شده در اعلان پیشرفته در جدول ۱ توضیح داده شده اند.

جدول ۱. کلیدهای اعلان پیشرفته

بعضی از کلید ها مقدارهای مختلف می گیرند که در جدول ۲ و جدول ۳ توضیح داده شده است.

# نام                                                                                     کاربرد                                                              مقادیر ممکن
1 applications قرار دادن نام پکیج اپلیکیشن ها رشته ای از نام بسته ها
2 title تیتر اعلان کوچک کاراکتر
3 Content متن اعلان کوچک کاراکتر
4 Big_title تیتر اعلان بزرگ(غیر فشرده) کاراکتر
5 Big_content متن اعلان بزرگ (غیر فشرده) کاراکتر
6 summary متن خلاصه اعلان کاراکتر
7 image عکس بنر URL عکس
8 icon انتخاب آیکون داخلی پوش URL آیکون
9 ticker متن نوار اعلان کاراکتر
10 notif_icon آیکون جایگزین آیکون اپ یکی از مقادیر جدول ۲
11 wake_screen روشن شدن صفحه نمایش به هنگام دریافت پیام بولین True/False
12 sound_url تغییر صدای هشدار به هنگام دریافت اعلان url صدا
13 notif_channel_id ارسال به کاربران کانال خاص رشته‌ای که حاوی شناسه کانال می‌باشد
14 visibility اعلان نمایش داده شود یا خیر بولین True/False
15 led_color led تعیین رنگ عدد صحیح متناظر با رنگ با استفاده این ابزار
16 led_on led زمان روشن ماندن زمان به میلی ثانیه
17 led_off led زمان خاموش ماندن زمان به میلی ثانیه
18 action_type تعیین نوع عملکرد مقادیر جدول ۳
19 url تعیین هدف عملکرد مقادیر جدول ۳
10 btn_order ترتیب دکمه یکی از اعداد 1، 2 یا 3
21 btn_content متن دکمه کاراکتر
22 btn_icon آیکون دکمه یکی از مقادیر جدول ۲
23 btn_id ID دکمه ID دکمه، برابر با همان مقدار btn_order
24 btn_action عملکرد دکمه مقادیر جدول ۳
25 delay_until عدم نمایش تا زمانی که گوشی غیرفعال است بولین True/False
26 collapse_key کلید جابجایی کاراکتر
27 time_to_live زمان ماندگاری زمان به ثانیه
28 operator نام اپراتور موبایل "ir-mci", "irancell", "rightel"
29 brand نام برند دستگاه "samsung", "LGE", "asus", "htc", "lenovo", "sony", "huawei"
30 mobile_net نوع اینترنت "lte", "wifi"
31 state استان "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"
32 app_version تعیین ورژن‌هایی که پیام ارسال شود لیستی از ورژن‌‌های اپلیکیشن
33 events فیلتر کاربران بر اساس رخدادهایی که ثبت شده است. لیستی از رخداد‌ها
34 visits فیلتر کاربران بر اساس بازدیدهایی که ثبت شده است. لیستی از بازدید‌ها
35 topics تعیین تاپیک‌ها که پیام ارسال شود لیستی‌ای از نام تاپیک‌هاکه با کاما جدا شوند
36 unique به کاربران مشترک اپها یک پیام ارسال شود بولین True/False
37 eta تعیین زمان ارسال "2016-10-18T13:28:00+03:30"
38 rate_limit (بزودی) ارسال در طول بازه زمانی زمان به ثانیه
39 platform پلتفرمی که اعلان برای آن ساخته شده است. یکی از اعداد: ۱ برای اندروید - ۲ برای وب - ۳ برای آی او اس
40 priority مشحص کننده اولیت اعلان ساخته است. یکی از اعداد : ۱ برای اولیت کم - ۲ برای اولیت متوسط -۳ برای اولیت زیاد
41 abt_ids(بزودی) فیلتر A/B test لییستی از شناسه اعلان‌هایی که قبلا ارسال شده است.

جدول ۲. آیکون ها

مقدار آیکون مقدار آیکون مقدار آیکون مقدار آیکون
airplane
airplanemode_active
alarm
alarm
announcement
announcement
apps
apps
attach_money
attach_money
audiotrack
audiotrack
build
build
business
business
call
call
cancel
cancel
card_giftcard
card_giftcard
chat
chat
check
check
check_box
check_box
close
close
delete
delete
edit
edit
email
email
event
event
forward
forward
group
group
help
help
highlight_off
highlight_off
history
history
home
home
image
image
info
info
exit_to_app
exit_to_app
favorite
favorite
file_download
file_download
file_upload
file_upload
flag
flag
notifications
notifications
open_in_browser
open_in_browser
pause_circle_filled
pause_circle_filled
payment
payment
person
person
phone_android
phone_android
photo_camera
photo_camera
place
place
language
language
local_cafe
local_cafe
local_dining
local_dining
local_offer
local_offer
loyalty
loyalty
map
map
mood_bad
mood_bad
mood
mood
attach
attach_file

جدول ۳. انواع عملکرد

مقدار کلید توضیح نوع عملکرد
"A" باز کردن اپلیکیشن url:""
"D" بستن اعلان url:""
"G" باز کردن دیالوگ url:""
"T" باز کردن اکتیویتی action_data:"نام اکتیویتی"
"W" باز کردن وب ویو url:"لینک شما"
"U" باز کردن لینک در مرورگر url:"لینک شما"
"U" پیوستن کانال تلگرام url:"tg://join?invite=لینک پیوستن"
"U" دعوت به کانال url:"tg://resolve?domain=نام کانال"
"U" باز کردن صفحه اپ در مایکت url:"myket://application/#Intent;scheme=myket;package=com.example.app;refId=[pushe];end"
"U" باز کردن صفحه اپ در بازار url:"bazaar://details?id=شناسه اپلیکیشن"
"U" باز کردن صفحه اپ در ایران اپس url:"iranapps://app/شناسه اپلیکیشن"
"U" باز کردن صفحه اپ در گوگل پلی url:"market://dev?id=شناسه اپلیکیشن"
"U" باز کردن صفحه توسعه دهنده در بازار url:"bazaar://collection?slug=by_author&aid=شناسه اپلیکیشن"
"U" باز کردن صفحه توسعه دهنده در ایران اپس url:"iranapps://user/شناسه اپلیکیشن"
"U" باز کردن صفحه توسعه دهنده در گوگل پلی url:"market://dev?id=شناسه اپلیکیشن"
"U" باز کردن شماره گیر url:"tel:شماره تلفن"
"U" باز کردن صفحه پیامک url:"sms:شماره پیامک?body=متن پیام"
"U" باز کردن نرم افزار ایمیل و پر کردن مقادیر url:"mailto:آدرس ایمیل?subject=عنوان ایمیل&body=متن ایمیل"
"U" سایر اینتنت ها url:"اینتنت مورد نظر"

جدول ۴. کدهای رنگ led

رنگ نشان داده شده کد رنگ رنگ نشان داده شده کد رنگ
-65536 -3286016
-16776961 -14336
-16711936 -26624
-256 -8206336
-43264 -16711681
-65436 -16733441
-5635841

جدول ۵. کدهای framework

کد چارچوب نام چارچوب نام چارچوب به لاتین
۱ کوردوا cordova
۲ اندروید android studio
۳ بیسیک۴اندروید basic4android
۴ یونیتی unity
۵ اکلیپس eclipse
۶ ری‌اکت نیتیو react native
۷ اپلیکیشن ساز app builder
۸ ایکس کد xcode

همیشه در کنارتان هستیم

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

شاید جواب سوال شما اینجا باشد: سوالات متداول ، مستندات
وارد کردن تمامی فیلد ها الزامی است.
پیام شما با موفقیت ارسال شد