API विधियों का संदर्भ सूचकांक

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

मैसेजिंग API v2

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

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

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

डिवाइस 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

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

संदेश इनबॉक्स API

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

सांख्यिकी API

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

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

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

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

अभियान सांख्यिकी

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

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

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

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

जियोज़ोन API

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