एपीआई मेथड्स रेफरेंस इंडेक्स

Pushwoosh 100 से ज़्यादा एपीआई मेथड्स की एक विशाल लाइब्रेरी प्रदान करता है, जिसे सूचनाएं भेजने, उपयोगकर्ताओं को प्रबंधित करने और एनालिटिक्स को ट्रैक करने जैसी विभिन्न कार्यात्मकताओं के लिए वर्गीकृत किया गया है।

मैसेजिंग एपीआई v2

एकीकृत एपीआई जो पूरे /create*Message परिवार (पुश, ईमेल, एसएमएस, काकाओ) की जगह लेता है। अवलोकन और माइग्रेशन गाइड देखें।

Notify	किसी भी चैनल के माध्यम से एक संदेश बनाता और भेजता है। /createMessage, /createTargetedMessage, /createEmailMessage, /createSMSMessage, /createKakaoMessage की जगह लेता है।

संदेश एपीआई

createMessage पदावनत	एक नई पुश सूचना बनाता है। इसके बजाय Notify का उपयोग करें।
deleteMessage	एक शेड्यूल किए गए संदेश को हटाता है।
getMessageDetails	संदेश का विवरण प्राप्त करता है।
createTargetedMessage पदावनत	एक नई लक्षित पुश सूचना बनाता है। इसके बजाय transactional प्रकार के साथ Notify का उपयोग करें।
getPushHistory पदावनत	विस्तृत डेटा के साथ संदेश इतिहास प्राप्त करने के लिए /messages:list का उपयोग करें।
cancelMessage	एक शेड्यूल किए गए संदेश को रद्द करता है।

प्रीसेट एपीआई

createPreset	एक नया प्रीसेट बनाता है।
getPreset	निर्दिष्ट पुश प्रीसेट के पैरामीटर प्राप्त करता है।
listPresets	ऐप के लिए बनाए गए प्रीसेट की सूची प्राप्त करता है।
deletePreset	आपके खाते से एक प्रीसेट हटाता है।

डिवाइस एपीआई

registerDevice	एप्लिकेशन के लिए एक डिवाइस पंजीकृत करता है।
unregisterDevice	डिवाइस का पुश टोकन हटाता है।
deleteDevice	निर्दिष्ट एप्लिकेशन में एक डिवाइस और उसके सभी संबंधित डेटा को हटाता है।
setTags	डिवाइस के लिए टैग मान सेट करता है।
getTags	एक विशिष्ट डिवाइस के लिए उनके संबंधित मानों के साथ टैग प्राप्त करता है।
setBadge	Pushwoosh को एक डिवाइस के लिए वर्तमान बैज मान भेजता है।
applicationOpen	एक ऐप ओपन इवेंट पंजीकृत करता है।
pushStat	एक पुश ओपन इवेंट पंजीकृत करता है।
messageDeliveryEvent	डिवाइस के लिए एक पुश डिलीवरी इवेंट पंजीकृत करता है।

ऑडियंस एपीआई

bulkSetTags	कई डिवाइसों के लिए टैग मान सेट करता है।
bulkSetTags Status	bulkSetTags ऑपरेशन की स्थिति लौटाता है।
bulkRegisterDevice	एक ही अनुरोध में कई डिवाइस पंजीकृत करता है, जिसमें प्रत्येक डिवाइस के लिए वैकल्पिक टैग मान शामिल हैं।
bulkRegisterDevice Status	एक अनुरोध आईडी का उपयोग करके बल्क डिवाइस पंजीकरण अनुरोध की स्थिति और परिणाम प्राप्त करता है।
bulkUnregisterDevice	एक ही अनुरोध में कई डिवाइसों को अपंजीकृत करता है।
bulkUnregisterDevice Status	एक अनुरोध आईडी का उपयोग करके बल्क डिवाइस अपंजीकरण अनुरोध की स्थिति और परिणाम प्राप्त करता है।

टैग्स एपीआई

