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

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

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

startLiveActivity

Anchor link to

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 में लाइव एक्टिविटी बनाने के लिए लाइव एक्टिविटी डेटा।
live_activity.content-stateऑब्जेक्टआवश्यकलाइव एक्टिविटी नोटिफिकेशन के लिए कंटेंट।
live_activity.attributes-typeस्ट्रिंगआवश्यकलाइव एक्टिविटी में उपयोग किए गए एट्रिब्यूट्स का प्रकार।
live_activity.attributesऑब्जेक्टआवश्यकलाइव एक्टिविटी के लिए एट्रिब्यूट्स।
live_activity_idस्ट्रिंगआवश्यकलाइव एक्टिविटी के लिए एक यूनिक आइडेंटिफायर। updateLiveActivity को कॉल करते समय इस एक्टिविटी को लक्षित करने के लिए उपयोग किया जाता है। प्रति एक्टिविटी सेशन यूनिक होना चाहिए।
filterस्ट्रिंगवैकल्पिकPushwoosh फ़िल्टर (सेगमेंट) का नाम। सेगमेंट / फ़िल्टर नाम देखें। इस फ़िल्टर से मेल खाने वाले सभी डिवाइस पर लाइव एक्टिविटी शुरू की जाएगी।
devicesस्ट्रिंग्स का ऐरेवैकल्पिकडिवाइस टोकन की एक सूची। लाइव एक्टिविटी केवल निर्दिष्ट डिवाइस पर शुरू की जाएगी।

रिक्वेस्ट का उदाहरण

Anchor link to
{
  "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"
      }
    ]
  }
}

रिस्पॉन्स का उदाहरण

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

ध्यान दें:

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

updateLiveActivity

Anchor link to

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

रिक्वेस्ट का उदाहरण

Anchor link to
{
  "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"
      }
    ]
  }
}

रिस्पॉन्स का उदाहरण

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

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

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

Anchor link to

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

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

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

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