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

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

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

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

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

SMTP गेटवे

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

मैसेज एपीआई

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

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

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

डिवाइस एपीआई

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	ऐप की प्लेटफ़ॉर्म स्थिति बदलता है।

कंट्रोल ग्रुप्स एपीआई

List	एक एप्लिकेशन के कंट्रोल ग्रुप्स को सूचीबद्ध करता है।
Create	एक कंट्रोल ग्रुप बनाता है।
Get	कोड द्वारा एक कंट्रोल ग्रुप प्राप्त करता है।
UpdatePercentage	एक कंट्रोल ग्रुप के होल्ड-आउट प्रतिशत का आकार बदलता है।
UpdateCountries	एक कंट्रोल ग्रुप को देशों के एक सेट पर फिर से स्कोप करता है।
Disable	एक कंट्रोल ग्रुप को बंद करता है।
Reshuffle	एक कंट्रोल ग्रुप के होल्ड-आउट सैंपल को फिर से बनाता है।
ForceUpdateCalculation	एक कंट्रोल ग्रुप के आकार की एक नई गिनती शुरू करता है।
GetCalculationStatus	चल रही आकार गणना को पोल करता है।
GetAnalytics	एक कंट्रोल ग्रुप के लिए कंट्रोल-बनाम-ट्रीटमेंट एनालिटिक्स प्राप्त करता है।
CheckControlGroupMembership	रिपोर्ट करता है कि यूज़र आईडी के एक बैच में से प्रत्येक को एक कंट्रोल ग्रुप द्वारा होल्ड आउट किया गया है या नहीं।
Delete	एक कंट्रोल ग्रुप को हटाता है।

डेटा इरेज़र एपीआई

Create	किसी विषय के व्यक्तिगत डेटा को मिटाना (या ड्राई-रन गिनती) शुरू करता है।
Upload	अपलोड किए गए पहचानकर्ताओं के CSV से एक इरेज़र टास्क बनाता है।
ListTasks	खाते के इरेज़र टास्क सूचीबद्ध करता है।
GetTask	एक इरेज़र टास्क की स्थिति और काउंटर प्राप्त करता है।
ListTaskRows	एक टास्क के प्रति-पहचानकर्ता परिणाम सूचीबद्ध करता है।
GetTaskReport	एक टास्क की रिपोर्ट को CSV के रूप में डाउनलोड करता है।
GetJournalReport	किसी अवधि के सभी टास्क को एक CSV के रूप में डाउनलोड करता है।

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

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	एक बाहरी यूज़र आईडी को एक निर्दिष्ट ईमेल पते के साथ जोड़ता है।

ईमेल टेम्प्लेट्स एपीआई

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

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

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

मैसेज इनबॉक्स एपीआई

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

स्टैटिस्टिक्स एपीआई

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

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 लाइव एक्टिविटीज़ एपीआई

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

Apple Wallet PassKit एपीआई

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

Google Wallet एपीआई

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	पास टेम्प्लेट सूचीबद्ध करता है या एक को शुरुआती बिंदु के रूप में प्राप्त करता है।

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

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

शेड्यूल्ड रिक्वेस्ट्स एपीआई

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

SMS एपीआई

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

WhatsApp एपीआई

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

LINE एपीआई

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

Kakao एपीआई

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

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

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