وب سرویس پوش نوتیفیکشن متد ارسال

shape
shape
shape
shape
shape
shape
shape
shape

API پوش نوتیفیکیشن متد ارسال

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

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

ارسال پوش نوتیفیکیشن

آدرس ارسال پوش

POST https://api.cheshmak.me/v1/push/app/{{appId}}/send

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

Name Type Required Default description
afterOpenType String True one of: openProgram,url,telegram
start Unix timestamp integer False Now زمان شروع ارسال
end Unix timestamp integer False ۲۴ ساعت پس از الآن زمان پایان ارسال: به شما کمک می کند تا مطمئن شوید پوش نوتیفیکیشن در خارج از بازه انتخابی شما ارسال نمی شود.
pushData.title String True عنوان پوش، ماکزیمم کاراکتر: ۱۰۰
pushData.shortMessage String False پیام کوتاه در پوش، ماکزیمم کاراکتر: ۱۰۰
pushData.icon String َURL | False | آدرس آیکن در اینترنت |
pushData.customData Stringified json False ‘{}’ یک JSON که به صورت String در آمده است و به منظور ارسال داده به اپلیکیشن به کار می رود
pushData.url String url False در صورت انتخاب url در afterOpenType به کار میرود
pushData.telegram String telegram url False در صورت انتخاب telegram در afterOpenType به کار میرود
filter.cheshmakIds array of string False لیستی از  Cheshmak ID هایی که قصد ارسال پیام به آن را دارید. ماکزیمم می‌تواند ۱۰۰ تا باشد.

در زیر لیست پاسخ های برگشتی از سرور نمایش داده شده است:

در صورت موفقیت در عملیات :

statusCode: 200

مقدار دریافتی:

{
“success”:true,
“pushId”: “ID”
}

در صورت خطا در ورود اطلاعات:

statusCode: 406

مقدار بازگشتی:

{
success: false,
error: 1, //invalid data
message: “”
}

در صورت بروز خطا در وارد کردن AppKey:

statusCode: 403

مقدار بازگشتی:

{
“success”: false,
“error”: 2,
“message”: “invalid appId or api key”
}

در صورت بروز خطای داخلی در پردازش:

statusCode: 500

مقدار بازگشتی:

{
success: false,
error: 3, //internal error
message: ‘internal server error’
}

یک مثال از دستور CURL مربوطه به صورت زیر می باشد:

curl -X POST -H “Content-Type: application/json” -H “key: APIKEY” \
-H “Cache-Control: no-cache” \
-d ‘{
“afterOpenType”:”openProgram”,
“pushData”:{
“title”:”this is some hi”
}
}’ “https://api.cheshmak.me/v1/push/app/57978086eeecf30b77359bb0/send”

مثالی از کد پی اچ پی برای ارسال پوش نوتیفیکیشن

<?php
$appId=”APP ID”;
$apiKey=”YOUR API KEY”;
$curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => “https://api.cheshmak.me/v1/push/app/$appId/send”,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => “”,
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => “POST”,
CURLOPT_POSTFIELDS => “{\n \”afterOpenType\”:\”openProgram\”,\n \”pushData\”:{\n \”title\”:\”this is some hi\”\n }\n}”,
CURLOPT_HTTPHEADER => array(
“cache-control: no-cache”,
“content-type: application/json”,
“key: $apiKey”
),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo “cURL Error #:” . $err;
} else {
echo $response;
}

یک مثال از دستور CURL برای ارسال به لیستی از چشمک آی دی ها:

curl -X POST -H “Content-Type: application/json” -H “key: APIKEY” \
-H “Cache-Control: no-cache” \
-d ‘{
“afterOpenType”: “openProgram”,
“pushData”: {
“title”: “sample title”,
“shortMessage”: “sample message”
},
“filter”: {
“cheshmakIds”: [
“a1a640d0-3284-11e9-89b0-130ce6a37a2b”
]
}
}’ “https://api.cheshmak.me/v1/push/app/57978086eeecf30b77359bb0/send”

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

منبع

پاسخی بگذارید

نشانی ایمیل شما منتشر نخواهد شد. بخش‌های موردنیاز علامت‌گذاری شده‌اند *