ईमेल एपीआई

createEmailMessage

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

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

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

नाम	प्रकार	आवश्यक	विवरण
auth	string	हाँ	Pushwoosh कंट्रोल पैनल से एपीआई एक्सेस टोकन।
application	string	हाँ	Pushwoosh एप्लिकेशन कोड
notifications	array	हाँ	ईमेल संदेश विवरण युक्त JSON ऐरे। नीचे नोटिफ़िकेशन पैरामीटर तालिका देखें।

नोटिफ़िकेशन पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
send_date	string	हाँ	परिभाषित करता है कि ईमेल कब भेजना है। प्रारूप: YYYY-MM-DD HH:mm या "now"।
preset	string	हाँ	ईमेल प्रीसेट कोड। Pushwoosh कंट्रोल पैनल में ईमेल कंटेंट एडिटर के URL बार से कॉपी करें।
subject	string या object	नहीं	ईमेल की विषय पंक्ति। ईमेल हमेशा कंटेंट की भाषा में होगा। यदि subject में content के लिए मेल खाने वाली भाषा नहीं है, तो विषय खाली रहेगा।
content	string या object	नहीं	ईमेल बॉडी कंटेंट। सादे HTML कंटेंट के लिए एक स्ट्रिंग या स्थानीयकृत संस्करणों के लिए एक ऑब्जेक्ट हो सकता है।
attachments	array	नहीं	ईमेल अटैचमेंट। केवल दो अटैचमेंट उपलब्ध हैं। प्रत्येक अटैचमेंट 1MB (base64 एन्कोडेड) से अधिक नहीं होना चाहिए।
list_unsubscribe	string	नहीं	”Link-Unsubscribe” हेडर के लिए कस्टम URL सेट करने की अनुमति देता है।
campaign	string	नहीं	ईमेल को एक विशिष्ट अभियान के साथ जोड़ने के लिए अभियान कोड।
ignore_user_timezone	boolean	नहीं	यदि true है, तो उपयोगकर्ता के टाइमज़ोन को अनदेखा करते हुए ईमेल तुरंत भेजता है।
timezone	string	नहीं	उपयोगकर्ता के टाइमज़ोन के अनुसार ईमेल भेजता है। उदाहरण: "America/New_York"।
filter	string	नहीं	एक विशिष्ट फ़िल्टर शर्त से मेल खाने वाले उपयोगकर्ताओं को ईमेल भेजता है।
devices	array	नहीं	लक्षित ईमेल भेजने के लिए ईमेल पतों की सूची (अधिकतम 1000)। यदि उपयोग किया जाता है, तो संदेश केवल इन पतों पर भेजा जाता है। यदि एप्लिकेशन समूह का उपयोग किया जाता है तो इसे अनदेखा कर दिया जाता है।
use_auto_registration	boolean	नहीं	यदि true है, तो devices पैरामीटर से ईमेल को स्वचालित रूप से पंजीकृत करता है।
users	array	नहीं	यदि सेट किया गया है, तो ईमेल संदेश केवल निर्दिष्ट यूज़र आईडी को दिया जाएगा (/registerEmail कॉल के माध्यम से पंजीकृत)। एक ऐरे में 1000 से अधिक यूज़र आईडी नहीं। यदि “devices” पैरामीटर निर्दिष्ट है, तो “users” पैरामीटर को अनदेखा कर दिया जाएगा।
dynamic_content_placeholders	object	नहीं	डिवाइस टैग मानों के बजाय डायनामिक कंटेंट के लिए प्लेसहोल्डर।
conditions	array	नहीं	टैग का उपयोग करके सेगमेंटेशन की शर्तें। उदाहरण: [["Country", "EQ", "BR"]]।
from	object	नहीं	एप्लिकेशन गुणों में डिफ़ॉल्ट को ओवरराइड करते हुए, एक कस्टम प्रेषक नाम और ईमेल निर्दिष्ट करें।
reply-to	object	नहीं	एप्लिकेशन गुणों में डिफ़ॉल्ट को ओवरराइड करते हुए, एक कस्टम रिप्लाई-टू ईमेल निर्दिष्ट करें।
email_type	string	नहीं	ईमेल प्रकार निर्दिष्ट करें: "marketing" या "transactional"।
email_category	string	email_type "marketing" होने पर आवश्यक।	सदस्यता वरीयता केंद्र में कॉन्फ़िगर किए गए श्रेणी नामों में से एक निर्दिष्ट करें (जैसे न्यूज़लेटर, प्रमोशनल, उत्पाद अपडेट)।
transactionId	string	नहीं	नेटवर्क समस्याओं के मामले में फिर से भेजने से रोकने के लिए अद्वितीय संदेश पहचानकर्ता। Pushwoosh की ओर से 5 मिनट के लिए संग्रहीत।
capping_days	integer	नहीं	प्रति डिवाइस फ़्रीक्वेंसी कैपिंग लागू करने के लिए दिनों की संख्या (अधिकतम 30)। ध्यान दें: सुनिश्चित करें कि कंट्रोल पैनल में वैश्विक फ़्रीक्वेंसी कैपिंग कॉन्फ़िगर किया गया है।
capping_count	integer	नहीं	एक capping_days अवधि के भीतर एक विशिष्ट ऐप से एक विशेष डिवाइस पर भेजे जा सकने वाले ईमेल की अधिकतम संख्या। यदि बनाया गया संदेश किसी डिवाइस के लिए capping_count सीमा से अधिक हो जाता है, तो यह उस डिवाइस पर नहीं भेजा जाएगा।
capping_exclude	boolean	नहीं	यदि true पर सेट है, तो यह ईमेल भविष्य के ईमेल के लिए कैपिंग में नहीं गिना जाएगा।
capping_avoid	boolean	नहीं	यदि true पर सेट है, तो इस विशिष्ट ईमेल पर कैपिंग लागू नहीं होगी।
send_rate	integer	नहीं	सभी उपयोगकर्ताओं में प्रति सेकंड कितने संदेश भेजे जा सकते हैं, इसे सीमित करें। उच्च-मात्रा में भेजने के दौरान बैकएंड ओवरलोड को रोकने में मदद करता है।
send_rate_avoid	boolean	नहीं	यदि true पर सेट है, तो इस विशिष्ट ईमेल पर थ्रॉटलिंग सीमा लागू नहीं होगी।

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

