/createMessage প্যারামিটারসমূহ

এখানে আপনি /createMessage API প্যারামিটারসমূহের বর্ণনা পাবেন।

• প্রয়োজনীয় প্যারামিটারসমূহ অবশ্যই /createMessage API অনুরোধ সফলভাবে পাঠাতে এবং নির্দিষ্ট সময়ে একটি পুশ নোটিফিকেশন সম্প্রচার করতে অন্তর্ভুক্ত করতে হবে।

• ঐচ্ছিক প্যারামিটারসমূহ আপনাকে পুশ নোটিফিকেশনের বৈশিষ্ট্য কাস্টমাইজ করার সুযোগ দেয়।

নোট

আপনি যদি SMS পাঠাতে /createMessage ব্যবহার করেন, তবে অনুগ্রহ করে SMS পাঠানোর জন্য প্যারামিটারসমূহ দেখুন। অন্যান্য প্যারামিটারসমূহ পাস করা হবে না।

প্রয়োজনীয় প্যারামিটারসমূহ

/createMessage অনুরোধে প্রয়োজনীয় প্যারামিটারসমূহ ব্যবহার করা বাধ্যতামূলক। অন্যথায়, অনুরোধটি জমা দেওয়া হবে না।

application

আপনার Pushwoosh অ্যাকাউন্টে তৈরি করা একটি অ্যাপের অনন্য কোড। অ্যাপ কোড কন্ট্রোল প্যানেলের উপরের বাম কোণে অথবা /createApplication অনুরোধের উত্তরে পাওয়া যাবে। অ্যাপ কোডটি ১০টি অক্ষরের (অক্ষর এবং সংখ্যা উভয়ই) একটি হাইফেন-বিভক্ত সেট।

API-এর মাধ্যমে একটি অ্যাপ তৈরি করার সময়, আপনি আপনার /createApplication অনুরোধের উত্তরে একটি অ্যাপ কোড পাবেন।

API-এর মাধ্যমে পূর্বে তৈরি করা একটি অ্যাপের কোড পেতে, /getApplications কল করুন। /getApplications অনুরোধের উত্তরে, আপনি আপনার Pushwoosh অ্যাকাউন্টে তৈরি করা সমস্ত অ্যাপের তালিকা তাদের নাম এবং কোড সহ পাবেন।

auth

Pushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন। Settings → API Access এ যান এবং আপনি যে টোকেনটি ব্যবহার করতে চান তা কপি করুন বা একটি নতুন তৈরি করুন।

একটি অ্যাক্সেস টোকেন তৈরি করার সময়, তার অনুমতিগুলি নির্দিষ্ট করুন। আপনি যে ধরনের কার্যকলাপের জন্য API টোকেন ব্যবহার করতে যাচ্ছেন তার জন্য চেকবক্সগুলি চেক করুন। আপনি Applications চেকবক্সগুলি চেক করে অ্যাপ-নির্দিষ্ট API টোকেন তৈরি করতে পারেন।

content

স্ট্রিং বা অবজেক্ট যা বার্তার বিষয়বস্তু নির্ধারণ করে। একটি স্ট্রিং টাইপ মান দিয়ে জমা দেওয়া “content” প্যারামিটার সমস্ত প্রাপকদের জন্য একই বার্তা পাঠাবে।

String

"content": "Hello world!",

JSON অবজেক্টগুলি ডাইনামিক কন্টেন্ট ব্যবহার করে বিষয়বস্তু নির্দিষ্ট করার জন্য ব্যবহৃত হয়, উদাহরণস্বরূপ, বহু-ভাষার বার্তাগুলির জন্য।

Object

"content": {
  "en": "Hello!",
  "es": "¡Hola!",
  "de": "Hallo!"
},

notifications

পুশ বৈশিষ্ট্যগুলির JSON অ্যারে। অবশ্যই কমপক্ষে প্রয়োজনীয় content এবং send_date প্যারামিটার অন্তর্ভুক্ত করতে হবে।

“notifications” অ্যারের মধ্যে ব্যবহার করার জন্য ঐচ্ছিক প্যারামিটারসমূহ:

• campaign
• capping_days
• capping_count
• conditions
• data
• devices
• dynamic_content
• filter
• ignore_user_timezone
• inbox_date
• inbox_image
• link
• minimize_link
• message_type
• platforms
• preset
• rich_media
• send_rate
• timezone
• template_bindings
• transactionId
• users

send_date

