पेलोड संदर्भ

Notify द्वारा किसी भी गैर-ईमेल चैनल (पुश, SMS, Telegram, Kakao, LINE, WhatsApp) के माध्यम से भेजने पर उपयोग किए जाने वाले Payload संदेश के लिए संदर्भ।

नोट

ईमेल के लिए, ईमेल पेलोड संदर्भ देखें।

पेलोड

• preset (स्ट्रिंग): इस संदेश पर लागू करने के लिए प्रीसेट कोड।
• content (LocalizedContent): संदेश की सामग्री। silent के साथ परस्पर अनन्य।
• silent (बूल): एक साइलेंट (केवल-डेटा) पुश भेजें। content के साथ परस्पर अनन्य।
• custom_data (ऑब्जेक्ट): क्लाइंट SDK को u पैरामीटर के रूप में फॉरवर्ड किया गया फ्री-फॉर्म JSON।
• open_action (OpenAction): जब उपयोगकर्ता अधिसूचना खोलता है तो ट्रिगर की जाने वाली कार्रवाई।
• open_actions (map<Platform, OpenAction>): open_action का प्रति-प्लेटफ़ॉर्म ओवरराइड। कुंजी एक संख्यात्मक Platform एनम मान है।
• voip_push (बूल): iOS VoIP अधिसूचना।

LocalizedContent

लोकेल कोड को प्रति-प्लेटफ़ॉर्म सामग्री पर मैप करता है। कुंजियाँ ISO 639-1 दो-अक्षर वाले कोड हैं (उदाहरण के लिए, "en", "es") और एक कैच-ऑल अनुवाद के लिए विशेष कुंजी "default" है। ISO 639-1 के अपवाद पारंपरिक और सरलीकृत चीनी के लिए "zh-Hant" और "zh-Hans" हैं।

{
  "localized_content": {
    "default": {
      "ios":     { "title": "Hello", "body": "Tap to view" },
      "android": { "title": "Hello", "body": "Tap to view" }
    },
    "es": {
      "ios":     { "title": "Hola",  "body": "Toca para ver" },
      "android": { "title": "Hola",  "body": "Toca para ver" }
    }
  }
}

किसी डिवाइस के लिए लोकेल चयन

किसी डिवाइस पर दी गई सामग्री इस क्रम में चुनी जाती है:

1. डिवाइस की भाषा पर सटीक मिलान।
2. कुंजी "default"।
3. कुंजी "en"।
4. मैप में मौजूद कोई अन्य लोकेल।

कम से कम "default" या "en" में से एक प्रदान करें ताकि हर डिवाइस के पास एक नियतात्मक फ़ॉलबैक हो। यदि आप प्रति-लोकेल वेरिएंट की उम्मीद नहीं करते हैं, तो केवल "default" भेजें।

प्रत्येक लोकेल प्रविष्टि वैकल्पिक प्रति-प्लेटफ़ॉर्म ब्लॉक के साथ एक Content ऑब्जेक्ट है। केवल उन प्लेटफ़ॉर्म को भरें जिन्हें आप लक्षित करते हैं।

प्लेटफ़ॉर्म ब्लॉक	चैनल
ios	iOS पुश
android	Android (FCM) पुश
huawei_android	Huawei Android पुश
baidu_android	Baidu Android पुश
mac_os	macOS पुश
amazon	Amazon (ADM) पुश
safari	Safari वेब पुश
chrome	Chrome वेब पुश
firefox	Firefox वेब पुश
ie	Internet Explorer वेब पुश
windows	Windows पुश (टाइल / टोस्ट / बैज)
telegram	Telegram संदेश
kakao	Kakao संदेश
line	LINE संदेश
whatsapp	WhatsApp संदेश

सामान्य पुश फ़ील्ड

ये फ़ील्ड ios, android, huawei_android, baidu_android, mac_os, amazon, safari, chrome, और firefox ब्लॉक द्वारा साझा किए जाते हैं (समर्थन भिन्न होता है। अप्रयुक्त फ़ील्ड संबंधित प्लेटफ़ॉर्म द्वारा अनदेखा कर दिए जाते हैं)।