{
  "request": {
    "auth": "API_ACCESS_TOKEN",         // आवश्यक। Pushwoosh कंट्रोल पैनल से एपीआई एक्सेस टोकन
    "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"
      },
      "email_type": "marketing",        // वैकल्पिक। "marketing" या "transactional"।
      "email_category": "category name",// email_type "marketing" होने पर आवश्यक। श्रेणी का नाम।
      "transactionId": "unique UUID",   // वैकल्पिक। नेटवर्क समस्याओं के मामले में फिर से भेजने से
                                        //           रोकने के लिए अद्वितीय संदेश पहचानकर्ता। Pushwoosh
                                        //           की ओर से 5 मिनट के लिए संग्रहीत।
      // फ़्रीक्वेंसी कैपिंग पैरामीटर। सुनिश्चित करें कि कंट्रोल पैनल में वैश्विक फ़्रीक्वेंसी कैपिंग कॉन्फ़िगर किया गया है।
      "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` पर सेट है, तो इस विशिष्ट ईमेल पर
                                        //           थ्रॉटलिंग सीमा लागू नहीं होगी।
    }]
  }
}

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

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}

403

{
  "status_code": 403,
  "status_message": "Token restrictions forbid this operation",
  "response": null
}

टैग की शर्तें

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

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

ऑपरेंड का विवरण

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

स्ट्रिंग टैग

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

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

इंटीजर टैग

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

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

दिनांक टैग

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

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

बूलियन टैग

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

सूची टैग

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

खतरा

याद रखें कि “filter” और “conditions” पैरामीटर का एक साथ उपयोग नहीं किया जाना चाहिए।
साथ ही, यदि एक ही अनुरोध में “devices” पैरामीटर का उपयोग किया जाता है, तो दोनों को अनदेखा कर दिया जाएगा।

नोट

देश और भाषा टैग

भाषा टैग मान ISO-639-1 के अनुसार एक लोअरकेस दो-अक्षर का कोड है
देश टैग मान ISO_3166-2 के अनुसार एक अपरकेस दो-अक्षर का कोड है
उदाहरण के लिए, ब्राजील में पुर्तगाली-भाषी ग्राहकों को पुश नोटिफ़िकेशन भेजने के लिए, आपको निम्नलिखित शर्त निर्दिष्ट करनी होगी: "conditions": [["Country", "EQ", "BR"],["Language", "EQ", "pt"]]

registerEmail

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

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

अनुरोध हेडर

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

अनुरोध बॉडी

