Audience API

bulkSetTags

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

ডিভাইসের তালিকার জন্য ট্যাগের মান সেট করে।

গুরুত্বপূর্ণ

bulkSetTags পদ্ধতি ব্যবহার করার সময়, নিশ্চিত করুন যে ট্যাগের মানগুলি কমপক্ষে ৫০টি ডিভাইসের জন্য সেট করা হয়েছে। একটি একক ডিভাইসের জন্য ট্যাগ সেট করতে, setTags পদ্ধতি ব্যবহার করুন।

Request Body

নাম	টাইপ	বিবরণ
application*	String	Pushwoosh অ্যাপ্লিকেশন কোড
auth*	String	Pushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন।
create_missing_tags	Boolean	যদি সত্য (true) হয়, তবে অনুপস্থিত ট্যাগগুলি স্বয়ংক্রিয়ভাবে তৈরি হয়।
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",          //           সঠিক মানের ধরন ব্যবহার করুন
      "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

নাম	টাইপ	বিবরণ
request_id	String	পূর্ববর্তী /bulkSetTags কল থেকে প্রাপ্ত request id

Query Parameters

নাম	টাইপ	বিবরণ
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

প্যারামিটার	টাইপ	প্রয়োজনীয়	বিবরণ
application	string	হ্যাঁ	Pushwoosh অ্যাপ্লিকেশন কোড
auth	string	হ্যাঁ	API অ্যাক্সেস টোকেন।
devices	array	হ্যাঁ	ডিভাইস অবজেক্টের একটি অ্যারে। প্রতিটি অবজেক্ট একটি ডিভাইস এবং তার সংশ্লিষ্ট ডেটা উপস্থাপন করে। বিস্তারিত জানতে নিচের Device object parameters টেবিলটি দেখুন।

Device object parameters

প্যারামিটার	টাইপ	প্রয়োজনীয়	বিবরণ
hwid	string	হ্যাঁ	হার্ডওয়্যার আইডি বা ডিভাইসের জন্য অনন্য শনাক্তকারী।
push_token	string	হ্যাঁ	ডিভাইসের জন্য পুশ টোকেন।
platform	integer	হ্যাঁ	প্ল্যাটফর্ম শনাক্তকারী। আরও জানুন
list_operator	string	না	তালিকা-ধরণের (list-type) ট্যাগগুলির জন্য অ্যাকশন নির্ধারণ করে: - “append”: ট্যাগ তালিকায় নির্দিষ্ট মান যোগ করুন। - “remove”: ট্যাগ তালিকা থেকে নির্দিষ্ট মান সরান। দ্রষ্টব্য: যদি list_operator প্যারামিটারটি নির্দিষ্ট করা না থাকে, তবে ট্যাগ তালিকার সমস্ত বিদ্যমান মান প্রদত্ত মানগুলির সাথে প্রতিস্থাপিত হবে।
tags	object	না	ডিভাইসে অ্যাসাইন করা কাস্টম ট্যাগ। ট্যাগ হলো কী-ভ্যালু পেয়ার (key-value pairs) যা সেগমেন্টেশনের জন্য ব্যবহৃত হয়।

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

এই পদ্ধতিটি একটি অপারেশন আইডি দিয়ে প্রতিক্রিয়া জানায়, যা বাল্ক রেজিস্ট্রেশন প্রক্রিয়ার স্থিতি এবং ফলাফল ট্র্যাক করতে ব্যবহার করা যেতে পারে।

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

প্যারামিটার	টাইপ	প্রয়োজনীয়	বিবরণ
request_id	string	হ্যাঁ	POST অনুরোধ দ্বারা ফেরত দেওয়া রিকোয়েস্ট আইডি।
detailed	boolean	না	যদি 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 থেকে একাধিক ডিভাইস আনরেজিস্টার (unregister) করে।

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

Request body parameters

প্যারামিটার	টাইপ	প্রয়োজনীয়	বিবরণ
application	string	হ্যাঁ	Pushwoosh অ্যাপ্লিকেশন কোড
auth	string	হ্যাঁ	API অ্যাক্সেস টোকেন
devices	array	হ্যাঁ	ডিভাইস অবজেক্টের একটি অ্যারে। প্রতিটি অবজেক্ট একটি ডিভাইস এবং তার সংশ্লিষ্ট ডেটা উপস্থাপন করে। বিস্তারিত জানতে নিচের Device object parameters টেবিলটি দেখুন।

Device object parameters

প্যারামিটার	টাইপ	প্রয়োজনীয়	বিবরণ
hwid	string	হ্যাঁ	হার্ডওয়্যার আইডি বা ডিভাইসের জন্য অনন্য শনাক্তকারী। আরও জানুন

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

এই পদ্ধতিটি একটি অপারেশন আইডি দিয়ে প্রতিক্রিয়া জানায়, যা বাল্ক প্রক্রিয়ার স্থিতি এবং ফলাফল ট্র্যাক করতে ব্যবহার করা যেতে পারে।

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

প্যারামিটার	টাইপ	প্রয়োজনীয়	বিবরণ
request_id	string	হ্যাঁ	POST অনুরোধ দ্বারা ফেরত দেওয়া রিকোয়েস্ট আইডি।
detailed	boolean	না	যদি 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"
    }
  ]
}