• title (स्ट्रिंग): अधिसूचना शीर्षक।
• body (स्ट्रिंग): अधिसूचना बॉडी।
• time_to_live (अवधि, जैसे "3600s"): पुश सर्वर को ऑफ़लाइन डिवाइस के लिए अधिसूचना को कितने समय तक बनाए रखना चाहिए।
• sound (स्ट्रिंग): ध्वनि फ़ाइल का नाम।
• sound_enabled (बूल): ध्वनि सक्षम या दबाएं।
• badges (स्ट्रिंग): बैज गणना (iOS) या एनालॉग।
• root_params (ऑब्जेक्ट): रॉ प्लेटफ़ॉर्म-विशिष्ट पेलोड ओवरराइड।
• inbox (Inbox): संदेश इनबॉक्स प्रविष्टि।

iOS (ios)

• subtitle (स्ट्रिंग): iOS अधिसूचना उपशीर्षक।
• is_critical (बूल): महत्वपूर्ण अलर्ट (एनटाइटलमेंट की आवश्यकता है)।
• attachment (स्ट्रिंग): मीडिया अटैचमेंट का URL।
• thread_id (स्ट्रिंग): समूहीकृत सूचनाओं के लिए थ्रेड पहचानकर्ता।
• trim_content (बूल): फिट करने के लिए सामग्री को ट्रिम करें।
• category_id (स्ट्रिंग): इंटरैक्टिव क्रियाओं के लिए UNNotificationCategory पहचानकर्ता।
• interruption_level (स्ट्रिंग): passive, active, time-sensitive, या critical।
• collapse_id (स्ट्रिंग): APNs कोलैप्स पहचानकर्ता। समान collapse_id वाली सूचनाएं डिवाइस पर एक-दूसरे को प्रतिस्थापित करती हैं।

Android (android, huawei_android, baidu_android)

• icon (स्ट्रिंग): अधिसूचना छोटा आइकन।
• banner (स्ट्रिंग): बिग-पिक्चर URL।
• delivery_priority (NORMAL | HIGH): FCM डिलीवरी प्राथमिकता।
• vibration (बूल): प्राप्त होने पर कंपन।
• led_color (स्ट्रिंग, हेक्स): अधिसूचना LED रंग।
• icon_background_color (स्ट्रिंग, हेक्स): आइकन पृष्ठभूमि रंग।
• show_on_lockscreen (बूल): लॉक स्क्रीन पर दिखाएं।
• custom_icon (स्ट्रिंग): कस्टम आइकन का URL।
• priority (NotificationPriority): इन-ट्रे प्राथमिकता।
• group_id (स्ट्रिंग): अधिसूचना समूह कुंजी।
• collapse_key (स्ट्रिंग): FCM कोलैप्स कुंजी। समान collapse_key वाली सूचनाएं डिवाइस ऑफ़लाइन होने पर एक-दूसरे को प्रतिस्थापित करती हैं।

macOS (mac_os)

सामान्य पुश फ़ील्ड और subtitle और action (जब उपयोगकर्ता अधिसूचना पर क्लिक करता है तो URL खोला जाता है) का उपयोग करता है।

Amazon (amazon)

सामान्य पुश फ़ील्ड और custom_icon और priority (NotificationPriority) का उपयोग करता है।

Safari (safari)

• action (स्ट्रिंग): जब उपयोगकर्ता अधिसूचना पर क्लिक करता है तो URL खोला जाता है।
• url_arguments (स्ट्रिंग की सरणी): Safari URL तर्क जो वेब पुश URL टेम्पलेट में प्रतिस्थापित किए जाते हैं।

Chrome (chrome)

• icon, image (स्ट्रिंग): छोटे आइकन और बड़े छवि URL।
• duration (अवधि): ऑटो-क्लोज टाइमर।
• button_text1 / button_url1, button_text2 / button_url2: दो एक्शन बटन तक।

Firefox (firefox)

