বিষয়বস্তুতে যান
ব্যবহারকারী গাইডসাপোর্ট ডেমো অনুরোধ করুন সাইন ইন করুন
Pushwoosh.com

ডিভাইস API

registerDevice

Anchor link to

POST https://api.pushwoosh.com/json/1.3/registerDevice

SDK থেকে অভ্যন্তরীণভাবে কল করা হয়। অ্যাপ্লিকেশনের জন্য ডিভাইস রেজিস্টার করে।

অনুরোধের হেডার
Anchor link to
নামপ্রয়োজনীয়মানবিবরণ
Authorizationহ্যাঁToken XXXXডিভাইস API অ্যাক্সেস করার জন্য API ডিভাইস টোকেন। XXXX কে আপনার আসল ডিভাইস API টোকেন দিয়ে প্রতিস্থাপন করুন।
অনুরোধের বডি
Anchor link to
নামটাইপবিবরণ
application*stringPushwoosh অ্যাপ্লিকেশন কোড
push_tokenstringডিভাইসের জন্য পুশ টোকেন।
languagestringডিভাইসের ভাষা লোকেল। এটি ISO-639-1 স্ট্যান্ডার্ড অনুযায়ী একটি ছোট হাতের দুই-অক্ষরের কোড হতে হবে।
hwid*stringডিভাইস শনাক্ত করার জন্য ইউনিক স্ট্রিং (iOS-এ IDFV, Android-এ র‍্যান্ডমভাবে জেনারেট করা মান)। আরও জানুন
timezoneintegerডিভাইসের জন্য সেকেন্ডে টাইমজোন অফসেট।
device_type*integerডিভাইসের প্রকার। নিচে সম্ভাব্য মান দেখুন।
emailstringরেজিস্টার করার জন্য ইমেল ঠিকানা (HWID এবং পুশ টোকেনের পরিবর্তে ইমেল ব্যবহারকারীদের জন্য ব্যবহার করুন)।
tagsobjectরেজিস্টার করা ডিভাইসে অ্যাসাইন করার জন্য ট্যাগের মান।
{
  "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
  • 14 – Email
  • 17 – Huawei
  • 18 – SMS
  • 21 – WhatsApp

ইমেল ডিভাইস রেজিস্টার করা

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
    }
  }
}

WhatsApp ডিভাইস রেজিস্টার করা

Anchor link to

আপনার অ্যাপের জন্য একটি WhatsApp ডিভাইস রেজিস্টার করতে, এই নির্দেশিকাগুলি অনুসরণ করুন:

  • hwid: নিশ্চিত করুন যে এই ফিল্ডে whatsapp: উপসর্গ এবং তারপরে E.164 ফরম্যাটে ফোন নম্বর রয়েছে (যেমন, whatsapp:+0000000000)। ফোন নম্বরটি অবশ্যই বৈধ হতে হবে, যা Pushwoosh যাচাই করবে।

  • Push token: একটি পুশ টোকেন প্রয়োজন নেই, কারণ hwid স্বয়ংক্রিয়ভাবে পুশ টোকেন হিসাবে কাজ করবে।

  • device_type: WhatsApp কে প্ল্যাটফর্ম হিসাবে নির্দিষ্ট করতে এই ফিল্ডটি 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
  }
}

SMS ডিভাইস রেজিস্টার করা

Anchor link to

আপনার অ্যাপের জন্য একটি SMS ডিভাইস রেজিস্টার করতে, এই নির্দেশিকাগুলি অনুসরণ করুন:

  • hwid: নিশ্চিত করুন যে এই ফিল্ডে E.164 ফরম্যাটে ফোন নম্বর রয়েছে (যেমন, +0000000000)। ফোন নম্বরটি অবশ্যই বৈধ হতে হবে, যা Pushwoosh যাচাই করবে।

  • Push token: একটি পুশ টোকেন প্রয়োজন নেই, কারণ hwid স্বয়ংক্রিয়ভাবে পুশ টোকেন হিসাবে কাজ করবে।

  • device_type: SMS কে প্ল্যাটফর্ম হিসাবে নির্দিষ্ট করতে এই প্রয়োজনীয় ফিল্ডটি 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বিবরণ
