API मेथड्स रेफरेंस इंडेक्स

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

मैसेजिंग API v2

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

Notify	किसी भी चैनल के माध्यम से एक संदेश बनाता और भेजता है। /createMessage, /createTargetedMessage, /createEmailMessage, /createSMSMessage, /createKakaoMessage की जगह लेता है।
Cancel	पहले बनाए गए संदेश को डिलीवर होने से पहले रद्द करता है। Notify से message_code के साथ उपयोग करें।
Update	अभी भी शेड्यूल किए गए संदेश को एक नई परिभाषा (पूर्ण प्रतिस्थापन) से बदलता है। Notify से message_code के साथ उपयोग करें।

SMTP गेटवे

API को सीधे कॉल करने के बजाय मानक SMTP पर ट्रांजैक्शनल ईमेल सबमिट करें। गेटवे आपके एप्लिकेशन कोड और API टोकन के साथ प्रमाणित होता है, फिर प्रत्येक संदेश को Notify पर फॉरवर्ड करता है। SMTP गेटवे रेफरेंस देखें।

मैसेजेस API

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

प्रीसेट्स API

Create	एक नया पुश प्रीसेट बनाता है।
List	एक एप्लिकेशन के पुश प्रीसेट को सूचीबद्ध करता है।
Get	कोड द्वारा एक एकल पुश प्रीसेट प्राप्त करता है।
Update	कोड द्वारा एक पुश प्रीसेट को ओवरराइट करता है।
UpdatePartial	कोड द्वारा एक पुश प्रीसेट के केवल दिए गए फ़ील्ड को अपडेट करता है।
Clone	एक ही एप्लिकेशन के भीतर एक पुश प्रीसेट की डुप्लिकेट बनाता है।
Delete	कोड द्वारा एक पुश प्रीसेट को हटाता है।

डिवाइस API

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

ऑडियंस API

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

टैग्स API

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

सेगमेंटेशन (फिल्टर्स) API

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

यूज़र-सेंट्रिक API

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

इवेंट्स API

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

एप्लीकेशंस API

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

कैंपेन्स API

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

ऐप कॉन्फ़िगरेशन API

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

ईमेल API

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

ईमेल टेम्प्लेट्स API

Create	एक एप्लिकेशन में एक नया ईमेल टेम्पलेट बनाता है।
List	एक एप्लिकेशन के ईमेल टेम्पलेट्स को सूचीबद्ध करता है।
Get	कोड द्वारा एक एकल ईमेल टेम्पलेट लौटाता है।
Update	कोड द्वारा एक मौजूदा ईमेल टेम्पलेट को अपडेट करता है।
Delete	कोड द्वारा एक ईमेल टेम्पलेट और उसके जुड़े प्रीसेट को हटाता है।
Clone	एक ईमेल टेम्पलेट को एक गंतव्य एप्लिकेशन में क्लोन करता है।

टेस्ट डिवाइसेस API

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

मैसेज इनबॉक्स API

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

स्टैटिस्टिक्स API

मैसेज स्टैटिस्टिक्स

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

एसिंक्रोनस मैसेज स्टैटिस्टिक्स एक्सपोर्ट

exportMessagesStatistics/export	messages:list की पंक्ति सीमाओं के बिना, एक CSV फ़ाइल में एक संदेश इतिहास निर्यात को कतार में लगाता है।
exportMessagesStatistics/status	एक निर्यात कार्य की प्रगति लौटाता है।
exportMessagesStatistics/result	कार्य पूरा हो जाने पर उत्पन्न फ़ाइल का नाम लौटाता है।
exportMessagesStatistics/lastTasks	एक एप्लिकेशन के लिए हाल के निर्यात कार्यों को सूचीबद्ध करता है।
exportMessagesStatistics/delete	रिटेंशन विंडो समाप्त होने से पहले एक कार्य और उसकी फ़ाइल को हटाता है।
exportMessagesStatistics/download	नाम से उत्पन्न CSV फ़ाइल डाउनलोड करता है।

एप्लीकेशन और सब्सक्राइबर स्टैटिस्टिक्स

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

कैंपेन स्टैटिस्टिक्स

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

इवेंट्स और टैग्स स्टैटिस्टिक्स

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

इन-ऐप स्टैटिस्टिक्स

inapps:totals	एक अवधि में एक या अधिक इन-ऐप अभियानों के लिए इंप्रेशन, इंटरैक्शन और फ़्रीक्वेंसी कैपिंग योग प्राप्त करता है।
inapps:timeline	एक एकल अभियान के लिए अवधि योग और इन-ऐप मेट्रिक्स की एक समय श्रृंखला प्राप्त करता है।

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

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

Apple Wallet PassKit API

Apple Wallet PassKit API	Pushwoosh में Apple Wallet पास और संबंधित कॉन्फ़िगरेशन के प्रबंधन के लिए संदर्भ।

Google Wallet API

Create a pass	Google Wallet में पास बनाता है और एक सेव लिंक लौटाता है।
Validate a pass	एक पास कॉन्फ़िगरेशन को बिना बनाए जाँचता है।
Update a pass	एक मौजूदा पास को अपडेट करता है। Google सहेजे गए डिवाइसों पर परिवर्तन वितरित करता है।
Get a save link	एक मौजूदा पास के लिए “Google Wallet में जोड़ें” सेव लिंक लौटाता है।
Get a pass	एक एकल संग्रहीत पास लौटाता है।
List passes	एक एप्लिकेशन के लिए पास की एक पृष्ठित सूची लौटाता है।
Set pass state	एक पास को सक्रिय या अमान्य करता है।
Delete a pass	Google में पास को अमान्य करता है और उसके Pushwoosh रिकॉर्ड को हटाता है।
Get configuration	एक एप्लिकेशन के लिए Google Wallet कॉन्फ़िगरेशन स्थिति लौटाता है।
Templates	पास टेम्पलेट्स को सूचीबद्ध करता है या एक को शुरुआती बिंदु के रूप में प्राप्त करता है।

कस्टमर जर्नी API

Lifecycle	एक जर्नी को उसके UUID द्वारा शुरू करता है, रोकता है, समाप्त करता है, ड्राफ्ट करता है, या संग्रहीत करता है।
Create and update	एक नई जर्नी परिभाषा बनाता है या एक मौजूदा को बदलता है।
Start by API	यूज़र्स को एक चल रही जर्नी के API एंट्री पॉइंट में इंजेक्ट करता है।
Get Journey stats	एक विशिष्ट जर्नी के लिए उसकी आईडी द्वारा आँकड़े प्राप्त करता है।
Remove users from journeys	एक या अधिक यूज़र्स को सभी या चयनित सक्रिय जर्नी से हटाता है।

शेड्यूल्ड रिक्वेस्ट्स API

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

SMS API

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

WhatsApp API

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

LINE API

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

Kakao API

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

जियोज़ोन्स API

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