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

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

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

• वैकल्पिक पैरामीटर्स आपको पुश नोटिफिकेशन प्रॉपर्टीज को कस्टमाइज़ करने की अनुमति देते हैं।

नोट

यदि आप SMS भेजने के लिए /createMessage का उपयोग कर रहे हैं, तो कृपया SMS भेजने के लिए पैरामीटर्स देखें। अन्य पैरामीटर्स पास नहीं किए जाएंगे।

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

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

application

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

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

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

auth

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

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

content

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

स्ट्रिंग

"content": "Hello world!",

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

ऑब्जेक्ट

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

notifications

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

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

• campaign
• capping_days
• capping_count
• conditions
• data
• devices
• dynamic_content
• filter
• ignore_user_timezone
• inbox_date
• inbox_image
• link
• minimize_link
• platforms
• preset
• rich_media
• send_rate
• timezone
• template_bindings
• transactionId
• users

send_date

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

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

campaign

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

उदाहरण:

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

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

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

capping_days

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

capping_count

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

conditions

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

• tagName — लागू किए जाने वाले टैग का नाम,
• operator — एक मान तुलना ऑपरेटर (“EQ” | “IN” | “NOTEQ” | “NOTIN” | “LTE” | “GTE” | “BETWEEN” | “NOTSET” | “ANY”),
• operand — निम्नलिखित में से किसी भी प्रकार के टैग मान: string | integer | array | date | boolean | list

ऑपरेटर विवरण

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

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

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

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

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

इंटीजर टैग्स

मान्य ऑपरेटर्स: 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	टैग का कोई भी मान है। ऑपरेंड पर विचार नहीं किया जाता है

डेट टैग्स

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

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

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

बूलियन टैग्स

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

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

लिस्ट टैग्स

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

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

महत्वपूर्ण

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

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

भाषा टैग मान ISO-639-1 के अनुसार एक लोअरकेस दो-अक्षरी कोड है। देश टैग मान ISO_3166-2 के अनुसार एक अपरकेस दो-अक्षरी कोड है।

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

conditions_operator

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

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

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

data

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

devices

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

dynamic_content

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

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

filter

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

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

ignore_user_timezone

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

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

inbox_date

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

नोट

मैसेज को इनबॉक्स में सेव करने के लिए, ‘inbox’ पैरामीटर्स में से कम से कम एक का उपयोग करें: “inbox_date” या “inbox_image”।

सावधानी

मैसेज निर्दिष्ट तारीख के 00:00:01 पर इनबॉक्स से हटा दिया जाएगा, इसलिए पिछली तारीख आखिरी दिन है जब कोई यूज़र अपने इनबॉक्स में मैसेज देख सकता है।

inbox_image

कस्टम इमेज का URL जिसे इनबॉक्स में मैसेज के पास दिखाया जाना है।

नोट

मैसेज को इनबॉक्स में सेव करने के लिए, ‘inbox’ पैरामीटर्स में से कम से कम एक का उपयोग करें: “inbox_date” या “inbox_image”।

inbox_days

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

link

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

minimize_link

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

platforms

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

उपलब्ध प्लेटफॉर्म कोड में शामिल हैं: 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

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

rich_media

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

send_rate

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

timezone

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

template_bindings

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

transactionId

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

users

userIds का ऐरे। User ID एक यूनिक यूज़र आइडेंटिफ़ायर है जो /registerUser, /registerDevice, या /registerEmail API रिक्वेस्ट द्वारा सेट किया जाता है।