Message Inbox API

Message Inbox API किसी उपयोगकर्ता के इनबॉक्स संदेशों को पढ़ता और अपडेट करता है। उपयोगकर्ता के संदेश प्राप्त करने के लिए /getInboxMessages और किसी संदेश की स्थिति बदलने के लिए /inboxStatus का उपयोग करें, उदाहरण के लिए जब आप अपना स्वयं का इनबॉक्स UI बनाते हैं। दोनों विधियाँ उपयोगकर्ता की पहचान यूज़र आईडी से करती हैं।

getInboxMessages

निर्दिष्ट HWID के लिए इनबॉक्स संदेशों की सूची लौटाता है।

POST https://api.pushwoosh.com/json/1.3/getInboxMessages

अनुरोध हेडर

नाम	आवश्यक	मान	विवरण
Authorization	हाँ	Token `XXXX`	Device API तक पहुंचने के लिए API Device Token। `XXXX` को अपने वास्तविक Device API टोकन से बदलें।

अनुरोध बॉडी

नाम	प्रकार	विवरण
application*	string	Pushwoosh एप्लिकेशन कोड
userId*	string	यदि कोई कस्टम User ID सेट नहीं है, तो HWID का उपयोग करें।
hwid	string	इनबॉक्स संदेश प्राप्त करने के लिए डिवाइस का हार्डवेयर आईडी।
last_code	string	पिछली प्रतिक्रिया में प्राप्त अंतिम संदेश का कोड। यदि खाली है, तो पहले संदेश लौटाए जाते हैं।
count	integer	एक ही प्रतिक्रिया में दिखाए जाने वाले संदेशों की संख्या; पेजिनेशन के लिए उपयोग किया जाता है। इनबॉक्स में सभी संदेशों को लोड करने के लिए 0।

200

{
  "response": {
    "messages": [{                      // वर्तमान में उपयोगकर्ता के इनबॉक्स में संग्रहीत संदेशों की सरणी
      "inbox_id": "avde1c792cd",
      "rt": "146078676",                // इनबॉक्स से संदेश को हटाने की तारीख
      "send_date": "1459758676",        // तारीख जब संदेश इनबॉक्स में सहेजा गया था
      "order": "59138176",              // इनबॉक्स प्रस्तुति क्रम में स्थिति
      "title": "New Rich Media in inbox!",
      "text": "Hi! New feature is available right now!",
      "action_type": "RichMedia",
      "action_params": {                // पुश खोलने पर क्रियाओं का वर्णन करने वाला पेलोड
        "rm": "{\"url\":\"https:\/\/richmedia.pushwoosh.com\/C82F7-51FC1.zip\",\"ts\":\"1459758676\",\"tags\":{\"tagName\":\"tagValue\"}}"
      },
      "status": 1,                      // 1 - वितरित, 2 - पढ़ा गया, 3 - खोला गया,
                                        // 4 - हटाया गया (उपयोगकर्ता द्वारा), 5 - कंट्रोल पैनल से हटाया गया
      "hash":"1C"                       // पुश नोटिफिकेशन का हैश कोड
    }, {
      ...
    }],
    "next":"afarew511",                 // अगला इनबॉक्स कोड जो
                                        // निम्नलिखित /getInboxMessages अनुरोध द्वारा लौटाया जाएगा
    "deleted": ["bbaf85ab", "a41957b"], // कंट्रोल पैनल से हटाए गए संदेशों की सूची
    "new_inbox": 6                      // उस उपयोगकर्ता के लिए वितरित इनबॉक्स संदेशों की संख्या (बैज के लिए उपयोग किया जा सकता है)
  }
}

{
  "request": {
    "application": "XXXXX-XXXXX", // आवश्यक। Pushwoosh ऐप कोड
     "userId": "user_name_1",     // आवश्यक। Pushwoosh में पंजीकृत User ID
     "device_type": 1             // वैकल्पिक। डिवाइस प्रकारों के लिए /registerDevice देखें
  }
}

inboxStatus

किसी विशेष इनबॉक्स संदेश की स्थिति को अपडेट करता है।

POST https://api.pushwoosh.com/json/1.3/inboxStatus

अनुरोध हेडर

नाम	आवश्यक	मान	विवरण
Authorization	हाँ	Token `XXXX`	Device API तक पहुंचने के लिए API Device Token। `XXXX` को अपने वास्तविक Device API टोकन से बदलें।

अनुरोध बॉडी

नाम	प्रकार	विवरण
application*	string	Pushwoosh एप्लिकेशन कोड
inbox_code*	string	कंट्रोल पैनल में संदेश विवरण से या `/getInboxMessages` अनुरोध के “order” पैरामीटर से प्राप्त किया जा सकता है
hash	string	इनबॉक्स संदेश का हैश कोड।
hwid	string	इनबॉक्स स्थिति को अपडेट करने के लिए डिवाइस का हार्डवेयर आईडी।
time	string	भेजने की तारीख का टाइमस्टैम्प।
userID*	string	यदि कोई कस्टम User ID सेट नहीं है, तो HWID का उपयोग करें।
status*	integer	1 - वितरित, 2 - पढ़ा गया, 3 - खोला गया, 4 - उपयोगकर्ता द्वारा हटाया गया।
device_type	integer	संभावित मान देखें।

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}

{
  "request": {
    "application": "XXXXX-XXXXX",    // आवश्यक। Pushwoosh एप्लिकेशन कोड
    "inbox_code": "874393934032909", // आवश्यक। /getInboxMessages अनुरोध का "order" पैरामीटर
    "hash": "1C",                    // वैकल्पिक।
    "userId": "some_user",           // आवश्यक।
    "status": 2,                     // आवश्यक। सेट करने के लिए स्थिति: 1-वितरित, 2-पढ़ा गया, 3-खोला गया, 4-हटाया गया (उपयोगकर्ता द्वारा)
    "device_type": 3                 // वैकल्पिक।
  }
}