iOS Live Activities API

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

• Live Activities সম্পর্কে
• ActivityKit পুশ নোটিফিকেশনের মাধ্যমে Live Activities আপডেট এবং শেষ করা

startLiveActivity

iOS Live Activities তৈরি করতে এই মেথডটি ব্যবহার করুন।

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

iOS Live Activities তৈরি করার অনুমতি দেয়।

Request body

প্যারামিটার	টাইপ	আবশ্যক/ঐচ্ছিক	বিবরণ
application	String	আবশ্যক	Pushwoosh অ্যাপ্লিকেশন কোড
auth	String	আবশ্যক	Pushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন।
notifications	Array	আবশ্যক	মেসেজ প্যারামিটারের JSON অ্যারে। নিচের Notifications টেবিলে বিস্তারিত দেখুন।

Notifications

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

প্যারামিটার	টাইপ	আবশ্যক/ঐচ্ছিক	বিবরণ
content	String	আবশ্যক	iOS 16.1 এর নিচের সংস্করণের ডিভাইসগুলির জন্য ফলব্যাক কন্টেন্ট যা Live Activity সমর্থন করে না। iOS 16.1+ (Live Activity সমর্থন সহ) এ, কন্টেন্ট live_activity ফিল্ড থেকে নেওয়া হয়।
title	String	ঐচ্ছিক	নোটিফিকেশন মেসেজের শিরোনাম।
live_activity	Object	আবশ্যক	iOS-এ Live Activity তৈরি করার জন্য Live Activity ডেটা।
content-state	Object	আবশ্যক	Live Activity নোটিফিকেশনের জন্য কন্টেন্ট।
attributes-type	String	আবশ্যক	Live Activity-তে ব্যবহৃত অ্যাট্রিবিউটের ধরন।
attributes	Object	আবশ্যক	Live Activity-র জন্য অ্যাট্রিবিউট।
live_activity_id	String	আবশ্যক	Live Activity-র জন্য একটি অনন্য (unique) ID, যা ব্যবহারকারী তৈরি করেন।
filter_code	String	ঐচ্ছিক	নির্দিষ্ট অডিয়েন্স সেগমেন্টকে টার্গেট করতে ফিল্টার (সেগমেন্ট) কোড।
devices	Array of strings	ঐচ্ছিক	টার্গেটেড পুশ নোটিফিকেশন পাঠাতে টোকেন বা HWIDs, সর্বোচ্চ ১০০০টি। যদি সেট করা হয়, মেসেজটি শুধুমাত্র তালিকার ডিভাইসগুলিতে পাঠানো হবে। নোট: ডিভাইস তালিকার জন্য অ্যাপ্লিকেশন গ্রুপ অনুমোদিত নয়, এবং iOS পুশ টোকেন অবশ্যই ছোট হাতের (lowercase) হতে হবে।
users	Array of strings	ঐচ্ছিক	যদি সেট করা হয়, মেসেজটি শুধুমাত্র নির্দিষ্ট User ID গুলিতে বিতরণ করা হবে (/registerUser কলের মাধ্যমে অ্যাসাইন করা)। আপনি অ্যারেতে ১০০০টি পর্যন্ত ইউজার আইডি অন্তর্ভুক্ত করতে পারেন। নোট: যদি devices প্যারামিটারের সাথে একসাথে ব্যবহার করা হয়, তবে users প্যারামিটার অগ্রাধিকার পাবে। ইউজার তালিকার জন্য অ্যাপ্লিকেশন গ্রুপ অনুমোদিত নয়।

Response

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "Messages": [
      "C3F8-C3863ED4-334AD4F1"
    ]
  }
}

Request example

