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

Email API

createEmailMessage

Anchor link to

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

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

Request body parameters

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

Notifications parameters

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

Request example

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 कंट्रोल पैनल में Email Content editor पेज के
                                        //           URL बार से ईमेल प्रीसेट कोड कॉपी करें।
      "subject": {                      // वैकल्पिक। ईमेल संदेश की विषय पंक्ति।
        "de": "subject de",
        "en": "subject en"
      },
      "content": {                      // वैकल्पिक। ईमेल का मुख्य भाग (body 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 encoded सामग्री
      }, {
        "name": "file.pdf",
        "content": "JVBERi...AFTarEGC"
      }],
      "list_unsubscribe": "URL",        // वैकल्पिक। "Link-Unsubscribe" हेडर के लिए कस्टम URL सेट करने की अनुमति देता है
      "campaign": "CAMPAIGN_CODE",      // वैकल्पिक। इस ईमेल संदेश को किसी विशेष अभियान (campaign) को सौंपने के लिए,
                                        //           यहाँ एक अभियान कोड जोड़ें।
      "ignore_user_timezone": true,     // वैकल्पिक।
      "timezone": "America/New_York",   // वैकल्पिक। उपयोगकर्ता के डिवाइस पर सेट समय क्षेत्र के अनुसार
                                        //           संदेश भेजने के लिए निर्दिष्ट करें।
      "filter": "FILTER_NAME",          // वैकल्पिक। फ़िल्टर शर्तों को पूरा करने वाले विशिष्ट उपयोगकर्ताओं को संदेश भेजें।
      "devices": [                      // वैकल्पिक। लक्षित ईमेल संदेश भेजने के लिए ईमेल पते निर्दिष्ट करें।
        "email_address1",               //           एक array में 1000 से अधिक पते नहीं।
        "email_address2"                //           यदि सेट किया गया है, तो संदेश केवल सूची में मौजूद पतों पर
      ],                                //           भेजा जाएगा। यदि एप्लिकेशन समूह का उपयोग किया जाता है तो इसे अनदेखा कर दिया जाता है।
      "use_auto_registration": true,    // वैकल्पिक। "devices" पैरामीटर में निर्दिष्ट ईमेल को स्वचालित रूप से पंजीकृत करें
      "users": [                        // वैकल्पिक। यदि सेट किया गया है, तो ईमेल संदेश केवल निर्दिष्ट
        "userId1",                      //           उपयोगकर्ता आईडी ( /registerEmail कॉल के माध्यम से पंजीकृत) को वितरित किया जाएगा।
        "userId2"                       //           एक array में 1000 से अधिक उपयोगकर्ता आईडी नहीं।
      ],                                //           यदि "devices" पैरामीटर निर्दिष्ट है,
                                        //           तो "users" पैरामीटर को अनदेखा कर दिया जाएगा।
      "dynamic_content_placeholders": { // वैकल्पिक। डिवाइस टैग मानों के बजाय डायनामिक सामग्री के लिए प्लेसहोल्डर।
        "firstname": "John",
        "firstname_en": "John"
      },
      "conditions": [                   // वैकल्पिक। विभाजन (segmentation) शर्तें, नीचे टिप्पणी देखें।
        ["Country", "EQ", "BR"],
        ["Language", "EQ", "pt"]
      ],
      "from": {                         // वैकल्पिक। डिफ़ॉल्ट "From name" और "From email" को बदलने के लिए
        "name": "alias from",           //           एक प्रेषक नाम और प्रेषक ईमेल पता निर्दिष्ट करें
        "email": "from-email@email.com" //           जो एप्लिकेशन गुणों में सेट है।
      },
      "reply-to": {                     // वैकल्पिक। एप्लिकेशन गुणों में सेट डिफ़ॉल्ट "Reply to" को
        "name": "alias reply to ",      //           बदलने के लिए एक ईमेल पता निर्दिष्ट करें।
        "email": "reply-to@email.com"
      },
      "transactionId": "unique UUID",   // वैकल्पिक। नेटवर्क समस्याओं के मामले में दोबारा भेजने से रोकने के लिए
                                        //           अद्वितीय संदेश पहचानकर्ता। Pushwoosh की ओर से
                                        //           5 मिनट के लिए संग्रहीत किया जाता है।
      // Frequency capping params. सुनिश्चित करें कि कंट्रोल पैनल में ग्लोबल फ़्रीक्वेंसी कैपिंग कॉन्फ़िगर किया गया है।
      "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 पर सेट किया जाता है, तो इस विशिष्ट ईमेल पर
                                        //           थ्रॉटलिंग सीमा लागू नहीं होगी।
    }]
  }
}

