सामग्री पर जाएं
उपयोगकर्ता गाइडसहायता डेमो अनुरोध करें साइन इन करें
Pushwoosh.com

ईमेल एपीआई

createEmailMessage अप्रचलित

Anchor link to

एक ईमेल संदेश बनाता है।

POST https://api.pushwoosh.com/json/1.3/createEmailMessage

अनुरोध बॉडी पैरामीटर

Anchor link to
नामप्रकार
आवश्यकविवरण
authstringहाँPushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
applicationstringहाँPushwoosh एप्लिकेशन कोड
notificationsarrayहाँईमेल संदेश विवरण युक्त JSON ऐरे। नीचे सूचना पैरामीटर तालिका देखें।

सूचना पैरामीटर

Anchor link to
नामप्रकार
आवश्यकविवरण
send_datestringहाँईमेल कब भेजना है यह परिभाषित करता है। प्रारूप: YYYY-MM-DD HH:mm या "now"।
presetstringहाँईमेल प्रीसेट कोड। Pushwoosh कंट्रोल पैनल में ईमेल कंटेंट एडिटर के URL बार से कॉपी करें।
subjectstring या objectनहींईमेल की विषय पंक्ति। ईमेल हमेशा कंटेंट की भाषा में होगा। यदि subject में content के लिए कोई मेल खाने वाली भाषा नहीं है, तो विषय खाली रहेगा।
contentstring या objectनहींईमेल बॉडी कंटेंट। सादे HTML कंटेंट के लिए एक स्ट्रिंग या स्थानीयकृत संस्करणों के लिए एक ऑब्जेक्ट हो सकता है।
attachmentsarrayनहींईमेल अटैचमेंट। केवल दो अटैचमेंट उपलब्ध हैं। प्रत्येक अटैचमेंट 1MB (base64 एन्कोडेड) से अधिक नहीं होना चाहिए।
list_unsubscribestringनहीं”Link-Unsubscribe” हेडर के लिए कस्टम URL सेट करने की अनुमति देता है।
campaignstringनहींईमेल को एक विशिष्ट अभियान के साथ जोड़ने के लिए अभियान कोड।
ignore_user_timezonebooleanनहींयदि true है, तो उपयोगकर्ता के टाइमज़ोन को अनदेखा करते हुए तुरंत ईमेल भेजता है।
timezonestringनहींउपयोगकर्ता के टाइमज़ोन के अनुसार ईमेल भेजता है। उदाहरण: "America/New_York"।
filterstringनहींएक विशिष्ट फ़िल्टर शर्त से मेल खाने वाले उपयोगकर्ताओं को ईमेल भेजता है।
devicesarrayनहींलक्षित ईमेल भेजने के लिए ईमेल पतों की सूची (अधिकतम 1000)। यदि उपयोग किया जाता है, तो संदेश केवल इन पतों पर भेजा जाता है। यदि एप्लिकेशन समूह का उपयोग किया जाता है तो इसे अनदेखा कर दिया जाता है।
use_auto_registrationbooleanनहींयदि true है, तो devices पैरामीटर से ईमेल स्वचालित रूप से पंजीकृत करता है।
usersarrayनहींयदि सेट है, तो ईमेल संदेश केवल निर्दिष्ट User ID को दिया जाएगा (/registerEmail कॉल के माध्यम से पंजीकृत)। एक ऐरे में 1000 से अधिक उपयोगकर्ता आईडी नहीं। यदि “devices” पैरामीटर निर्दिष्ट है, तो “users” पैरामीटर को अनदेखा कर दिया जाएगा।
dynamic_content_placeholdersobjectनहींडिवाइस टैग मानों के बजाय डायनामिक कंटेंट के लिए प्लेसहोल्डर।
conditionsarrayनहींटैग का उपयोग करके सेगमेंटेशन की शर्तें। उदाहरण: [["Country", "EQ", "BR"]]।
fromobjectनहींएप्लिकेशन गुणों में डिफ़ॉल्ट को ओवरराइड करते हुए, एक कस्टम प्रेषक नाम और ईमेल निर्दिष्ट करें।
reply-toobjectनहींएप्लिकेशन गुणों में डिफ़ॉल्ट को ओवरराइड करते हुए, एक कस्टम रिप्लाई-टू ईमेल निर्दिष्ट करें।
bccarrayनहींBCC (ब्लाइंड कार्बन कॉपी): ईमेल पतों का ऐरे जो अन्य प्राप्तकर्ताओं को देखे बिना ईमेल की एक प्रति प्राप्त करते हैं।
email_typestringनहींईमेल प्रकार निर्दिष्ट करें: "marketing" या "transactional"। यदि छोड़ा जाता है, तो PW_ControlGroup: true वाले उपयोगकर्ताओं को संदेश प्राप्त नहीं होगा।
email_categorystringजब email_type "marketing" हो तो आवश्यक है।सदस्यता वरीयता केंद्र में कॉन्फ़िगर किए गए श्रेणी नामों में से एक निर्दिष्ट करें (जैसे न्यूज़लेटर, प्रमोशनल, उत्पाद अपडेट)।
transactionIdstringनहींनेटवर्क समस्याओं के मामले में फिर से भेजने से रोकने के लिए अद्वितीय संदेश पहचानकर्ता। Pushwoosh की ओर से 5 मिनट के लिए संग्रहीत।
capping_daysintegerनहींप्रति डिवाइस फ़्रीक्वेंसी कैपिंग लागू करने के लिए दिनों की संख्या (अधिकतम 30)। ध्यान दें: सुनिश्चित करें कि कंट्रोल पैनल में वैश्विक फ़्रीक्वेंसी कैपिंग कॉन्फ़िगर किया गया है।
capping_countintegerनहींएक capping_days अवधि के भीतर एक विशिष्ट ऐप से किसी विशेष डिवाइस पर भेजे जा सकने वाले ईमेल की अधिकतम संख्या। यदि बनाया गया संदेश किसी डिवाइस के लिए capping_count सीमा से अधिक हो जाता है, तो यह उस डिवाइस पर नहीं भेजा जाएगा।
capping_excludebooleanनहींयदि true पर सेट है, तो यह ईमेल भविष्य के ईमेल के लिए कैपिंग में नहीं गिना जाएगा।
capping_avoidbooleanनहींयदि true पर सेट है, तो इस विशिष्ट ईमेल पर कैपिंग लागू नहीं होगी।
send_rateintegerनहींसभी उपयोगकर्ताओं में प्रति सेकंड कितने संदेश भेजे जा सकते हैं, इसे सीमित करें। उच्च-मात्रा में भेजने के दौरान बैकएंड ओवरलोड को रोकने में मदद करता है।
send_rate_avoidbooleanनहींयदि true पर सेट है, तो इस विशिष्ट ईमेल पर थ्रॉटलिंग सीमा लागू नहीं होगी।

