सामग्री पर जाएं
उपयोगकर्ता गाइड सहायता डेमो अनुरोध करें साइन इन करें
Pushwoosh.com

ऑडियंस API

bulkSetTags

Anchor link to

POST https://api.pushwoosh.com/api/v2/audience/bulkSetTags

डिवाइसों की सूची के लिए टैग मान सेट करता है।

अनुरोध बॉडी

Anchor link to
नामप्रकारविवरण
application*स्ट्रिंगPushwoosh एप्लिकेशन कोड
auth*स्ट्रिंगPushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
create_missing_tagsबूलियनयदि सत्य है, तो अनुपलब्ध टैग स्वचालित रूप से बनाए जाते हैं।
devices*ऑब्जेक्टडिवाइसों का ऐरे।
devices.hwidस्ट्रिंगuser_id या push_token के बजाय डिवाइस की पहचान करने के लिए उपयोग किया जा सकता है। अधिक जानें
devices.user_idस्ट्रिंगhwid या push_token के बजाय उपयोगकर्ता की पहचान करने के लिए उपयोग किया जा सकता है। अधिक जानें
devices.push_tokenस्ट्रिंगhwid या user_id के बजाय डिवाइस की पहचान करने के लिए उपयोग किया जा सकता है। अधिक जानें
devices.list_operatorस्ट्रिंगसूची प्रकार के टैग के लिए मान कैसे सेट करें, यह परिभाषित करता है: सेट, एपेंड, या रिमूव
devices.tags*ऑब्जेक्टनिर्दिष्ट टैग के लिए सेट किए जाने वाले मान।
{
  "request_id": "जॉब की स्थिति प्राप्त करने के लिए GET विधि में उपयोग करने के लिए request_id",
  "status": "लंबित"
}
अनुरोध:
{
  "application": "application code",   // आवश्यक। Pushwoosh ऐप कोड
  "auth": "Pushwoosh auth token",      // आवश्यक। Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन
  "create_missing_tags": false,        // वैकल्पिक। अनुपलब्ध टैग स्वचालित रूप से बनाए जाने चाहिए
  "devices": [{                        // आवश्यक। डिवाइसों का ऐरे
    "hwid": "device hwid",             // वैकल्पिक। "user_id" या "push_token" के बजाय डिवाइस की पहचान करने के लिए उपयोग किया जा सकता है।
    "user_id": "user ID",              // वैकल्पिक। "hwid" या "push_token" के बजाय उपयोगकर्ता की पहचान करने के लिए उपयोग किया जा सकता है।
    "push_token": "device push token", // वैकल्पिक। "hwid" या "user_id" के बजाय डिवाइस की पहचान करने के लिए उपयोग किया जा सकता है।
    "list_operator": "set",            // आवश्यक। सूची टैग के लिए। सूची प्रकार के टैग के लिए मान कैसे सेट करें, यह परिभाषित करता है: सेट, एपेंड, या रिमूव
    "tags": {                          // आवश्यक। निर्दिष्ट टैग के लिए सेट किए जाने वाले मान।
      "tag_name": "tagvalue",          //           सही मान प्रकार का उपयोग करें
      "tag_name2": "tagvalue2"
    }
  }]
}
प्रतिक्रिया:
{
  "request_id": "जॉब की स्थिति प्राप्त करने के लिए GET विधि में उपयोग करने के लिए request_id",
  "status": "लंबित"
}

bulkSetTags स्थिति

Anchor link to

GET https://api.pushwoosh.com/api/v2/audience/bulkSetTags/{request_id}?detailed=false

/bulkSetTags ऑपरेशन की स्थिति लौटाता है

पाथ पैरामीटर्स

Anchor link to
नामप्रकारविवरण
request_idस्ट्रिंगपिछले /bulkSetTags कॉल से अनुरोध आईडी

क्वेरी पैरामीटर्स

Anchor link to
नामप्रकारविवरण
detailedबूलियन(true/false) क्या प्रति-डिवाइस विस्तृत जानकारी लौटानी है
प्रतिक्रिया:
{
  "request_id": "अनुरोध की आईडी",
  "status": "पूर्ण",          // "लंबित", "विफल" भी
  "progress": 100,                // जॉब की प्रगति 0-100
  "devices_success": 100,         // अच्छे डिवाइस
  "devices_not_found": 0,         // Pushwoosh में डिवाइस नहीं मिले
  "devices_failed": 0,            // त्रुटिपूर्ण
  "devices": [{                   // डिवाइस रिपोर्ट (केवल detailed = true में)
    "hwid": "device hwid",
    "status": "पूर्ण",             // "विफल", "नहीं मिला" भी
    "tags": {
      "tagName": "ठीक है",
      "tagName2": "टैग नहीं मिला",
      "tagName3": "गलत मान। अपेक्षा :स्ट्रिंग"
    }
  }]
}

bulkRegisterDevice

Anchor link to

