[Go to site: main page, start]

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

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

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

मैसेजिंग API v2

Anchor link to

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

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

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

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

ईमेल API

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

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

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

परीक्षण डिवाइस API

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

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

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

आँकड़े API

Anchor link to

संदेश आँकड़े

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

एसिंक्रोनस संदेश आँकड़े निर्यात

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

एप्लिकेशन और ग्राहक आँकड़े

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

अभियान आँकड़े

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

इवेंट्स और टैग्स आँकड़े

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

इन-ऐप आँकड़े

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

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

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

Apple वॉलेट पासकिट API

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

Google वॉलेट API

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

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

Anchor link to
Lifecycleएक जर्नी को उसके UUID द्वारा शुरू करता है, रोकता है, समाप्त करता है, ड्राफ्ट करता है, या संग्रहीत करता है।
Create and updateएक नई जर्नी परिभाषा बनाता है या एक मौजूदा को प्रतिस्थापित करता है।
Start by APIचल रही जर्नी के API एंट्री पॉइंट में उपयोगकर्ताओं को इंजेक्ट करता है।
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 का उपयोग करें।

जियोज़ोन API

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