User centric API

registerUser

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

बाहरी User ID को एक निर्दिष्ट डिवाइस के साथ जोड़ता (Associate) है।

Request headers

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

Request body

नाम	प्रकार	विवरण
userId	string	डिवाइस के साथ जोड़ने के लिए User ID। यदि खाली है, तो hwid का उपयोग करें।
application*	string	Pushwoosh एप्लिकेशन कोड
hwid*	string	Pushwoosh HWID
tz_offset	integer	डिवाइस के लिए सेकंड में टाइमज़ोन ऑफसेट।
device_type	integer	Device type। `/registerDevice` में संभावित मान देखें।

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

इसे बाद में /createMessage API कॉल (users पैरामीटर) में उपयोग किया जा सकता है।
पुश टोकन प्राप्त करने और /registerDevice कॉल करने से पहले इस फ़ंक्शन को कॉल करना सामान्य है।

{
  "request": {
    "userId": "user_3078a",                     // वैकल्पिक। यदि खाली है, तो hwid का उपयोग करें
    "application": "XXXXX-XXXXX",               // आवश्यक। Pushwoosh एप्लिकेशन कोड
    "hwid": "8f65b16df378e7a6bece9614e1530fb2", // आवश्यक। हार्डवेयर डिवाइस ID
    "tz_offset": -3600,                         // वैकल्पिक। सेकंड में टाइमज़ोन ऑफसेट
    "device_type": 3                            // वैकल्पिक। डिवाइस प्रकार, डिवाइस प्रकारों के लिए
                                                //           /registerDevice देखें
  }
}

postEvent

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

इवेंट को कॉल करता है।

Request headers

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

Request body

नाम	प्रकार	विवरण
hwid*	string	/registerDevice अनुरोध में उपयोग किया गया Hardware device ID। इसका उपयोग ‘userId’ के साथ उस यूज़र की पहचान करने के लिए किया जा सकता है जिसने इवेंट ट्रिगर किया है।
application*	string	Pushwoosh एप्लिकेशन कोड
event*	string	Event name ठीक वैसे ही जैसे Pushwoosh Control Panel में बनाया गया है।
attributes*	object	इवेंट एट्रिब्यूट्स के साथ JSON ऑब्जेक्ट। यदि कोई एट्रिब्यूट पास करने की आवश्यकता नहीं है तो इसे खाली छोड़ दें।
timestampUTC	integer	UTC में टाइमस्टैम्प।
timestampCurrent	integer	स्थानीय समय में टाइमस्टैम्प।
userId*	string	उस यूज़र से जुड़ा User ID जिसने इवेंट ट्रिगर किया है। इसे HWID द्वारा बदला जा सकता है या इसके साथ उपयोग किया जा सकता है।
device_type	integer	संभावित मान देखें

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "code": "61BC9-84DD0"
  }
}

अनुरोध में इवेंट का नाम Pushwoosh Control Panel में इवेंट के नाम से मेल खाना चाहिए। ध्यान दें कि यदि इवेंट में कोई एट्रिब्यूट नहीं है, तो “attributes” प्रॉपर्टी खाली हो सकती है (लेकिन छोड़ी नहीं जा सकती)।

{
  "request":{
    "hwid": "8f65b16df378e7a6bece9614e1530fb2", // आवश्यक। /registerDevice API में उपयोग किया गया हार्डवेयर डिवाइस ID।
                                                //           इवेंट ट्रिगर करने वाले यूज़र की पहचान करने के लिए
                                                //           userId के साथ उपयोग किया जा सकता है।
    "application": "XXXXX-XXXXX",               // आवश्यक। Pushwoosh एप्लिकेशन कोड
    "event": "activityCompleted",               // आवश्यक। इवेंट का नाम ठीक वैसे ही जैसे Pushwoosh Control Panel में बनाया गया है
    "attributes": {                             // आवश्यक। यदि कोई एट्रिब्यूट पास करने की आवश्यकता नहीं है तो खाली छोड़ दें।
      "login": "facebook",
      "success": "yes",
      "internet": "wifi",
    },
    "timestampUTC": 1435228403,                 // वैकल्पिक। UTC में टाइमस्टैम्प
    "timestampCurrent": 1435253603,             // वैकल्पिक। स्थानीय समय में टाइमस्टैम्प
    "userId": "someuser@user.com",              // आवश्यक। एक यूज़र आईडी जिसका उपयोग कई डिवाइस पर यूज़र्स की
                                                //           पहचान के लिए किया जाता है। इसे HWID द्वारा बदला जा
                                                //           सकता है या इसके साथ उपयोग किया जा सकता है।
    "device_type": 1                            // वैकल्पिक।
  }
}