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

ব্যবহারকারী কেন্দ্রিক API

registerUser

Anchor link to

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

একটি নির্দিষ্ট ডিভাইসের সাথে বাহ্যিক User ID যুক্ত করে।

অনুরোধের হেডার

Anchor link to
নামপ্রয়োজনীয়মানবিবরণ
Authorizationহ্যাঁToken XXXXডিভাইস API অ্যাক্সেস করার জন্য API ডিভাইস টোকেনXXXX কে আপনার আসল ডিভাইস API টোকেন দিয়ে প্রতিস্থাপন করুন।

অনুরোধের বডি

Anchor link to
নামপ্রয়োজনীয়টাইপবিবরণ
userIdনাstringএকটি ডিভাইসের সাথে যুক্ত করার জন্য User ID। যদি খালি থাকে, hwid ব্যবহার করুন।
applicationহ্যাঁstringPushwoosh অ্যাপ্লিকেশন কোড
hwidহ্যাঁstringPushwoosh HWID
tz_offsetনাintegerডিভাইসের জন্য সেকেন্ডে টাইমজোন অফসেট।
device_typeনাintegerডিভাইসের প্রকার/registerDevice এ সম্ভাব্য মানগুলি দেখুন।

পরে /createMessage API কলে (users প্যারামিটারে) ব্যবহার করা যেতে পারে। পুশ টোকেন পাওয়ার আগে এবং /registerDevice কল করার আগে আপনি এই ফাংশনটি কল করতে পারেন।

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

Anchor link to
{
"request": {
"userId": "user_3078a", // optional. If empty, use hwid
"application": "XXXXX-XXXXX", // required. Pushwoosh application code
"hwid": "8f65b16df378e7a6bece9614e1530fb2", // required. Hardware device ID
"tz_offset": -3600, // optional. Timezone offset in seconds
"device_type": 3 // optional. Device type, see /registerDevice
// for device types
}
}

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

Anchor link to
{
"status_code": 200,
"status_message": "OK",
"response": null
}

deleteUser

Anchor link to

POST https://api.pushwoosh.com/api/v2/device-api/deleteUser

অ্যাপ্লিকেশনের মধ্যে নির্দিষ্ট User ID এর সাথে যুক্ত একজন ব্যবহারকারী এবং সমস্ত ডিভাইস মুছে ফেলে। অনুরোধটি অ্যাসিঙ্ক্রোনাসভাবে প্রক্রিয়া করা হয়, এবং ডিলিট অনুরোধ প্রক্রিয়াকরণের জন্য গৃহীত হওয়ার সাথে সাথে এন্ডপয়েন্ট 200 OK ফেরত দেয়।

অনুরোধের হেডার

Anchor link to
নামপ্রয়োজনীয়মানবিবরণ
Authorizationহ্যাঁToken XXXXডিভাইস API অ্যাক্সেস করার জন্য API ডিভাইস টোকেনXXXX কে আপনার আসল ডিভাইস API টোকেন দিয়ে প্রতিস্থাপন করুন।
Content-Typeহ্যাঁapplication/json

অনুরোধের বডি

Anchor link to
নামপ্রয়োজনীয়টাইপবিবরণ
applicationহ্যাঁstringPushwoosh অ্যাপ্লিকেশন কোড
user_idহ্যাঁstringমুছে ফেলার জন্য User ID। নির্দিষ্ট অ্যাপ্লিকেশনে এই ব্যবহারকারীর সাথে যুক্ত সমস্ত ডিভাইস মুছে ফেলা হবে।

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

Anchor link to
{
"application": "XXXXX-XXXXX", // required. Pushwoosh application code
"user_id": "user_3078a" // required. User ID to delete
}

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

Anchor link to
{
"status_code": 200,
"status_message": "OK",
"response": null
}
স্ট্যাটাস কোড
Anchor link to
HTTP স্ট্যাটাস কোডstatus_codeবিবরণ
200200ডিলিট অনুরোধ গৃহীত হয়েছে
200210আর্গুমেন্ট ত্রুটি। আরও তথ্যের জন্য status_message দেখুন।
400N/Aত্রুটিপূর্ণ অনুরোধ স্ট্রিং
401N/Aঅনুপস্থিত বা অবৈধ Authorization টোকেন
500500অভ্যন্তরীণ ত্রুটি

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