যে তারিখ এবং সময়ে বার্তাটি পাঠানো হবে। YYYY-MM-DD HH:mm বা ‘now’ হিসাবে ফর্ম্যাট করা যেকোনো তারিখ এবং সময় হতে পারে। যদি ‘now’ সেট করা হয়, অনুরোধ জমা দেওয়ার সাথে সাথে বার্তাটি পাঠানো হবে।

ঐচ্ছিক প্যারামিটারসমূহ

campaign

একটি ক্যাম্পেইনের কোড। একটি ক্যাম্পেইন কোড পেতে, Statistics → Aggregated statistics এ যান এবং আপনি যে ক্যাম্পেইনটি ব্যবহার করতে যাচ্ছেন তা নির্বাচন করুন। ক্যাম্পেইন কোডটি পৃষ্ঠার URL-এর শেষে XXXXX-XXXXX ফর্ম্যাটে দৃশ্যমান হবে।

উদাহরণ:

URL: https://app.pushwoosh.com/applications/AAAAA-AAAAA/statistics/aggregated-message?campaignCode=XXXXX-XXXXX

ক্যাম্পেইন কোড: XXXXX-XXXXX

তাদের কোড সহ ক্যাম্পেইনগুলির একটি তালিকা পেতে, /getCampaigns কল করুন। /getCampaigns অনুরোধের উত্তরে, আপনি আপনার Pushwoosh অ্যাকাউন্টে একটি নির্দিষ্ট অ্যাপের জন্য তৈরি করা সমস্ত ক্যাম্পেইনের তালিকা পাবেন, তাদের কোড, নাম এবং বর্ণনা সহ।

capping_days

ফ্রিকোয়েন্সি ক্যাপিংয়ের জন্য প্রয়োগ করার সময়কাল, দিনে (সর্বোচ্চ ৩০ দিন)। বিস্তারিত জানতে ফ্রিকোয়েন্সি ক্যাপিং দেখুন।

message_type: transactional সহ বার্তাগুলিতে ফ্রিকোয়েন্সি ক্যাপিং প্রয়োগ করা হয় না। অন্যান্য সমস্ত ক্ষেত্রে, ফ্রিকোয়েন্সি ক্যাপিং প্রয়োগ করা হয়, যার মধ্যে message_type বাদ দেওয়া অনুরোধগুলিও অন্তর্ভুক্ত।

capping_count

একটি নির্দিষ্ট অ্যাপ থেকে একটি নির্দিষ্ট ডিভাইসে “capping_days” সময়কালের মধ্যে পাঠানো যেতে পারে এমন পুশের সর্বোচ্চ সংখ্যা। যদি তৈরি করা বার্তাটি একটি ডিভাইসের জন্য “capping_count” সীমা অতিক্রম করে, তবে এটি সেই ডিভাইসে পাঠানো হবে না। বিস্তারিত জানতে ফ্রিকোয়েন্সি ক্যাপিং দেখুন।

conditions

শর্তগুলি হল [tagName, operator, operand] এর মতো অ্যারে যা ট্যাগ এবং তাদের মানের উপর ভিত্তি করে লক্ষ্যযুক্ত বার্তা পাঠানোর জন্য ব্যবহৃত হয়, যেখানে:

• tagName — প্রয়োগ করার জন্য একটি ট্যাগের নাম,
• operator — একটি মান তুলনা অপারেটর (“EQ” | “IN” | “NOTEQ” | “NOTIN” | “LTE” | “GTE” | “BETWEEN” | “NOTSET” | “ANY”),
• operand — নিম্নলিখিত যেকোনো ধরনের ট্যাগের মান: string | integer | array | date | boolean | list

অপারেটরের বর্ণনা

EQ	ট্যাগের মান অপারেন্ডের সমান।
IN	ট্যাগের মান অপারেন্ডের সাথে ছেদ করে (অপারেন্ড অবশ্যই একটি অ্যারে হতে হবে)।
NOTEQ	ট্যাগের মান একটি অপারেন্ডের সমান নয়।
NOTIN	ট্যাগের মান অপারেন্ডের সাথে ছেদ করে না (অপারেন্ড অবশ্যই একটি অ্যারে হতে হবে)।
GTE	ট্যাগের মান অপারেন্ডের চেয়ে বড় বা সমান।
LTE	ট্যাগের মান অপারেন্ডের চেয়ে ছোট বা সমান।
BETWEEN	ট্যাগের মান সর্বনিম্ন অপারেন্ড মানের চেয়ে বড় বা সমান কিন্তু সর্বোচ্চ অপারেন্ড মানের চেয়ে ছোট বা সমান (অপারেন্ড অবশ্যই একটি অ্যারে হতে হবে)।
NOTSET	ট্যাগ সেট করা নেই। অপারেন্ড বিবেচনা করা হয় না।
ANY	ট্যাগের যেকোনো মান আছে। অপারেন্ড বিবেচনা করা হয় না।

