বিষয়বস্তুতে যান

/createMessage প্যারামিটার

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

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

Anchor link to

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

application

Anchor link to

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

Pushwoosh অ্যাপ্লিকেশন কোড কন্ট্রোল প্যানেলের উপরের বাম কোণে প্রদর্শিত হচ্ছে

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

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

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

Pushwoosh কন্ট্রোল প্যানেলে API অ্যাক্সেস সেটিংস পৃষ্ঠা API অ্যাক্সেস টোকেন দেখাচ্ছে

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

API টোকেন জেনারেশন ডায়ালগ অনুমতি এবং অ্যাপ্লিকেশন চেকবক্স সহ

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

String
"content": "Hello world!",

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

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

notifications

Anchor link to

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

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

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

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

Anchor link to

একটি ক্যাম্পেইনের কোড। একটি ক্যাম্পেইন কোড পেতে, StatisticsAggregated 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

Anchor link to

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

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

capping_count

Anchor link to

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

conditions

Anchor link to

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

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

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

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

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

Anchor link to

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

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

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

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

Anchor link to

বৈধ অপারেটর: 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ট্যাগের যেকোনো মান আছে। অপারেন্ড বিবেচনা করা হয় না

তারিখ ট্যাগ

Anchor link to

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

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

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

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

Anchor link to

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

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

তালিকা ট্যাগ

Anchor link to

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

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

conditions_operator

Anchor link to

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

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

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

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

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

dynamic_content

Anchor link to

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

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

Pushwoosh কন্ট্রোল প্যানেলে বা /createFilter API অনুরোধের মাধ্যমে তৈরি করা একটি সেগমেন্ট এর নাম। AudienceSegments বিভাগে যান এবং তৈরি করা সেগমেন্টগুলির তালিকা পরীক্ষা করুন।

Pushwoosh কন্ট্রোল প্যানেলের Audience বিভাগে সেগমেন্ট তালিকা

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

ignore_user_timezone

Anchor link to

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

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

inbox_date

Anchor link to

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

inbox_image

Anchor link to

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

inbox_days

Anchor link to

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

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

message_type

Anchor link to

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

এই প্যারামিটারটি ঐচ্ছিক। যদি বাদ দেওয়া হয়, বার্তাটি ট্রানজ্যাকশনাল হিসাবে বিবেচিত হয় এবং কন্ট্রোল গ্রুপ সহ সবাইকে বিতরণ করা হয়। মার্কেটিং বার্তাগুলি কন্ট্রোল গ্রুপ সদস্যদের কাছে বিতরণ করা হয় না।

Anchor link to

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

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

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

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

Content বিভাগে প্রিসেট তালিকা Preset Code দেখাচ্ছে

rich_media

Anchor link to

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

Content বিভাগে রিচ মিডিয়া পৃষ্ঠা ব্রাউজার URL বারে রিচ মিডিয়া কোড সহ

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

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

template_bindings

Anchor link to

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

transactionId

Anchor link to

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

use_latest_user_device

Anchor link to

যদি true তে সেট করা হয়, তবে প্রতি ডিভাইসে একটির পরিবর্তে প্রতি ব্যবহারকারীকে একটি পুশ সরবরাহ করে: platforms এর প্ল্যাটফর্মগুলির মধ্যে শুধুমাত্র সাম্প্রতিকতম Last Application Open সহ ডিভাইসটি এটি গ্রহণ করে। যদি সেই প্ল্যাটফর্মগুলিতে কোনও ব্যবহারকারীর ডিভাইসে সেই ডেটা না থাকে, তবে প্রথম মিলে যাওয়া ডিভাইসটি এটি পায়, তাই প্রেরণটি কখনও বাদ যায় না। ব্যবহারকারী আইডি ছাড়া ডিভাইসগুলি প্রভাবিত হয় না। শ্রোতাদের কীভাবে লক্ষ্য করা হয়েছিল তা নির্বিশেষে প্রযোজ্য — users, filter, বা conditions দ্বারা। Messaging API v2use_latest_user_device এর মতো একইভাবে কাজ করে। ডিফল্ট false (প্রতিটি ডিভাইসে পাঠান)।

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