addTag	आपके खाते में एक टैग बनाता है।
deleteTag	सभी संबंधित जानकारी के साथ एक टैग हटाता है।
listTags	खाते पर टैग की एक सूची प्राप्त करता है।

सेगमेंटेशन (फिल्टर्स) एपीआई

createFilter	एक नया सेगमेंट बनाता है।
listFilters	उनकी शर्तों के साथ उपलब्ध सेगमेंट की एक सूची लौटाता है।
deleteFilter	एक मौजूदा सेगमेंट को हटाता है।
exportSegment	सेगमेंट शर्तों से मेल खाने वाले ग्राहकों को निर्यात करने के लिए एक अनुरोध शेड्यूल करता है।
exportSegment Results	exportSegment परिणामों के लिए CSV लिंक प्राप्त करता है।

उपयोगकर्ता-केंद्रित एपीआई

registerUser	बाहरी उपयोगकर्ता आईडी को एक निर्दिष्ट डिवाइस के साथ जोड़ता है।
deleteUser	एक उपयोगकर्ता और निर्दिष्ट उपयोगकर्ता आईडी से जुड़े सभी डिवाइस को हटाता है।
postEvent	ऐप के भीतर इवेंट को कॉल करता है।

इवेंट्स एपीआई

createEvent	ऐप के लिए एक इवेंट बनाता है।

एप्लीकेशंस एपीआई

createApplication	खाते पर एक नया एप्लिकेशन बनाता है।
updateApplication	एप्लिकेशन सेटिंग्स को अपडेट करता है।
deleteApplication	खाते से ऐप को हटाता है।
getApplication	ऐप के बारे में विवरण प्राप्त करता है।
getApplications	खाते पर एप्लिकेशन की एक सूची प्राप्त करता है।
getApplicationFile	ऐप से संबंधित कॉन्फ़िगरेशन फ़ाइलें प्राप्त करता है।
setApplicationPlatformStatus	ऐप की प्लेटफ़ॉर्म स्थिति बदलता है।

कैंपेन्स एपीआई

createCampaign	एक नया पुश कैंपेन बनाता है।
deleteCampaign	एक विशेष कैंपेन को हटाता है।
getCampaigns	ऐप के लिए कैंपेन की एक सूची प्राप्त करता है।

ऐप कॉन्फ़िगरेशन एपीआई

configureApplication 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	ऐप के लिए ईमेल प्लेटफ़ॉर्म को कॉन्फ़िगर करता है।

ईमेल एपीआई

createEmailMessage पदावनत	एक ईमेल संदेश बनाता है। इसके बजाय platforms: ["EMAIL"] और एक email_payload के साथ Notify का उपयोग करें।
registerEmail	ऐप के लिए एक ईमेल पता पंजीकृत करता है।
deleteEmail	आपके डेटाबेस से एक ईमेल पता हटाता है।
setEmailTags	निर्दिष्ट ईमेल पते के लिए टैग मान सेट करता है।
registerEmailUser	एक बाहरी उपयोगकर्ता आईडी को एक निर्दिष्ट ईमेल पते के साथ जोड़ता है।

टेस्ट डिवाइस एपीआई

createTestDevice	एप्लिकेशन के लिए एक परीक्षण डिवाइस पंजीकृत करता है।
listTestDevices	एप्लिकेशन के लिए पंजीकृत सभी परीक्षण डिवाइस प्राप्त करता है।

संदेश इनबॉक्स एपीआई

getInboxMessages	एक निर्दिष्ट HWID के लिए इनबॉक्स संदेशों की सूची प्राप्त करता है।
inboxStatus	एक विशिष्ट इनबॉक्स संदेश की स्थिति को अपडेट करता है।

सांख्यिकी एपीआई

संदेश सांख्यिकी

messages:list	भेजे गए संदेशों की सूची प्राप्त करता है।
totalsByIntervals	घंटे के हिसाब से एकत्रित मेट्रिक्स और रूपांतरण डेटा प्रदान करता है।
getMessageLog	भेजे गए संदेशों के बारे में विस्तृत जानकारी प्राप्त करता है।
linksInteractions	ईमेल लिंक क्लिक पर सांख्यिकी प्रदान करता है।
linksInteractionsDevices	ईमेल में लिंक पर क्लिक करने वाले उपयोगकर्ताओं को सूचीबद्ध करता है।
bouncedEmails	ईमेल बाउंस, शिकायतों और बाउंस कारणों पर जानकारी प्रदान करता है।

