उपयोगकर्ता-केंद्रित एपीआई

registerUser

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

बाहरी यूज़र आईडी को एक निर्दिष्ट डिवाइस के साथ जोड़ता है।

अनुरोध हेडर

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

अनुरोध बॉडी

नाम	आवश्यक	प्रकार	विवरण
userId	नहीं	string	डिवाइस के साथ जोड़ने के लिए यूज़र आईडी। यदि खाली है, तो hwid का उपयोग करें।
application	हाँ	string	पुशवूश एप्लिकेशन कोड
hwid	हाँ	string	पुशवूश एचडब्ल्यूआईडी
tz_offset	नहीं	integer	डिवाइस के लिए सेकंड में टाइमज़ोन ऑफ़सेट।
device_type	नहीं	integer	डिवाइस प्रकार। /registerDevice में संभावित मान देखें।

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

अनुरोध का उदाहरण

{
  "request": {
    "userId": "user_3078a",                     // optional. If empty, use hwid
    "application": "XXXXX-XXXXX",               // required. Pushwoosh application code
    "hwid": "8f65b16df378e7a6bece9614e1530fb2", // required. Hardware device ID
    "tz_offset": -3600,                         // optional. Timezone offset in seconds
    "device_type": 3                            // optional. Device type, see /registerDevice
                                                //           for device types
  }
}

प्रतिक्रिया का उदाहरण

200

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

नोट

ईमेल के लिए, /registerEmailUser पर कॉल करें।

deleteUser

POST https://api.pushwoosh.com/api/v2/device-api/deleteUser

एप्लिकेशन के भीतर निर्दिष्ट यूज़र आईडी से जुड़े एक उपयोगकर्ता और सभी उपकरणों को हटा देता है। अनुरोध को एसिंक्रोनस रूप से संसाधित किया जाता है, और जैसे ही हटाने का अनुरोध प्रसंस्करण के लिए स्वीकार कर लिया जाता है, एंडपॉइंट 200 OK लौटाता है।

अनुरोध हेडर

नाम	आवश्यक	मान	विवरण
Authorization	हाँ	Token XXXX	डिवाइस एपीआई तक पहुंचने के लिए एपीआई डिवाइस टोकन। XXXX को अपने वास्तविक डिवाइस एपीआई टोकन से बदलें।
Content-Type	हाँ	application/json

अनुरोध बॉडी

नाम	आवश्यक	प्रकार	विवरण
application	हाँ	string	पुशवूश एप्लिकेशन कोड
user_id	हाँ	string	हटाने के लिए यूज़र आईडी। निर्दिष्ट एप्लिकेशन में इस उपयोगकर्ता से जुड़े सभी डिवाइस हटा दिए जाएंगे।

अनुरोध का उदाहरण

{
  "application": "XXXXX-XXXXX",   // required. Pushwoosh application code
  "user_id": "user_3078a"         // required. User ID to delete
}

प्रतिक्रिया का उदाहरण

200

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

स्टेटस कोड

HTTP स्टेटस कोड	status_code	विवरण
200	200	हटाने का अनुरोध स्वीकार किया गया
200	210	आर्गुमेंट त्रुटि। अधिक जानकारी के लिए status_message देखें।
400	N/A	अनुरोध स्ट्रिंग विकृत है
401	N/A	Authorization टोकन गुम या अमान्य है
500	500	आंतरिक त्रुटि

postEvent

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

एक ईवेंट को ट्रिगर करता है।

अनुरोध हेडर

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

अनुरोध बॉडी

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

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

अनुरोध का उदाहरण

{
  "request":{
    "hwid": "8f65b16df378e7a6bece9614e1530fb2", // required. Hardware device ID used in a /registerDevice API.
                                                //           Can be used along with an userId to identify a
                                                //           user who has triggered an event.
    "application": "XXXXX-XXXXX",               // required. Pushwoosh application code
    "event": "activityCompleted",               // required. Event name exactly as created in Pushwoosh Control Panel
    "attributes": {                             // required. Leave empty if no attributes need to be passed.
      "login": "facebook",
      "success": "yes",
      "internet": "wifi"
    },
    "timestampUTC": 1435228403,                 // optional. Timestamp in UTC
    "timestampCurrent": 1435253603,             // optional. Timestamp in local time
    "userId": "someuser@user.com",              // required. A user id which is used for identification of
                                                //           users on multiple devices. Can be replaced by
                                                //           or used along with an HWID.
    "device_type": 1                            // optional.
  }
}

प्रतिक्रिया का उदाहरण

200

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