{
  "request": {
    "application": "XXXXX-XXXXX",        // আবশ্যক। Pushwoosh অ্যাপ্লিকেশন কোড
    "auth": "yxoPUlwqm…………pIyEX4H",      // আবশ্যক। Pushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন
    "notifications": [{
      "live_activity": {                 // আবশ্যক। iOS-এ Live Activity তৈরি করার জন্য Live Activity ডেটা
        "content-state": {
          "emoji": ":wink:"
        },
        "attributes-type": "LiveActivityAttributes",
        "attributes": {
          "name": "Apple"
        }
      },
      "live_activity_id": "unique UUID", // ঐচ্ছিক। Live Activity-র অনন্য আইডেন্টিফায়ার।
      "filter_code": "FILTER_NAME",      // ঐচ্ছিক। ফিল্টার নির্দিষ্ট করুন।
      "devices": [                       // ঐচ্ছিক। টার্গেটেড পুশ নোটিফিকেশন পাঠাতে টোকেন বা hwid নির্দিষ্ট করুন।
          "hwid_XXXX"                    //           অ্যারেতে ১০০০টির বেশি টোকেন/hwid নয়।
      ],                                 //           যদি সেট করা হয়, মেসেজটি শুধুমাত্র তালিকার ডিভাইসগুলিতে
                                         //           পাঠানো হবে। ডিভাইস তালিকার জন্য অ্যাপ্লিকেশন গ্রুপ
                                         //           অনুমোদিত নয়।
                                         //           iOS পুশ টোকেন শুধুমাত্র ছোট হাতের হতে পারে।
      "users": [                         // ঐচ্ছিক। যদি সেট করা হয়, মেসেজটি শুধুমাত্র নির্দিষ্ট ইউজার আইডিতে
        "user_XXXX"                      //           বিতরণ করা হবে (/registerUser কলের মাধ্যমে সেট করা)।
      ]                                  //           যদি devices প্যারামিটারের সাথে নির্দিষ্ট করা হয়, তবে পরেরটি
                                         //           উপেক্ষা করা হবে। অ্যারেতে ১০০০টির বেশি ইউজার আইডি নয়।
                                         //           ইউজার তালিকার জন্য অ্যাপ্লিকেশন গ্রুপ অনুমোদিত নয়।
    }]
  }
}

নোট:

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

updateLiveActivity

iOS Live Activities পরিচালনা করতে এই মেথডটি ব্যবহার করুন।

নোট

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

• Live Activities সম্পর্কে
• ActivityKit পুশ নোটিফিকেশনের মাধ্যমে Live Activities আপডেট এবং শেষ করা

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

iOS Live Activities তৈরি এবং পরিচালনা করার অনুমতি দেয়।

Request body

প্যারামিটার	টাইপ	আবশ্যক/ঐচ্ছিক	বিবরণ
auth	String	আবশ্যক	Pushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন।
application	String	আবশ্যক	Pushwoosh অ্যাপ্লিকেশন কোড
notifications	Array	আবশ্যক	মেসেজ প্যারামিটারের JSON অ্যারে। নিচের Notifications টেবিলে বিস্তারিত দেখুন।

Notifications

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

প্যারামিটার	টাইপ	আবশ্যক/ঐচ্ছিক	বিবরণ
live_activity	Object	আবশ্যক	iOS-এ Live Activity আপডেট করার জন্য Live Activity ডেটা।
event	String	আবশ্যক	ইভেন্টের ধরন নির্দিষ্ট করে। Live Activity আপডেট করতে "update" অথবা বন্ধ করতে "end" ব্যবহার করুন।
content-state	Object	আবশ্যক	কন্টেন্ট আপডেট করার জন্য Live Activity-তে ডেটা পাস করতে ব্যবহৃত কী-ভ্যালু পেয়ার সহ অবজেক্ট।
dismissal-date	Integer	ঐচ্ছিক	সময় (সেকেন্ডে) যখন Live Activity শেষ হওয়া উচিত।
live_activity_id	String	আবশ্যক	আপডেট করা হচ্ছে এমন Live Activity-র জন্য একটি অনন্য আইডেন্টিফায়ার।
stale-date	Integer	ঐচ্ছিক	সময় (সেকেন্ডে) যা সেই তারিখ নির্দেশ করে যখন একটি Live Activity বাসি (stale) বা মেয়াদোত্তীর্ণ হয়ে যায়।

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "Messages": [
      "C3F8-C3863ED4-334AD4F1"
    ]
  }
}

Request example

{
  "request": {
    "application": "XXXXX-XXXXX",        // আবশ্যক। Pushwoosh অ্যাপ্লিকেশন কোড
    "auth": "yxoPUlwqm…………pIyEX4H",      // আবশ্যক। Pushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন
    "notifications": [{
      "live_activity": {                 // আবশ্যক। iOS-এ Live Activity আপডেট করার জন্য Live Activity ডেটা
        "event": "update",               // আবশ্যক। Live Activity আপডেট করতে "update" বা
                                         //           বন্ধ করতে "end" ব্যবহার করুন
        "content-state": {               // আবশ্যক। কন্টেন্ট আপডেট করার জন্য Live Activity-তে ডেটা পাস করতে
          "courierName": "NUMBER: 15",   //           ব্যবহৃত কী-ভ্যালু পেয়ার সহ অবজেক্ট
          "deliveryStatus": "Done"
        },
        "dismissal-date": 12345678,      // ঐচ্ছিক। সেকেন্ডে Live Activity শেষ হওয়ার সময়
        "stale-date": 23456789           // ঐচ্ছিক। সময় (সেকেন্ডে) যখন Live Activity বাসি (stale) হয়ে যায়
      },
      "live_activity_id": "unique UUID"  // ঐচ্ছিক। Live Activity-র অনন্য আইডেন্টিফায়ার।
    }]
  }
}

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