স্ট্রিং ট্যাগ

বৈধ অপারেটর: EQ, IN, NOTEQ, NOTIN, NOTSET, ANY

বৈধ অপারেন্ড:

EQ, NOTEQ	অপারেন্ড অবশ্যই একটি স্ট্রিং হতে হবে
IN, NOTIN	অপারেন্ড অবশ্যই ["value 1", "value 2", "value N"] এর মতো স্ট্রিংগুলির একটি অ্যারে হতে হবে
NOTSET	ট্যাগ সেট করা নেই। অপারেন্ড বিবেচনা করা হয় না
ANY	ট্যাগের যেকোনো মান আছে। অপারেন্ড বিবেচনা করা হয় না

ইন্টিজার ট্যাগ

বৈধ অপারেটর: EQ, IN, NOTEQ, NOTIN, BETWEEN, GTE, LTE, NOTSET, ANY

বৈধ অপারেন্ড:

EQ, NOTEQ, GTE, LTE	অপারেন্ড অবশ্যই একটি ইন্টিজার হতে হবে
IN, NOTIN	অপারেন্ড অবশ্যই [value 1, value 2, value N] এর মতো ইন্টিজারগুলির একটি অ্যারে হতে হবে
BETWEEN	অপারেন্ড অবশ্যই [min_value, max_value] এর মতো ইন্টিজারগুলির একটি অ্যারে হতে হবে
NOTSET	ট্যাগ সেট করা নেই। অপারেন্ড বিবেচনা করা হয় না
ANY	ট্যাগের যেকোনো মান আছে। অপারেন্ড বিবেচনা করা হয় না

তারিখ ট্যাগ

বৈধ অপারেটর: EQ, IN, NOTEQ, NOTIN, BETWEEN, GTE, LTE, NOTSET, ANY

বৈধ অপারেন্ড:

• "YYYY-MM-DD 00:00" (স্ট্রিং)
• ইউনিক্স টাইমস্ট্যাম্প 1234567890 (ইন্টিজার)
• "N days ago" (স্ট্রিং) EQ, BETWEEN, GTE, LTE অপারেটরদের জন্য

বুলিয়ান ট্যাগ

বৈধ অপারেটর: EQ, NOTSET, ANY

বৈধ অপারেন্ড: 0, 1, true, false

তালিকা ট্যাগ

বৈধ অপারেটর: IN, NOTIN, NOTSET, ANY

বৈধ অপারেন্ড: অপারেন্ড অবশ্যই ["value 1", "value 2", "value N"] এর মতো স্ট্রিংগুলির একটি অ্যারে হতে হবে।

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

মনে রাখবেন যে “filter” এবং “conditions” প্যারামিটার একসাথে ব্যবহার করা উচিত নয়।
এছাড়াও, “devices” প্যারামিটার একই অনুরোধে ব্যবহার করা হলে উভয়ই উপেক্ষা করা হবে।

দেশ এবং ভাষার ট্যাগ

ভাষার ট্যাগের মান ISO-639-1 অনুযায়ী একটি ছোট হাতের দুই-অক্ষরের কোড। দেশের ট্যাগের মান ISO_3166-2 অনুযায়ী একটি বড় হাতের দুই-অক্ষরের কোড।

উদাহরণস্বরূপ, ব্রাজিলের পর্তুগিজ-ভাষী গ্রাহকদের কাছে একটি পুশ নোটিফিকেশন পাঠাতে, আপনাকে নিম্নলিখিত শর্তটি নির্দিষ্ট করতে হবে: "conditions": [["Country", "EQ", "BR"],["Language", "EQ", "pt"]]

conditions_operator

শর্ত অ্যারেগুলির জন্য লজিক্যাল অপারেটর। সম্ভাব্য মান: AND | OR। AND ডিফল্ট।

