Audience API

bulkSetTags

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

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

महत्वपूर्ण

bulkSetTags विधि का उपयोग करते समय, सुनिश्चित करें कि टैग मान कम से कम 50 डिवाइस के लिए सेट किए गए हैं। एक डिवाइस के लिए टैग सेट करने के लिए, setTags विधि का उपयोग करें।

Request Body

Name	Type	Description
application*	String	Pushwoosh एप्लिकेशन कोड
auth*	String	Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
create_missing_tags	Boolean	यदि true है, तो गायब (missing) टैग अपने आप बन जाते हैं।
devices*	Object	डिवाइस का एरे (Array)।
devices.hwid	String	user_id या push_token के बजाय डिवाइस की पहचान करने के लिए उपयोग किया जा सकता है। और जानें
devices.user_id	String	hwid या push_token के बजाय यूज़र की पहचान करने के लिए उपयोग किया जा सकता है। और जानें
devices.push_token	String	hwid या user_id के बजाय डिवाइस की पहचान करने के लिए उपयोग किया जा सकता है। और जानें
devices.list_operator	String	लिस्ट प्रकार के टैग के लिए मान सेट करने का तरीका परिभाषित करता है: set, append, या remove
devices.tags*	Object	निर्दिष्ट टैग के लिए सेट किए जाने वाले मान।

OK

{
  "request_id": "request_id to use in GET method to obtain job status",
  "status": "Pending"
}

Error

{
  "message": "invalid request"
}

Request:

{
  "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",            // आवश्यक। लिस्ट टैग के लिए। लिस्ट प्रकार के टैग के लिए मान सेट करने का तरीका
                                       //           परिभाषित करता है: set, append, या remove
    "tags": {                          // आवश्यक। निर्दिष्ट टैग के लिए सेट किए जाने वाले मान।
      "tag_name": "tagvalue",          //           सही मान प्रकार (value type) का उपयोग करें
      "tag_name2": "tagvalue2"
    }
  }]
}

Response:

{
  "request_id": "request_id to use in GET method to obtain job status",
  "status": "Pending"
}

bulkSetTags status

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

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

Path Parameters

Name	Type	Description
request_id	String	पिछले /bulkSetTags कॉल से request id

Query Parameters

Name	Type	Description
detailed	Boolean	(true/false) क्या विस्तृत प्रति-डिवाइस जानकारी लौटानी है

Response:

{
  "request_id": "id of the request",
  "status": "Completed",          // "Pending", "Failed" भी हो सकता है
  "progress": 100,                // जॉब की प्रगति 0-100
  "devices_success": 100,         // सही डिवाइस
  "devices_not_found": 0,         // Pushwoosh में डिवाइस नहीं मिले
  "devices_failed": 0,            // त्रुटिपूर्ण
  "devices": [{                   // डिवाइस रिपोर्ट (केवल detailed = true में)
    "hwid": "device hwid",
    "status": "done",             // "failed", "not found" भी हो सकता है
    "tags": {
      "tagName": "ok",
      "tagName2": "tag not found",
      "tagName3": "wrong value. expect :string"
    }
  }]
}

bulkRegisterDevice

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

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

Request body parameters

Parameter	Type	Required	Description
application	string	Yes	Pushwoosh एप्लिकेशन कोड
auth	string	Yes	API एक्सेस टोकन।
devices	array	Yes	डिवाइस ऑब्जेक्ट्स का एक एरे। प्रत्येक ऑब्जेक्ट एक डिवाइस और उसके संबंधित डेटा का प्रतिनिधित्व करता है। नीचे Device object parameters तालिका में विवरण देखें।

Device object parameters

Parameter	Type	Required	Description
hwid	string	Yes	डिवाइस के लिए हार्डवेयर ID या विशिष्ट पहचानकर्ता (unique identifier)।
push_token	string	Yes	डिवाइस के लिए पुश टोकन।
platform	integer	Yes	प्लेटफ़ॉर्म पहचानकर्ता। और जानें
list_operator	string	No	लिस्ट-प्रकार के टैग के लिए कार्रवाई निर्धारित करता है: - “append”: टैग सूची में निर्दिष्ट मान जोड़ें। - “remove”: टैग सूची से निर्दिष्ट मान हटाएँ। नोट: यदि list_operator पैरामीटर निर्दिष्ट नहीं है, तो टैग सूची में सभी मौजूदा मान प्रदान किए गए मानों से बदल दिए जाएंगे।
tags	object	No	डिवाइस को असाइन किए गए कस्टम टैग। टैग की-वैल्यू (key-value) जोड़े होते हैं जिनका उपयोग सेगमेन्टेशन के लिए किया जाता है।

Request example

{
  "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"
    }
  }]
}

Response

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

{
  "request_id": "request_id to use in GET method to obtain job status",
  "status": "Pending"
}

bulkRegisterDevice status

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

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

Parameter	Type	Required	Description
request_id	string	Yes	POST अनुरोध द्वारा लौटाया गया अनुरोध ID (request ID)।
detailed	boolean	No	यदि true पर सेट किया जाता है, तो प्रतिक्रिया में प्रत्येक पंजीकृत डिवाइस के लिए विस्तृत परिणाम शामिल होते हैं।

Example response

{
  "request_id": "9a2e1a14-XXXX-46c3-XXXX-c254b25d3782",
  "status": "Completed",
  "progress": 100,
  "devices_success": 4,
  "devices": [
    {
      "hwid": "user1@example.com",
      "status": "done"
    },
    {
      "hwid": "user2@example.com",
      "status": "done"
    },
    {
      "hwid": "user3@example.com",
      "status": "done"
    },
    {
      "hwid": "invalid_email@example.com",
      "status": "failed"
    }
  ]
}

bulkUnregisterDevice

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

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

Request body parameters

Parameter	Type	Required	Description
application	string	Yes	Pushwoosh एप्लिकेशन कोड
auth	string	Yes	API एक्सेस टोकन
devices	array	Yes	डिवाइस ऑब्जेक्ट्स का एक एरे। प्रत्येक ऑब्जेक्ट एक डिवाइस और उसके संबंधित डेटा का प्रतिनिधित्व करता है। नीचे Device object parameters तालिका में विवरण देखें।

Device object parameters

Parameter	Type	Required	Description
hwid	string	Yes	डिवाइस के लिए हार्डवेयर ID या विशिष्ट पहचानकर्ता। और जानें

Request example

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

Response

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

{
  "request_id": "request_id to use in GET method to obtain job status",
  "status": "Pending"
}

bulkUnregisterDevice status

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

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

Parameter	Type	Required	Description
request_id	string	Yes	POST अनुरोध द्वारा लौटाया गया अनुरोध ID (request ID)।
detailed	boolean	No	यदि true पर सेट किया जाता है, तो प्रतिक्रिया में प्रत्येक अन-रजिस्टर किए गए डिवाइस के लिए विस्तृत परिणाम शामिल होते हैं।

Example response

{
  "request_id": "9a2e1a14-XXXX-46c3-XXXX-c254b25d3782",
  "status": "Completed",
  "progress": 100,
  "devices_success": 4,
  "devices": [
    {
      "hwid": "user1@example.com",
      "status": "done"
    },
    {
      "hwid": "user2@example.com",
      "status": "done"
    },
    {
      "hwid": "user3@example.com",
      "status": "done"
    },
    {
      "hwid": "invalid_email@example.com",
      "status": "failed"
    }
  ]
}