एप्लीकेशन और सब्सक्राइबर सांख्यिकी

getApplicationSubscribersStats	डिवाइस प्रकार के अनुसार समूहीकृत, ऐप की सब्सक्राइबर सांख्यिकी प्राप्त करता है।
getAppStats	एक विशिष्ट समय अवधि के लिए ऐप सांख्यिकी प्राप्त करता है।
getSubscribersStatistics	एक विशिष्ट समय अवधि के लिए सब्सक्राइबर सांख्यिकी प्राप्त करता है।

कैंपेन सांख्यिकी

getCampaignStats	एक विशिष्ट समय अवधि के लिए कैंपेन सांख्यिकी प्राप्त करता है।

इवेंट्स और टैग्स सांख्यिकी

getEventStatistics	एक विशिष्ट अवधि के दौरान एक इवेंट को कितनी बार ट्रिगर किया गया था, इसकी संख्या प्राप्त करता है।
getTagStats	एक विशिष्ट टैग के लिए सांख्यिकी प्राप्त करता है।

iOS लाइव एक्टिविटीज़ एपीआई

startLiveActivity	एक नई iOS लाइव एक्टिविटी बनाता है।
updateLiveActivity	एक मौजूदा iOS लाइव एक्टिविटी को अपडेट करता है।

कस्टमर जर्नी एपीआई

Get Journey stats	इसकी आईडी द्वारा एक विशिष्ट जर्नी के लिए आँकड़े प्राप्त करता है।
Remove users from journeys	सभी या चयनित सक्रिय जर्नी से एक या अधिक उपयोगकर्ताओं को हटाता है।

शेड्यूल किए गए अनुरोध एपीआई

getResults	एक शेड्यूल किए गए अनुरोध का परिणाम प्राप्त करता है।

एसएमएस एपीआई

createSMSMessage पदावनत	एक नया एसएमएस संदेश बनाता है। इसके बजाय platforms: ["SMS"] के साथ Notify का उपयोग करें।

व्हाट्सएप एपीआई

createWhatsAppMessage पदावनत	एक नया व्हाट्सएप संदेश बनाता है। इसके बजाय platforms: ["WHATS_APP"] के साथ Notify का उपयोग करें।

लाइन एपीआई

createLineMessage पदावनत	एक नया लाइन संदेश बनाता है। इसके बजाय platforms: ["LINE"] के साथ Notify का उपयोग करें।

काकाओ एपीआई

createKakaoMessage पदावनत	एक स्वीकृत टेम्पलेट का उपयोग करके एक काकाओ संदेश भेजता है। इसके बजाय platforms: ["KAKAO"] के साथ Notify का उपयोग करें।

जियोज़ोन्स एपीआई

getNearestZone	निकटतम जियोज़ोन के पैरामीटर और उसकी दूरी प्राप्त करता है। जियो पुश सूचनाओं के लिए डिवाइस के स्थान को भी रिकॉर्ड करता है।
addGeoZone	एक विशिष्ट ऐप में एक जियोज़ोन जोड़ता है।
updateGeoZone	जियोज़ोन गुणों जैसे नाम, स्थिति, सामग्री और सीमा को अपडेट करता है।
deleteGeoZone	ऐप से जियोज़ोन हटाता है।
addGeoZoneCluster	ऐप में एक जियोज़ोन क्लस्टर जोड़ता है।
deleteGeoZoneCluster	ऐप से एक जियोज़ोन क्लस्टर हटाता है।
listGeoZones	ऐप के लिए जियोज़ोन की एक सूची प्राप्त करता है।
listGeoZoneClusters	ऐप के लिए जियोज़ोन क्लस्टर की एक सूची प्राप्त करता है।