अनुरोध का उदाहरण

Anchor link to
{
  "request": {
    "auth": "API_ACCESS_TOKEN",         // आवश्यक। Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन
    "application": "APPLICATION_CODE",  // आवश्यक। Pushwoosh एप्लिकेशन कोड।
    "notifications": [{
      "send_date": "now",               // आवश्यक। YYYY-MM-DD HH:mm या 'now'
      "preset": "ERXXX-32XXX",          // आवश्यक। Pushwoosh कंट्रोल पैनल में ईमेल कंटेंट एडिटर पेज
                                        //           के URL बार से ईमेल प्रीसेट कोड कॉपी करें।
      "subject": {                      // वैकल्पिक। ईमेल संदेश की विषय पंक्ति।
        "de": "subject de",
        "en": "subject en"
      },
      "content": {                      // वैकल्पिक। ईमेल बॉडी कंटेंट।
        "de": "<html><body>de Hello, moto</body></html>",
        "default": "<html><body>default Hello, moto</body></html>"
      },
      "attachments": [{                 // वैकल्पिक। ईमेल अटैचमेंट
        "name": "image.png",            //           "name" - फ़ाइल का नाम
        "content": "iVBANA...AFTkuQmwC" //           "content" - फ़ाइल का base64 एन्कोडेड कंटेंट
      }, {
        "name": "file.pdf",
        "content": "JVBERi...AFTarEGC"
      }],
      "list_unsubscribe": "URL",        // वैकल्पिक। "Link-Unsubscribe" हेडर के लिए कस्टम URL सेट करने की अनुमति दें
      "campaign": "CAMPAIGN_CODE",      // वैकल्पिक। इस ईमेल संदेश को किसी विशेष अभियान को सौंपने के लिए,
                                        //           यहां एक अभियान कोड जोड़ें।
      "ignore_user_timezone": true,     // वैकल्पिक।
      "timezone": "America/New_York",   // वैकल्पिक। उपयोगकर्ता के डिवाइस पर सेट टाइमज़ोन के अनुसार
                                        //           संदेश भेजने के लिए निर्दिष्ट करें।
      "filter": "FILTER_NAME",          // वैकल्पिक। फ़िल्टर शर्तों को पूरा करने वाले विशिष्ट उपयोगकर्ताओं को संदेश भेजें।
      "devices": [                      // वैकल्पिक। लक्षित ईमेल संदेश भेजने के लिए ईमेल पते निर्दिष्ट करें।
        "email_address1",               //           एक ऐरे में 1000 से अधिक पते नहीं।
        "email_address2"                //           यदि सेट है, तो संदेश केवल सूची में दिए गए पतों पर भेजा जाएगा।
      ],                                //           यदि एप्लिकेशन समूह का उपयोग किया जाता है तो इसे अनदेखा कर दिया जाता है।
      "use_auto_registration": true,    // वैकल्पिक। "devices" पैरामीटर में निर्दिष्ट ईमेल को स्वचालित रूप से पंजीकृत करें
      "users": [                        // वैकल्पिक। यदि सेट है, तो ईमेल संदेश केवल निर्दिष्ट
        "userId1",                      //           उपयोगकर्ता आईडी (/registerEmail कॉल के माध्यम से पंजीकृत) को दिया जाएगा।
        "userId2"                       //           एक ऐरे में 1000 से अधिक उपयोगकर्ता आईडी नहीं।
      ],                                //           यदि "devices" पैरामीटर निर्दिष्ट है,
                                        //           तो "users" पैरामीटर को अनदेखा कर दिया जाएगा।
      "dynamic_content_placeholders": { // वैकल्पिक। डिवाइस टैग मानों के बजाय डायनामिक कंटेंट के लिए प्लेसहोल्डर।
        "firstname": "John",
        "firstname_en": "John"
      },
      "conditions": [                   // वैकल्पिक। सेगमेंटेशन की शर्तें, नीचे टिप्पणी देखें।
        ["Country", "EQ", "BR"],
        ["Language", "EQ", "pt"]
      ],
      "from": {                         // वैकल्पिक। एक प्रेषक नाम और प्रेषक ईमेल पता निर्दिष्ट करें
        "name": "alias from",           //           डिफ़ॉल्ट "From name" और "From email" को बदलने के लिए
        "email": "from-email@email.com" //           जो एप्लिकेशन गुणों में सेट हैं।
      },
      "reply-to": {                     // वैकल्पिक। एक ईमेल पता निर्दिष्ट करें जो
        "name": "alias reply to ",      //           एप्लिकेशन गुणों में सेट डिफ़ॉल्ट "Reply to" को बदल देगा।
        "email": "reply-to@email.com"
      },
      "bcc": [                          // वैकल्पिक। BCC: ईमेल पतों का ऐरे जो अन्य प्राप्तकर्ताओं को देखे बिना एक प्रति प्राप्त करते हैं।
        "bcc1@example.com",
        "bcc2@example.com"
      ],
      "email_type": "marketing",        // वैकल्पिक। "marketing" या "transactional"।
                                        // यदि छोड़ा जाता है, तो PW_ControlGroup: true वाले उपयोगकर्ताओं को संदेश प्राप्त नहीं होगा।
      "email_category": "category name",// जब email_type "marketing" हो तो आवश्यक है। श्रेणी का नाम।
      "transactionId": "unique UUID",   // वैकल्पिक। नेटवर्क समस्याओं के मामले में फिर से भेजने से रोकने के लिए
                                        //           अद्वितीय संदेश पहचानकर्ता। Pushwoosh की ओर से
                                        //           5 मिनट के लिए संग्रहीत।
      // फ़्रीक्वेंसी कैपिंग पैरामीटर। सुनिश्चित करें कि कंट्रोल पैनल में वैश्विक फ़्रीक्वेंसी कैपिंग कॉन्फ़िगर किया गया है।
      // फ़्रीक्वेंसी कैपिंग ट्रांसेक्शनल संदेशों पर लागू नहीं होती है।
      // अन्य सभी मामलों में, जिसमें "email_type" छोड़ा गया है, फ़्रीक्वेंसी कैपिंग लागू होती है।
      "capping_days": 30,               // वैकल्पिक। फ़्रीक्वेंसी कैपिंग के लिए दिनों की संख्या (अधिकतम 30 दिन)
      "capping_count": 10,              // वैकल्पिक। एक 'capping_days' अवधि के भीतर एक विशिष्ट ऐप से
                                        //           किसी विशेष डिवाइस पर भेजे जा सकने वाले ईमेल की अधिकतम संख्या।
                                        //           यदि बनाया गया संदेश किसी डिवाइस के लिए 'capping_count'
                                        //           सीमा से अधिक हो जाता है, तो यह उस डिवाइस पर नहीं भेजा जाएगा।
      "capping_exclude": true,          // वैकल्पिक। यदि true पर सेट है, तो यह ईमेल भविष्य के ईमेल के लिए
                                        //           कैपिंग में नहीं गिना जाएगा।
      "capping_avoid": true,            // वैकल्पिक। यदि true पर सेट है, तो इस विशिष्ट ईमेल पर
                                        //           कैपिंग लागू नहीं होगी।
      "send_rate": 100,                 // वैकल्पिक। थ्रॉटलिंग सीमा।
                                        //           सभी उपयोगकर्ताओं में प्रति सेकंड कितने संदेश भेजे जा सकते हैं, इसे सीमित करें।
                                        //           उच्च-मात्रा में भेजने के दौरान बैकएंड ओवरलोड को रोकने में मदद करता है।
      "send_rate_avoid": true,          // वैकल्पिक। यदि true पर सेट है, तो इस विशिष्ट ईमेल पर
                                        //           थ्रॉटलिंग सीमा लागू नहीं होगी।
    }]
  }
}

