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

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

• लाइव एक्टिविटीज़ के बारे में
• ActivityKit पुश नोटिफिकेशन के साथ लाइव एक्टिविटीज़ को अपडेट करना और समाप्त करना

startLiveActivity

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

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

अनुरोध का मुख्य भाग

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

नोटिफिकेशन

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

पैरामीटर	प्रकार	आवश्यक/वैकल्पिक	विवरण
content	String	आवश्यक	iOS 16.1 से नीचे के संस्करणों पर चलने वाले डिवाइस के लिए फॉलबैक कंटेंट जो लाइव एक्टिविटी का समर्थन नहीं करते हैं। iOS 16.1+ पर (लाइव एक्टिविटी समर्थन के साथ), कंटेंट live_activity फ़ील्ड से लिया जाता है।
title	String	वैकल्पिक	नोटिफिकेशन संदेश का शीर्षक।
live_activity	Object	आवश्यक	iOS में लाइव एक्टिविटी बनाने के लिए लाइव एक्टिविटी डेटा।
live_activity.content-state	Object	आवश्यक	लाइव एक्टिविटी नोटिफिकेशन के लिए कंटेंट।
live_activity.attributes-type	String	आवश्यक	लाइव एक्टिविटी में उपयोग किए गए एट्रिब्यूट्स का प्रकार।
live_activity.attributes	Object	आवश्यक	लाइव एक्टिविटी के लिए एट्रिब्यूट्स।
live_activity_id	String	आवश्यक	लाइव एक्टिविटी के लिए एक यूनिक आइडेंटिफ़ायर। updateLiveActivity को कॉल करते समय इस एक्टिविटी को टारगेट करने के लिए उपयोग किया जाता है। प्रति एक्टिविटी सेशन यूनिक होना चाहिए।
filter	String	वैकल्पिक	Pushwoosh फ़िल्टर (सेगमेंट) का नाम। सेगमेंट / फ़िल्टर नाम देखें। इस फ़िल्टर से मेल खाने वाले सभी डिवाइस पर लाइव एक्टिविटी शुरू की जाएगी।
devices	Array of Strings	वैकल्पिक	डिवाइस टोकन की एक सूची। लाइव एक्टिविटी केवल निर्दिष्ट डिवाइस पर शुरू की जाएगी।
send_date	String	वैकल्पिक	उस पुश को शेड्यूल करता है जो एक विशिष्ट तारीख और समय के लिए लाइव एक्टिविटी शुरू करता है — filter या devices टारगेटिंग के साथ काम करता है। YYYY-MM-DD HH:mm फॉर्मेट का उपयोग करें, या तुरंत शुरू करने के लिए now का उपयोग करें (यह पैरामीटर छोड़े जाने पर डिफ़ॉल्ट भी है)। अतीत में 1 दिन से अधिक या भविष्य में 30 दिनों से अधिक नहीं होना चाहिए, अन्यथा अनुरोध एक सत्यापन त्रुटि के साथ अस्वीकार कर दिया जाता है।
timezone	String	वैकल्पिक	send_date की व्याख्या करने के लिए उपयोग किया जाने वाला टाइमज़ोन। यदि छोड़ा जाता है, तो send_date की व्याख्या UTC में की जाती है।

सावधानी

startLiveActivity के माध्यम से लाइव एक्टिविटी का रिमोट स्टार्ट डिवाइस पर iOS 17.2+ की आवश्यकता है — पहले के संस्करण pushToStartTokenUpdates API का समर्थन नहीं करते हैं जिस पर यह एंडपॉइंट निर्भर करता है। रिमोट पुश नोटिफिकेशन के साथ लाइव एक्टिविटी शुरू करें देखें।

एक filter (सेगमेंट) को टारगेट करते समय, निर्धारित भेजने का समय वह होता है जब Pushwoosh पुश भेजना शुरू करता है, न कि एक गारंटीकृत डिलीवरी का क्षण — बड़े दर्शकों के लिए, व्यक्तिगत डिवाइस पर डिलीवरी send_date से कुछ मिनट पीछे हो सकती है, क्योंकि लाइव एक्टिविटी पुश के लिए भेजने की दर को send_rate के साथ कस्टमाइज़ नहीं किया जा सकता है।

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

फ़िल्टर के साथ

{
  "request": {
    "application": "XXXXX-XXXXX",
    "auth": "SECRET_API_TOKEN",
    "notifications": [
      {
        "content": "Your order is being prepared",
        "title": "Food Delivery",
        "live_activity": {
          "event": "start",
          "title": "Order status",
          "content-state": {
            "status": "Third",
            "estimatedTime": "37 min",
            "emoji": "👨‍🍳"
          },
          "attributes-type": "FoodDeliveryAttributes",
          "attributes": {}
        },
        "live_activity_id": "FIRST_LIVE_ACTIVITY",
        "filter": "FILTER_NAME_1"
      }
    ]
  }
}

डिवाइस के साथ