একটি ইভেন্ট ট্রিগার করে।

অনুরোধের হেডার

Anchor link to
নামপ্রয়োজনীয়মানবিবরণ
Authorizationহ্যাঁToken XXXXডিভাইস API অ্যাক্সেস করার জন্য API ডিভাইস টোকেনXXXX কে আপনার আসল ডিভাইস API টোকেন দিয়ে প্রতিস্থাপন করুন।

অনুরোধের বডি

Anchor link to
নামপ্রয়োজনীয়টাইপবিবরণ
hwidহ্যাঁstring/registerDevice অনুরোধে ব্যবহৃত হার্ডওয়্যার ডিভাইস আইডি। ইভেন্ট ট্রিগারকারী ব্যবহারকারীকে শনাক্ত করতে ‘userId’ এর সাথে ব্যবহার করা যেতে পারে।
applicationহ্যাঁstringPushwoosh অ্যাপ্লিকেশন কোড
eventহ্যাঁstringPushwoosh কন্ট্রোল প্যানেলে তৈরি করা ইভেন্টের নাম হুবহু একই হতে হবে।
attributesহ্যাঁobjectইভেন্ট অ্যাট্রিবিউট সহ JSON অবজেক্ট। যদি কোনো অ্যাট্রিবিউট পাস করার প্রয়োজন না হয় তবে এটি খালি রাখুন।
timestampUTCনাintegerUTC-তে টাইমস্ট্যাম্প।
timestampCurrentনাintegerস্থানীয় সময়ে টাইমস্ট্যাম্প।
userIdহ্যাঁstringইভেন্ট ট্রিগারকারী ব্যবহারকারীর সাথে যুক্ত User ID। এটি HWID দ্বারা প্রতিস্থাপিত হতে পারে বা এর সাথে ব্যবহার করা যেতে পারে।
device_typeনাintegerসম্ভাব্য মানগুলি দেখুন

অনুরোধে ইভেন্টের নাম অবশ্যই Pushwoosh কন্ট্রোল প্যানেলের ইভেন্টের নামের সাথে মিলতে হবে। মনে রাখবেন, যদি ইভেন্টের কোনো অ্যাট্রিবিউট না থাকে তবে “attributes” প্রপার্টি খালি হতে পারে (কিন্তু বাদ দেওয়া যাবে না)।

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

Anchor link to
{
"request":{
"hwid": "8f65b16df378e7a6bece9614e1530fb2", // required. Hardware device ID used in a /registerDevice API.
// Can be used along with an userId to identify a
// user who has triggered an event.
"application": "XXXXX-XXXXX", // required. Pushwoosh application code
"event": "activityCompleted", // required. Event name exactly as created in Pushwoosh Control Panel
"attributes": { // required. Leave empty if no attributes need to be passed.
"login": "facebook",
"success": "yes",
"internet": "wifi"
},
"timestampUTC": 1435228403, // optional. Timestamp in UTC
"timestampCurrent": 1435253603, // optional. Timestamp in local time
"userId": "someuser@user.com", // required. A user id which is used for identification of
// users on multiple devices. Can be replaced by
// or used along with an HWID.
"device_type": 1 // optional.
}
}

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

Anchor link to
{
"status_code": 200,
"status_message": "OK",
"response": {
"code": "61BC9-84DD0"
}
}

রূপান্তর ইভেন্ট পাঠানো

Anchor link to

সরাসরি আয় রিপোর্ট করার জন্য, একটি বিদ্যমান ইভেন্ট ম্যাপ করার পরিবর্তে, ইভেন্টের নাম হিসাবে PW_Conversion এবং attributes-এ লেনদেনের value এবং currency সহ postEvent পাঠান:

{
"request":{
"hwid": "8f65b16df378e7a6bece9614e1530fb2",
"application": "XXXXX-XXXXX",
"event": "PW_Conversion",
"attributes": {
"value": 49.99, // required. Transaction amount
"currency": "USD", // required. ISO 4217 currency code
"transaction_id": "txn_8f21", // optional. Your own transaction reference
"product_id": "prod_premium" // optional
},
"userId": "someuser@user.com"
}
}