प्रतिक्रिया के उदाहरण

Anchor link to
{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}

टैग शर्तें

Anchor link to

प्रत्येक टैग शर्त [tagName, operator, operand] जैसा एक ऐरे है जहाँ

  • tagName: एक टैग का नाम
  • operator: “EQ” | “IN” | “NOTEQ” | “NOTIN” | “LTE” | “GTE” | “BETWEEN”
  • operand: string | integer | array | date

ऑपरेंड विवरण

Anchor link to
  • EQ: टैग मान ऑपरेंड के बराबर है;
  • IN: टैग मान ऑपरेंड के साथ प्रतिच्छेद करता है (ऑपरेंड हमेशा एक ऐरे होना चाहिए);
  • NOTEQ: टैग मान एक ऑपरेंड के बराबर नहीं है;
  • NOTIN: टैग मान ऑपरेंड के साथ प्रतिच्छेद नहीं करता है (ऑपरेंड हमेशा एक ऐरे होना चाहिए);
  • GTE: टैग मान ऑपरेंड से बड़ा या बराबर है;
  • LTE: टैग मान ऑपरेंड से छोटा या बराबर है;
  • BETWEEN: टैग मान न्यूनतम ऑपरेंड मान से बड़ा या बराबर है लेकिन अधिकतम ऑपरेंड मान से छोटा या बराबर है (ऑपरेंड हमेशा एक ऐरे होना चाहिए)।

