सामग्री पर जाएं

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

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

मैसेजिंग API v2

Anchor link to

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

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

SMTP गेटवे

Anchor link to

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

संदेश API

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

प्रीसेट API

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

डिवाइस API

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

ऑडियंस API

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

टैग API

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

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

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

उपयोगकर्ता-केंद्रित API

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

इवेंट्स API

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

एप्लीकेशंस API

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

कैंपेन API

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

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

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

ईमेल API

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

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

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

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

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

सांख्यिकी API

Anchor link to

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

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

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

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

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

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

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

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

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

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

Apple Wallet PassKit API

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

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

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

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

Anchor link to
getResultsएक अनुसूचित अनुरोध का परिणाम प्राप्त करता है।
createSMSMessage अस्वीकृतएक नया SMS संदेश बनाता है। इसके बजाय platforms: ["SMS"] के साथ Notify का उपयोग करें।

WhatsApp API

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

Geozones API

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