Response examples

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

Tag conditions

Anchor link to

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

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

Operand description

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

String tags

Anchor link to

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

  • EQ, NOTEQ: operand एक string होना चाहिए;
  • IN, NOTIN: operand ["value 1", "value 2", "value N"] जैसा strings का एक array होना चाहिए;

Integer tags

Anchor link to

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

  • EQ, NOTEQ, GTE, LTE: operand एक integer होना चाहिए;
  • IN, NOTIN: operand [value 1, value 2, value N] जैसा integers का एक array होना चाहिए;
  • BETWEEN: operand [min_value, max_value] जैसा integers का एक array होना चाहिए।

Date tags

Anchor link to

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

  • "YYYY-MM-DD 00:00" (string)
  • unix timestamp 1234567890 (integer)
  • "N days ago" (string) ऑपरेटर्स EQ, BETWEEN, GTE, LTE के लिए

Boolean tags

Anchor link to

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

List tags

Anchor link to

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

registerEmail

Anchor link to

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

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

Request headers

Anchor link to
NameRequiredValueDescription
AuthorizationहाँToken XXXXDevice API तक पहुँचने के लिए API डिवाइस टोकन। XXXX को अपने वास्तविक Device API टोकन से बदलें।

Request body

Anchor link to
NameTypeDescription
application*stringPushwoosh एप्लिकेशन कोड
email*stringईमेल पता।
languagestringडिवाइस का भाषा लोकेल (Language locale)। ISO-639-1 मानक के अनुसार एक लोअरकेस दो-अक्षर वाला कोड होना चाहिए।
userIdstringईमेल पते के साथ जोड़ने के लिए User ID।
tz_offsetintegerसेकंड में समय क्षेत्र ऑफसेट (Timezone offset)।
tagsobjectपंजीकृत डिवाइस को असाइन करने के लिए टैग मान।
{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}
Example
{
  "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"], // List प्रकार के टैग के लिए मानों की सूची सेट करता है
       "DateTag": "2024-10-02 22:11",    // ध्यान दें कि समय UTC में होना चाहिए
       "BooleanTag": true                // मान्य मान हैं: true, false
    }
  }
}

deleteEmail

Anchor link to

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

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

Request headers

Anchor link to
NameRequiredValueDescription
AuthorizationहाँToken XXXXDevice API तक पहुँचने के लिए API डिवाइस टोकन। XXXX को अपने वास्तविक Device API टोकन से बदलें।

Request body

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

setEmailTags

Anchor link to

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

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

Request headers

Anchor link to
NameRequiredValueDescription
AuthorizationहाँToken XXXXDevice API तक पहुँचने के लिए API डिवाइस टोकन। XXXX को अपने वास्तविक Device API टोकन से बदलें।

Request body

Anchor link to
NameTypeDescription
applicationstringPushwoosh एप्लिकेशन कोड
emailstringईमेल पता।
tagsobjectसेट करने के लिए टैग का JSON ऑब्जेक्ट, मान हटाने के लिए ‘null’ भेजें।
userIdstringईमेल पते से जुड़ा User ID।
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "skipped": []
  }
}
Example
{
  "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’ पैरामीटर) में उपयोग किया जा सकता है।

Request headers

Anchor link to
NameRequiredValueDescription
AuthorizationहाँToken XXXXDevice API तक पहुँचने के लिए API डिवाइस टोकन। XXXX को अपने वास्तविक Device API टोकन से बदलें।

Request body

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