स्ट्रिंग टैग

Anchor link to

मान्य ऑपरेटर: EQ, IN, NOTEQ, NOTIN
मान्य ऑपरेंड:

  • EQ, NOTEQ: ऑपरेंड एक स्ट्रिंग होना चाहिए;
  • IN, NOTIN: ऑपरेंड ["value 1", "value 2", "value N"] जैसे स्ट्रिंग्स का एक ऐरे होना चाहिए;

पूर्णांक टैग

Anchor link to

मान्य ऑपरेटर: EQ, IN, NOTEQ, NOTIN, BETWEEN, GTE, LTE
मान्य ऑपरेंड:

  • EQ, NOTEQ, GTE, LTE: ऑपरेंड एक पूर्णांक होना चाहिए;
  • IN, NOTIN: ऑपरेंड [value 1, value 2, value N] जैसे पूर्णांकों का एक ऐरे होना चाहिए;
  • BETWEEN: ऑपरेंड [min_value, max_value] जैसे पूर्णांकों का एक ऐरे होना चाहिए।

दिनांक टैग

Anchor link to

मान्य ऑपरेटर: EQ, IN, NOTEQ, NOTIN, BETWEEN, GTE, LTE
मान्य ऑपरेंड:

  • "YYYY-MM-DD 00:00" (स्ट्रिंग)
  • यूनिक्स टाइमस्टैम्प 1234567890 (पूर्णांक)
  • ऑपरेटर EQ, BETWEEN, GTE, LTE के लिए "N days ago" (स्ट्रिंग)

