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

ईमेल एपीआई

createEmailMessage

Anchor link to

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

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

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

Anchor link to
नामप्रकार
आवश्यकविवरण
authstringहाँPushwoosh कंट्रोल पैनल से एपीआई एक्सेस टोकन।
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नहींयदि सेट है, तो ईमेल संदेश केवल निर्दिष्ट यूज़र आईडी (/registerEmail कॉल के माध्यम से पंजीकृत) को दिया जाएगा। एक ऐरे में 1000 से अधिक यूज़र आईडी नहीं। यदि “devices” पैरामीटर निर्दिष्ट है, तो “users” पैरामीटर को अनदेखा कर दिया जाएगा।
dynamic_content_placeholdersobjectनहींडिवाइस टैग मानों के बजाय गतिशील सामग्री के लिए प्लेसहोल्डर।
conditionsarrayनहींटैग का उपयोग करके सेगमेंटेशन की शर्तें। उदाहरण: [["Country", "EQ", "BR"]]।
fromobjectनहींएप्लिकेशन गुणों में डिफ़ॉल्ट को ओवरराइड करते हुए, एक कस्टम प्रेषक नाम और ईमेल निर्दिष्ट करें।
reply-toobjectनहींएप्लिकेशन गुणों में डिफ़ॉल्ट को ओवरराइड करते हुए, एक कस्टम रिप्लाई-टू ईमेल निर्दिष्ट करें।
bccarrayनहींBCC (ब्लाइंड कार्बन कॉपी): ईमेल पतों का ऐरे जो अन्य प्राप्तकर्ताओं को देखे बिना ईमेल की एक प्रति प्राप्त करते हैं।
email_typestringनहींईमेल प्रकार निर्दिष्ट करें: "marketing" या "transactional"।
email_categorystring"marketing" होने पर email_type आवश्यक है।सदस्यता वरीयता केंद्र में कॉन्फ़िगर किए गए श्रेणी नामों में से एक निर्दिष्ट करें (जैसे न्यूज़लेटर, प्रमोशनल, उत्पाद अपडेट)।
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",         // required. API access token from Pushwoosh Control Panel
    "application": "APPLICATION_CODE",  // required. Pushwoosh application code.
    "notifications": [{
      "send_date": "now",               // required. YYYY-MM-DD HH:mm  OR 'now'
      "preset": "ERXXX-32XXX",          // required. Copy Email preset code from the URL bar of
                                        //           the Email Content editor page in Pushwoosh Control Panel.
      "subject": {                      // optional. Email message subject line.
        "de": "subject de",
        "en": "subject en"
      },
      "content": {                      // optional. Email body content.
        "de": "<html><body>de Hello, moto</body></html>",
        "default": "<html><body>default Hello, moto</body></html>"
      },
      "attachments": [{                 // optional. Email attachments
        "name": "image.png",            //           "name" - file name
        "content": "iVBANA...AFTkuQmwC" //           "content" - base64 encoded content of the file
      }, {
        "name": "file.pdf",
        "content": "JVBERi...AFTarEGC"
      }],
      "list_unsubscribe": "URL",        // optional. Allow to set custom URL for "Link-Unsubscribe" header
      "campaign": "CAMPAIGN_CODE",      // optional. To assign this email message to a particular campaign,
                                        //           add a campaign code here.
      "ignore_user_timezone": true,     // optional.
      "timezone": "America/New_York",   // optional. Specify to send the message according to
                                        //           timezone set on user's device.
      "filter": "FILTER_NAME",          // optional. Send the message to specific users meeting filter conditions.
      "devices": [                      // optional. Specify email addresses to send targeted email messages.
        "email_address1",               //           Not more than 1000 addresses in an array.
        "email_address2"                //           If set, the message will only be sent to the addresses on
      ],                                //           the list. Ignored if the Application Group is used.
      "use_auto_registration": true,    // optional. Automatically register emails specified in "devices" parameter
      "users": [                        // optional. If set, the email message will only be delivered to the
        "userId1",                      //           specified user IDs (registered via /registerEmail call).
        "userId2"                       //           Not more than 1000 user IDs in an array.
      ],                                //           If the "devices" parameter is specified,
                                        //           the "users" parameter will be ignored.
      "dynamic_content_placeholders": { // optional. Placeholders for dynamic content instead of device tag values.
        "firstname": "John",
        "firstname_en": "John"
      },
      "conditions": [                   // optional. Segmentation conditions, see remark below.
        ["Country", "EQ", "BR"],
        ["Language", "EQ", "pt"]
      ],
      "from": {                         // optional. Specify a sender name and sender email address
        "name": "alias from",           //           to replace the default "From name" and "From email"
        "email": "from-email@email.com" //           set up in application properties.
      },
      "reply-to": {                     // optional. Specify an email address to replace the
        "name": "alias reply to ",      //           default "Reply to" set up in application properties.
        "email": "reply-to@email.com"
      },
      "bcc": [                          // optional. BCC: array of email addresses that receive a copy without other recipients seeing them.
        "bcc1@example.com",
        "bcc2@example.com"
      ],
      "email_type": "marketing",        // optional. "marketing" or "transactional".
      "email_category": "category name",// required when email_type is "marketing". Category name.
      "transactionId": "unique UUID",   // optional. Unique message identifier to prevent re-sending
                                        //           in case of network problems. Stored on the side
                                        //           of Pushwoosh for 5 minutes.
      // Frequency capping params. Ensure that Global frequency capping is configured in the Control Panel.
      "capping_days": 30,               // optional. Amount of days for frequency capping (max 30 days)
      "capping_count": 10,              // optional. The max number of emails that can be sent from a
                                        //           specific app to a particular device within a 'capping_days'
                                        //           period. In case the message created exceeds the
                                        //           'capping_count' limit for a device, it won't
                                        //           be sent to that device.
      "capping_exclude": true,          // optional. If set to true, this email will not
                                        //           be counted towards the capping for future emails.
      "capping_avoid": true,            // optional. If set to true, capping will not be applied to
                                        //           this specific email.
      "send_rate": 100,                 // optional. Throttling limit.
                                        //           Limit how many messages can be sent per second across all users.
                                        //           Helps prevent backend overload during high-volume sends.
      "send_rate_avoid": true,          // optional. If set to true, throttling limit will not be applied to
                                        //           this specific email.
    }]
  }
}

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

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डिवाइस एपीआई तक पहुंचने के लिए एपीआई डिवाइस टोकन। XXXX को अपने वास्तविक डिवाइस एपीआई टोकन से बदलें।

