सामग्री पर जाएं
उपयोगकर्ता गाइडसहायता डेमो अनुरोध करें साइन इन करें
Pushwoosh.com

iOS लाइव एक्टिविटीज़ API

Apple दस्तावेज़ीकरण:

startLiveActivity

Anchor link to

iOS लाइव एक्टिविटीज़ बनाने के लिए इस मेथड का उपयोग करें।

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

iOS लाइव एक्टिविटीज़ बनाने की अनुमति देता है।

अनुरोध बॉडी

Anchor link to
पैरामीटरप्रकारआवश्यक/वैकल्पिकविवरण
applicationस्ट्रिंगआवश्यकPushwoosh एप्लिकेशन कोड
authस्ट्रिंगआवश्यकPushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
notificationsऐरेआवश्यकसंदेश पैरामीटर का JSON ऐरे। नीचे दिए गए नोटिफिकेशन टेबल में विवरण देखें।

नोटिफिकेशन

Anchor link to

notifications ऐरे में उपयोग किए गए पैरामीटर:

पैरामीटरप्रकारआवश्यक/वैकल्पिकविवरण
contentस्ट्रिंगआवश्यक16.1 से नीचे के iOS संस्करण चलाने वाले डिवाइसों के लिए फ़ॉलबैक कंटेंट जो लाइव एक्टिविटी का समर्थन नहीं करते हैं। iOS 16.1+ पर (लाइव एक्टिविटी समर्थन के साथ), कंटेंट live_activity फ़ील्ड से लिया जाता है।
titleस्ट्रिंगवैकल्पिकनोटिफिकेशन संदेश का शीर्षक।
live_activityऑब्जेक्टआवश्यकiOS में लाइव एक्टिविटी बनाने के लिए लाइव एक्टिविटी डेटा।
content-stateऑब्जेक्टआवश्यकलाइव एक्टिविटी नोटिफिकेशन के लिए कंटेंट।
attributes-typeस्ट्रिंगआवश्यकलाइव एक्टिविटी में उपयोग किए गए एट्रिब्यूट्स का प्रकार।
attributesऑब्जेक्टआवश्यकलाइव एक्टिविटी के लिए एट्रिब्यूट्स।
live_activity_idस्ट्रिंगआवश्यकलाइव एक्टिविटी के लिए एक यूनिक ID, जो उपयोगकर्ता द्वारा बनाई गई है।
filter_codeस्ट्रिंगवैकल्पिकविशिष्ट ऑडियंस सेगमेंट को लक्षित करने के लिए फ़िल्टर (सेगमेंट) कोड।
devicesस्ट्रिंग्स का ऐरेवैकल्पिकलक्षित पुश नोटिफिकेशन भेजने के लिए टोकन या HWID, अधिकतम 1000 के साथ। यदि सेट किया गया है, तो संदेश केवल सूची में मौजूद डिवाइसों को भेजा जाएगा। ध्यान दें: डिवाइस सूची के लिए एप्लिकेशन ग्रुप की अनुमति नहीं है, और iOS पुश टोकन लोअरकेस में होने चाहिए।
usersस्ट्रिंग्स का ऐरेवैकल्पिकयदि सेट किया गया है, तो संदेश केवल निर्दिष्ट यूज़र आईडी को ही दिया जाएगा (/registerUser कॉल के माध्यम से असाइन किया गया)। आप ऐरे में 1000 तक यूज़र आईडी शामिल कर सकते हैं। ध्यान दें: यदि devices पैरामीटर के साथ उपयोग किया जाता है, तो users पैरामीटर को प्राथमिकता दी जाएगी। यूज़र सूची के लिए एप्लिकेशन ग्रुप की अनुमति नहीं है।

प्रतिक्रिया

Anchor link to

200

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

अनुरोध का उदाहरण

