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

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

লাইভ অ্যাক্টিভিটিস সম্পর্কে

ActivityKit পুশ নোটিফিকেশনের মাধ্যমে আপনার লাইভ অ্যাক্টিভিটি আপডেট এবং শেষ করা

startLiveActivity

iOS লাইভ অ্যাক্টিভিটিস তৈরি করতে এই মেথডটি ব্যবহার করুন।

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

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

রিকোয়েস্ট বডি

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

নোটিফিকেশনস

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

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

রেসপন্স

200

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

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

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

দ্রষ্টব্য:

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

updateLiveActivity

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

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

iOS লাইভ অ্যাক্টিভিটিস তৈরি এবং পরিচালনা করার অনুমতি দেয়।

রিকোয়েস্ট বডি

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

নোটিফিকেশনস

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

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

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

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

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

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