যদি প্রয়োগ করা অপারেটরটি AND হয় (যখন কোনো অপারেটর নির্দিষ্ট করা না থাকে, বা ‘conditions_operator’ প্যারামিটারের মান ‘AND’ থাকে), তবে একই সাথে সমস্ত শর্ত মেনে চলা ডিভাইসগুলি পুশ নোটিফিকেশন পাবে।

যদি অপারেটরটি OR হয়, তবে নির্দিষ্ট করা যেকোনো শর্ত মেনে চলা ডিভাইসগুলি বার্তাটি পাবে।

data

পুশ পেলোডে যেকোনো কাস্টম ডেটা পাস করার জন্য ব্যবহৃত JSON স্ট্রিং বা JSON অবজেক্ট; পেলোডে “u” প্যারামিটার হিসাবে পাস করা হয় (JSON স্ট্রিং-এ রূপান্তরিত)।

devices

লক্ষ্যযুক্ত পুশ নোটিফিকেশন পাঠানোর জন্য পুশ টোকেন বা hwids এর অ্যারে। যদি সেট করা থাকে, বার্তাটি শুধুমাত্র তালিকার ডিভাইসগুলিতে পাঠানো হবে।

dynamic_content

ডিভাইস ট্যাগ মানের পরিবর্তে ব্যবহার করার জন্য ডাইনামিক কন্টেন্ট এর জন্য প্লেসহোল্ডার। নীচের উদাহরণটি আপনার লক্ষ্য করা প্রতিটি ব্যবহারকারীকে “Hello, John!” বার্তা পাঠাবে। যদি সেট করা না থাকে, ডাইনামিক কন্টেন্ট মানগুলি ডিভাইস ট্যাগ থেকে নেওয়া হয়।

"content": "Hello, {firstname|CapitalizeFirst}!",
"dynamic_content_placeholders": {
  "firstname": "John",
  "lastname": "Doe"
},

filter

Pushwoosh কন্ট্রোল প্যানেলে বা /createFilter API অনুরোধের মাধ্যমে তৈরি করা একটি সেগমেন্ট এর নাম ঠিক যেমনটি তৈরি করা হয়েছে। Audience → Segments বিভাগে যান এবং তৈরি করা সেগমেন্টগুলির তালিকা পরীক্ষা করুন।

API এর মাধ্যমে সেগমেন্ট তালিকা পেতে, /listFilters API পদ্ধতি কল করুন। /listFilters অনুরোধের উত্তরে, আপনি আপনার Pushwoosh অ্যাকাউন্টে তৈরি করা সমস্ত সেগমেন্টের তালিকা পাবেন, সেগমেন্টের নাম, শর্ত এবং মেয়াদ শেষ হওয়ার তারিখ সহ।

ignore_user_timezone

যদি ‘true’ তে সেট করা হয়, তবে UTC-0 অনুযায়ী “send_date” প্যারামিটারে নির্দিষ্ট করা সময় এবং তারিখে বার্তা পাঠায়।

যদি ‘false’ তে সেট করা হয়, ব্যবহারকারীরা তাদের ডিভাইসের সেটিংস অনুযায়ী নির্দিষ্ট স্থানীয় সময়ে বার্তাটি পাবেন।

inbox_date

যে তারিখ পর্যন্ত বার্তাটি ব্যবহারকারীদের ইনবক্সে রাখা উচিত। যদি নির্দিষ্ট করা না থাকে, বার্তাটি পাঠানোর তারিখের পরের দিন ইনবক্স থেকে সরানো হবে।

নোট

বার্তাটি ইনবক্সে সংরক্ষণ করতে, কমপক্ষে একটি ‘inbox’ প্যারামিটার ব্যবহার করুন: “inbox_date” বা “inbox_image”।

সতর্কতা

নির্দিষ্ট তারিখের 00:00:01 এ বার্তাটি ইনবক্স থেকে সরানো হবে, তাই আগের তারিখটি হল শেষ দিন যখন একজন ব্যবহারকারী তাদের ইনবক্সে বার্তাটি দেখতে পারেন।

inbox_image

ইনবক্সে বার্তার পাশে দেখানোর জন্য কাস্টম ছবির URL।

নোট

বার্তাটি ইনবক্সে সংরক্ষণ করতে, কমপক্ষে একটি ‘inbox’ প্যারামিটার ব্যবহার করুন: “inbox_date” বা “inbox_image”।

inbox_days

