বিষয়বস্তুতে যান

iOS লাইভ অ্যাক্টিভিটিজ API

Apple ডকুমেন্টেশন:

startLiveActivity

Anchor link to

POST https://api.pushwoosh.com/json/1.3/startLiveActivity

iOS লাইভ অ্যাক্টিভিটিজ তৈরি করার অনুমতি দেয়।

রিকোয়েস্ট বডি

Anchor link to
প্যারামিটারটাইপপ্রয়োজনীয়/ঐচ্ছিকবর্ণনা
applicationStringপ্রয়োজনীয়Pushwoosh অ্যাপ্লিকেশন কোড
authStringপ্রয়োজনীয়Pushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন
notificationsArrayপ্রয়োজনীয়মেসেজ প্যারামিটারের JSON অ্যারে। নিচের নোটিফিকেশন টেবিলে বিস্তারিত দেখুন।

নোটিফিকেশন

Anchor link to

notifications অ্যারেতে ব্যবহৃত প্যারামিটার:

প্যারামিটারটাইপপ্রয়োজনীয়/ঐচ্ছিকবর্ণনা
contentStringপ্রয়োজনীয়iOS 16.1-এর নিচের ভার্সন চালিত ডিভাইসগুলির জন্য ফলব্যাক কন্টেন্ট, যা লাইভ অ্যাক্টিভিটি সাপোর্ট করে না। iOS 16.1+ (লাইভ অ্যাক্টিভিটি সাপোর্ট সহ) ডিভাইসে, কন্টেন্ট live_activity ফিল্ড থেকে নেওয়া হয়।
titleStringঐচ্ছিকনোটিফিকেশন মেসেজের টাইটেল।
live_activityObjectপ্রয়োজনীয়iOS-এ লাইভ অ্যাক্টিভিটি তৈরি করার জন্য লাইভ অ্যাক্টিভিটি ডেটা।
live_activity.content-stateObjectপ্রয়োজনীয়লাইভ অ্যাক্টিভিটি নোটিফিকেশনের জন্য কন্টেন্ট।
live_activity.attributes-typeStringপ্রয়োজনীয়লাইভ অ্যাক্টিভিটিতে ব্যবহৃত অ্যাট্রিবিউটের প্রকার।
live_activity.attributesObjectপ্রয়োজনীয়লাইভ অ্যাক্টিভিটির জন্য অ্যাট্রিবিউট।
live_activity_idStringপ্রয়োজনীয়লাইভ অ্যাক্টিভিটির জন্য একটি ইউনিক আইডেন্টিফায়ার। updateLiveActivity কল করার সময় এই অ্যাক্টিভিটিটিকে টার্গেট করতে ব্যবহৃত হয়। প্রতিটি অ্যাক্টিভিটি সেশনের জন্য ইউনিক হতে হবে।
filterStringঐচ্ছিকএকটি Pushwoosh ফিল্টারের (সেগমেন্ট) নাম। দেখুন সেগমেন্ট / ফিল্টার নাম। এই ফিল্টারের সাথে মিলে যাওয়া সমস্ত ডিভাইসে লাইভ অ্যাক্টিভিটি শুরু হবে।
devicesArray of Stringsঐচ্ছিকডিভাইস টোকেন এর একটি তালিকা। শুধুমাত্র নির্দিষ্ট ডিভাইসগুলিতে লাইভ অ্যাক্টিভিটি শুরু হবে।
send_dateStringঐচ্ছিকএকটি নির্দিষ্ট তারিখ এবং সময়ের জন্য লাইভ অ্যাক্টিভিটি শুরু করা পুশটি শিডিউল করে — filter বা devices টার্গেটিংয়ের সাথে কাজ করে। YYYY-MM-DD HH:mm ফরম্যাট ব্যবহার করুন, অথবা অবিলম্বে শুরু করতে now ব্যবহার করুন (প্যারামিটারটি বাদ দেওয়া হলে এটিই ডিফল্ট)। এটি অতীতের ১ দিনের বেশি বা ভবিষ্যতের ৩০ দিনের বেশি হতে পারবে না, অন্যথায় রিকোয়েস্টটি একটি ভ্যালিডেশন ত্রুটির সাথে প্রত্যাখ্যান করা হবে।
timezoneStringঐচ্ছিকsend_date ব্যাখ্যা করতে ব্যবহৃত টাইমজোন। যদি বাদ দেওয়া হয়, send_date UTC-তে ব্যাখ্যা করা হয়।

রিকোয়েস্টের উদাহরণ

Anchor link to
{
"request": {
"application": "XXXXX-XXXXX",
"auth": "SECRET_API_TOKEN",
"notifications": [
{
"content": "Your order is being prepared",
"title": "Food Delivery",
"live_activity": {
"event": "start",
"title": "Order status",
"content-state": {
"status": "Third",
"estimatedTime": "37 min",
"emoji": "👨‍🍳"
},
"attributes-type": "FoodDeliveryAttributes",
"attributes": {}
},
"live_activity_id": "FIRST_LIVE_ACTIVITY",
"filter": "FILTER_NAME_1"
}
]
}
}

রেসপন্সের উদাহরণ

Anchor link to
{
"status_code": 200,
"status_message": "OK",
"response": {
"Messages": [
"XXXXX-XXXXXXXX-XXXXXXXX"
]
}
}

দ্রষ্টব্য:

Pushwoosh iOS SDK ব্যবহার করে লাইভ অ্যাক্টিভিটিজ নিয়ে কাজ করার বিষয়ে আরও জানতে এই নিবন্ধটি পড়ুন।

updateLiveActivity

Anchor link to

POST https://api.pushwoosh.com/json/1.3/updateLiveActivity

