iOS Live Activities API

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

• Live Activities के बारे में
• ActivityKit पुश नोटिफिकेशन के साथ अपनी Live Activity को अपडेट करना और समाप्त करना

startLiveActivity

इस मेथड का उपयोग iOS Live Activities बनाने के लिए करें।

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

iOS Live Activities बनाने की अनुमति देता है।

रिक्वेस्ट बॉडी

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

नोटिफिकेशन्स

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

पैरामीटर	टाइप	आवश्यक/वैकल्पिक	विवरण
content	String	आवश्यक	16.1 से नीचे के iOS वर्शन पर चलने वाले डिवाइस के लिए फॉलबैक कंटेंट जो 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 के लिए एक यूनिक ID, जो यूज़र द्वारा बनाई गई है।

रिस्पॉन्स

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 में Live Activity बनाने के लिए Live Activity डेटा
        "content-state": {
          "emoji": ":wink:"
        },
        "attributes-type": "LiveActivityAttributes",
        "attributes": {
          "name": "Apple"
        }
      },
      "live_activity_id": "unique UUID"  // वैकल्पिक। Live Activity का यूनिक आइडेंटिफायर।
    }]
  }
}

ध्यान दें:

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

updateLiveActivity

इस मेथड का उपयोग iOS Live Activities को मैनेज करने के लिए करें।

नोट

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

• Live Activities के बारे में
• ActivityKit पुश नोटिफिकेशन के साथ अपनी Live Activity को अपडेट करना और समाप्त करना

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

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

रिक्वेस्ट बॉडी

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

नोटिफिकेशन्स

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 के लिए एक यूनिक आइडेंटिफायर।
relevance-score	Integer	वैकल्पिक	iOS सिस्टम को बताता है कि किस Live Activity की प्राथमिकता दूसरों की तुलना में अधिक है। 1 से अनंत तक के मान स्वीकार करता है (100 तक के मान अनुशंसित हैं)।
stale-date	Integer	वैकल्पिक	वह समय (सेकंड में) जो उस तारीख को दर्शाता है जिस पर एक Live Activity पुरानी या आउट ऑफ डेट हो जाती है।

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 में Live Activity को अपडेट करने के लिए Live Activity डेटा
        "event": "update",               // आवश्यक। Live Activity को अपडेट करने के लिए "update" का उपयोग करें या
                                         //           Live Activity को बंद करने के लिए "end"
        "content-state": {               // आवश्यक। डेटा पास करने के लिए उपयोग किए जाने वाले की-वैल्यू पेयर्स वाला ऑब्जेक्ट
          "courierName": "NUMBER: 15",   //           उसके कंटेंट को अपडेट करने के लिए Live Activity को
          "deliveryStatus": "Done"
        },
        "dismissal-date": 12345678,      // वैकल्पिक। सेकंड में Live Activity के समाप्त होने का समय
        "relevance-score": 50,           // वैकल्पिक। Live Activity के लिए प्राथमिकता (1 से 100 अनुशंसित)
        "stale-date": 23456789           // वैकल्पिक। समय (सेकंड में) जब Live Activity पुरानी हो जाती है
      },
      "live_activity_id": "unique UUID"  // वैकल्पिक। Live Activity का यूनिक आइडेंटिफायर।
    }]
  }
}

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