অডিয়েন্স API

bulkSetTags

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

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

অনুরোধের বডি

নাম	টাইপ	বর্ণনা
application*	String	Pushwoosh অ্যাপ্লিকেশন কোড
auth*	String	Pushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন।
create_missing_tags	Boolean	যদি true হয়, তাহলে অনুপস্থিত ট্যাগগুলি স্বয়ংক্রিয়ভাবে তৈরি হয়।
devices*	Object	ডিভাইসের অ্যারে।
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	তালিকা ধরনের ট্যাগগুলির জন্য মান কীভাবে সেট করতে হবে তা নির্ধারণ করে: সেট, অ্যাপেন্ড, বা রিমুভ
devices.tags*	Object	নির্দিষ্ট ট্যাগগুলির জন্য সেট করার মান।

ঠিক আছে
ত্রুটি

{
  "request_id": "জব স্ট্যাটাস পেতে GET পদ্ধতিতে ব্যবহার করার জন্য request_id",
  "status": "Pending"
}

{
  "message": "অবৈধ অনুরোধ"
}

{
  "application": "application code",   // required. Pushwoosh app code
  "auth": "Pushwoosh auth token",      // required. API access token from Pushwoosh Control Panel
  "create_missing_tags": false,        // optional. Should automatically create missing tags
  "devices": [{                        // required. Array of devices
    "hwid": "device hwid",             // optional. Can be used to identify a device instead of
                                       //           "user_id" or "push_token".
    "user_id": "user ID",              // optional. Can be used to identify a user instead of "hwid" or "push_token".
    "push_token": "device push token", // optional. Can be used to identify a device instead of "hwid" or "user_id".
    "list_operator": "set",            // required. For list tags. Defines how to set values for
                                       //           tags of the list type: set, append, or remove
    "tags": {                          // required. Values to set for the tags specified.
      "tag_name": "tagvalue",          //           use correct value type
      "tag_name2": "tagvalue2"
    }
  }]
}

{
  "request_id": "জব স্ট্যাটাস পেতে GET পদ্ধতিতে ব্যবহার করার জন্য request_id",
  "status": "Pending"
}

bulkSetTags স্ট্যাটাস

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

/bulkSetTags অপারেশনের স্ট্যাটাস প্রদান করে।

পাথ প্যারামিটার

নাম	টাইপ	বর্ণনা
request_id	String	পূর্ববর্তী `/bulkSetTags` কল থেকে অনুরোধ আইডি

কোয়েরি প্যারামিটার

নাম	টাইপ	বর্ণনা
detailed	Boolean	(true/false) প্রতি-ডিভাইস বিস্তারিত তথ্য প্রদান করবে কিনা

{
  "request_id": "id of the request",
  "status": "Completed",          // also "Pending", "Failed"
  "progress": 100,                // jobs progress 0-100
  "devices_success": 100,         // good devices
  "devices_not_found": 0,         // devices not found in Pushwoosh
  "devices_failed": 0,            // errored
  "devices": [{                   // device report (only in detailed = true)
    "hwid": "device hwid",
    "status": "done",             // also "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

অনুরোধের বডি প্যারামিটার

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

ডিভাইস অবজেক্ট প্যারামিটার

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

অনুরোধের উদাহরণ

{
  "application": "application code",   // required. Pushwoosh app code
  "auth": "Pushwoosh auth token",      // required. API access token from Pushwoosh Control Panel
  "devices": [{                        // required. Array of devices
    "hwid": "device hwid",             // required. Unique identifier for the device (can be an email).
    "push_token": "device push token", // required. Push notification token for the device.
    "platform": 14,                    // required. Device platform (e.g., 14 for email).
    "list_operator": "append",         // optional. For list tags. Adds or removes the specified value(s) from the tag of list type.
    "tags": {                          // optional. Values to set for the specified tags.
      "language": "en",                //           use correct value type.
      "CSV_Import": "summer_camp"
    }
  },
  {
    "hwid": "device hwid 2",           // required. Unique identifier for the second device.
    "push_token": "device push token 2", // required. Push notification token for the device.
    "platform": 14,                    // required. Device platform.
    "list_operator": "remove",         // optional. Adds or removes values from tags of the list type.
    "tags": {                          // optional. Values to remove from the specified tags.
      "language": "en",
      "CSV_Import": "summer_camp2"
    }
  },
  {
    "hwid": "device hwid 3",           // required. Unique identifier for the third device.
    "push_token": "device push token 3", // required. Push notification token for the device.
    "platform": 14,                    // required. Device platform.
    "tags": {                          // optional. Values to set for the specified tags.
      "language": "en",
      "CSV_Import": "summer_camp3"
    }
  }]
}

প্রতিক্রিয়া

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

{
  "request_id": "জব স্ট্যাটাস পেতে GET পদ্ধতিতে ব্যবহার করার জন্য request_id",
  "status": "Pending"
}

bulkRegisterDevice স্ট্যাটাস

আপনি নিম্নলিখিত GET অনুরোধ করে একটি বাল্ক রেজিস্ট্রেশন প্রক্রিয়ার স্ট্যাটাস পরীক্ষা করতে পারেন:

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

প্যারামিটার	টাইপ	প্রয়োজনীয়	বর্ণনা
request_id	string	হ্যাঁ	POST অনুরোধ দ্বারা ফেরত দেওয়া অনুরোধ আইডি।
detailed	boolean	না	যদি `true` তে সেট করা হয়, প্রতিক্রিয়াতে প্রতিটি নিবন্ধিত ডিভাইসের জন্য বিস্তারিত ফলাফল অন্তর্ভুক্ত থাকে।

প্রতিক্রিয়ার উদাহরণ

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

অনুরোধের বডি প্যারামিটার

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

ডিভাইস অবজেক্ট প্যারামিটার

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

অনুরোধের উদাহরণ

{
  "application": "application code",   // required. Pushwoosh app code
  "auth": "Pushwoosh auth token",      // required. API access token from Pushwoosh Control Panel
  "devices": [{                        // required. Array of devices
    "hwid": "device hwid",             // required. Unique identifier for the device (can be an email).
  },
  {
    "hwid": "device hwid 2",           // required. Unique identifier for the second device.
  },
  {
    "hwid": "device hwid 3",           // required. Unique identifier for the third device.
  }]
}

প্রতিক্রিয়া

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

{
  "request_id": "জব স্ট্যাটাস পেতে GET পদ্ধতিতে ব্যবহার করার জন্য request_id",
  "status": "Pending"
}

bulkUnregisterDevice স্ট্যাটাস

আপনি নিম্নলিখিত GET অনুরোধ করে একটি বাল্ক আন-রেজিস্ট্রেশন প্রক্রিয়ার স্ট্যাটাস পরীক্ষা করতে পারেন:

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

প্যারামিটার	টাইপ	প্রয়োজনীয়	বর্ণনা
request_id	string	হ্যাঁ	POST অনুরোধ দ্বারা ফেরত দেওয়া অনুরোধ আইডি।
detailed	boolean	না	যদি `true` তে সেট করা হয়, প্রতিক্রিয়াতে প্রতিটি আনরেজিস্টার করা ডিভাইসের জন্য বিস্তারিত ফলাফল অন্তর্ভুক্ত থাকে।

প্রতিক্রিয়ার উদাহরণ

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