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

/createMessage पैरामीटर्स

यहां आपको /createMessage API पैरामीटर्स का विवरण मिलेगा।

  • [/createMessage API अनुरोध को सफलतापूर्वक भेजने और निर्दिष्ट समय पर एक पुश नोटिफिकेशन प्रसारित करने के लिए आवश्यक पैरामीटर्स को शामिल किया जाना चाहिए।

  • वैकल्पिक पैरामीटर्स आपको पुश नोटिफिकेशन गुणों को अनुकूलित करने की अनुमति देते हैं।

आवश्यक पैरामीटर्स

Anchor link to

/createMessage अनुरोधों में आवश्यक पैरामीटर्स का उपयोग करना अनिवार्य है। अन्यथा, अनुरोध सबमिट नहीं किया जाएगा।

application

Anchor link to

आपके Pushwoosh अकाउंट में बनाए गए ऐप का यूनिक कोड। ऐप कोड कंट्रोल पैनल के ऊपरी बाएं कोने में या /createApplication अनुरोध के जवाब में पाया जा सकता है। ऐप कोड 10 वर्णों (अक्षर और अंक दोनों) का एक हाइफ़न-पृथक सेट है।

Pushwoosh एप्लीकेशन कोड कंट्रोल पैनल में ऊपर बाएं कोने में प्रदर्शित है

API के माध्यम से एक ऐप बनाते समय, आपको अपने /createApplication अनुरोध के जवाब में एक ऐप कोड मिलेगा।

API के माध्यम से पहले से बनाए गए ऐप का कोड प्राप्त करने के लिए, /getApplications को कॉल करें। /getApplications अनुरोध के जवाब में, आपको अपने Pushwoosh अकाउंट में बनाए गए सभी ऐप्स की सूची उनके नाम और कोड के साथ मिलेगी।

auth

Anchor link to

Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन। सेटिंग्स → API एक्सेस पर जाएं और उस टोकन को कॉपी करें जिसका आप उपयोग करना चाहते हैं या एक नया जेनरेट करें।

Pushwoosh कंट्रोल पैनल में API एक्सेस सेटिंग्स पेज जो API एक्सेस टोकन दिखा रहा है

एक्सेस टोकन जेनरेट करते समय, उसकी अनुमतियां निर्दिष्ट करें। उन गतिविधियों के प्रकारों के लिए चेकबॉक्स चेक करें जिनके साथ आप API टोकन का उपयोग करने जा रहे हैं। आप एप्लीकेशन चेकबॉक्स को चेक करके ऐप-विशिष्ट API टोकन बना सकते हैं।

अनुमतियों और एप्लीकेशन चेकबॉक्स के साथ API टोकन जनरेशन डायलॉग

content

Anchor link to

स्ट्रिंग या ऑब्जेक्ट जो संदेश की सामग्री को परिभाषित करता है। एक स्ट्रिंग प्रकार के मान के साथ सबमिट किया गया “content” पैरामीटर सभी प्राप्तकर्ताओं के लिए एक ही संदेश भेजेगा।

String
"content": "Hello world!",

JSON ऑब्जेक्ट्स का उपयोग डायनामिक कंटेंट का उपयोग करके सामग्री निर्दिष्ट करने के लिए किया जाता है, उदाहरण के लिए, बहु-भाषी संदेशों के लिए।

Object
"content": {
  "en": "Hello!",
  "es": "¡Hola!",
  "de": "Hallo!"
},

notifications

Anchor link to

पुश गुणों का JSON ऐरे। इसमें कम से कम आवश्यक content और send_date पैरामीटर्स शामिल होने चाहिए।

“notifications” ऐरे के भीतर उपयोग करने के लिए वैकल्पिक पैरामीटर्स:

send_date

Anchor link to

वह तारीख और समय जिस पर संदेश भेजा जाता है। YYYY-MM-DD HH:mm या ‘now’ के रूप में स्वरूपित कोई भी तारीख और समय हो सकता है। यदि ‘now’ पर सेट किया जाता है, तो अनुरोध सबमिट करने के तुरंत बाद संदेश भेजा जाएगा।

वैकल्पिक पैरामीटर्स

Anchor link to

campaign

Anchor link to

एक कैंपेन का कोड। कैंपेन कोड प्राप्त करने के लिए, सांख्यिकी → एकत्रित सांख्यिकी पर जाएं और उस कैंपेन का चयन करें जिसका आप उपयोग करने जा रहे हैं। कैंपेन कोड पेज URL के अंत में XXXXX-XXXXX प्रारूप में दिखाई देगा।

उदाहरण:

URL: https://app.pushwoosh.com/applications/AAAAA-AAAAA/statistics/aggregated-message?campaignCode=XXXXX-XXXXX

कैंपेन कोड: XXXXX-XXXXX

कैंपेन की सूची उनके कोड के साथ प्राप्त करने के लिए, /getCampaigns को कॉल करें। /getCampaigns अनुरोध के जवाब में, आपको अपने Pushwoosh अकाउंट में किसी विशेष ऐप के लिए बनाए गए सभी कैंपेन की सूची, उनके कोड, नाम और विवरण के साथ मिलेगी।

capping_days

Anchor link to

फ्रीक्वेंसी कैपिंग के लिए लागू की जाने वाली अवधि, दिनों में (अधिकतम 30 दिन)। विवरण के लिए फ्रीक्वेंसी कैपिंग देखें।

फ्रीक्वेंसी कैपिंग message_type: transactional वाले संदेशों पर लागू नहीं होती है। अन्य सभी मामलों में, फ्रीक्वेंसी कैपिंग लागू होती है, जिसमें वे अनुरोध भी शामिल हैं जहां message_type को छोड़ दिया गया है।

capping_count

Anchor link to

“capping_days” अवधि के भीतर किसी विशेष ऐप से किसी विशेष डिवाइस पर भेजे जा सकने वाले पुश की अधिकतम संख्या। यदि बनाया गया संदेश किसी डिवाइस के लिए “capping_count” सीमा से अधिक हो जाता है, तो यह उस डिवाइस पर नहीं भेजा जाएगा। विवरण के लिए फ्रीक्वेंसी कैपिंग देखें।

conditions

Anchor link to

कंडीशंस [tagName, operator, operand] जैसे ऐरे हैं जो टैग्स और उनके मानों के आधार पर लक्षित संदेश भेजने के लिए उपयोग किए जाते हैं, जहां:

  • tagName — लागू किए जाने वाले टैग का नाम,
  • ऑपरेटर — एक मान तुलना ऑपरेटर (“EQ” | “IN” | “NOTEQ” | “NOTIN” | “LTE” | “GTE” | “BETWEEN” | “NOTSET” | “ANY”),
  • ऑपरेंड — निम्नलिखित में से किसी भी प्रकार के टैग मान: स्ट्रिंग | इंटीजर | ऐरे | डेट | बूलियन | लिस्ट

ऑपरेटर विवरण

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

स्ट्रिंग टैग्स

Anchor link to

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

मान्य ऑपरेंड्स:

EQ, NOTEQऑपरेंड एक स्ट्रिंग होना चाहिए
IN, NOTINऑपरेंड स्ट्रिंग्स का एक ऐरे होना चाहिए जैसे ["value 1", "value 2", "value N"]
NOTSETटैग सेट नहीं है। ऑपरेंड पर विचार नहीं किया जाता है
ANYटैग का कोई भी मान है। ऑपरेंड पर विचार नहीं किया जाता है

इंटीजर टैग्स

Anchor link to

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

मान्य ऑपरेंड्स:

EQ, NOTEQ, GTE, LTEऑपरेंड एक इंटीजर होना चाहिए
IN, NOTINऑपरेंड इंटीजर्स का एक ऐरे होना चाहिए जैसे [value 1, value 2, value N]
BETWEENऑपरेंड इंटीजर्स का एक ऐरे होना चाहिए जैसे [min_value, max_value]
NOTSETटैग सेट नहीं है। ऑपरेंड पर विचार नहीं किया जाता है
ANYटैग का कोई भी मान है। ऑपरेंड पर विचार नहीं किया जाता है

डेट टैग्स

Anchor link to

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

मान्य ऑपरेंड्स:

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

बूलियन टैग्स

Anchor link to

मान्य ऑपरेटर्स: EQ, NOTSET, ANY

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

लिस्ट टैग्स

Anchor link to

मान्य ऑपरेटर्स: IN, NOTIN, NOTSET, ANY

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

conditions_operator

Anchor link to

कंडीशंस ऐरे के लिए लॉजिकल ऑपरेटर। संभावित मान: AND | OR। AND डिफ़ॉल्ट है।

यदि लागू किया गया ऑपरेटर AND है (जब कोई ऑपरेटर निर्दिष्ट नहीं किया गया है, या ‘conditions_operator’ पैरामीटर का मान ‘AND’ है), तो सभी कंडीशंस का एक साथ पालन करने वाले डिवाइस पुश नोटिफिकेशन प्राप्त करेंगे।

यदि ऑपरेटर OR है, तो निर्दिष्ट कंडीशंस में से किसी का भी पालन करने वाले डिवाइस संदेश प्राप्त करेंगे।

data

Anchor link to

पुश पेलोड में किसी भी कस्टम डेटा को पास करने के लिए उपयोग किया जाने वाला JSON स्ट्रिंग या JSON ऑब्जेक्ट; पेलोड में “u” पैरामीटर के रूप में पास किया जाता है (JSON स्ट्रिंग में परिवर्तित)।

devices

Anchor link to

लक्षित पुश नोटिफिकेशन भेजने के लिए पुश टोकन या HWIDs का ऐरे। यदि सेट किया गया है, तो संदेश केवल सूची में मौजूद डिवाइस पर भेजा जाएगा।

dynamic_content

Anchor link to

डिवाइस टैग मानों के बजाय उपयोग किए जाने वाले डायनामिक कंटेंट के लिए प्लेसहोल्डर्स। नीचे दिया गया उदाहरण आपके द्वारा लक्षित प्रत्येक उपयोगकर्ता को “Hello, John!” संदेश भेजेगा। यदि सेट नहीं किया गया है, तो डायनामिक कंटेंट मान डिवाइस टैग से लिए जाते हैं।

"content": "Hello, {firstname|CapitalizeFirst}!",
"dynamic_content_placeholders": {
  "firstname": "John",
  "lastname": "Doe"
},

filter

Anchor link to

एक सेगमेंट का नाम ठीक वैसे ही जैसे यह Pushwoosh कंट्रोल पैनल में या /createFilter API अनुरोध के माध्यम से बनाया गया है। ऑडियंस → सेगमेंट्स सेक्शन पर जाएं और बनाए गए सेगमेंट्स की सूची देखें।

Pushwoosh कंट्रोल पैनल के ऑडियंस सेक्शन में सेगमेंट्स की सूची

API के माध्यम से सेगमेंट्स सूची प्राप्त करने के लिए, /listFilters API मेथड को कॉल करें। /listFilters अनुरोध के जवाब में, आपको अपने Pushwoosh अकाउंट में बनाए गए सभी सेगमेंट्स की सूची, सेगमेंट्स के नाम, कंडीशंस और समाप्ति तिथियों के साथ मिलेगी।

ignore_user_timezone

Anchor link to

यदि ‘true’ पर सेट किया गया है, तो संदेश को “send_date” पैरामीटर में UTC-0 के अनुसार निर्दिष्ट समय और तारीख पर भेजता है।

यदि ‘false’ पर सेट किया गया है, तो उपयोगकर्ता अपने डिवाइस की सेटिंग्स के अनुसार निर्दिष्ट स्थानीय समय पर संदेश प्राप्त करेंगे।

inbox_date

Anchor link to

वह तारीख जब तक संदेश को उपयोगकर्ताओं के इनबॉक्स में रखा जाना चाहिए। यदि निर्दिष्ट नहीं किया गया है, तो संदेश भेजने की तारीख के अगले दिन इनबॉक्स से हटा दिया जाएगा।

inbox_image

Anchor link to

इनबॉक्स में संदेश के पास दिखाए जाने वाले कस्टम इमेज का URL।

inbox_days

Anchor link to

एक इनबॉक्स संदेश का जीवनकाल दिनों में, 30 दिनों तक। इस अवधि के बाद, संदेश इनबॉक्स से हटा दिया जाएगा। inbox_date पैरामीटर के बजाय उपयोग किया जा सकता है।

Anchor link to

एक बार जब कोई उपयोगकर्ता पुश नोटिफिकेशन खोलता है तो खोला जाने वाला URL।

message_type

Anchor link to

पुश संदेश का प्रकार निर्दिष्ट करता है। उपलब्ध मान marketing और transactional हैं। विवरण के लिए मार्केटिंग बनाम ट्रांजैक्शनल संदेश देखें।

यह पैरामीटर वैकल्पिक है। यदि छोड़ दिया जाता है, तो PW_ControlGroup: true वाले उपयोगकर्ता संदेश प्राप्त नहीं करेंगे।

Anchor link to

“link” पैरामीटर में सबमिट किए गए URL को छोटा करने के लिए शॉर्टनर। कृपया ध्यान दें कि पुश नोटिफिकेशन पेलोड का आकार सीमित है, इसलिए सीमा से अधिक न होने के लिए छोटे URL बनाने पर विचार करें। उपलब्ध मान: 0 — छोटा न करें, 2 — bitly। डिफ़ॉल्ट = 2। Google URL शॉर्टनर 30 मार्च, 2019 से अक्षम है।

platforms

Anchor link to

संदेश को केवल विशिष्ट प्लेटफॉर्म पर भेजने के लिए प्लेटफॉर्म कोड का ऐरे।

उपलब्ध प्लेटफॉर्म कोड में शामिल हैं: 1 — iOS, 3 — Android, 7 — Mac OS X, 8 — Windows, 9 — Amazon, 10 — Safari, 11 — Chrome, 12 — Firefox, 14 — Email, 17 — Huawei, 18 — SMS, और 21 — WhatsApp।

preset

Anchor link to

Pushwoosh कंट्रोल पैनल में या API के माध्यम से बनाए गए प्रीसेट का कोड। प्रीसेट कोड प्राप्त करने के लिए, कंटेंट → प्रीसेट्स पर जाएं, जिस प्रीसेट का आप उपयोग करने जा रहे हैं उसे विस्तृत करें, और प्रीसेट के विवरण से प्रीसेट कोड कॉपी करें।

कंटेंट सेक्शन में प्रीसेट की सूची जो प्रीसेट कोड दिखा रही है

rich_media

Anchor link to

रिच मीडिया पेज का कोड जिसे आप अपने संदेश के साथ संलग्न करने जा रहे हैं। कोड प्राप्त करने के लिए, कंटेंट → रिच मीडिया पर जाएं, जिस रिच मीडिया पेज का आप उपयोग करने जा रहे हैं उसे खोलें, और अपने ब्राउज़र के URL बार से कोड कॉपी करें। कोड 10 वर्णों (अक्षर और अंक दोनों) का एक हाइफ़न-पृथक सेट है।

कंटेंट सेक्शन में रिच मीडिया पेज जिसमें ब्राउज़र URL बार में रिच मीडिया कोड है

send_rate

Anchor link to

पुश भेजने की गति को नियंत्रित करने के लिए थ्रॉटलिंग। मान्य मान 100 से 1000 पुश/सेकंड तक हैं।

timezone

Anchor link to

जब संदेश किसी विशेष तारीख और समय पर भेजा जाता है तो ध्यान में रखा जाने वाला टाइमज़ोन। यदि सेट किया गया है, तो डिवाइस का टाइमज़ोन अनदेखा कर दिया जाता है। यदि अनदेखा किया जाता है, तो संदेश UTC में भेजा जाता है। समर्थित टाइमज़ोन के लिए https://php.net/manual/timezones.php देखें।

template_bindings

Anchor link to

आपके कंटेंट टेम्प्लेट में उपयोग करने के लिए टेम्प्लेट प्लेसहोल्डर्स। विवरण के लिए लिक्विड टेम्प्लेट्स गाइड देखें।

transactionId

Anchor link to

नेटवर्क समस्याओं के मामले में संदेशों की नकल को रोकने के लिए यूनिक संदेश पहचानकर्ता। आप /createMessage या /createTargetedMessage अनुरोध के माध्यम से बनाए गए संदेश को कोई भी ID असाइन कर सकते हैं। Pushwoosh की ओर से 5 मिनट के लिए संग्रहीत किया जाता है।

users

Anchor link to

userIds का ऐरे। यूज़र आईडी एक यूनिक उपयोगकर्ता पहचानकर्ता है जो /registerUser, /registerDevice, या /registerEmail API अनुरोध द्वारा सेट किया जाता है।