मैसेजिंग API v2 का अवलोकन

मैसेजिंग API v2 एक सिंगल REST/JSON एंडपॉइंट है जो Pushwoosh द्वारा समर्थित हर चैनल पर आउटबाउंड संदेश बनाने के लिए है:

पुश: iOS, Android, Huawei, Baidu, macOS, Amazon, Windows, Safari, Chrome, Firefox, IE
ईमेल
SMS
Telegram, Kakao, LINE, WhatsApp

चैनल को पेलोड प्रकार (payload पुश / SMS / मैसेंजर के लिए, email_payload ईमेल के लिए) द्वारा चुना जाता है।

टारगेटिंग को अनुरोध के प्रकार (segment ऑडियंस सेगमेंट के लिए, transactional स्पष्ट डिवाइस या उपयोगकर्ता सूचियों के लिए) द्वारा चुना जाता है।

बेस URL

https://api.pushwoosh.com

यदि आप एक समर्पित क्षेत्र या निजी परिनियोजन का उपयोग करते हैं, तो अपने Pushwoosh कस्टमर सक्सेस मैनेजर से सटीक बेस URL की पुष्टि करें।

प्रमाणीकरण

प्रत्येक अनुरोध में सर्वर-साइड Pushwoosh API एक्सेस टोकन के साथ एक Authorization हेडर शामिल होना चाहिए:

Authorization: Token YOUR_API_TOKEN

उसी टोकन का उपयोग करें जिसे आप पहले से सर्वर-टू-सर्वर API कॉल के लिए जारी करते हैं। इस टोकन को क्लाइंट एप्लिकेशन में उजागर न करें।

मेथड्स

Notify: POST /messaging/v2/notify। एक एकल संदेश (सेगमेंट या ट्रांजैक्शनल) बनाएं और भेजें।

अनुरोध और प्रतिक्रिया प्रारूप

कंटेंट प्रकार: application/json।
फ़ील्ड नाम snake_case का उपयोग करते हैं। oneof समूह नेस्टेड ऑब्जेक्ट के रूप में दिखाई देते हैं जिनमें ठीक एक कुंजी सेट होती है।
एनम मान उनके स्ट्रिंग नामों के रूप में क्रमबद्ध होते हैं (उदाहरण के लिए, "IOS", "MESSAGE_TYPE_MARKETING")।
सफल प्रतिक्रियाएं JSON बॉडी के साथ HTTP 200 लौटाती हैं; त्रुटियां मानक gRPC-गेटवे त्रुटि लिफाफे का उपयोग करती हैं — { "code": ..., "message": ..., "details": [...] }।

क्विक स्टार्ट

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":     { "body": "Hello from v2!" },
              "android": { "body": "Hello from v2!" }
            }
          }
        }
      },
      "schedule": { "at": "2026-05-01T12:00:00Z" },
      "message_type": "MESSAGE_TYPE_MARKETING"
    }
  }'

SMTP पर ईमेल भेजना

यदि कोई सेवा पहले से ही SMTP का समर्थन करती है, तो आप सीधे Notify को कॉल करने के बजाय SMTP गेटवे के माध्यम से ट्रांजैक्शनल ईमेल सबमिट कर सकते हैं। गेटवे प्रत्येक संदेश को इस API को एक ट्रांजैक्शनल Notify के रूप में अग्रेषित करता है, इसलिए वही प्रमाणीकरण और ईमेल पेलोड नियम लागू होते हैं।

अगले चरण

Notify

पेलोड संदर्भ

ईमेल पेलोड संदर्भ

SMTP गेटवे

v1 से माइग्रेशन