iOS লাইভ অ্যাক্টিভিটিজ আপডেট এবং শেষ করার অনুমতি দেয়।

রিকোয়েস্ট বডি

Anchor link to
প্যারামিটারটাইপপ্রয়োজনীয়/ঐচ্ছিকবর্ণনা
authStringপ্রয়োজনীয়Pushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন
applicationStringপ্রয়োজনীয়Pushwoosh অ্যাপ্লিকেশন কোড
notificationsArrayপ্রয়োজনীয়মেসেজ প্যারামিটারের JSON অ্যারে। নিচের নোটিফিকেশন টেবিলে বিস্তারিত দেখুন।

নোটিফিকেশন

Anchor link to

notifications অ্যারেতে ব্যবহৃত প্যারামিটার:

প্যারামিটারটাইপপ্রয়োজনীয়/ঐচ্ছিকবর্ণনা
live_activityObjectপ্রয়োজনীয়iOS-এ লাইভ অ্যাক্টিভিটি আপডেট করার জন্য লাইভ অ্যাক্টিভিটি ডেটা।
live_activity.eventStringপ্রয়োজনীয়ইভেন্টের প্রকার নির্দিষ্ট করে। লাইভ অ্যাক্টিভিটি আপডেট করতে "update" ব্যবহার করুন অথবা এটি বন্ধ করতে "end" ব্যবহার করুন।
live_activity.content-stateObjectপ্রয়োজনীয়কী-ভ্যালু পেয়ার সহ অবজেক্ট যা লাইভ অ্যাক্টিভিটিতে তার কন্টেন্ট আপডেট করার জন্য ডেটা পাস করতে ব্যবহৃত হয়।
live_activity.dismissal-dateIntegerঐচ্ছিকসময় (সেকেন্ডে) যখন লাইভ অ্যাক্টিভিটি শেষ হওয়া উচিত।
live_activity_idStringপ্রয়োজনীয়আপডেট করার জন্য লাইভ অ্যাক্টিভিটির ইউনিক আইডেন্টিফায়ার। startLiveActivity-তে ব্যবহৃত live_activity_id-এর সাথে অবশ্যই মিলতে হবে। আপডেটটি সেই সমস্ত ডিভাইসে বিতরণ করা হবে যেখানে এই অ্যাক্টিভিটি শুরু হয়েছিল।
live_activity.relevance-scoreIntegerঐচ্ছিকiOS সিস্টেমকে জানায় কোন লাইভ অ্যাক্টিভিটির অগ্রাধিকার অন্যদের চেয়ে বেশি। ১ থেকে অসীম পর্যন্ত মান গ্রহণ করে (১০০ পর্যন্ত মান সুপারিশ করা হয়)।
live_activity.stale-dateIntegerঐচ্ছিকসময় (সেকেন্ডে) যা সেই তারিখটিকে প্রতিনিধিত্ব করে যখন একটি লাইভ অ্যাক্টিভিটি পুরনো বা অচল হয়ে যায়।

রিকোয়েস্টের উদাহরণ

Anchor link to
{
"request": {
"application": "XXXXX-XXXXX",
"auth": "SECRET_API_TOKEN",
"notifications": [
{
"live_activity": {
"event": "update",
"title": "Live Activity Update",
"content-state": {
"status": "second 66",
"estimatedTime": "66 min",
"emoji": "👨‍"
},
"relevance-score": 60
},
"live_activity_id": "FIRST_LIVE_ACTIVITY"
}
]
}
}

রেসপন্সের উদাহরণ

Anchor link to
{
"status_code": 200,
"status_message": "OK",
"response": {
"Messages": [
"XXXXX-XXXXXXXX-XXXXXXXX"
]
}
}

Pushwoosh iOS SDK ব্যবহার করে লাইভ অ্যাক্টিভিটিজ নিয়ে কাজ করার বিষয়ে আরও জানতে এই নিবন্ধটি পড়ুন

প্রতি ডিভাইসে একাধিক অ্যাক্টিভিটি

Anchor link to

আপনি একই ডিভাইসে একাধিক লাইভ অ্যাক্টিভিটি শুরু করতে পারেন, ভিন্ন ভিন্ন live_activity_id মান দিয়ে startLiveActivity একাধিকবার কল করে।

উদাহরণস্বরূপ, যদি আপনি দুটি অ্যাক্টিভিটি শুরু করেন: FIRST_LIVE_ACTIVITY filter: FILTER_NAME_1 সহ এবং SECOND_LIVE_ACTIVITY filter: FILTER_NAME_2 সহ, তাহলে যে ডিভাইসটি উভয় ফিল্টারের সাথে মেলে, সেখানে উভয় অ্যাক্টিভিটি একই সাথে চলবে।

তাদের মধ্যে একটি আপডেট করতে, তার live_activity_id updateLiveActivity-তে পাস করুন। আপডেটটি সেই সমস্ত ডিভাইসে পৌঁছে দেওয়া হয় যেখানে সেই অ্যাক্টিভিটি তৈরি হয়েছিল। অন্য অ্যাক্টিভিটি প্রভাবিত হয় না।

relevance-score প্যারামিটারটি ডিসপ্লে অগ্রাধিকার নিয়ন্ত্রণ করে যখন একই ডিভাইসে একাধিক লাইভ অ্যাক্টিভিটি সক্রিয় থাকে। যদি স্ক্রিনের জায়গা সীমিত থাকে বা অ্যাক্টিভিটিগুলি গ্রুপ করা হয়, তবে উচ্চতর মান সহ অ্যাক্টিভিটিটি উচ্চতর অগ্রাধিকারের সাথে দেখানো হয়।