सामग्री पर जाएं
उपयोगकर्ता गाइड कैसे करें गाइड सहायता डेमो अनुरोध करें साइन इन करें
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 — लागू किए जाने वाले टैग का नाम,
  • operator — एक मान तुलना ऑपरेटर (“EQ” | “IN” | “NOTEQ” | “NOTIN” | “LTE” | “GTE” | “BETWEEN” | “NOTSET” | “ANY”),
  • operand — निम्नलिखित में से किसी भी प्रकार के टैग मान: स्ट्रिंग | पूर्णांक | ऐरे | तारीख | बूलियन | सूची

ऑपरेटर विवरण

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 (पूर्णांक)
  • "N days ago" (स्ट्रिंग) ऑपरेटर्स EQ, BETWEEN, GTE, LTE के लिए

बूलियन टैग्स

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

यदि ‘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 हैं। विवरण के लिए मार्केटिंग बनाम ट्रांसेक्शनल संदेश देखें।

यह पैरामीटर वैकल्पिक है। यदि छोड़ा जाता है, तो संदेश को ट्रांसेक्शनल माना जाता है और कंट्रोल ग्रुप सहित सभी को दिया जाता है। मार्केटिंग संदेश कंट्रोल ग्रुप के सदस्यों को नहीं दिए जाते हैं।

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 मिनट के लिए संग्रहीत किया जाता है।

use_latest_user_device

Anchor link to

यदि true पर सेट है, तो प्रति डिवाइस एक के बजाय प्रति उपयोगकर्ता एक पुश डिलीवर करता है: platforms में प्लेटफ़ॉर्म के बीच सबसे हालिया लास्ट एप्लिकेशन ओपन वाले डिवाइस को ही यह प्राप्त होता है। यदि उन प्लेटफ़ॉर्म पर किसी उपयोगकर्ता के डिवाइस में वह डेटा नहीं है, तो पहला मिलान करने वाला डिवाइस इसे प्राप्त करता है, इसलिए भेजा गया संदेश कभी भी ड्रॉप नहीं होता है। बिना उपयोगकर्ता ID वाले डिवाइस अप्रभावित रहते हैं। यह इस बात पर ध्यान दिए बिना लागू होता है कि दर्शकों को कैसे लक्षित किया गया था — users, filter, या conditions द्वारा। Messaging API v2 में use_latest_user_device की तरह ही काम करता है। डिफ़ॉल्ट false है (हर डिवाइस पर भेजें)।

users

Anchor link to

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