बूलियन टैग

Anchor link to

मान्य ऑपरेटर: EQ
मान्य ऑपरेंड: 0, 1, true, false

सूची टैग

Anchor link to

मान्य ऑपरेटर: IN
मान्य ऑपरेंड: ऑपरेंड ["value 1", "value 2", "value N"] जैसे स्ट्रिंग्स का एक ऐरे होना चाहिए।

registerEmail

Anchor link to

ऐप के लिए ईमेल पता पंजीकृत करता है।

POST https://api.pushwoosh.com/json/1.3/registerEmail

अनुरोध हेडर

Anchor link to
नामआवश्यकमानविवरण
AuthorizationहाँToken XXXXडिवाइस एपीआई तक पहुंचने के लिए API डिवाइस टोकन। XXXX को अपने वास्तविक डिवाइस एपीआई टोकन से बदलें।

अनुरोध बॉडी

Anchor link to
नामप्रकारविवरण
application*stringPushwoosh एप्लिकेशन कोड
email*stringईमेल पता।
languagestringडिवाइस की भाषा लोकेल। ISO-639-1 मानक के अनुसार एक लोअरकेस दो-अक्षर का कोड होना चाहिए।
userIdstringईमेल पते के साथ संबद्ध करने के लिए User ID।
tz_offsetintegerसेकंड में टाइमज़ोन ऑफ़सेट।
tagsobjectपंजीकृत डिवाइस को सौंपने के लिए टैग मान।
{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}
उदाहरण
{
  "request": {
    "application": "APPLICATION_CODE",   // आवश्यक। Pushwoosh एप्लिकेशन कोड।
    "email":"email@domain.com",          // आवश्यक। पंजीकृत किया जाने वाला ईमेल पता।
    "language": "en",                    // वैकल्पिक। भाषा लोकेल।
    "userId": "userId",                  // वैकल्पिक। ईमेल पते के साथ संबद्ध करने के लिए User ID।
    "tz_offset": 3600,                   // वैकल्पिक। सेकंड में टाइमज़ोन ऑफ़सेट।
    "tags": {                            // वैकल्पिक। पंजीकृत डिवाइस के लिए सेट करने के लिए टैग मान।
       "StringTag": "string value",
       "IntegerTag": 42,
       "ListTag": ["string1","string2"], // सूची प्रकार के टैग के लिए मानों की सूची सेट करता है
       "DateTag": "2024-10-02 22:11",    // ध्यान दें कि समय UTC में होना चाहिए
       "BooleanTag": true                // मान्य मान हैं: true, false
    }
  }
}