केवल title, body, icon, root_params, और inbox का उपयोग करता है।

Windows (windows)

Windows एक अलग आकार का उपयोग करता है:

{
  "windows": {
    "type": "TOAST",
    "template": { "title": "Hello", "body": "Tap to view" },
    "tag": "promo",
    "cache": true,
    "time_to_live": "3600s"
  }
}

• type TILE, TOAST, या BADGE है।
• template (संरचित) या raw ({ "content": "<raw xml>" }) — ठीक एक।

Telegram (telegram)

• body (स्ट्रिंग): संदेश का पाठ।
• content_variables (स्ट्रिंग): बॉट-साइड टेम्पलेट के लिए JSON-स्ट्रिंगिफाइड चर।

Kakao (kakao)

• content (स्ट्रिंग): संदेश की सामग्री।
• template (स्ट्रिंग): स्वीकृत टेम्पलेट कोड।
• content_variables (स्ट्रिंग): JSON-स्ट्रिंगिफाइड टेम्पलेट चर बाइंडिंग।

LINE (line)

• content (स्ट्रिंग): सादा पाठ बॉडी।
• template (स्ट्रिंग): Pushwoosh कंट्रोल पैनल में कॉन्फ़िगर किए गए LINE टेम्पलेट का कोड (छवि, हिंडोला, या फ्लेक्स संदेश भेजने के लिए उपयोग किया जाता है)। समृद्ध सामग्री के लिए, कंट्रोल पैनल में टेम्पलेट को पहले से कॉन्फ़िगर करें और इसे यहाँ संदर्भित करें।

content या template में से कम से कम एक सेट होना चाहिए।

WhatsApp (whatsapp)

WhatsApp संदेश Meta के माध्यम से जाते हैं और Meta के संदेश नियमों के अधीन हैं। मुख्य विभाजन फ्री-फॉर्म टेक्स्ट (केवल उपयोगकर्ता से आने वाले संदेश द्वारा खोले गए 24-घंटे के ग्राहक सेवा विंडो के अंदर दिया जाता है) और स्वीकृत टेम्पलेट्स (आउटबाउंड दीक्षा के लिए और 24-घंटे की खिड़की के बाहर किसी भी संदेश के लिए आवश्यक) के बीच है।

• content (स्ट्रिंग): फ्री-फॉर्म संदेश पाठ। Meta द्वारा केवल 24-घंटे की खिड़की के अंदर दिया जाता है।
• content_id (स्ट्रिंग): पूर्व-अनुमोदित Meta टेम्पलेट का नाम (जैसे "hello_world")। आउटबाउंड दीक्षा या 24-घंटे की खिड़की के बाहर किसी भी संदेश के लिए आवश्यक है।
• language (स्ट्रिंग): टेम्पलेट लोकेल जो Meta में स्वीकृत लोकेल से बिल्कुल मेल खाना चाहिए (जैसे "en_US", "en_GB")। केवल content_id के साथ ही सार्थक है। यह बाहरी LocalizedContent कुंजी से स्वतंत्र है। बाहरी कुंजी एक डिवाइस के लिए सामग्री का चयन करती है, और language उस सामग्री के लिए Meta-टेम्पलेट लोकेल का चयन करती है।
• content_variables (स्ट्रिंग): JSON ऑब्जेक्ट जो बॉडी प्लेसहोल्डर्स को मैप करता है, जैसे "{\"1\":\"John\"}"।
• button_url_variables (स्ट्रिंग): JSON ऑब्जेक्ट जो बटन-URL प्लेसहोल्डर्स को बटन इंडेक्स द्वारा कुंजीबद्ध करता है, जैसे "{\"0\":\"https://...\"}"।
• header_variables (स्ट्रिंग): JSON ऑब्जेक्ट जो हेडर प्लेसहोल्डर्स को प्रकार द्वारा कुंजीबद्ध करता है, जैसे "{\"image\":\"https://...\"}"।

content या content_id में से कम से कम एक सेट होना चाहिए।

SMS

