डिवाइस API
registerDevice
Anchor link toPOST https://api.pushwoosh.com/json/1.3/registerDevice
SDK से आंतरिक रूप से कॉल किया जाता है। एप्लिकेशन के लिए डिवाइस पंजीकृत करता है।
अनुरोध हेडर
Anchor link to| नाम | आवश्यक | मान | विवरण |
|---|---|---|---|
| Authorization | हाँ | Token XXXX | डिवाइस API तक पहुंचने के लिए API डिवाइस टोकन। XXXX को अपने वास्तविक डिवाइस API टोकन से बदलें। |
अनुरोध बॉडी
Anchor link to| नाम | प्रकार | विवरण |
|---|---|---|
| application* | string | Pushwoosh एप्लिकेशन कोड |
| push_token | string | डिवाइस के लिए पुश टोकन। |
| language | string | डिवाइस की भाषा लोकेल। ISO-639-1 मानक के अनुसार एक लोअरकेस दो-अक्षर का कोड होना चाहिए। |
| hwid* | string | डिवाइस की पहचान करने के लिए अद्वितीय स्ट्रिंग (iOS पर IDFV, Android पर यादृच्छिक रूप से उत्पन्न मान)। और जानें |
| timezone | integer | डिवाइस के लिए सेकंड में टाइमज़ोन ऑफ़सेट। |
| device_type* | integer | डिवाइस प्रकार। नीचे संभावित मान देखें। |
| string | पंजीकृत करने के लिए ईमेल पता (HWID और पुश टोकन के बजाय ईमेल उपयोगकर्ताओं के लिए उपयोग करें)। | |
| tags | object | पंजीकृत डिवाइस को असाइन करने के लिए टैग मान। |
{ "status_code": 200, "status_message": "OK", "response": null}{ "request": { "application": "XXXXX-XXXXX", // required. Pushwoosh application code "push_token": "dec301908b9ba8XXXXX57a58e40f96f5XXXXX2068674f5XXXXa25cdc250a2a41", // optional. "hwid": "1CA6XXXXX-8DAC-XXXXX-XXXXX-B756288B6D3C", // required. Hardware device ID "idfa": "AEBE52E7-0XXXXX-455A-XXXXX-E57283966239", // optional. "timezone": 3600, // optional. Offset in seconds "device_type": 1, // required. See the possible values below. For emails, // use the "emails" params as described below. "email": "email_address@domain.com", // use instead of "hwid" and "push_token" to register // the email address for your email project "language": "en", // optional. ISO 639-1|639-2 language code "userId": "Alex", // optional. "tags": { // optional. Tag values to set for the device registered "StringTag": "string value", "IntegerTag": 42, "ListTag": ["string1", "string2"], // sets the list of values for Tags of List type "DateTag": "2024-10-02 22:11", // note the time should be in UTC "BooleanTag": true // valid values are: true, false },
// system tags, optionals "app_version": "1.2.3", "device_model": "Samsung SM-G355H", "os_version": "2.3",
// optional encryption keys for chrome/firefox "public_key": "BNmDO4BTKEMJqaqprTf7t/HBXXXXX/orcXXXXX/scS5CFP6XXXXXHI1/GgRQD8c4kTxTEEF0quvIUiLQqoBY0/Qo=", "auth_token": "RlRmCXXXXX/s7XXXXXjKFzoQ==",
// optional FCM keys for Chrome (for XMPP) "fcm_token": "BNmDO4BTKEMJXXXXXprTf7t/XXXXXBQ/orXXXXXc/scS5CFP6zhQGIHI1/GgRQD8c4kTxTEEF0quvIUiLQqoBY0/Qo=", "fcm_push_set": "RlXXXXXGM/s7XXXXXjKFzoQ==" }}संभावित डिवाइस प्रकार:
- 1 – iOS
- 3 – Android
- 7 – Mac OS X
- 8 – Windows
- 9 – Amazon
- 10 – Safari
- 11 – Chrome
- 12 – Firefox
- 13 – Internet Explorer
- 14 – Email
- 17 – Huawei
- 18 – SMS
- 20 – Web
- 21 – WhatsApp
- 22 – Line
- 23 – Kakao Talk
- 24 – Telegram
- 25 – Apple Wallet
- 26 – Google Wallet
- 27 – Viber
ईमेल डिवाइस पंजीकृत करना
Anchor link toअपने ऐप के लिए एक ईमेल सब्सक्राइबर पंजीकृत करने के लिए, अपने /registerDevice या /registerEmail अनुरोध में "email": "email_address@domain.com" पैरामीटर निम्नानुसार भेजें:
अनुरोध उदाहरण
Anchor link to{ "request":{ "application": "XXXXX-XXXXX", // required. Pushwoosh application code "email": "email_address@domain.com", // required. Email address to register for your email project "language": "en", // optional. ISO 639-1|639-2 language code "userId": "Alex", // optional. "tags": { // optional. Tag values to set for the device registered "StringTag": "string value", "IntegerTag": 42, "ListTag": ["string1", "string2"], // sets the list of values for Tags of List type "DateTag": "2024-10-02 22:11", // note the time should be in UTC "BooleanTag": true // valid values are: true, false } }}व्हाट्सएप डिवाइस पंजीकृत करना
Anchor link toअपने ऐप के लिए व्हाट्सएप डिवाइस पंजीकृत करने के लिए, इन दिशानिर्देशों का पालन करें:
-
hwid: सुनिश्चित करें कि इस फ़ील्ड में
whatsapp:उपसर्ग के बाद E.164 प्रारूप में फ़ोन नंबर शामिल है (उदाहरण के लिए,whatsapp:+0000000000)। फ़ोन नंबर मान्य होना चाहिए, जिसे Pushwoosh सत्यापित करेगा। -
Push token: पुश टोकन की आवश्यकता नहीं है, क्योंकि
hwidस्वचालित रूप से पुश टोकन के रूप में कार्य करेगा। -
device_type: व्हाट्सएप को प्लेटफ़ॉर्म के रूप में निर्दिष्ट करने के लिए इस फ़ील्ड को 21 पर सेट करें।
अनुरोध उदाहरण
Anchor link to{ "request": { "application": "XXXXX-XXXXX", // required. Pushwoosh application code "hwid": "whatsapp:+0000000000", // required. WhatsApp prefix and valid phone number "timezone": 3600, // optional. Time offset in seconds "device_type": 21, // required. WhatsApp device type is 21 "language": "en", // optional. ISO 639-1|639-2 language code "userId": "Alex", // optional. User identifier "tags": { // optional. Tag values for custom segmentation "StringTag": "string value", "IntegerTag": 42, "ListTag": ["string1", "string2"], "DateTag": "2024-10-02 22:11", // UTC format "BooleanTag": true }, "app_version": "1.2.3", // optional. Application version "device_model": "Samsung SM-G355H", // optional. Device model "os_version": "2.3" // optional. Operating system version }}एसएमएस डिवाइस पंजीकृत करना
Anchor link toअपने ऐप के लिए एक एसएमएस डिवाइस पंजीकृत करने के लिए, इन दिशानिर्देशों का पालन करें:
-
hwid: सुनिश्चित करें कि इस फ़ील्ड में E.164 प्रारूप में फ़ोन नंबर शामिल है (उदाहरण के लिए, +0000000000)। फ़ोन नंबर मान्य होना चाहिए, जिसे Pushwoosh सत्यापित करेगा।
-
Push token: पुश टोकन की आवश्यकता नहीं है, क्योंकि
hwidस्वचालित रूप से पुश टोकन के रूप में कार्य करेगा। -
device_type: एसएमएस को प्लेटफ़ॉर्म के रूप में नामित करने के लिए इस आवश्यक फ़ील्ड को 18 पर सेट करें।
अनुरोध उदाहरण
Anchor link to{ "request": { "application": "XXXXX-XXXXX", // required. Pushwoosh application code "hwid": "+0000000000", // required. Valid phone number in E.164 format "timezone": 3600, // optional. Time offset in seconds "device_type": 18, // required. SMS device type is 18 "language": "en", // optional. ISO 639-1|639-2 language code "userId": "Alex", // optional. User identifier "tags": { // optional. Tag values for custom segmentation "StringTag": "string value", "IntegerTag": 42, "ListTag": ["string1", "string2"], "DateTag": "2024-10-02 22:11", // UTC format "BooleanTag": true }, "app_version": "1.2.3", // optional. Application version "device_model": "Samsung SM-G355H", // optional. Device model "os_version": "2.3" // optional. Operating system version }}स्टेटस कोड:
| HTTP स्टेटस कोड | status_code | विवरण |
|---|---|---|
| 200 | 200 | डिवाइस सफलतापूर्वक पंजीकृत हो गया |
| 200 | 210 | आर्गुमेंट त्रुटि। अधिक जानकारी के लिए status_message देखें। |
| 400 | N/A | विकृत अनुरोध स्ट्रिंग |
| 500 | 500 | आंतरिक त्रुटि |
unregisterDevice
Anchor link toPOST https://api.pushwoosh.com/json/1.3/unregisterDevice
डिवाइस का पुश टोकन हटाता है। अपंजीकृत डिवाइस अभी भी कुल डिवाइस में गिना जाता है और इन-ऐप्स के साथ पहुंचा जा सकता है। SDK से आंतरिक रूप से कॉल किया जाता है।
अनुरोध हेडर
Anchor link to| नाम | आवश्यक | मान | विवरण |
|---|---|---|---|
| Authorization | हाँ | Token XXXX | डिवाइस API तक पहुंचने के लिए API डिवाइस टोकन। XXXX को अपने वास्तविक डिवाइस API टोकन से बदलें। |
अनुरोध बॉडी
Anchor link to| नाम | प्रकार | विवरण |
|---|---|---|
| application* | string | Pushwoosh एप्लिकेशन कोड |
| hwid* | string | हार्डवेयर डिवाइस आईडी जिसका उपयोग /registerDevice अनुरोध में किया गया है। |
{ "status_code": 200, "status_message": "OK", "response": null}{ "request": { "application": "XXXXX-XXXXX", // required. Pushwoosh application code "hwid": "8f65b16XXXXXe7a6beceXXXXX530fb2" // required. Hardware device ID used in /registerDevice API }}स्टेटस कोड:
| HTTP स्टेटस कोड | status_code | विवरण |
|---|---|---|
| 200 | 200 | डिवाइस सफलतापूर्वक अनसब्सक्राइब हो गया |
| 200 | 210 | आर्गुमेंट त्रुटि। अधिक जानकारी के लिए status_message देखें। |
| 400 | N/A | विकृत अनुरोध स्ट्रिंग |
| 500 | 500 | आंतरिक त्रुटि |
deleteDevice
Anchor link toPOST https://api.pushwoosh.com/api/v2/device-api/deleteDevice
एप्लिकेशन के भीतर निर्दिष्ट HWID द्वारा पहचाने गए डिवाइस और उसके सभी संबंधित डेटा को हटाता है। /unregisterDevice के विपरीत, जो केवल पुश टोकन को हटाता है और डिवाइस रिकॉर्ड को रखता है, /deleteDevice डिवाइस को पूरी तरह से हटा देता है। अनुरोध को एसिंक्रोनस रूप से संसाधित किया जाता है, और एंडपॉइंट 200 OK लौटाता है जैसे ही हटाने का अनुरोध प्रसंस्करण के लिए स्वीकार कर लिया जाता है।
अनुरोध हेडर
Anchor link to| नाम | आवश्यक | मान | विवरण |
|---|---|---|---|
| Authorization | हाँ | Token XXXX | डिवाइस API तक पहुंचने के लिए API डिवाइस टोकन। XXXX को अपने वास्तविक डिवाइस API टोकन से बदलें। |
| Content-Type | हाँ | application/json |
अनुरोध बॉडी
Anchor link to| नाम | आवश्यक | प्रकार | विवरण |
|---|---|---|---|
| application | हाँ | string | Pushwoosh एप्लिकेशन कोड |
| hwid | हाँ | string | हटाए जाने वाले डिवाइस का हार्डवेयर डिवाइस आईडी। |
अनुरोध उदाहरण
Anchor link to{ "application": "XXXXX-XXXXX", // required. Pushwoosh application code "hwid": "8f65b16df378e7a6bece9614e1530fb2" // required. Hardware device ID of the device to delete}प्रतिक्रिया उदाहरण
Anchor link to{ "status_code": 200, "status_message": "OK", "response": null}स्टेटस कोड
Anchor link to| HTTP स्टेटस कोड | status_code | विवरण |
|---|---|---|
| 200 | 200 | हटाने का अनुरोध स्वीकार किया गया |
| 200 | 210 | आर्गुमेंट त्रुटि। अधिक जानकारी के लिए status_message देखें। |
| 400 | N/A | विकृत अनुरोध स्ट्रिंग |
| 401 | N/A | प्राधिकरण टोकन गुम या अमान्य है |
| 500 | 500 | आंतरिक त्रुटि |
setTags
Anchor link toPOST https://api.pushwoosh.com/json/1.3/setTags
डिवाइस के लिए टैग मान सेट करता है। SDK से कॉल किया जाता है।
अनुरोध हेडर
Anchor link to| नाम | आवश्यक | मान | विवरण |
|---|---|---|---|
| Authorization | हाँ | Token XXXX | डिवाइस API तक पहुंचने के लिए API डिवाइस टोकन। XXXX को अपने वास्तविक डिवाइस API टोकन से बदलें। |
अनुरोध बॉडी
Anchor link to| नाम | प्रकार | विवरण |
|---|---|---|
| application* | string | Pushwoosh एप्लिकेशन कोड |
| hwid* | string | हार्डवेयर डिवाइस आईडी जिसका उपयोग /registerDevice अनुरोध में किया गया है। |
| tags* | object | सेट करने के लिए टैग का JSON ऑब्जेक्ट, मान को हटाने के लिए “null” भेजें। |
{ "status_code": 200, "status_message": "OK", "response": null}{ "request":{ "application": "XXXXX-XXXXX", // required. Pushwoosh application code "hwid": "8f65b16XXXXXe7a6becXXXXXe1530fb2", // required. Hardware device ID used in /registerDevice API "tags": { // required. "StringTag": "string value", "IntegerTag": 42, "ListTag": ["string1", "string2"], // sets the list of values for Tags of List type "DateTag": "2024-10-02 22:11", // note the time is in UTC "BooleanTag": true // valid values are - true, false } }}इंटीजर टैग मान बढ़ाएँ
Anchor link toइंटीजर टैग का मान बढ़ाने के लिए, “increment” मान के साथ operation पैरामीटर का उपयोग निम्नानुसार करें:
{ "request":{ "application": "12345-67890", // required. Pushwoosh application code "hwid": "21AB7628-XXXX-XXXX-CCC0-PO287CS24CA4", // required. hardware device ID used in /registerDevice API "tags": { // required. "Level": { // Tag name "operation": "increment", // overwrites the integer tag in increments of the following value "value": 1 // increment for the tag value } } }}इंटीजर टैग मान घटाएँ
Anchor link toघटाने के लिए, “increment” ऑपरेशन के लिए मान के रूप में ऋणात्मक संख्याओं का उपयोग करें (-1, -2, -3,-n):
{ "request":{ "application": "12345-67890", // required. Pushwoosh application code "hwid": "21AB7628-XXXX-XXXX-CCC0-PO287CS24CA4", // required. Hardware device ID used in /registerDevice API "tags": { // required "Level": { // Tag name "operation": "increment", // overwrites the integer tag in decrement of the following value "value": -1 // decrement for the tag value } } }}सूची टैग मान जोड़ें
Anchor link toनए मानों के साथ सूची टैग का विस्तार करने के लिए, “append” मान के साथ operation पैरामीटर का उपयोग निम्नानुसार करें:
{ "request": { "hwid": "3d124a79XXXXf189XXXX7dfd9XXXXafd", // required. Hardware device ID used in /registerDevice API "application": "6XXXX-XXXX3", // required. Pushwoosh application code "tags": { // required. "ListTag": { // Tag name "operation": "append", // appends following values to the Tag's list of values "value": [ // values to append "tag2", "tag3" ] } } }}सूची टैग मान हटाएँ
Anchor link toसूची टैग से कुछ मान हटाने के लिए, “remove” ऑपरेशन का उपयोग निम्नानुसार करें:
{ "request":{ "application": "12345-67890", // required. Pushwoosh application code "hwid": "21AB7628-XXXX-XXXX-CCC0-PO287CS24CA4", // required. Hardware device ID used in /registerDevice API "tags": { // required. "In-App Product": { // Tag name "operation": "remove", // removes the following values from the list tag "value": "outwear_02" // value or values to remove } } }}UserID द्वारा टैग सेट करें
Anchor link toकिसी विशेष User ID से जुड़े सभी डिवाइसों के लिए टैग सेट करने के लिए, “hwid” के बजाय “userId” पैरामीटर का उपयोग करें।
{ "request":{ "application": "AAAAA-BBBBB", // Pushwoosh app code "userId": "some_user", // user ID you'd like to set tags for "tags": { // tags and values to set "Language": "es" } }}स्टेटस कोड:
| HTTP स्टेटस कोड | status_code | विवरण |
|---|---|---|
| 200 | 200 | टैग सफलतापूर्वक सेट कर दिए गए हैं |
| 200 | 210 | आर्गुमेंट त्रुटि। अधिक जानकारी के लिए status_message देखें। |
| 400 | N/A | विकृत अनुरोध स्ट्रिंग |
| 500 | 500 | आंतरिक त्रुटि |
getTags
Anchor link toPOST https://api.pushwoosh.com/json/1.3/getTags
विशिष्ट डिवाइस के लिए संबंधित मानों के साथ टैग की एक सूची पुनर्प्राप्त करता है।
अनुरोध हेडर
Anchor link to| नाम | आवश्यक | मान | विवरण |
|---|---|---|---|
| Authorization | हाँ | Token XXXX | डिवाइस API तक पहुंचने के लिए API डिवाइस टोकन। XXXX को अपने वास्तविक डिवाइस API टोकन से बदलें। |
अनुरोध बॉडी
Anchor link to| नाम | प्रकार | विवरण |
|---|---|---|
| application* | string | Pushwoosh एप्लिकेशन कोड |
| userId | string | User ID जिसका उपयोग “hwid” के बजाय किया जाना है। यदि “hwid” के साथ उपयोग किया जाता है, तो “hwid” प्रबल होता है। |
| hwid | string | /registerDevice अनुरोध में उपयोग किया गया हार्डवेयर डिवाइस आईडी। |
{ "status_code": 200, "status_message": "OK", "response": { "result": { "Language": "fr" } }}{ "request":{ "application": "XXXXX-XXXXX", // required. Pushwoosh application code "hwid": "HWID", // optional. Hardware device ID used in /registerDevice API "userId": "USER_ID" // optional. Can be used instead of "hwid" to retrieve tags for a specific user }}setBadge
Anchor link toPOST https://api.pushwoosh.com/json/1.3/setBadge
Pushwoosh को एक डिवाइस के लिए वर्तमान बैज मान भेजता है। SDK से आंतरिक रूप से कॉल किया जाता है।
अनुरोध हेडर
Anchor link to| नाम | आवश्यक | मान | विवरण |
|---|---|---|---|
| Authorization | हाँ | Token XXXX | डिवाइस API तक पहुंचने के लिए API डिवाइस टोकन। XXXX को अपने वास्तविक डिवाइस API टोकन से बदलें। |
अनुरोध बॉडी
Anchor link to| नाम | प्रकार | विवरण |
|---|---|---|
| application* | string | Pushwoosh एप्लिकेशन कोड |
| hwid* | string | हार्डवेयर डिवाइस आईडी जिसका उपयोग /registerDevice अनुरोध में किया गया है। |
| badge* | integer | एप्लिकेशन पर वर्तमान बैज। |
{ "status_code": 200, "status_message": "OK"}{ "request":{ "application": "XXXXX-XXXXX", // required. Pushwoosh application code "hwid": "8f65b16dXXXXe7a6XXXX9614XXXX0fb2", // required. Hardware device ID used in /registerDevice API "badge": 4 // required. Current badge on the application }}SDK से आंतरिक रूप से कॉल किया जाता है। Pushwoosh को एक डिवाइस के लिए वर्तमान बैज मान भेजता है। यह आंतरिक रूप से तब होता है जब ऐप iOS डिवाइस पर बैज मान बदलता है। ऑटो-इंक्रीमेंटिंग बैज को ठीक से काम करने की अनुमति देता है।
applicationOpen
Anchor link toPOST https://api.pushwoosh.com/json/1.3/applicationOpen
एक ऐप ओपन इवेंट पंजीकृत करता है। SDK से आंतरिक रूप से कॉल किया जाता है।
अनुरोध हेडर
Anchor link to| नाम | आवश्यक | मान | विवरण |
|---|---|---|---|
| Authorization | हाँ | Token XXXX | डिवाइस API तक पहुंचने के लिए API डिवाइस टोकन। XXXX को अपने वास्तविक डिवाइस API टोकन से बदलें। |
अनुरोध बॉडी
Anchor link to| नाम | प्रकार | विवरण |
|---|---|---|
| application* | string | Pushwoosh एप्लिकेशन कोड |
| hwid* | string | /registerDevice अनुरोध में उपयोग किया गया हार्डवेयर डिवाइस आईडी। |
{ "status_code": 200, "status_message": "OK"}{ "request": { "application": "XXXXX-XXXXX", // required. Pushwoosh application code "hwid": "8f65b16dXXXXe7a6XXXX9614eXXXXfb2" // required. Hardware device ID used in /registerDevice API }}pushStat
Anchor link toPOST https://api.pushwoosh.com/json/1.3/pushStat
एक पुश ओपन इवेंट पंजीकृत करता है। SDK से आंतरिक रूप से कॉल किया जाता है।
अनुरोध हेडर
Anchor link to| नाम | आवश्यक | मान | विवरण |
|---|---|---|---|
| Authorization | हाँ | Token XXXX | डिवाइस API तक पहुंचने के लिए API डिवाइस टोकन। XXXX को अपने वास्तविक डिवाइस API टोकन से बदलें। |
अनुरोध बॉडी
Anchor link to| नाम | प्रकार | विवरण |
|---|---|---|
| application* | string | Pushwoosh एप्लिकेशन कोड |
| hwid* | string | हार्डवेयर डिवाइस आईडी जिसका उपयोग /registerDevice अनुरोध में किया गया है। |
| userId | string | पुश ओपन इवेंट के साथ संबद्ध करने के लिए User ID। |
| hash | string | पुश नोटिफिकेशन में प्राप्त हैश टैग (पुश पेलोड का “p” पैरामीटर)। |
{ "status_code": 200, "status_message": "OK", "response": null}{ "request": { "application": "XXXXX-XXXXX", // required. Pushwoosh application code "hwid": "8f65b16dfXXXX7a6beXXXX14e1530fb2", // required. Hardware device ID used in /registerDevice API "userId": "USER012345", // optional. The user id to associate with the push open event "hash": "HASH_TAG" // optional. Hash tag received in push notification // ("p" parameter in the push payload) }}messageDeliveryEvent
Anchor link toPOST https://api.pushwoosh.com/json/1.3/messageDeliveryEvent
डिवाइस के लिए पुश डिलीवरी इवेंट पंजीकृत करता है। SDK से आंतरिक रूप से कॉल किया जाता है।
अनुरोध हेडर
Anchor link to| नाम | आवश्यक | मान | विवरण |
|---|---|---|---|
| Authorization | हाँ | Token XXXX | डिवाइस API तक पहुंचने के लिए API डिवाइस टोकन। XXXX को अपने वास्तविक डिवाइस API टोकन से बदलें। |
अनुरोध बॉडी
Anchor link to| नाम | प्रकार | विवरण |
|---|---|---|
| application* | string | Pushwoosh एप्लिकेशन कोड |
| hwid* | string | /registerDevice अनुरोध में उपयोग किया गया हार्डवेयर डिवाइस आईडी। |
| hash | string | पुश नोटिफिकेशन में प्राप्त हैश टैग (पुश पेलोड का “p” पैरामीटर)। |
{ "status_code": 200, "status_message": "OK", "response": null} { "request": { "application": "XXXXX-XXXXX", // required. Pushwoosh application code "hwid": "8f65b16dfXXXX7a6bece9XXXX1530fb2", // required. Hardware device ID used in /registerDevice API "hash": "HASH_TAG" // optional. Hash tag received in push notification // ("p" parameter in the push payload) }}