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 Control Panel से API एक्सेस टोकन।
notifications	Array	आवश्यक	संदेश मापदंडों का JSON array। नीचे Notifications तालिका में विवरण देखें।

Notifications

notifications array में उपयोग किए जाने वाले पैरामीटर:

पैरामीटर	प्रकार	आवश्यक/वैकल्पिक	विवरण
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 का प्रकार।
attributes	Object	आवश्यक	Live Activity के लिए attributes।
live_activity_id	String	आवश्यक	Live Activity के लिए एक अद्वितीय ID, जो उपयोगकर्ता द्वारा बनाया गया है।
filter_code	String	वैकल्पिक	विशिष्ट ऑडियंस सेगमेंट को लक्षित करने के लिए Filter (Segment) कोड।
devices	Array of strings	वैकल्पिक	लक्षित पुश नोटिफिकेशन भेजने के लिए Tokens या HWIDs, अधिकतम 1000। यदि सेट किया जाता है, तो संदेश केवल सूची में मौजूद उपकरणों को भेजा जाएगा। नोट: उपकरणों की सूची के लिए Application Group की अनुमति नहीं है, और iOS पुश टोकन लोअरकेस में होने चाहिए।
users	Array of strings	वैकल्पिक	यदि सेट किया जाता है, तो संदेश केवल निर्दिष्ट User IDs (जो `/registerUser` कॉल के माध्यम से असाइन किए गए हैं) को वितरित किया जाएगा। आप array में 1000 तक user IDs शामिल कर सकते हैं। नोट: यदि `devices` पैरामीटर के साथ उपयोग किया जाता है, तो `users` पैरामीटर को प्राथमिकता दी जाएगी। उपयोगकर्ताओं की सूची के लिए Application Group की अनुमति नहीं है।

Response

200

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

Request example

{
  "request": {
    "application": "XXXXX-XXXXX",        // आवश्यक। Pushwoosh एप्लिकेशन कोड
    "auth": "yxoPUlwqm…………pIyEX4H",      // आवश्यक। Pushwoosh Control Panel से 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": [                       // वैकल्पिक। लक्षित पुश नोटिफिकेशन भेजने के लिए टोकन या hwids
          "hwid_XXXX"                    //           निर्दिष्ट करें। एक array में 1000 से अधिक टोकन/hwids नहीं।
      ],                                 //           यदि सेट किया जाता है, तो संदेश केवल सूची में मौजूद
                                         //           उपकरणों को भेजा जाएगा। उपकरणों की सूची के लिए
                                         //           Application Group की अनुमति नहीं है।
                                         //           iOS पुश टोकन केवल लोअरकेस हो सकते हैं।
      "users": [                         // वैकल्पिक। यदि सेट किया जाता है, तो संदेश केवल निर्दिष्ट
        "user_XXXX"                      //           user ID's (/registerUser कॉल के माध्यम से सेट) को वितरित किया जाएगा।
      ]                                  //           यदि devices पैरामीटर के साथ निर्दिष्ट किया जाता है, तो बाद वाले को
                                         //           अनदेखा कर दिया जाएगा। एक array में 1000 से अधिक user ID's नहीं।
                                         //           उपयोगकर्ताओं की सूची के लिए Application Group की अनुमति नहीं है।
    }]
  }
}

नोट:

Pushwoosh iOS SDK का उपयोग करके Live Activities के साथ काम करने के बारे में अधिक जानने के लिए यह लेख पढ़ें।

updateLiveActivity

iOS Live Activities को प्रबंधित करने के लिए इस विधि का उपयोग करें।

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

iOS Live Activities बनाने और प्रबंधित करने की अनुमति देता है।

Request body

पैरामीटर	प्रकार	आवश्यक/वैकल्पिक	विवरण
auth	String	आवश्यक	Pushwoosh Control Panel से API एक्सेस टोकन।
application	String	आवश्यक	Pushwoosh एप्लिकेशन कोड
notifications	Array	आवश्यक	संदेश मापदंडों का JSON array। नीचे Notifications तालिका में विवरण देखें।

Notifications

notifications array में उपयोग किए जाने वाले पैरामीटर:

पैरामीटर	प्रकार	आवश्यक/वैकल्पिक	विवरण
live_activity	Object	आवश्यक	iOS में Live Activity को अपडेट करने के लिए Live Activity डेटा।
event	String	आवश्यक	ईवेंट प्रकार निर्दिष्ट करता है। Live Activity को अपडेट करने के लिए `"update"` या इसे बंद करने के लिए `"end"` का उपयोग करें।
content-state	Object	आवश्यक	अपनी सामग्री को अपडेट करने के लिए Live Activity को डेटा पास करने के लिए उपयोग किए जाने वाले key-value जोड़े वाला ऑब्जेक्ट।
dismissal-date	Integer	वैकल्पिक	वह समय (सेकंड में) जब Live Activity समाप्त होनी चाहिए।
live_activity_id	String	आवश्यक	अपडेट की जा रही Live Activity के लिए एक अद्वितीय पहचानकर्ता।
stale-date	Integer	वैकल्पिक	वह समय (सेकंड में) जो उस तारीख का प्रतिनिधित्व करता है जिस पर Live Activity बासी (stale) या पुरानी हो जाती है।

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

Request example

{
  "request": {
    "application": "XXXXX-XXXXX",        // आवश्यक। Pushwoosh एप्लिकेशन कोड
    "auth": "yxoPUlwqm…………pIyEX4H",      // आवश्यक। Pushwoosh Control Panel से API एक्सेस टोकन
    "notifications": [{
      "live_activity": {                 // आवश्यक। iOS में Live Activity को अपडेट करने के लिए Live Activity डेटा
        "event": "update",               // आवश्यक। Live Activity को अपडेट करने के लिए "update" या
                                         //           Live Activity को बंद करने के लिए "end" का उपयोग करें
        "content-state": {               // आवश्यक। अपनी सामग्री को अपडेट करने के लिए Live Activity को
          "courierName": "NUMBER: 15",   //           डेटा पास करने के लिए उपयोग किए जाने वाले key-value जोड़े वाला ऑब्जेक्ट
          "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 के साथ काम करने के बारे में अधिक जानने के लिए यह लेख पढ़ें।