200200ডিভাইস সফলভাবে রেজিস্টার করা হয়েছে
200210আর্গুমেন্ট ত্রুটি। আরও তথ্যের জন্য status_message দেখুন।
400N/Aত্রুটিপূর্ণ অনুরোধ স্ট্রিং
500500অভ্যন্তরীণ ত্রুটি

unregisterDevice

Anchor link to

POST https://api.pushwoosh.com/json/1.3/unregisterDevice

ডিভাইসের পুশ টোকেন সরিয়ে দেয়। আনরেজিস্টার করা ডিভাইসটি এখনও মোট ডিভাইসের মধ্যে গণনা করা হয় এবং ইন-অ্যাপস দিয়ে পৌঁছানো যায়। SDK থেকে অভ্যন্তরীণভাবে কল করা হয়।

অনুরোধের হেডার
Anchor link to
নামপ্রয়োজনীয়মানবিবরণ
Authorizationহ্যাঁToken XXXXডিভাইস API অ্যাক্সেস করার জন্য API ডিভাইস টোকেন। XXXX কে আপনার আসল ডিভাইস API টোকেন দিয়ে প্রতিস্থাপন করুন।
অনুরোধের বডি
Anchor link to
নামটাইপবিবরণ
application*stringPushwoosh অ্যাপ্লিকেশন কোড
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বিবরণ
200200ডিভাইস সফলভাবে আনসাবস্ক্রাইব করা হয়েছে
200210আর্গুমেন্ট ত্রুটি। আরও তথ্যের জন্য status_message দেখুন।
400N/Aত্রুটিপূর্ণ অনুরোধ স্ট্রিং
500500অভ্যন্তরীণ ত্রুটি

setTags

Anchor link to

POST https://api.pushwoosh.com/json/1.3/setTags

ডিভাইসের জন্য ট্যাগের মান সেট করে। SDK থেকে কল করা হয়।

অনুরোধের হেডার
Anchor link to
নামপ্রয়োজনীয়মানবিবরণ
Authorizationহ্যাঁToken XXXXডিভাইস API অ্যাক্সেস করার জন্য API ডিভাইস টোকেন। XXXX কে আপনার আসল ডিভাইস API টোকেন দিয়ে প্রতিস্থাপন করুন।
অনুরোধের বডি
Anchor link to
নামটাইপবিবরণ
application*stringPushwoosh অ্যাপ্লিকেশন কোড
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
    }
  }
}

Integer ট্যাগের মান বৃদ্ধি করা

Anchor link to

Integer ট্যাগের মান বৃদ্ধি করতে, operation প্যারামিটারটি “increment” মান সহ ব্যবহার করুন:

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

Integer ট্যাগের মান হ্রাস করা

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
      }
    }
  }
}

List ট্যাগের মান যুক্ত করা

Anchor link to

নতুন মান দিয়ে List ট্যাগ প্রসারিত করতে, operation প্যারামিটারটি “append” মান সহ ব্যবহার করুন:

উদাহরণ
{
  "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"
        ]
      }
    }
  }
}

List ট্যাগের মান অপসারণ করা

Anchor link to

List ট্যাগ থেকে কিছু মান অপসারণ করতে, “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বিবরণ
200200ট্যাগ সফলভাবে সেট করা হয়েছে
200210আর্গুমেন্ট ত্রুটি। আরও তথ্যের জন্য status_message দেখুন।
400N/Aত্রুটিপূর্ণ অনুরোধ স্ট্রিং
500500অভ্যন্তরীণ ত্রুটি

getTags

Anchor link to

POST https://api.pushwoosh.com/json/1.3/getTags

নির্দিষ্ট ডিভাইসের জন্য সংশ্লিষ্ট মান সহ ট্যাগের একটি তালিকা পুনরুদ্ধার করে।

