API विधियों का संदर्भ सूचकांक
Pushwoosh 100 से अधिक API विधियों की एक विशाल लाइब्रेरी प्रदान करता है, जिसे सूचनाएं भेजने, उपयोगकर्ताओं को प्रबंधित करने और एनालिटिक्स को ट्रैक करने जैसी विभिन्न कार्यात्मकताओं के लिए वर्गीकृत किया गया है।
मैसेजिंग API v2
Anchor link toएकीकृत API जो पूरे /create*Message परिवार (पुश, ईमेल, SMS, Kakao) की जगह लेता है। अवलोकन और माइग्रेशन गाइड देखें।
Notify | किसी भी चैनल के माध्यम से एक संदेश बनाता और भेजता है। /createMessage, /createTargetedMessage, /createEmailMessage, /createSMSMessage, /createKakaoMessage की जगह लेता है। |
Cancel | पहले बनाए गए संदेश को डिलीवर होने से पहले रद्द करता है। Notify से message_code के साथ उपयोग करें। |
Update | अभी भी निर्धारित संदेश को एक नई परिभाषा (पूर्ण प्रतिस्थापन) से बदल देता है। Notify से message_code के साथ उपयोग करें। |
SMTP गेटवे
Anchor link toAPI को सीधे कॉल करने के बजाय मानक SMTP पर ट्रांसेक्शनल ईमेल सबमिट करें। गेटवे आपके एप्लिकेशन कोड और API टोकन के साथ प्रमाणित होता है, फिर प्रत्येक संदेश को Notify पर अग्रेषित करता है। SMTP गेटवे संदर्भ देखें।
संदेश API
Anchor link tocreateMessage पदावनत | एक नई पुश सूचना बनाता है। इसके बजाय Notify का उपयोग करें। |
deleteMessage | एक संदेश (भेजा गया या निर्धारित) को हटाता है और इसे संदेश इतिहास से हटा देता है। |
getMessageDetails | संदेश का विवरण प्राप्त करता है। |
createTargetedMessage पदावनत | एक नई लक्षित पुश सूचना बनाता है। इसके बजाय transactional प्रकार के साथ Notify का उपयोग करें। |
getPushHistory पदावनत | विस्तृत डेटा के साथ संदेश इतिहास प्राप्त करने के लिए /messages:list का उपयोग करें। |
cancelMessage | एक निर्धारित संदेश को रद्द करता है, इसे संदेश इतिहास में रखते हुए। |
प्रीसेट API
Anchor link toCreate | एक नया पुश प्रीसेट बनाता है। |
List | एक एप्लिकेशन के पुश प्रीसेट को सूचीबद्ध करता है। |
Get | कोड द्वारा एक एकल पुश प्रीसेट प्राप्त करता है। |
Update | कोड द्वारा एक पुश प्रीसेट को ओवरराइट करता है। |
UpdatePartial | कोड द्वारा एक पुश प्रीसेट के केवल दिए गए फ़ील्ड को अपडेट करता है। |
Clone | एक ही एप्लिकेशन के भीतर एक पुश प्रीसेट की डुप्लिकेट बनाता है। |
Delete | कोड द्वारा एक पुश प्रीसेट को हटाता है। |
डिवाइस API
Anchor link toregisterDevice | एप्लिकेशन के लिए एक डिवाइस पंजीकृत करता है। |
unregisterDevice | डिवाइस का पुश टोकन हटाता है। |
deleteDevice | निर्दिष्ट एप्लिकेशन में एक डिवाइस और उसके सभी संबंधित डेटा को हटाता है। |
setTags | डिवाइस के लिए टैग मान सेट करता है। |
getTags | एक विशिष्ट डिवाइस के लिए उनके संबंधित मानों के साथ टैग प्राप्त करता है। |
setBadge | एक डिवाइस के लिए वर्तमान बैज मान Pushwoosh को भेजता है। |
applicationOpen | एक ऐप ओपन इवेंट पंजीकृत करता है। |
pushStat | एक पुश ओपन इवेंट पंजीकृत करता है। |
messageDeliveryEvent | डिवाइस के लिए एक पुश डिलीवरी इवेंट पंजीकृत करता है। |
ऑडियंस API
Anchor link tobulkSetTags | कई डिवाइसों के लिए टैग मान सेट करता है। |
bulkSetTags Status | bulkSetTags ऑपरेशन की स्थिति लौटाता है। |
bulkRegisterDevice | एक ही अनुरोध में कई डिवाइसों को पंजीकृत करता है, जिसमें प्रत्येक डिवाइस के लिए वैकल्पिक टैग मान शामिल हैं। |
bulkRegisterDevice Status | एक अनुरोध आईडी का उपयोग करके एक बल्क डिवाइस पंजीकरण अनुरोध की स्थिति और परिणाम प्राप्त करता है। |
bulkUnregisterDevice | एक ही अनुरोध में कई डिवाइसों को अपंजीकृत करता है। |
bulkUnregisterDevice Status | एक अनुरोध आईडी का उपयोग करके एक बल्क डिवाइस अपंजीकरण अनुरोध की स्थिति और परिणाम प्राप्त करता है। |
टैग्स API
Anchor link toaddTag | आपके खाते में एक टैग बनाता है। |
deleteTag | सभी संबंधित जानकारी के साथ एक टैग को हटाता है। |
listTags | खाते पर टैग की एक सूची प्राप्त करता है। |
सेगमेंटेशन (फिल्टर) API
Anchor link tocreateFilter | एक नया सेगमेंट बनाता है। |
listFilters | उनकी शर्तों के साथ उपलब्ध सेगमेंट की एक सूची लौटाता है। |
deleteFilter | एक मौजूदा सेगमेंट को हटाता है। |
exportSegment | सेगमेंट शर्तों से मेल खाने वाले ग्राहकों को निर्यात करने के लिए एक अनुरोध निर्धारित करता है। |
exportSegment Results | exportSegment परिणामों के लिए CSV लिंक प्राप्त करता है। |
उपयोगकर्ता-केंद्रित API
Anchor link toregisterUser | बाहरी उपयोगकर्ता आईडी को एक निर्दिष्ट डिवाइस के साथ जोड़ता है। |
deleteUser | एक उपयोगकर्ता और निर्दिष्ट उपयोगकर्ता आईडी से जुड़े सभी डिवाइस को हटाता है। |
postEvent | ऐप के भीतर इवेंट को कॉल करता है। |
इवेंट्स API
Anchor link tocreateEvent | ऐप के लिए एक इवेंट बनाता है। |
एप्लिकेशन API
Anchor link tocreateApplication | खाते पर एक नया एप्लिकेशन बनाता है। |
updateApplication | एप्लिकेशन सेटिंग्स को अपडेट करता है। |
deleteApplication | खाते से ऐप को हटाता है। |
getApplication | ऐप के बारे में विवरण प्राप्त करता है। |
getApplications | खाते पर एप्लिकेशन की एक सूची प्राप्त करता है। |
getApplicationFile | ऐप से संबंधित कॉन्फ़िगरेशन फ़ाइलों को प्राप्त करता है। |
setApplicationPlatformStatus | ऐप की प्लेटफ़ॉर्म स्थिति को बदलता है। |
अभियान API
Anchor link tocreateCampaign | एक नया पुश अभियान बनाता है। |
deleteCampaign | एक विशेष अभियान को हटाता है। |
getCampaigns | ऐप के लिए अभियानों की एक सूची प्राप्त करता है। |
ऐप कॉन्फ़िगरेशन API
Anchor link toconfigureApplication for iOS | ऐप के लिए iOS प्लेटफ़ॉर्म को कॉन्फ़िगर करता है। |
configureApplication for Android | ऐप के लिए Android प्लेटफ़ॉर्म को कॉन्फ़िगर करता है। |
configureApplication for Mac OS X | ऐप के लिए macOS प्लेटफ़ॉर्म को कॉन्फ़िगर करता है। |
configureApplication for Windows | ऐप के लिए Windows प्लेटफ़ॉर्म को कॉन्फ़िगर करता है। |
configureApplication for Amazon | ऐप के लिए Amazon प्लेटफ़ॉर्म को कॉन्फ़िगर करता है। |
configureApplication for Chrome | ऐप के लिए Chrome प्लेटफ़ॉर्म को कॉन्फ़िगर करता है। |
configureApplication for Safari | ऐप के लिए Safari प्लेटफ़ॉर्म को कॉन्फ़िगर करता है। |
configureApplication for Firefox | ऐप के लिए Firefox प्लेटफ़ॉर्म को कॉन्फ़िगर करता है। |
configureApplication for Email | ऐप के लिए ईमेल प्लेटफ़ॉर्म को कॉन्फ़िगर करता है। |
ईमेल API
Anchor link tocreateEmailMessage पदावनत | एक ईमेल संदेश बनाता है। इसके बजाय platforms: ["EMAIL"] और एक email_payload के साथ Notify का उपयोग करें। |
registerEmail | ऐप के लिए एक ईमेल पता पंजीकृत करता है। |
deleteEmail | आपके डेटाबेस से एक ईमेल पता हटाता है। |
setEmailTags | निर्दिष्ट ईमेल पते के लिए टैग मान सेट करता है। |
registerEmailUser | एक बाहरी उपयोगकर्ता आईडी को एक निर्दिष्ट ईमेल पते के साथ जोड़ता है। |
ईमेल टेम्पलेट्स API
Anchor link toCreate | एक एप्लिकेशन में एक नया ईमेल टेम्पलेट बनाता है। |
List | एक एप्लिकेशन के ईमेल टेम्पलेट्स को सूचीबद्ध करता है। |
Get | कोड द्वारा एक एकल ईमेल टेम्पलेट लौटाता है। |
Update | कोड द्वारा एक मौजूदा ईमेल टेम्पलेट को अपडेट करता है। |
Delete | कोड द्वारा एक ईमेल टेम्पलेट और उसके जुड़े प्रीसेट को हटाता है। |
Clone | एक ईमेल टेम्पलेट को एक गंतव्य एप्लिकेशन में क्लोन करता है। |
परीक्षण डिवाइस API
Anchor link tocreateTestDevice | एप्लिकेशन के लिए एक परीक्षण डिवाइस पंजीकृत करता है। |
listTestDevices | एप्लिकेशन के लिए पंजीकृत सभी परीक्षण डिवाइसों को प्राप्त करता है। |
संदेश इनबॉक्स API
Anchor link togetInboxMessages | एक निर्दिष्ट HWID के लिए इनबॉक्स संदेशों की सूची प्राप्त करता है। |
inboxStatus | एक विशिष्ट इनबॉक्स संदेश की स्थिति को अपडेट करता है। |
आँकड़े API
Anchor link toसंदेश आँकड़े
Anchor link tomessages:list | भेजे गए संदेशों की एक सूची प्राप्त करता है। |
totalsByIntervals | घंटे के हिसाब से एकत्रित मेट्रिक्स और रूपांतरण डेटा प्रदान करता है। |
getDeliveryFunnel | एक एकल संदेश के लिए डिलीवरी फ़नल लौटाता है, जिसमें प्रत्येक चरण में दर्शक कहाँ खो गए हैं, इसका विवरण होता है। |
getMessageLog | भेजे गए संदेशों के बारे में विस्तृत जानकारी प्राप्त करता है। |
linksInteractions | ईमेल लिंक क्लिक पर आँकड़े प्रदान करता है। |
linksInteractionsDevices | उन उपयोगकर्ताओं को सूचीबद्ध करता है जिन्होंने ईमेल में लिंक पर क्लिक किया है। |
bouncedEmails | ईमेल बाउंस, शिकायतों और बाउंस के कारणों पर जानकारी प्रदान करता है। |
एसिंक्रोनस संदेश आँकड़े निर्यात
Anchor link toexportMessagesStatistics/export | messages:list की पंक्ति सीमाओं के बिना, एक CSV फ़ाइल में संदेश इतिहास निर्यात को कतारबद्ध करता है। |
exportMessagesStatistics/status | एक निर्यात कार्य की प्रगति लौटाता है। |
exportMessagesStatistics/result | कार्य पूरा हो जाने पर उत्पन्न फ़ाइल का नाम लौटाता है। |
exportMessagesStatistics/lastTasks | एक एप्लिकेशन के लिए हाल के निर्यात कार्यों को सूचीबद्ध करता है। |
exportMessagesStatistics/delete | अवधारण अवधि समाप्त होने से पहले एक कार्य और उसकी फ़ाइल को हटाता है। |
exportMessagesStatistics/download | नाम से उत्पन्न CSV फ़ाइल डाउनलोड करता है। |
एप्लिकेशन और ग्राहक आँकड़े
Anchor link togetApplicationSubscribersStats | डिवाइस प्रकार के अनुसार समूहीकृत, ऐप के ग्राहक आँकड़े प्राप्त करता है। |
getAppStats | एक विशिष्ट समय अवधि के लिए ऐप आँकड़े प्राप्त करता है। |
getSubscribersStatistics | एक विशिष्ट समय अवधि के लिए ग्राहक आँकड़े प्राप्त करता है। |
अभियान आँकड़े
Anchor link togetCampaignStats | एक विशिष्ट समय अवधि के लिए अभियान आँकड़े प्राप्त करता है। |
इवेंट्स और टैग्स आँकड़े
Anchor link togetEventStatistics | एक विशिष्ट अवधि के दौरान एक इवेंट कितनी बार ट्रिगर हुआ, इसकी संख्या प्राप्त करता है। |
getTagStats | एक विशिष्ट टैग के लिए आँकड़े प्राप्त करता है। |
इन-ऐप आँकड़े
Anchor link toinapps:totals | एक अवधि में एक या अधिक इन-ऐप अभियानों के लिए इंप्रेशन, इंटरैक्शन और फ़्रीक्वेंसी कैपिंग के कुल योग प्राप्त करता है। |
inapps:timeline | एक एकल अभियान के लिए अवधि के कुल योग और इन-ऐप मेट्रिक्स की एक समय श्रृंखला प्राप्त करता है। |
iOS लाइव एक्टिविटीज़ API
Anchor link tostartLiveActivity | एक नई iOS लाइव एक्टिविटी बनाता है। |
updateLiveActivity | एक मौजूदा iOS लाइव एक्टिविटी को अपडेट करता है। |
Apple वॉलेट पासकिट API
Anchor link toApple Wallet PassKit API | Pushwoosh में Apple वॉलेट पास और संबंधित कॉन्फ़िगरेशन के प्रबंधन के लिए संदर्भ। |
Google वॉलेट API
Anchor link toCreate a pass | Google वॉलेट में पास बनाता है और एक सेव लिंक लौटाता है। |
Validate a pass | बिना बनाए पास कॉन्फ़िगरेशन की जाँच करता है। |
Update a pass | एक मौजूदा पास को अपडेट करता है। Google सहेजे गए डिवाइसों में बदलाव पहुंचाता है। |
Get a save link | एक मौजूदा पास के लिए “Google वॉलेट में जोड़ें” सेव लिंक लौटाता है। |
Get a pass | एक एकल संग्रहीत पास लौटाता है। |
List passes | एक एप्लिकेशन के लिए पास की एक पृष्ठित सूची लौटाता है। |
Set pass state | एक पास को सक्रिय या अमान्य करता है। |
Delete a pass | Google में पास को अमान्य करता है और उसके Pushwoosh रिकॉर्ड को हटाता है। |
Get configuration | एक एप्लिकेशन के लिए Google वॉलेट कॉन्फ़िगरेशन स्थिति लौटाता है। |
Templates | पास टेम्पलेट्स को सूचीबद्ध करता है या एक को शुरुआती बिंदु के रूप में प्राप्त करता है। |
कस्टमर जर्नी API
Anchor link toLifecycle | एक जर्नी को उसके UUID द्वारा शुरू करता है, रोकता है, समाप्त करता है, ड्राफ्ट करता है, या संग्रहीत करता है। |
Create and update | एक नई जर्नी परिभाषा बनाता है या एक मौजूदा को प्रतिस्थापित करता है। |
Start by API | चल रही जर्नी के API एंट्री पॉइंट में उपयोगकर्ताओं को इंजेक्ट करता है। |
Get Journey stats | एक विशिष्ट जर्नी के लिए उसकी आईडी द्वारा आँकड़े प्राप्त करता है। |
Remove users from journeys | सभी या चयनित सक्रिय जर्नी से एक या अधिक उपयोगकर्ताओं को हटाता है। |
निर्धारित अनुरोध API
Anchor link togetResults | एक निर्धारित अनुरोध का परिणाम प्राप्त करता है। |
SMS API
Anchor link tocreateSMSMessage पदावनत | एक नया SMS संदेश बनाता है। इसके बजाय platforms: ["SMS"] के साथ Notify का उपयोग करें। |
WhatsApp API
Anchor link tocreateWhatsAppMessage पदावनत | एक नया WhatsApp संदेश बनाता है। इसके बजाय platforms: ["WHATS_APP"] के साथ Notify का उपयोग करें। |
LINE API
Anchor link tocreateLineMessage पदावनत | एक नया LINE संदेश बनाता है। इसके बजाय platforms: ["LINE"] के साथ Notify का उपयोग करें। |
Kakao API
Anchor link tocreateKakaoMessage पदावनत | एक स्वीकृत टेम्पलेट का उपयोग करके एक Kakao संदेश भेजता है। इसके बजाय platforms: ["KAKAO"] के साथ Notify का उपयोग करें। |
जियोज़ोन API
Anchor link togetNearestZone | निकटतम जियोज़ोन के पैरामीटर और उसकी दूरी प्राप्त करता है। जियो पुश सूचनाओं के लिए डिवाइस के स्थान को भी रिकॉर्ड करता है। |
addGeoZone | एक विशिष्ट ऐप में एक जियोज़ोन जोड़ता है। |
updateGeoZone | जियोज़ोन के गुणों जैसे नाम, स्थिति, सामग्री और सीमा को अपडेट करता है। |
deleteGeoZone | ऐप से जियोज़ोन हटाता है। |
addGeoZoneCluster | ऐप में एक जियोज़ोन क्लस्टर जोड़ता है। |
deleteGeoZoneCluster | ऐप से एक जियोज़ोन क्लस्टर हटाता है। |
listGeoZones | ऐप के लिए जियोज़ोन की एक सूची प्राप्त करता है। |
listGeoZoneClusters | ऐप के लिए जियोज़ोन क्लस्टर की एक सूची प्राप्त करता है। |