SMS सामान्य संदेश प्रवाह का उपयोग करता है। sms प्लेटफ़ॉर्म ब्लॉक आरक्षित है। किसी भी भरे हुए प्लेटफ़ॉर्म ब्लॉक पर सामान्य body फ़ील्ड के माध्यम से पाठ प्रदान करें। प्रेषक आईडी और अन्य प्रदाता विकल्प ऐप के SMS कॉन्फ़िगरेशन से आते हैं। SMS कॉन्फ़िगरेशन देखें।

OpenAction

जब उपयोगकर्ता संदेश खोलता है तो की जाने वाली कार्रवाई को परिभाषित करता है।

इनमें से ठीक एक:

• rich_media (RichMedia): एक रिच मीडिया पेज खोलें।
• deep_link: एक डीप लिंक खोलें: { "code": "flow-code", "params": { "key": "value" } }।
• link (Link): एक URL खोलें।

RichMedia

{ "code": "XXXXX-XXXXX" }        // रिच मीडिया कोड द्वारा
{ "url":  "https://..." }        // रिमोट URL द्वारा

Link

{
  "url": "https://example.com/promo",
  "shortener": "BITLY"
}

shortener NONE (डिफ़ॉल्ट) या BITLY है।

इनबॉक्स

संदेश इनबॉक्स में संदेश कैसे दिखाई देता है, इसे कॉन्फ़िगर करता है।

{
  "image_url": "https://cdn.example.com/inbox.png",
  "expiration_date": "2026-05-15T00:00:00Z"
}

• image_url (स्ट्रिंग): इनबॉक्स प्रविष्टि में दिखाई गई छवि।
• expiration_date (टाइमस्टैम्प): जब प्रविष्टि इनबॉक्स से हटा दी जाती है।

NotificationPriority एनम

लक्ष्य डिवाइस पर अधिसूचना प्राथमिकता को नियंत्रित करता है, PRIORITY_MIN (सबसे कम) से PRIORITY_MAX (उच्चतम) तक।

• PRIORITY_UNSPECIFIED
• PRIORITY_MIN
• PRIORITY_LOW
• PRIORITY_DEFAULT
• PRIORITY_HIGH
• PRIORITY_MAX

उदाहरण: एक सेगमेंट को पुश भेजें

curl -X POST https://api.pushwoosh.com/messaging/v2/notify \
  -H "Authorization: Token YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "segment": {
      "application": "XXXXX-XXXXX",
      "platforms": ["IOS", "ANDROID"],
      "code": "active_users",
      "payload": {
        "content": {
          "localized_content": {
            "en": {
              "ios":     { "title": "Hello",   "body": "Hello, world!" },
              "android": { "title": "Hello",   "body": "Hello, world!" }
            },
            "es": {
              "ios":     { "title": "¡Hola!",  "body": "¡Hola, mundo!" },
              "android": { "title": "¡Hola!",  "body": "¡Hola, mundo!" }
            }
          }
        },
        "open_action": { "link": { "url": "https://example.com/promo" } }
      },
      "schedule":     { "at": "2026-05-01T12:00:00Z" },
      "message_type": "MESSAGE_TYPE_MARKETING"
    }
  }'

उदाहरण: उपयोगकर्ता आईडी द्वारा ट्रांसेक्शनल पुश

curl -X POST https://api.pushwoosh.com/messaging/v2/notify \
  -H "Authorization: Token YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "transactional": {
      "application": "XXXXX-XXXXX",
      "platforms": ["IOS", "ANDROID"],
      "users": { "list": ["customer-42"] },
      "payload": {
        "content": {
          "localized_content": {
            "default": {
              "ios":     { "title": "Your order", "body": "Order #42 has shipped." },
              "android": { "title": "Your order", "body": "Order #42 has shipped." }
            }
          }
        },
        "custom_data": { "order_id": "42" }
      },
      "schedule":     { "at": "2026-05-01T12:00:00Z" },
      "message_type": "MESSAGE_TYPE_TRANSACTIONAL"
    }
  }'