एक ही अनुरोध में Pushwoosh में कई डिवाइसों को पंजीकृत करता है। यह प्रत्येक डिवाइस के लिए विभिन्न टैग निर्दिष्ट करने की भी अनुमति देता है।

POST https://api.pushwoosh.com/api/v2/audience/bulkRegisterDevice

अनुरोध बॉडी पैरामीटर्स

Anchor link to
पैरामीटरप्रकारआवश्यकविवरण
applicationस्ट्रिंगहाँPushwoosh एप्लिकेशन कोड
authस्ट्रिंगहाँAPI एक्सेस टोकन।
devicesऐरेहाँडिवाइस ऑब्जेक्ट्स का एक ऐरे। प्रत्येक ऑब्जेक्ट एक डिवाइस और उससे जुड़े डेटा का प्रतिनिधित्व करता है। नीचे डिवाइस ऑब्जेक्ट पैरामीटर्स तालिका में विवरण देखें।

डिवाइस ऑब्जेक्ट पैरामीटर्स

Anchor link to
पैरामीटरप्रकारआवश्यकविवरण
hwidस्ट्रिंगहाँडिवाइस के लिए हार्डवेयर आईडी या अद्वितीय पहचानकर्ता।
push_tokenस्ट्रिंगहाँडिवाइस के लिए पुश टोकन।
platformपूर्णांकहाँप्लेटफ़ॉर्म पहचानकर्ता। अधिक जानें
list_operatorस्ट्रिंगनहींसूची-प्रकार के टैग के लिए क्रिया निर्धारित करता है:
- “append”: निर्दिष्ट मान को टैग सूची में जोड़ें।
- “remove”: निर्दिष्ट मान को टैग सूची से हटा दें।
ध्यान दें: यदि list_operator पैरामीटर निर्दिष्ट नहीं है, तो टैग सूची में सभी मौजूदा मान प्रदान किए गए मानों से बदल दिए जाएंगे।
tagsऑब्जेक्टनहींडिवाइस को सौंपे गए कस्टम टैग। टैग विभाजन के लिए उपयोग किए जाने वाले कुंजी-मान जोड़े हैं।

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

Anchor link to
{
  "application": "application code",   // आवश्यक। Pushwoosh ऐप कोड
  "auth": "Pushwoosh auth token",      // आवश्यक। Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन
  "devices": [{                        // आवश्यक। डिवाइसों का ऐरे
    "hwid": "device hwid",             // आवश्यक। डिवाइस के लिए अद्वितीय पहचानकर्ता (एक ईमेल हो सकता है)।
    "push_token": "device push token", // आवश्यक। डिवाइस के लिए पुश नोटिफिकेशन टोकन।
    "platform": 14,                    // आवश्यक। डिवाइस प्लेटफ़ॉर्म (जैसे, ईमेल के लिए 14)।
    "list_operator": "append",         // वैकल्पिक। सूची टैग के लिए। सूची प्रकार के टैग से निर्दिष्ट मान(मानों) को जोड़ता या हटाता है।
    "tags": {                          // वैकल्पिक। निर्दिष्ट टैग के लिए सेट किए जाने वाले मान।
      "language": "en",                //           सही मान प्रकार का उपयोग करें।
      "CSV_Import": "summer_camp"
    }
  },
  {
    "hwid": "device hwid 2",           // आवश्यक। दूसरे डिवाइस के लिए अद्वितीय पहचानकर्ता।
    "push_token": "device push token 2", // आवश्यक। डिवाइस के लिए पुश नोटिफिकेशन टोकन।
    "platform": 14,                    // आवश्यक। डिवाइस प्लेटफ़ॉर्म।
    "list_operator": "remove",         // वैकल्पिक। सूची प्रकार के टैग से मान जोड़ता या हटाता है।
    "tags": {                          // वैकल्पिक। निर्दिष्ट टैग से हटाए जाने वाले मान।
      "language": "en",
      "CSV_Import": "summer_camp2"
    }
  },
  {
    "hwid": "device hwid 3",           // आवश्यक। तीसरे डिवाइस के लिए अद्वितीय पहचानकर्ता।
    "push_token": "device push token 3", // आवश्यक। डिवाइस के लिए पुश नोटिफिकेशन टोकन।
    "platform": 14,                    // आवश्यक। डिवाइस प्लेटफ़ॉर्म।
    "tags": {                          // वैकल्पिक। निर्दिष्ट टैग के लिए सेट किए जाने वाले मान।
      "language": "en",
      "CSV_Import": "summer_camp3"
    }
  }]
}

प्रतिक्रिया

Anchor link to

विधि एक ऑपरेशन आईडी के साथ प्रतिक्रिया देती है, जिसका उपयोग बल्क पंजीकरण प्रक्रिया की स्थिति और परिणामों को ट्रैक करने के लिए किया जा सकता है।

{
  "request_id": "जॉब की स्थिति प्राप्त करने के लिए GET विधि में उपयोग करने के लिए request_id",
  "status": "लंबित"
}