नाम	प्रकार	विवरण
application*	string	Pushwoosh एप्लिकेशन कोड
email*	string	ईमेल पता।
language	string	डिवाइस की भाषा लोकेल। ISO-639-1 मानक के अनुसार एक लोअरकेस दो-अक्षर का कोड होना चाहिए।
userId	string	ईमेल पते के साथ संबद्ध करने के लिए यूज़र आईडी।
tz_offset	integer	सेकंड में टाइमज़ोन ऑफ़सेट।
tags	object	पंजीकृत डिवाइस को सौंपने के लिए टैग मान।

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}

उदाहरण

{
  "request": {
    "application": "APPLICATION_CODE",   // आवश्यक। Pushwoosh एप्लिकेशन कोड।
    "email":"email@domain.com",          // आवश्यक। पंजीकृत किया जाने वाला ईमेल पता।
    "language": "en",                    // वैकल्पिक। भाषा लोकेल।
    "userId": "userId",                  // वैकल्पिक। ईमेल पते के साथ संबद्ध करने के लिए यूज़र आईडी।
    "tz_offset": 3600,                   // वैकल्पिक। सेकंड में टाइमज़ोन ऑफ़सेट।
    "tags": {                            // वैकल्पिक। पंजीकृत डिवाइस के लिए सेट किए जाने वाले टैग मान।
       "StringTag": "string value",
       "IntegerTag": 42,
       "ListTag": ["string1","string2"], // सूची प्रकार के टैग के लिए मानों की सूची सेट करता है
       "DateTag": "2024-10-02 22:11",    // ध्यान दें कि समय UTC में होना चाहिए
       "BooleanTag": true                // मान्य मान हैं: true, false
    }
  }
}

deleteEmail

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

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

अनुरोध हेडर

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

अनुरोध बॉडी

नाम	प्रकार	विवरण
application	string	Pushwoosh एप्लिकेशन कोड
email	string	/registerEmail अनुरोध में उपयोग किया गया ईमेल पता।

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}

उदाहरण

{
  "request": {
    "application": "APPLICATION_CODE",  // आवश्यक। Pushwoosh एप्लिकेशन कोड
    "email": "email@domain.com"         // आवश्यक। ऐप ग्राहकों से हटाने के लिए ईमेल।
  }
}

setEmailTags

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

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

अनुरोध हेडर

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

अनुरोध बॉडी

नाम	प्रकार	विवरण
application	string	Pushwoosh एप्लिकेशन कोड
email	string	ईमेल पता।
tags	object	सेट करने के लिए टैग का JSON ऑब्जेक्ट, मान हटाने के लिए ‘null’ भेजें।
userId	string	ईमेल पते से संबद्ध यूज़र आईडी।

200

{
  "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"                            // वैकल्पिक। ईमेल पते से संबद्ध यूज़र आईडी।
  }
}

नोट

अन्य डिवाइस प्रकारों के लिए 200 OK लौटाया जाएगा, हालांकि टैग सहेजे नहीं जाएंगे।

सावधानी

कृपया एक ही /setEmailTags अनुरोध में 50 से अधिक टैग मान सेट करने से बचें।

registerEmailUser

एक बाहरी यूज़र आईडी को एक निर्दिष्ट ईमेल पते के साथ जोड़ता है।

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

नोट

कृपया ध्यान दें कि यह विधि आपके उपयोगकर्ता आधार में एक ईमेल पता पंजीकृत नहीं करती है; इसका उपयोग केवल उन ईमेल पतों पर यूज़र आईडी निर्दिष्ट करने के लिए किया जाना चाहिए जो पहले से ही /registerEmail अनुरोध द्वारा पंजीकृत किए जा चुके हैं।

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

अनुरोध हेडर

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

अनुरोध बॉडी

नाम	प्रकार	विवरण
application*	string	Pushwoosh एप्लिकेशन कोड
email*	string	ईमेल पता।
userId*	string	ईमेल पते के साथ संबद्ध करने के लिए यूज़र आईडी।
tz_offset	integer	सेकंड में टाइमज़ोन ऑफ़सेट।

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}

400

{
  "status_code": 400,
  "status_message": "Request format is not valid."
}

403

{
  "status_code": 403,
  "status_message": "Forbidden."
}

उदाहरण

{
  "request": {
    "application": "APPLICATION_CODE", // आवश्यक। Pushwoosh एप्लिकेशन कोड।
    "email": "email@domain.com",       // आवश्यक। उपयोगकर्ता का ईमेल पता।
    "userId": "userId",                // आवश्यक। ईमेल पते के साथ संबद्ध करने के लिए यूज़र आईडी।
    "tz_offset": 3600                  // वैकल्पिक। सेकंड में टाइमज़ोन ऑफ़सेट।
  }
}

नोट

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