{
  "request": {
    "application": "XXXXX-XXXXX",
    "auth": "SECRET_API_TOKEN",
    "notifications": [
      {
        "content": "Your order is being prepared",
        "title": "Food Delivery",
        "live_activity": {
          "event": "start",
          "title": "Order status",
          "content-state": {
            "status": "Third",
            "estimatedTime": "37 min",
            "emoji": "👨‍🍳"
          },
          "attributes-type": "FoodDeliveryAttributes",
          "attributes": {}
        },
        "live_activity_id": "SECOND_LIVE_ACTIVITY",
        "devices": ["first_third", "second_device"]
      }
    ]
  }
}

शेड्यूल्ड स्टार्ट

{
  "request": {
    "application": "XXXXX-XXXXX",
    "auth": "SECRET_API_TOKEN",
    "notifications": [
      {
        "content": "Your order is being prepared",
        "title": "Food Delivery",
        "live_activity": {
          "event": "start",
          "title": "Order status",
          "content-state": {
            "status": "Third",
            "estimatedTime": "37 min",
            "emoji": "👨‍🍳"
          },
          "attributes-type": "FoodDeliveryAttributes",
          "attributes": {}
        },
        "live_activity_id": "THIRD_LIVE_ACTIVITY",
        "filter": "FILTER_NAME_1",
        "send_date": "2026-06-16 16:00"
      }
    ]
  }
}

प्रतिक्रिया का उदाहरण

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "Messages": [
      "XXXXX-XXXXXXXX-XXXXXXXX"
    ]
  }
}

ध्यान दें:

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

updateLiveActivity

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 में लाइव एक्टिविटी को अपडेट करने के लिए लाइव एक्टिविटी डेटा।
live_activity.event	String	आवश्यक	इवेंट प्रकार निर्दिष्ट करता है। लाइव एक्टिविटी को अपडेट करने के लिए "update" का उपयोग करें या इसे बंद करने के लिए "end" का उपयोग करें।
live_activity.content-state	Object	आवश्यक	की-वैल्यू पेयर वाला ऑब्जेक्ट जिसका उपयोग लाइव एक्टिविटी को उसके कंटेंट को अपडेट करने के लिए डेटा पास करने के लिए किया जाता है।
live_activity.dismissal-date	Integer	वैकल्पिक	वह समय (सेकंड में) जब लाइव एक्टिविटी समाप्त होनी चाहिए।
live_activity_id	String	आवश्यक	अपडेट करने के लिए लाइव एक्टिविटी का यूनिक आइडेंटिफ़ायर। startLiveActivity में उपयोग किए गए live_activity_id से मेल खाना चाहिए। अपडेट उन सभी डिवाइस पर डिलीवर किया जाएगा जिन पर यह एक्टिविटी शुरू की गई थी।
live_activity.relevance-score	Integer	वैकल्पिक	iOS सिस्टम को बताता है कि किस लाइव एक्टिविटी की प्राथमिकता दूसरों की तुलना में अधिक है। 1 से अनंत तक के मान स्वीकार करता है (100 तक के मान अनुशंसित हैं)।
live_activity.stale-date	Integer	वैकल्पिक	वह समय (सेकंड में) जो उस तारीख का प्रतिनिधित्व करता है जिस पर एक लाइव एक्टिविटी पुरानी या आउट ऑफ डेट हो जाती है।

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

{
  "request": {
    "application": "XXXXX-XXXXX",
    "auth": "SECRET_API_TOKEN",
    "notifications": [
      {
        "live_activity": {
          "event": "update",
          "title": "Live Activity Update",
          "content-state": {
            "status": "second 66",
            "estimatedTime": "66 min",
            "emoji": "👨‍"
          },
          "relevance-score": 60
        },
        "live_activity_id": "FIRST_LIVE_ACTIVITY"
      }
    ]
  }
}

प्रतिक्रिया का उदाहरण

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "Messages": [
      "XXXXX-XXXXXXXX-XXXXXXXX"
    ]
  }
}

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

प्रति डिवाइस कई एक्टिविटीज़

आप अलग-अलग live_activity_id मानों के साथ कई बार startLiveActivity को कॉल करके एक ही डिवाइस पर कई लाइव एक्टिविटीज़ शुरू कर सकते हैं।

उदाहरण के लिए, यदि आप दो एक्टिविटीज़ शुरू करते हैं: FIRST_LIVE_ACTIVITY filter: FILTER_NAME_1 के साथ और SECOND_LIVE_ACTIVITY filter: FILTER_NAME_2 के साथ, तो एक डिवाइस जो दोनों फ़िल्टर से मेल खाता है, उसमें दोनों एक्टिविटीज़ एक साथ चल रही होंगी।

उनमें से किसी एक को अपडेट करने के लिए, उसका live_activity_id updateLiveActivity को पास करें। अपडेट उन सभी डिवाइस पर डिलीवर किया जाता है जहां वह एक्टिविटी बनाई गई थी। दूसरी एक्टिविटी प्रभावित नहीं होती है।

जब एक ही डिवाइस पर कई लाइव एक्टिविटीज़ सक्रिय होती हैं, तो relevance-score पैरामीटर प्रदर्शन प्राथमिकता को नियंत्रित करता है। यदि स्क्रीन स्पेस सीमित है या एक्टिविटीज़ को समूहीकृत किया गया है, तो उच्च मान वाली एक्टिविटी को उच्च प्राथमिकता के साथ दिखाया जाता है।