Anchor link to
{
  "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"                    //           एक ऐरे में 1000 से अधिक टोकन/hwid नहीं।
      ],                                 //           यदि सेट किया गया है, तो संदेश केवल सूची में मौजूद डिवाइसों को भेजा जाएगा।
                                         //           डिवाइस सूची के लिए एप्लिकेशन ग्रुप की अनुमति नहीं है।
                                         //           iOS पुश टोकन केवल लोअरकेस में हो सकते हैं।
      "users": [                         // वैकल्पिक। यदि सेट किया गया है, तो संदेश केवल निर्दिष्ट
        "user_XXXX"                      //           यूज़र आईडी को ही दिया जाएगा (/registerUser कॉल के माध्यम से सेट)। यदि डिवाइस
      ]                                  //           पैरामीटर के साथ निर्दिष्ट किया गया है, तो बाद वाले को अनदेखा कर दिया जाएगा।
                                         //           एक ऐरे में 1000 से अधिक यूज़र आईडी नहीं।
                                         //           यूज़र सूची के लिए एप्लिकेशन ग्रुप की अनुमति नहीं है।
    }]
  }
}

ध्यान दें:

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

updateLiveActivity

Anchor link to

iOS लाइव एक्टिविटीज़ को प्रबंधित करने के लिए इस मेथड का उपयोग करें।

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

iOS लाइव एक्टिविटीज़ बनाने और प्रबंधित करने की अनुमति देता है।

अनुरोध बॉडी

Anchor link to
पैरामीटरप्रकारआवश्यक/वैकल्पिकविवरण
authस्ट्रिंगआवश्यकPushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
applicationस्ट्रिंगआवश्यकPushwoosh एप्लिकेशन कोड
notificationsऐरेआवश्यकसंदेश पैरामीटर का JSON ऐरे। नीचे दिए गए नोटिफिकेशन टेबल में विवरण देखें।

नोटिफिकेशन

Anchor link to

notifications ऐरे में उपयोग किए गए पैरामीटर:

पैरामीटरप्रकारआवश्यक/वैकल्पिकविवरण
live_activityऑब्जेक्टआवश्यकiOS में लाइव एक्टिविटी को अपडेट करने के लिए लाइव एक्टिविटी डेटा।
eventस्ट्रिंगआवश्यकइवेंट प्रकार निर्दिष्ट करता है। लाइव एक्टिविटी को अपडेट करने के लिए "update" का उपयोग करें या इसे बंद करने के लिए "end" का उपयोग करें।
content-stateऑब्जेक्टआवश्यककी-वैल्यू पेयर वाला ऑब्जेक्ट जिसका उपयोग लाइव एक्टिविटी को उसके कंटेंट को अपडेट करने के लिए डेटा पास करने के लिए किया जाता है।
dismissal-dateइंटीजरवैकल्पिकवह समय (सेकंड में) जब लाइव एक्टिविटी समाप्त होनी चाहिए।
live_activity_idस्ट्रिंगआवश्यकअपडेट की जा रही लाइव एक्टिविटी के लिए एक यूनिक पहचानकर्ता।
relevance-scoreइंटीजरवैकल्पिकiOS सिस्टम को बताता है कि किस लाइव एक्टिविटी की प्राथमिकता दूसरों से अधिक है। 1 से अनंत तक के मान स्वीकार करता है (100 तक के मान अनुशंसित हैं)।
stale-dateइंटीजरवैकल्पिकवह समय (सेकंड में) जो उस तारीख का प्रतिनिधित्व करता है जिस पर एक लाइव एक्टिविटी पुरानी या आउट-ऑफ-डेट हो जाती है।
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "Messages": [
      "C3F8-C3863ED4-334AD4F1"
    ]
  }
}

अनुरोध का उदाहरण

Anchor link to
{
  "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,           // वैकल्पिक। लाइव एक्टिविटी के लिए प्राथमिकता (1 से 100 अनुशंसित)
        "stale-date": 23456789           // वैकल्पिक। समय (सेकंड में) जब लाइव एक्टिविटी पुरानी हो जाती है
      },
      "live_activity_id": "unique UUID"  // वैकल्पिक। लाइव एक्टिविटी का यूनिक पहचानकर्ता।
    }]
  }
}

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