अनुरोध बॉडी

Anchor link to
नामप्रकारविवरण
application*stringPushwoosh एप्लिकेशन कोड
email*stringईमेल पता।
languagestringडिवाइस की भाषा लोकेल। ISO-639-1 मानक के अनुसार एक लोअरकेस दो-अक्षर का कोड होना चाहिए।
userIdstringईमेल पते के साथ संबद्ध करने के लिए यूज़र आईडी।
tz_offsetintegerसेकंड में टाइमज़ोन ऑफ़सेट।
tagsobjectपंजीकृत डिवाइस को असाइन करने के लिए टैग मान।
{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}
उदाहरण
{
  "request": {
    "application": "APPLICATION_CODE",   // required. Pushwoosh application code.
    "email":"email@domain.com",          // required. Email address to be registered.
    "language": "en",                    // optional. Language locale.
    "userId": "userId",                  // optional. User ID to associate with the email address.
    "tz_offset": 3600,                   // optional. Timezone offset in seconds.
    "tags": {                            // optional. Tag values to set for the device registered.
       "StringTag": "string value",
       "IntegerTag": 42,
       "ListTag": ["string1","string2"], // sets the list of values for Tags of List type
       "DateTag": "2024-10-02 22:11",    // note the time should be in UTC
       "BooleanTag": true                // valid values are: true, false
    }
  }
}

deleteEmail

Anchor link to

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

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

अनुरोध हेडर

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

अनुरोध बॉडी

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

setEmailTags

Anchor link to

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

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

अनुरोध हेडर

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

अनुरोध बॉडी

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

registerEmailUser

Anchor link to

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

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

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

अनुरोध हेडर

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

अनुरोध बॉडी

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