deleteEmail

Anchor link to

आपके उपयोगकर्ता आधार से ईमेल पता हटाता है।

POST https://api.pushwoosh.com/json/1.3/deleteEmail

अनुरोध हेडर

Anchor link to
नामआवश्यकमानविवरण
AuthorizationहाँToken XXXXडिवाइस एपीआई तक पहुंचने के लिए API डिवाइस टोकन। XXXX को अपने वास्तविक डिवाइस एपीआई टोकन से बदलें।

अनुरोध बॉडी

Anchor link to
नामप्रकारविवरण
applicationstringPushwoosh एप्लिकेशन कोड
emailstring/registerEmail अनुरोध में प्रयुक्त ईमेल पता।
{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}
उदाहरण
{
  "request": {
    "application": "APPLICATION_CODE",  // आवश्यक। Pushwoosh एप्लिकेशन कोड
    "email": "email@domain.com"         // आवश्यक। ऐप ग्राहकों से हटाने के लिए ईमेल।
  }
}

setEmailTags

Anchor link to

ईमेल पते के लिए टैग मान सेट करता है।

POST https://api.pushwoosh.com/json/1.3/setEmailTags

अनुरोध हेडर

Anchor link to
नामआवश्यकमानविवरण
AuthorizationहाँToken XXXXडिवाइस एपीआई तक पहुंचने के लिए API डिवाइस टोकन। XXXX को अपने वास्तविक डिवाइस एपीआई टोकन से बदलें।

अनुरोध बॉडी

Anchor link to
नामप्रकारविवरण
applicationstringPushwoosh एप्लिकेशन कोड
emailstringईमेल पता।
tagsobjectसेट करने के लिए टैग का JSON ऑब्जेक्ट, मान हटाने के लिए ‘null’ भेजें।
userIdstringईमेल पते से संबद्ध User ID।
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "skipped": []
  }
}
उदाहरण
{
  "request": {
    "email": "email@domain.com",                  // आवश्यक। टैग सेट करने के लिए ईमेल पता।
    "application": "APPLICATION_CODE",            // आवश्यक। Pushwoosh एप्लिकेशन कोड।
    "tags": {
      "StringTag": "string value",
      "IntegerTag": 42,
      "ListTag": ["string1", "string2"],
      "DateTag": "2024-10-02 22:11",              // UTC में समय
      "BooleanTag": true                          // मान्य मान हैं: true, false
    },
    "userId": "userId"                            // वैकल्पिक। ईमेल पते से संबद्ध User ID।
  }
}

registerEmailUser

Anchor link to

एक बाहरी User ID को एक निर्दिष्ट ईमेल पते के साथ संबद्ध करता है।

POST https://api.pushwoosh.com/json/1.3/registerEmailUser

/createEmailMessage API कॉल (‘users’ पैरामीटर) में उपयोग किया जा सकता है।

अनुरोध हेडर

Anchor link to
नामआवश्यकमानविवरण
AuthorizationहाँToken XXXXडिवाइस एपीआई तक पहुंचने के लिए API डिवाइस टोकन। XXXX को अपने वास्तविक डिवाइस एपीआई टोकन से बदलें।

अनुरोध बॉडी

Anchor link to
नामप्रकारविवरण
application*stringPushwoosh एप्लिकेशन कोड
email*stringईमेल पता।
userId*stringईमेल पते के साथ संबद्ध करने के लिए User ID।
tz_offsetintegerसेकंड में टाइमज़ोन ऑफ़सेट।
{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}
उदाहरण
{
  "request": {
    "application": "APPLICATION_CODE", // आवश्यक। Pushwoosh एप्लिकेशन कोड।
    "email": "email@domain.com",       // आवश्यक। उपयोगकर्ता का ईमेल पता।
    "userId": "userId",                // आवश्यक। ईमेल पते के साथ संबद्ध करने के लिए User ID।
    "tz_offset": 3600                  // वैकल्पिक। सेकंड में टाइमज़ोन ऑफ़सेट।
  }
}