bulkRegisterDevice स्थिति

Anchor link to

आप निम्नलिखित GET अनुरोध करके बल्क पंजीकरण प्रक्रिया की स्थिति की जांच कर सकते हैं:

GET https://api.pushwoosh.com/api/v2/audience/bulkRegisterDevice/{request_id}?detailed=true

पैरामीटरप्रकारआवश्यकविवरण
request_idस्ट्रिंगहाँPOST अनुरोध द्वारा लौटाई गई अनुरोध आईडी।
detailedबूलियननहींयदि true पर सेट है, तो प्रतिक्रिया में प्रत्येक पंजीकृत डिवाइस के लिए विस्तृत परिणाम शामिल होते हैं।

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

Anchor link to
{
  "request_id": "9a2e1a14-XXXX-46c3-XXXX-c254b25d3782",
  "status": "पूर्ण",
  "progress": 100,
  "devices_success": 4,
  "devices": [
    {
      "hwid": "user1@example.com",
      "status": "पूर्ण"
    },
    {
      "hwid": "user2@example.com",
      "status": "पूर्ण"
    },
    {
      "hwid": "user3@example.com",
      "status": "पूर्ण"
    },
    {
      "hwid": "invalid_email@example.com",
      "status": "विफल"
    }
  ]
}

bulkUnregisterDevice

Anchor link to

एक ही अनुरोध में Pushwoosh से कई डिवाइसों को अपंजीकृत करता है।

POST https://api.pushwoosh.com/api/v2/audience/bulkUnregisterDevice

अनुरोध बॉडी पैरामीटर्स

Anchor link to
पैरामीटरप्रकारआवश्यकविवरण
applicationस्ट्रिंगहाँPushwoosh एप्लिकेशन कोड
authस्ट्रिंगहाँAPI एक्सेस टोकन
devicesऐरेहाँडिवाइस ऑब्जेक्ट्स का एक ऐरे। प्रत्येक ऑब्जेक्ट एक डिवाइस और उससे जुड़े डेटा का प्रतिनिधित्व करता है। नीचे डिवाइस ऑब्जेक्ट पैरामीटर्स तालिका में विवरण देखें।

डिवाइस ऑब्जेक्ट पैरामीटर्स

Anchor link to
पैरामीटरप्रकारआवश्यकविवरण
hwidस्ट्रिंगहाँडिवाइस के लिए हार्डवेयर आईडी या अद्वितीय पहचानकर्ता। अधिक जानें

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

Anchor link to
{
  "application": "application code",   // आवश्यक। Pushwoosh ऐप कोड
  "auth": "Pushwoosh auth token",      // आवश्यक। Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन
  "devices": [{                        // आवश्यक। डिवाइसों का ऐरे
    "hwid": "device hwid",             // आवश्यक। डिवाइस के लिए अद्वितीय पहचानकर्ता (एक ईमेल हो सकता है)।
  },
  {
    "hwid": "device hwid 2",           // आवश्यक। दूसरे डिवाइस के लिए अद्वितीय पहचानकर्ता।
  },
  {
    "hwid": "device hwid 3",           // आवश्यक। तीसरे डिवाइस के लिए अद्वितीय पहचानकर्ता।
  }]
}

प्रतिक्रिया

Anchor link to

विधि एक ऑपरेशन आईडी के साथ प्रतिक्रिया देती है, जिसका उपयोग बल्क प्रक्रिया की स्थिति और परिणामों को ट्रैक करने के लिए किया जा सकता है।

{
  "request_id": "जॉब की स्थिति प्राप्त करने के लिए GET विधि में उपयोग करने के लिए request_id",
  "status": "लंबित"
}

bulkUnregisterDevice स्थिति

Anchor link to

आप निम्नलिखित GET अनुरोध करके बल्क अपंजीकरण प्रक्रिया की स्थिति की जांच कर सकते हैं:

GET https://api.pushwoosh.com/api/v2/audience/bulkUnregisterDevice/{request_id}?detailed=true

पैरामीटरप्रकारआवश्यकविवरण
request_idस्ट्रिंगहाँPOST अनुरोध द्वारा लौटाई गई अनुरोध आईडी।
detailedबूलियननहींयदि true पर सेट है, तो प्रतिक्रिया में प्रत्येक अपंजीकृत डिवाइस के लिए विस्तृत परिणाम शामिल होते हैं।

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

Anchor link to
{
  "request_id": "9a2e1a14-XXXX-46c3-XXXX-c254b25d3782",
  "status": "पूर्ण",
  "progress": 100,
  "devices_success": 4,
  "devices": [
    {
      "hwid": "user1@example.com",
      "status": "पूर्ण"
    },
    {
      "hwid": "user2@example.com",
      "status": "पूर्ण"
    },
    {
      "hwid": "user3@example.com",
      "status": "पूर्ण"
    },
    {
      "hwid": "invalid_email@example.com",
      "status": "विफल"
    }
  ]
}