একটি ইনবক্স বার্তার জীবনকাল দিনে, ৩০ দিন পর্যন্ত। এই সময়ের পরে, বার্তাটি ইনবক্স থেকে সরানো হবে। inbox_date প্যারামিটারের পরিবর্তে ব্যবহার করা যেতে পারে।

link

একজন ব্যবহারকারী একটি পুশ নোটিফিকেশন খুললে যে URLটি খোলা হবে।

message_type

পুশ বার্তার ধরন নির্দিষ্ট করে। উপলব্ধ মানগুলি হল marketing এবং transactional। বিস্তারিত জানতে মার্কেটিং বনাম ট্রানজাকশনাল বার্তা দেখুন।

এই প্যারামিটারটি ঐচ্ছিক। যদি বাদ দেওয়া হয়, PW_ControlGroup: true সহ ব্যবহারকারীরা বার্তাটি পাবেন না।

minimize_link

“link” প্যারামিটারে জমা দেওয়া URLটি ছোট করার জন্য শর্টনার। দয়া করে মনে রাখবেন যে পুশ নোটিফিকেশন পেলোডের আকার সীমিত, তাই সীমা অতিক্রম না করার জন্য ছোট URL তৈরি করার কথা বিবেচনা করুন। উপলব্ধ মান: 0 — ছোট করবেন না, 2 — bitly। ডিফল্ট = 2। Google URL শর্টনার মার্চ 30, 2019 থেকে নিষ্ক্রিয় করা হয়েছে।

platforms

শুধুমাত্র নির্দিষ্ট প্ল্যাটফর্মে বার্তা পাঠানোর জন্য প্ল্যাটফর্ম কোডের অ্যারে।

উপলব্ধ প্ল্যাটফর্ম কোডগুলির মধ্যে রয়েছে: 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।

preset

Pushwoosh কন্ট্রোল প্যানেলে বা API এর মাধ্যমে তৈরি করা একটি প্রিসেট এর কোড। একটি প্রিসেট কোড পেতে, Content → Presets এ যান, আপনি যে প্রিসেটটি ব্যবহার করতে যাচ্ছেন তা প্রসারিত করুন এবং প্রিসেটের বিবরণ থেকে Preset Code কপি করুন।

rich_media

আপনি আপনার বার্তার সাথে সংযুক্ত করতে যাচ্ছেন এমন একটি রিচ মিডিয়া পৃষ্ঠার কোড। একটি কোড পেতে, Content → Rich Media এ যান, আপনি যে রিচ মিডিয়া পৃষ্ঠাটি ব্যবহার করতে যাচ্ছেন তা খুলুন এবং আপনার ব্রাউজারের URL বার থেকে কোডটি কপি করুন। কোডটি ১০টি অক্ষরের (অক্ষর এবং সংখ্যা উভয়ই) একটি হাইফেন-বিভক্ত সেট।

send_rate

পুশ পাঠানোর গতি সীমাবদ্ধ করার জন্য থ্রটলিং। বৈধ মানগুলি 100 থেকে 1000 পুশ/সেকেন্ড পর্যন্ত।

timezone

বার্তাটি একটি নির্দিষ্ট তারিখ এবং সময়ে পাঠানোর সময় যে টাইমজোনটি বিবেচনা করা হবে। যদি সেট করা থাকে, ডিভাইসের টাইমজোন উপেক্ষা করা হয়। যদি উপেক্ষা করা হয়, বার্তাটি UTC-তে পাঠানো হয়। সমর্থিত টাইমজোনগুলির জন্য https://php.net/manual/timezones.php দেখুন।

template_bindings

আপনার কন্টেন্ট টেমপ্লেটে ব্যবহার করার জন্য টেমপ্লেট প্লেসহোল্ডার। বিস্তারিত জানতে লিকুইড টেমপ্লেট গাইড দেখুন।

transactionId

নেটওয়ার্ক সমস্যার ক্ষেত্রে বার্তাগুলির নকল হওয়া রোধ করতে অনন্য বার্তা শনাক্তকারী। আপনি /createMessage বা /createTargetedMessage অনুরোধের মাধ্যমে তৈরি করা একটি বার্তাকে যেকোনো ID বরাদ্দ করতে পারেন। Pushwoosh-এর দিকে ৫ মিনিটের জন্য সংরক্ষণ করা হয়।

users

userIds এর অ্যারে। User ID হল একটি অনন্য ব্যবহারকারী শনাক্তকারী যা একটি /registerUser, /registerDevice, বা /registerEmail API অনুরোধ দ্বারা সেট করা হয়।