অনুরোধের হেডার
Anchor link to
নামপ্রয়োজনীয়মানবিবরণ
Authorizationহ্যাঁToken XXXXডিভাইস API অ্যাক্সেস করার জন্য API ডিভাইস টোকেন। XXXX কে আপনার আসল ডিভাইস API টোকেন দিয়ে প্রতিস্থাপন করুন।
অনুরোধের বডি
Anchor link to
নামটাইপবিবরণ
application*stringPushwoosh অ্যাপ্লিকেশন কোড
userIdstringUser ID যা “hwid” এর পরিবর্তে ব্যবহার করা হবে। যদি “hwid” এর সাথে একসাথে ব্যবহার করা হয়, তবে “hwid” প্রাধান্য পাবে।
hwidstring/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 to

POST https://api.pushwoosh.com/json/1.3/setBadge

Pushwoosh-এ একটি ডিভাইসের জন্য বর্তমান ব্যাজের মান পাঠায়। SDK থেকে অভ্যন্তরীণভাবে কল করা হয়।

অনুরোধের হেডার
Anchor link to
নামপ্রয়োজনীয়মানবিবরণ
Authorizationহ্যাঁToken XXXXডিভাইস API অ্যাক্সেস করার জন্য API ডিভাইস টোকেন। XXXX কে আপনার আসল ডিভাইস API টোকেন দিয়ে প্রতিস্থাপন করুন।
অনুরোধের বডি
Anchor link to
নামটাইপবিবরণ
application*stringPushwoosh অ্যাপ্লিকেশন কোড
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 to

POST https://api.pushwoosh.com/json/1.3/applicationOpen

একটি অ্যাপ খোলার ইভেন্ট রেজিস্টার করে। SDK থেকে অভ্যন্তরীণভাবে কল করা হয়।

অনুরোধের হেডার
Anchor link to
নামপ্রয়োজনীয়মানবিবরণ
Authorizationহ্যাঁToken XXXXডিভাইস API অ্যাক্সেস করার জন্য API ডিভাইস টোকেন। XXXX কে আপনার আসল ডিভাইস API টোকেন দিয়ে প্রতিস্থাপন করুন।
অনুরোধের বডি
Anchor link to
নামটাইপবিবরণ
application*stringPushwoosh অ্যাপ্লিকেশন কোড
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 to

POST https://api.pushwoosh.com/json/1.3/pushStat

একটি পুশ খোলার ইভেন্ট রেজিস্টার করে। SDK থেকে অভ্যন্তরীণভাবে কল করা হয়।

অনুরোধের হেডার
Anchor link to
নামপ্রয়োজনীয়মানবিবরণ
Authorizationহ্যাঁToken XXXXডিভাইস API অ্যাক্সেস করার জন্য API ডিভাইস টোকেন। XXXX কে আপনার আসল ডিভাইস API টোকেন দিয়ে প্রতিস্থাপন করুন।
অনুরোধের বডি
Anchor link to
নামটাইপবিবরণ
application*stringPushwoosh অ্যাপ্লিকেশন কোড
hwid*string/registerDevice অনুরোধে ব্যবহৃত হার্ডওয়্যার ডিভাইস আইডি।
userIdstringপুশ খোলার ইভেন্টের সাথে যুক্ত করার জন্য User ID।
hashstringপুশ বিজ্ঞপ্তিতে প্রাপ্ত হ্যাশ ট্যাগ (পুশ পেলোডের “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 to

POST https://api.pushwoosh.com/json/1.3/messageDeliveryEvent

ডিভাইসের জন্য পুশ ডেলিভারি ইভেন্ট রেজিস্টার করে। SDK থেকে অভ্যন্তরীণভাবে কল করা হয়।

অনুরোধের হেডার
Anchor link to
নামপ্রয়োজনীয়মানবিবরণ
Authorizationহ্যাঁToken XXXXডিভাইস API অ্যাক্সেস করার জন্য API ডিভাইস টোকেন। XXXX কে আপনার আসল ডিভাইস API টোকেন দিয়ে প্রতিস্থাপন করুন।
অনুরোধের বডি
Anchor link to
নামটাইপবিবরণ
application*stringPushwoosh অ্যাপ্লিকেশন কোড
hwid*string/registerDevice অনুরোধে ব্যবহৃত হার্ডওয়্যার ডিভাইস আইডি।
hashstringপুশ বিজ্ঞপ্তিতে প্রাপ্ত হ্যাশ ট্যাগ (পুশ পেলোডের “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)
  }
}