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

মেসেজ এপিআই

createMessage অবচিত

Anchor link to

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

একটি নতুন পুশ নোটিফিকেশন তৈরি করে।

অনুরোধের বডি

Anchor link to
নামটাইপবিবরণ
auth*stringPushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন।
application*stringPushwoosh অ্যাপ্লিকেশন কোড
notifications*arrayমেসেজ প্যারামিটারের JSON অ্যারে। নিচে একটি অনুরোধের উদাহরণে বিস্তারিত দেখুন।
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "Messages": [
      "C3F8-C3863ED4-334AD4F1"
    ]
  }
}

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

Anchor link to
উদাহরণ
{
  "request": {
    "application": "XXXXX-XXXXX",       // required. Pushwoosh application code.
    "auth": "yxoPUlwqm…………pIyEX4H",     // required. API access token from Pushwoosh Control Panel.
    "notifications": [{
      "send_date": "now",               // optional. YYYY-MM-DD HH:mm OR 'now'
      "content": {                      // optional. object OR string.
        "en": "English",                //           Use "wns_content" instead for Windows.
        "fr": "French"
      },
      "title": {                        // optional. object OR string.
        "en": "Title",                  //           Ignored if platform-specific titles are specified
        "fr": "Titre"                   //           'ios_title', 'android_header', etc.
      },                                //           see the platform-specific parameters examples below.
      "subtitle":{                      // optional. object OR string.
        "en": "Subtitle",               //           Ignored if platform-specific titles are specified
        "fr": "Sous-titre"              //           'ios_subtitle', etc.
      },                                //           see the platform-specific parameters examples below.
      "ignore_user_timezone": true,     // optional.
      "timezone": "America/New_York",   // optional. If ignored UTC-0 is default for "send_date".
                                        //           See https://php.net/manual/timezones.php for
                                        //           supported timezones.
      "campaign": "CAMPAIGN_CODE",      // optional. Campaign code to which you want to
                                        //           assign this push message.
      "geozone": {                      // optional. Send to Geozone
        "lat": 22.22,
        "lng": 33.33,
        "range": 110
      },
      "rich_media": "XXXXX-XXXXX",      // optional. Copy the Rich Media code from the URL bar of
                                        //           the Rich Media editor page in Pushwoosh Control Panel.
      "link": "https://google.com",     // optional. For deeplinks add "minimize_link": 0
      "minimize_link": 0,               // optional. 0 — do not minimize, 2 — bitly. Default = 2.
                                        //           Please note that shorteners have restrictions
                                        //           on a number of calls.
      "data": {                         // optional. JSON string or JSON object, will be passed as
        "key": "value"                  //           "u" parameter in the payload (converted to JSON string).
      },
      "transactionId": "unique UUID",   // optional. Unique message identifier to prevent duplicating
                                        //           in case of network problems. Stored on the side of
                                        //           Pushwoosh for 5 minutes.
      "platforms": [                    // optional. 1 — iOS; 3 — Android; 7 — Mac OS X; 8 — Windows;
        1, 3, 7, 8, 9, 10,              //           9 — Amazon; 10 — Safari; 11 — Chrome;
        11, 12, 17                      //           12 — Firefox; 17 — Huawei
      ],
      "preset": "XXXXX-XXXXX",          // optional. Push Preset Code from your Control Panel.
                                        //           If specific params are sent in the request,
                                        //           they override preset's params.
      "send_rate": 100,                 // optional. Throttling. Valid values are from 100 to 1000 pushes/second.
      "send_rate_avoid": true,          // optional. If set to true, throttling limit will not be applied to
                                        //           this specific push notification.
      // Templating related, please refer to the Template Engine guide to learn more
      "template_bindings": {            // optional.
        "TemplatePlaceholder": "Value"
      },
      "dynamic_content_placeholders": { // optional. Placeholders for dynamic content instead of device tags.
        "firstname": "John",
        "lastname": "Doe"
      },
      "message_type": "marketing",       // optional. "marketing" or "transactional".
                                         // If omitted, users with PW_ControlGroup: true will not receive the message.


      // Frequency capping params. Ensure that Global frequency capping is configured in the Control Panel.
      // Frequency capping does not apply to transactional messages.
      // In all other cases, including omitted "message_type", frequency capping applies.
      "capping_days": 30,               // optional. Amount of days for frequency capping (max 30 days)
      "capping_count": 10,              // optional. The max number of pushes that can be sent from a
                                        //           specific app to a particular device within a 'capping_days'
                                        //           period. In case the message created exceeds the
                                        //           'capping_count' limit for a device, it won't
                                        //           be sent to that device.
      "capping_exclude": true,          // optional. If set to true, this push notification will not
                                        //           be counted towards the capping for future pushes.
      "capping_avoid": true,            // optional. If set to true, capping will not be applied to
                                        //           this specific push notification.


      // To save the message to the Inbox via API, use "inbox_date" or "inbox_image".
      // The message is saved when at least one of these parameters is used.
      "inbox_date": "2017-02-02",       // optional. Specify when to remove a message from the Inbox.
                                        //           Message will be removed from Inbox at 00:00:01 UTC
                                        //           of the date specified, so the previous date is the
                                        //           last day a user can see the message in their Inbox.
                                        //           If not specified, the default removal date is the
                                        //           next day after the send date.
      "inbox_image": "Inbox image URL", // optional. The image to be shown near the message.
    "inbox_days": 5,                  // optional. Specify when to remove a message from the
                                        //           Inbox(lifetime of an inbox message in days).
                                        //           Can be used instead of the "inbox_date" parameter.
                                        //           Up to 30 days.


      "devices": [                      // optional. Specify tokens or hwids to send targeted push
          "hwid_XXXX"                   //           notifications. Not more than 1000 tokens/hwids in
      ],                                //           an array. If set, the message will only be sent to
                                        //           the devices on the list. Application Group for devices
                                        //           list is not allowed. iOS push tokens can only be lower case.
      "to": [                           // optional. For email, SMS, and similar channels. List of recipients
          "email_1", "email_2"          //           (e.g. email addresses, phone numbers). Max 1000 items.
      ],                                //           For push, use "devices" instead.
      // User-centric push notifications
      "users": [                        // optional. If set, message will only be delivered to the
          "user_XXXX"                   //           specified user ID's (set via /registerUser call).
      ],                                //           If specified together with devices or to,
                                        //           the latter will be ignored. Not more than 1000 user
                                        //           ID's in an array. Application Group for users list
                                        //           is not allowed.


      // Filters and conditions
      "filter": "FILTER_NAME",          // optional.
      "conditions": [                   // optional. See the remark below.
        ["Country", "EQ", "fr"],
        ["Language", "EQ", "en"]
      ],
      "conditions_operator": "AND"      // optional. Logical operator for conditions arrays.
                                        //           Possible values: AND | OR. AND is default.
    }]
  }
}

VoIP নোটিফিকেশন অনুরোধের উদাহরণ

Anchor link to

Pushwoosh iOS এবং Android এর জন্য VoIP-স্টাইলের কল নোটিফিকেশন সমর্থন করে।
নিচে আপনি প্রতিটি প্ল্যাটফর্মের জন্য উদাহরণ API createMessage অনুরোধ খুঁজে পেতে পারেন।

iOS

Anchor link to
উদাহরণ
{
  "request": {
    "application": "XXXXX-XXXXX",     // required. Pushwoosh application code.
    "auth": "yxoPUlwqm…………pIyEX4H",   // required. API access token from Pushwoosh Control Panel.
    "notifications": [
      {
        "voip_push": true,            // required. Parameter is required to send out a VoIP push notification.
        "ios_root_params": {
          "aps": {
            "mutable-content": 1      // required for iOS10+ Media attachments.
          },
          "callerName": "CallerName", // optional. Caller name. If not specified, "unknown caller" is shown.
          "video": true,              // optional. Indicates whether video calls are supported.
          "supportsHolding": true,    // optional. Indicates whether call holding functionality is supported.
          "supportsDTMF": false,      // optional. Controls Dual-Tone Multi-Frequency signal support.
          "callId": "42",             // optional. The unique identifier of the call to cancel.
          "cancelCall": true          // optional. Set to "true" to cancel the call with the specified "callId".
        }
      }
    ]
  }
}

Android

Anchor link to
উদাহরণ
{
  "request": {
    "application": "XXXXX-XXXXX",   // required. Pushwoosh application code.
    "auth": "yxoPUlwqm…………pIyEX4H", // required. API access token from Pushwoosh Control Panel.
    "notifications": [
      {
      "voip_push": true,            // required. Parameter is required to send out a VoIP push notification.
      "android_root_params": {
        "callerName": "callerName", // optional. Caller name. If not specified, "unknown caller" is shown.
        "video": true,              // optional. Indicates whether video calls are supported.
        "callId": 42,               // optional. The unique identifier of the call to cancel.
        "cancelCall": true          // optional. Set to "true" to cancel the call with the specified "callId".
        }
      }
    ]
  }
}

প্ল্যাটফর্ম-নির্দিষ্ট প্যারামিটার

Anchor link to

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

Anchor link to
উদাহরণ
{
  "request": {
    "application": "12345-67891",         // required. Pushwoosh application code
    "auth": "yxoPUlwqm…………pIyEX4H",       // required. API access token from Pushwoosh Control Panel
    "notifications": [{
      "ios_title": {                      // optional. Object OR string. Adds iOS specific title for push notification.
        "en": "title"
      },
      "ios_subtitle": {                   // optional. Object OR string. Adds iOS specific subtitle for push notification.
        "en": "subtitle"
      },
      "ios_content": {                    // optional. Object OR string. Adds iOS specific content for push notification.
        "en": "content"
      },
      "ios_badges": 5,                    // optional. iOS application badge number.
                                          //           Use "+n" or "-n" to increment/decrement the badge value by n.
      "ios_sound": "sound file.wav",      // optional. Sound file name in the main bundle of application.
                                          //           If left empty, the device will produce a default system sound.
      "ios_sound_off": true,              // optional. Enable/disable sound set by "ios_sound" field.
      "ios_ttl": 3600,                    // optional. Time to live parameter - maximum message lifespan in seconds.
      "ios_silent": 1,                    // optional. Enables silent notifications (ignore "sound" and "content").
      "ios_category_id": "1",             // optional. iOS8 category ID from Pushwoosh.
      "ios_root_params": {                // optional. Root level parameters to the aps dictionary.
        "aps": {
          "content-available": "0",       // optional. Set "1" to send a silent push and "0" for regular push.
          "mutable-content": 1            // required for iOS10+ Media attachments.
        },
        "callerName": "CallerName",       // optional VoIP parameter. Caller name. If not specified, "unknown caller" is shown.
        "video": true,                    // optional VoIP parameter. Indicates whether video calls are supported.
        "supportsHolding": true,          // optional VoIP parameter. Indicates whether call holding functionality is supported.
        "supportsDTMF": false,            // optional VoIP parameter. Controls Dual-Tone Multi-Frequency signal support.
        "data": {}                        // optional User supplied data, max of 4KB
      },
      "ios_attachment": "URL",            // optional. Insert media content in notification.
      "ios_thread_id": "some thread id",  // optional. Identifier to group related notifications.
                                          //           Messages with the same thread ID will be grouped
                                          //           on the lock screen and in the Notification Center.
      "ios_critical": true,               // optional. Marks iOS notification as a critical alert
                                          //           playing sound even if a device is muted or
                                          //           Do Not Disturb mode is on.
      "ios_category_custom": "category",  // optional. Custom APNS category.
      "ios_interruption_level": "active", // optional. One of "passive", "active", "time-sensitive",
                                          //           "critical". Indicates the importance and
                                          //           delivery timing of a notification. Refer to the
                                          //           One-time push guide for details.
      "apns_collapse_id": "promo",        // optional. APNs collapse identifier. Notifications with the same
                                          //           apns_collapse_id replace each other on the device.
      "apns_trim_content": 1              // optional. (0|1) Trims the exceeding content strings with ellipsis.
    }]
  }
}

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

Anchor link to
উদাহরণ
{
  "request": {
    "application": "12345-67891",            // required. Pushwoosh application code
    "auth": "yxoPUlwqm…………pIyEX4H",          // required. API access token from Pushwoosh Control Panel
    "notifications": [{
      "android_header": {                    // optional. Android notification header.
        "en": "header"
      },
      "android_content": {                   // optional. Android notification content.
        "en": "content"
      },
      "android_root_params": {               // optional. Custom key-value object.
        "key": "value",                      //           Root level parameters for the android payload recipients.
        "CancelID": 12345678,                // optional. Cancels the push notification with the
        "voip": true,                        // required VoIP parameter. Parameter is required to send out VoIP push notifications.
        "callerName": "callerName",          // optional VoIP parameter. Caller name. If not specified, "unknown caller" is shown.
        "video": true,                       // optional VoIP parameter. Indicates whether video calls are supported.
      },                                     //           specified Message ID (get the ID from the Message History)
      "android_sound": "soundfile",          // optional. No file extension. If left empty,
                                             //           the device will produce a default system sound.
      "android_sound_off": true,             // optional. Enable/disable sound set by "android_sound" field
      "android_icon": "icon.png",            // optional.
      "android_custom_icon": "URL.png",      // optional. Full URL to the image file.
      "android_banner": "URL.png",           // optional. Full URL to the image file.
      "android_badges": 5,                   // optional. Android application icon badge number.
                                             //           Use "+n" or "-n" to increment/decrement the badge value by n.
      "android_gcm_ttl": 3600,               // optional. Time to live parameter — maximum message lifespan in seconds.
      "android_vibration": 0,                // optional. Android force-vibration for high-priority pushes.
      "android_led": "#rrggbb",              // optional. LED hex color, device will do its best approximation.
      "android_priority": -1,                // optional. Sets the "importance" parameter for devices with
                                             //           Android 8.0 and higher, as well as the "priority" parameter
                                             //           for devices with Android 7.1 and lower. Establishes the
                                             //           interruption level of a notification channel or a particular
                                             //           notification. Valid values are -2, -1, 0, 1, 2.
      "android_delivery_priority": "normal", // optional. "normal" or "high".
                                             //           Enables notification’s delivery when the
                                             //           device is in the power saving mode.
      "android_ibc": "#RRGGBB",              // optional. icon background color on Lollipop, #RRGGBB,
                                             //           #AARRGGBB, "red", "black", "yellow", etc.
      "android_silent": 1,                   // optional. 0 or 1. Enable silent notification.
                                             //           Ignore sound and content
      "android_group_id": "123",             // optional. Identifier to group related notifications. Messages with
                                             //           the same thread ID will be grouped in
                                             //           the Notification Center.
      "android_collapse_key": "promo"        // optional. FCM collapse key. Notifications with the same
                                             //           collapse key replace each other while the device is offline.
    }]
  }
}

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

Huawei
{
  "request": {
    "application": "12345-67891",                   // required. Pushwoosh application code
    "auth": "yxoPUlwqm…………pIyEX4H",                 // required. API access token from Pushwoosh Control Panel
    "notifications": [{
      "huawei_android_header": {                    // optional. Object OR string. Notification title
        "en": "header"
      },
      "huawei_android_content": {                   // optional. Object OR string. Notification content
        "en": "content"
      },
      "huawei_android_badges": true,                // optional.
      "huawei_android_silent": 0,                   // optional. 0 or 1. Enable silent notification.
                                                    //           Ignore sound and content
      "huawei_android_icon": "URL.png",             // optional.
      "huawei_android_led": "#FF0011",              // optional. LED hex color, device will do its best approximation
      "huawei_android_vibration": 1,                // optional. Huawei force-vibration for high-priority pushes
      "huawei_android_sound": "sound.wav",          // optional. If left empty, the device will produce
                                                    //           a default system sound
      "huawei_android_sound_off": true,             // optional. Enable/disable sound set by
                                                    //           "huawei_android_sound" field
      "huawei_android_custom_icon": "URL.png",      // optional
      "huawei_android_gcm_ttl": 2400,               // optional. Time to live parameter - maximum
                                                    //           message lifespan in seconds
      "huawei_android_banner": "URL.png",           // optional. Full path URL to the image file
      "huawei_android_root_params": {               // optional. Custom key-value object.
        "key": "value"                              //           Root-level parameters for Huawei payload recipients.
      },
      "huawei_android_priority": 0,                 // optional. Valid values: -2, -1, 0, 1, 2
      "huawei_android_ibc": "#0011AA",              // optional. Icon background color on Lollipop
      "huawei_android_lockscreen": 1,               // optional
      "huawei_android_delivery_priority": "normal", // optional. "normal" or "high". Enables notification
                                                    //           delivery in power saving mode
      "huawei_android_group_id": "group_id"         // optional. Identifier to group related notifications
    }]
  }
}

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

Anchor link to
Safari
{
  "request": {
    "application": "12345-67891",    // required. Pushwoosh application code
    "auth": "yxoPUlwqm…………pIyEX4H",  // required. API access token from Pushwoosh Control Panel
    "notifications": [{
      "safari_url_args": [           // required, but the value may be empty
        "firstArgument",
        "secondArgument"
      ],
      "safari_title": {              // optional. Object OR string. Title of the notification.
        "en": "content"
      },
      "safari_content": {            // optional. Object OR string. Content of the notification.
        "en": "content"
      },
      "safari_action": "Click here", // optional.
      "safari_ttl": 3600             // optional. Time to live parameter — the maximum
                                     //           lifespan of a message in seconds.
    }]
  }
}

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

Anchor link to
Chrome
{
  "request": {
    "application": "12345-67891",          // required. Pushwoosh application code
    "auth": "yxoPUlwqm…………pIyEX4H",        // required. API access token from Pushwoosh Control Panel
    "notifications": [{
      "chrome_title": {                    // optional. Object OR string. You can specify the header
        "en": "title"                      //           of the message in this parameter.
      },
      "chrome_content": {                  // optional. Object OR string. You can specify the content
        "en": "content"                    //           of the message in this parameter.
      },
      "chrome_icon": "URL.png",            // optional. Full URL to the icon or extension resources file path
      "chrome_gcm_ttl": 3600,              // optional. Time to live parameter – maximum message lifespan in seconds.
      "chrome_duration": 20,               // optional. max 50 seconds. Changes chrome push display time.
                                           //           Set to 0 to display push until user interacts with it.
      "chrome_image": "image_URL",         // optional. URL to large image.
      "chrome_root_params": {              // optional. Set parameters specific to messages sent to Chrome.
        "key": "value"
      },
      "chrome_button_text1": "text1",      // optional
      "chrome_button_url1": "button1_URL", // optional. Ignored if chrome_button_text1 is not set.
      "chrome_button_text2": "text2",      // optional
      "chrome_button_url2": "button2_url"  // optional. Ignored if chrome_button_text2 is not set.
    }]
  }
}

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

Anchor link to
Firefox
{
  "request": {
    "application": "12345-67891",   // required. Pushwoosh application code
    "auth": "yxoPUlwqm…………pIyEX4H", // required. API access token from Pushwoosh Control Panel
    "notifications": [{
      "firefox_title": {            // optional. Object OR string. You can specify message header here.
        "en": "title"
      },
      "firefox_content": {          // optional. Object OR string. You can specify message content here.
        "en": "content"
      },
      "firefox_icon": "URL.png",    // optional. Full path URL to the icon or path to the
                                    //           file in extension resources.
      "firefox_root_params": {      // optional. Set parameters specific to messages sent to Firefox.
        "key": "value"
      }
    }]
  }
}

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

Anchor link to
Amazon
{
  "request": {
    "application": "12345-67891",   // required. Pushwoosh application code
    "auth": "yxoPUlwqm…………pIyEX4H", // required. API access token from Pushwoosh Control Panel
    "notifications": [{
      "adm_header": {               // optional. Object OR string. You can specify message header here.
        "en": "header"
      },
      "adm_content": {              // optional. Object OR string. You can specify message content here.
        "en": "content"
      },
      "adm_root_params": {          // optional. Custom key-value object
        "key": "value"
      },
      "adm_sound": "push.mp3",      // optional.
      "adm_sound_off": true,        // optional. Enable/disable sound set by "adm_sound" field
      "adm_icon": "icon.png",       // optional. Full URL to the icon.
      "adm_custom_icon": "URL.png", // optional.
      "adm_banner": "URL.png",      // optional.
      "adm_ttl": 3600,              // optional. Time to live parameter — the maximum message
                                    //           lifespan in seconds.
      "adm_priority": -1            // optional. Priority of the push in Amazon push drawer,
                                    //           valid values are -2, -1, 0, 1 and 2.
    }]
  }
}

Mac OS X প্যারামিটার

Anchor link to
Mac OS X
{
  "request": {
    "application": "12345-67891",   // required. Pushwoosh application code
    "auth": "yxoPUlwqm…………pIyEX4H", // required. API access token from Pushwoosh Control Panel
    "notifications": [{
      "mac_title": {                // optional. Object OR string. Adds Title for push notification.
        "en": "title"
      },
      "mac_subtitle": {             // optional. Adds subtitle for push notification.
        "en": "subtitle"
      },
      "mac_content": {              // optional. Adds content for push notification.
        "en": "content"
      },
      "mac_badges": 3,              // optional.
      "mac_sound": "sound.caf",     // optional.
      "mac_sound_off": true,        // optional. Enable/disable sound set by "mac_sound" field
      "mac_root_params": {          // optional.
        "content-available": 1
      },
      "mac_ttl": 3600               // optional. Time to live parameter — maximum message lifespan in seconds.
    }]
  }
}

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

Anchor link to
Windows
{
  "request": {
    "application": "12345-67891",   // required. Pushwoosh application code
    "auth": "yxoPUlwqm…………pIyEX4H", // required. API access token from Pushwoosh Control Panel
    "notifications": [{
      "wns_content": {              // required. Content (XML or raw) of notification encoded in MIME's base64
                                    //           in form of Object OR String
        "en": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48YmFkZ2UgdmFsdWU9ImF2YWlsYWJsZSIvPg==",
        "de": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48YmFkZ2UgdmFsdWU9Im5ld01lc3NhZ2UiLz4="
      },
      "wns_type": "Badge",          // optional. 'Tile' | 'Toast' | 'Badge' | 'Raw'
      "wns_tag": "myTag",           // optional. Used in Tile replacement policy.
                                    //           An alphanumeric string of no more than 16 characters.
      "wns_cache": 1,               // optional. (1|0) Translates into X-WNS-Cache-Policy value.
      "wns_ttl": 600                // optional. Expiration time for notification in seconds.
    }]
  }
}

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

HTTP স্ট্যাটাস কোডstatus_codeবিবরণ
200200মেসেজ সফলভাবে তৈরি হয়েছে
200210আর্গুমেন্ট ত্রুটি। আরও তথ্যের জন্য status_message দেখুন
400N/Aত্রুটিপূর্ণ অনুরোধ স্ট্রিং
500500অভ্যন্তরীণ ত্রুটি

API মেসেজিং ট্রেসিং

Anchor link to

লোড ব্যালেন্সিংয়ের উদ্দেশ্যে, আমরা API-এর মাধ্যমে পাঠানো মেসেজগুলি সংরক্ষণ করি না যেখানে “ডিভাইস” প্যারামিটারে 10টিরও কম ডিভাইস থাকে। এই কারণে, এই ধরনের মেসেজগুলি আপনার মেসেজ হিস্ট্রিতে প্রদর্শিত হবে না।

পরীক্ষার পর্যায়ে পুশ রিপোর্ট দেখতে, API মেসেজিং ট্রেসিং ব্যবহার করুন। এই বিকল্পটি চালু করলে আপনি 1 ঘন্টার জন্য এই সীমাটি অতিক্রম করতে পারবেন এবং এই ধরনের পুশগুলি মেসেজ হিস্ট্রিতে সংরক্ষণ করতে পারবেন। API মেসেজিং ট্রেসিং 1 ঘন্টা পরে স্বয়ংক্রিয়ভাবে বন্ধ হয়ে যায়।

API মেসেজিং ট্রেসিং মেসেজ হিস্ট্রি পৃষ্ঠায় উপরের ডান কোণায় Start API messaging tracing ক্লিক করে সক্রিয় করা যেতে পারে।

ট্যাগ শর্তাবলী

Anchor link to

প্রতিটি ট্যাগ শর্ত একটি অ্যারে যেমন [tagName, operator, operand] যেখানে

  • tagName: একটি ট্যাগের নাম
  • operator: “EQ” | “IN” | “NOTEQ” | “NOTIN” | “LTE” | “GTE” | “BETWEEN” | “NOTSET” | “ANY”
  • operand: string | integer | array | date

অপারেটরের বিবরণ

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" (স্ট্রিং)
  • unix timestamp 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"]।

/createMessage স্নিপেট

Anchor link to

নমুনা /createMessage অনুরোধ:

#!/bin/bash


#Usage
if [ ! -n "$1" ] || [ ! -n "$2" ]
then
  echo "`basename $0` usage: api_token appid message";
  exit 1;
fi;
MESSAGE="$3";
if [ -z "$3" ]
then
MESSAGE='One push to rule them all!'
fi;


echo -e "Response:"
curl --data-binary "
{\"request\":
    {\"application\":\"$2\",
     \"auth\":\"$1\",
     \"notifications\":
        [{
                        \"send_date\": \"now\",
            \"content\": \"$MESSAGE\"
        }]
    }
}" \
-H "Content-type: application/json" \
"https://api.pushwoosh.com/json/1.3/createMessage"
echo "";
exit 0;

deleteMessage

Anchor link to

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

একটি মেসেজ মুছে ফেলে, তা এখনও নির্ধারিত থাকুক বা ইতিমধ্যে পাঠানো হয়ে থাকুক। একটি নির্ধারিত মেসেজের জন্য, এটি মেসেজ হিস্ট্রি থেকে সঙ্গে সঙ্গে মুছে ফেলে — ইতিমধ্যে পাঠানো মেসেজের জন্য, নিচের সতর্কতাটি দেখুন।

রিসেন্ড টু নন-ওপেনার্স দিয়ে মেসেজ থেকে তৈরি ফলো-আপ সেন্ডগুলি প্রভাবিত হয় না — প্রতিটি আলাদাভাবে মুছে ফেলুন বা বাতিল করুন।

আপনি যদি পাঠানো বন্ধ করতে চান কিন্তু মেসেজটি মেসেজ হিস্ট্রিতে canceled স্ট্যাটাস সহ রাখতে চান তবে এর পরিবর্তে /cancelMessage ব্যবহার করুন।

অনুরোধের বডি

Anchor link to
নামটাইপবিবরণ
auth*stringPushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন।
message*string/createMessage অনুরোধে প্রাপ্ত মেসেজ কোড।
{
  "status_code": 200,
  "status_message": "OK"
}
উদাহরণ
{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H",  // required. API access token from Pushwoosh Control Panel
    "message": "xxxx-xxxxxxx-xxxxxx" // required. Message code obtained in /createMessage
  }
}

স্ট্যাটাস কোড:

HTTP স্ট্যাটাস কোডstatus_codeবিবরণ
200200মেসেজ সফলভাবে মুছে ফেলা হয়েছে
200210আর্গুমেন্ট ত্রুটি, যেমন মেসেজটি এখনও creating স্ট্যাটাসে আছে। আরও তথ্যের জন্য status_message দেখুন
400N/Aত্রুটিপূর্ণ অনুরোধ স্ট্রিং
500500অভ্যন্তরীণ ত্রুটি
<?php
// see https://gomoob.github.io/php-pushwoosh/delete-message.html
use Gomoob\Pushwoosh\Model\Request\DeleteMessageRequest;


// creates request instance
$request = DeleteMessageRequest::create()->setMessage('MESSAGE_CODE');


// call '/deleteMessage' Web Service
$response = $pushwoosh->deleteMessage($request);


if($response->isOk()) {
    print 'Great, my message has been deleted !';
} else {
    print 'Oups, the deletion failed :-(';
    print 'Status code : ' . $response->getStatusCode();
    print 'Status message : ' . $response->getStatusMessage();
}

getMessageDetails

Anchor link to

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

মেসেজের বিস্তারিত তথ্য পুনরুদ্ধার করে।

অনুরোধের বডি

Anchor link to
নামটাইপবিবরণ
auth*stringPushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন।
message*stringমেসেজ কোড বা মেসেজ আইডি।
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "message": {
      "id": 2068991743,
      "created": "2016-09-14 17:19:42",
      "send_date": "2016-09-14 17:19:41",
      "status": "done",
      "content": {
        "en": "Hello {Name|CapitalizeFirst|friend}! 🚀"
      },
      "platforms": "[1]",
      "ignore_user_timezone": "1",
      "code": "XXXX-92B4C3C5-A7F5EF70",
      "data": {
        "key": "value"
      }
    }
  }
}
উদাহরণ
{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H",  // required. API access token from Pushwoosh Control Panel
    "message": "xxxx-xxxxxxx-xxxxxx" // required. message code or message ID
  }
}

createTargetedMessage অবচিত

Anchor link to

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

একটি নতুন টার্গেটেড পুশ নোটিফিকেশন তৈরি করে।

অনুরোধের বডি

Anchor link to
নামটাইপবিবরণ
auth*stringPushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন।
devices_filter*stringনিচের মন্তব্য দেখুন।
send_date*stringYYYY-MM-DD HH:mm বা ‘now’।
ignore_user_timezonebooleanযদি উপেক্ষা করা হয়, “send_date” এর জন্য ডিফল্ট UTC-0।
timezonestringযদি উপেক্ষা করা হয়, “send_date” এর জন্য ডিফল্ট UTC-0।
campaignstringএকটি ক্যাম্পেইনের কোড যেখানে আপনি এই পুশ মেসেজটি বরাদ্দ করতে চান।
content*stringনোটিফিকেশন কন্টেন্ট। বিস্তারিত জানতে অনুরোধের উদাহরণ দেখুন।
transactionIdstringনেটওয়ার্ক সমস্যার ক্ষেত্রে মেসেজ ডুপ্লিকেট হওয়া রোধ করতে অনন্য মেসেজ শনাক্তকারী। Pushwoosh-এর দিকে 5 মিনিটের জন্য সংরক্ষিত থাকে।
linkstringব্যবহারকারী পুশ মেসেজ খুললে যে লিঙ্কটি খোলা হবে।
minimize_linkinteger0 - ছোট করবেন না, 2 - bit.ly। ডিফল্ট = 2।
dataobjectJSON স্ট্রিং বা JSON অবজেক্ট। পেলোডে “u” প্যারামিটার হিসেবে পাস করা হবে (JSON স্ট্রিং-এ রূপান্তরিত)।
presetstringপ্রিসেট কোড।
send_rateintegerথ্রটলিং। বৈধ মান 100 থেকে 1000 পুশ প্রতি সেকেন্ড।
inbox_datestringইনবক্স থেকে একটি মেসেজ কখন সরাতে হবে তা নির্দিষ্ট করুন।
inbox_imagestringইনবক্সে মেসেজের পাশে দেখানো হবে এমন ছবির URL।
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "messageCode": "97B0-C7473871-2FBDFDC6"
  }
}

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

{
  "status_code": 210,
  "status_message": "Errors occurred while compiling filter",
  "response": {
    "errors": [{
      "message": "Invalid tag set specification. \")\" expected.",
      "type": "syntax"
    }]
  }
}
উদাহরণ
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",    // required. API access token from Pushwoosh Control Panel
    "devices_filter": "A(\"XXXXX-XXXXX\") * T(\"City\", EQ, \"Name\")", // required. Syntax explained below
    "send_date": "now",                // optional. YYYY-MM-DD HH:mm OR 'now'
    "ignore_user_timezone": true,      // optional.
    "timezone": "America/New_York",    // optional. If ignored UTC-0 is default for "send_date".
                                       //           More info https://php.net/manual/timezones.php.
    "campaign": "CAMPAIGN_CODE",       // optional. Campaign code to which you want to assign this push message.
    "content": {                       // optional. Object OR string. Use "wns_content" instead for Windows.
      "en": "English",
      "de": "Deutsch"
    },
    "transactionId": "unique UUID",    // optional. Unique message identifier to prevent duplicating messages
                                       //           in case of network problems. Stored on the side of
                                       //           Pushwoosh for 5 minutes.
    "rich_media": "XXXXX-XXXXX",       // optional. Copy the Rich Media code from the URL bar of the
                                       //           Rich Media editor page in Pushwoosh Control Panel.
    "link": "https://google.com",      // optional. For deeplinks add "minimize_link": 0
    "minimize_link": 0,                // optional. 0 — do not minimize, 2 — bitly. Default = 2.
                                       //           Google URL shortener is disabled since March 30, 2019.
                                       //           Please note that shorteners have restrictions
                                       //           on a number of calls.
    "data": {                          // optional. JSON string or JSON object.
      "key": "value"                   //           Will be passed as "u" parameter in the payload
    },                                 //           (converted to JSON string).
    "preset": "XXXXX-XXXXX",           // optional. Push Preset Code from your Control Panel.
    "send_rate": 100,                  // optional. Throttling. Valid values are from 100 to 1000 pushes/second.
    "dynamic_content_placeholders": {  // optional. Placeholders for dynamic content instead of device tags.
      "firstname": "John",
      "lastname": "Doe"
    },


    // To save the message to the Inbox via API, use "inbox_date" or "inbox_image".
    // The message is saved when at least one of these parameters is used.
    "inbox_image": "Inbox image URL",  // optional. The image to be shown near the message.
    "inbox_date": "2017-02-02"         // optional. Specify when to remove a message from the Inbox.
                                       //           Message will be removed from Inbox at 00:00:01 UTC of
                                       //           the date specified, so the previous date is the last
                                       //           day a user can see the message in their Inbox.
                                       //           If not specified, the default removal date is the next
                                       //           day after the send date.
  }
}

মৌলিক বিষয়গুলি খুব সহজ – সমস্ত ফিল্টার সত্তার সেট-এর উপর সঞ্চালিত হয়।

সেট

Anchor link to

সেটগুলি এইভাবে সংজ্ঞায়িত করা হয়:

1. নির্দিষ্ট অ্যাপে সাবস্ক্রাইব করা ডিভাইস (A);
2. নির্দিষ্ট ট্যাগ মান (T) বা অ্যাপ-নির্দিষ্ট ট্যাগ মান (AT) এর সাথে মিলে যাওয়া ডিভাইস;\

সিনট্যাক্স

Anchor link to

উপরের তালিকা অনুযায়ী কিছু নমুনা দিয়ে চেষ্টা করা যাক।

অ্যাপ সাবস্ক্রাইবারদের টার্গেট করা

Anchor link to

“A” ফিল্টার একটি নির্দিষ্ট অ্যাপে সাবস্ক্রাইব করা ডিভাইসগুলির একটি সেট সংজ্ঞায়িত করে:

A("XXXXX-XXXXX", ["iOS", "Android", "OsX", "Windows", "Amazon", "Safari", "Chrome", "Firefox"])

যেখানে

  • “XXXXX-XXXXX” – Pushwoosh অ্যাপ্লিকেশন কোড
  • [“iOS”, “Android”, …] – টার্গেটেড প্ল্যাটফর্মের অ্যারে। যদি বাদ দেওয়া হয়, মেসেজটি এই অ্যাপের জন্য উপলব্ধ সমস্ত প্ল্যাটফর্মে পাঠানো হবে।

ট্যাগ মান দ্বারা ফিল্টারিং

Anchor link to

“T” ফিল্টার নির্দিষ্ট ট্যাগ মান বরাদ্দ করা ডিভাইসগুলির একটি সেট সংজ্ঞায়িত করে।

T(\"Age\", IN, [17,20])

ডিভাইসগুলির সেট সংজ্ঞায়িত করে যেগুলির “age” ট্যাগ 17, 18, 19, 20 এর মধ্যে একটি মান সেট করা আছে।

ট্যাগের প্রকার এবং অপারেটর

Anchor link to

সবচেয়ে গুরুত্বপূর্ণ বিষয় হল ট্যাগগুলি অ্যাপগুলির মধ্যে শেয়ার করা হয়, এবং এটি একটি নির্দিষ্ট অ্যাপে নিজেকে আবদ্ধ না করে আপনার টার্গেট ব্যবহারকারীদের বিভাজন এবং ফিল্টার করার জন্য একটি খুব শক্তিশালী উপকরণ উপস্থাপন করে।

ট্যাগটি তিনটি ভিন্ন ধরনের হতে পারে: স্ট্রিং, পূর্ণসংখ্যা, তালিকা। ট্যাগের ধরন নির্ধারণ করে যে আপনি একটি নির্দিষ্ট ট্যাগের জন্য কোন অপারেটর ব্যবহার করতে পারেন।

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

Anchor link to

প্রযোজ্য অপারেটর:

  • EQ – একটি নির্দিষ্ট ট্যাগ মান সহ ডিভাইসগুলিকে টার্গেট করে
  • IN – নির্দিষ্ট ট্যাগ মানগুলির যেকোনো একটি সহ ডিভাইসগুলিকে টার্গেট করে
  • NOTIN – কোনো নির্দিষ্ট ট্যাগ মান ছাড়া ডিভাইসগুলিকে টার্গেট করে
  • NOTEQ – একটি নির্দিষ্ট মানের সমান নয় এমন ট্যাগ মান সহ ডিভাইসগুলিকে টার্গেট করে
  • NOTSET – একটি নির্দিষ্ট ট্যাগের জন্য কোনো মান ছাড়া ডিভাইসগুলিকে টার্গেট করে
  • ANY – একটি নির্দিষ্ট ট্যাগের জন্য যেকোনো মান সেট করা ডিভাইসগুলিকে টার্গেট করে

উদাহরণ:

T (\"Age\", EQ, 30) – 30 বছর বয়সী ব্যবহারকারীদের ফিল্টার করে

T (\"favorite_color\", IN, [\"red\",\"green\",\"blue\"]) – যারা তাদের প্রিয় রঙ হিসাবে লাল, সবুজ বা নীল বেছে নিয়েছে তাদের ফিল্টার করে।

T (\"Name", NOTSET, \"\") – নাম ট্যাগের জন্য কোনো মান ছাড়া ডিভাইসগুলিকে টার্গেট করে।

আপনি স্ট্রিং ট্যাগগুলির সাথে সংখ্যাসূচক মান ব্যবহার করতে পারেন, কিন্তু এই ধরনের মানগুলি একটি স্ট্রিং-এ রূপান্তরিত হবে।

পূর্ণসংখ্যা ট্যাগ

Anchor link to

প্রযোজ্য অপারেটর:

  • GTE – একটি নির্দিষ্ট মানের চেয়ে বড় বা সমান
  • LTE– একটি নির্দিষ্ট মানের চেয়ে ছোট বা সমান
  • EQ – একটি নির্দিষ্ট মানের সমান
  • BETWEEN – সর্বনিম্ন এবং সর্বোচ্চ নির্দিষ্ট মানের মধ্যে
  • IN – নির্দিষ্ট মানগুলির যেকোনো একটি
  • NOTIN – একটি ডিভাইসে কোনো নির্দিষ্ট মান বরাদ্দ করা হয়নি
  • NOTEQ – একটি নির্দিষ্ট মানের সমান নয় এমন ট্যাগ মান সহ ডিভাইস
  • NOTSET – একটি নির্দিষ্ট ট্যাগের জন্য কোনো মান ছাড়া ডিভাইস
  • ANY – একটি নির্দিষ্ট ট্যাগের জন্য যেকোনো মান সেট করা ডিভাইস

উদাহরণ:

T (\"Level\", EQ, 14) – শুধুমাত্র 14 স্তরের ব্যবহারকারীদের ফিল্টার করে।

T (\"Level\", BETWEEN, [1,5) – 1, 2, 3, 4, এবং 5 স্তরের ব্যবহারকারীদের ফিল্টার করে।

T (\"Level", GTE, 29) – যারা কমপক্ষে 29 স্তরে পৌঁছেছে তাদের টার্গেট করে।

তালিকা ট্যাগ

Anchor link to

প্রযোজ্য অপারেটর:

  • IN – নির্দিষ্ট ট্যাগ মানগুলির যেকোনো একটি সহ ডিভাইস

উদাহরণ: T("Category", IN, ["breaking_news","business","politics"])

তারিখ ট্যাগ

Anchor link to

প্রযোজ্য অপারেটর:

  • GTE – একটি নির্দিষ্ট মানের চেয়ে বড় বা সমান
  • LTE– একটি নির্দিষ্ট মানের চেয়ে ছোট বা সমান
  • EQ – একটি নির্দিষ্ট মানের সমান
  • BETWEEN – সর্বনিম্ন এবং সর্বোচ্চ নির্দিষ্ট মানের মধ্যে
  • NOTEQ – একটি নির্দিষ্ট মানের সমান নয় এমন ট্যাগ মান সহ ডিভাইস
  • NOTSET – একটি নির্দিষ্ট ট্যাগের জন্য কোনো মান ছাড়া ডিভাইস
  • ANY – একটি নির্দিষ্ট ট্যাগের জন্য যেকোনো মান সেট করা ডিভাইস

উদাহরণ:

AT("7777D-322A7","Last Application Open", BETWEEN, ["2022-02-28", "2022-03-02"])

AT("7777D-322A7","Last Application Open", GTE, "90 days ago")

অপারেশন

Anchor link to
  • “+” – দুটি সেট যোগ করে (OR এর সমান)
  • “*” – দুটি সেটের ছেদ (AND এর সমান)
  • “\” – একটি সেট থেকে অন্যটি বিয়োগ করে (NOT এর সমান)

সমস্ত অপারেশন বাম-সহযোগী। ”+” এবং ”*” এর একই অগ্রাধিকার রয়েছে। "" এর অগ্রাধিকার বেশি। আপনি গণনার অগ্রাধিকার নির্ধারণ করতে বন্ধনী ব্যবহার করতে পারেন।

মনে রাখবেন যে “\” অপারেশনটি বিনিময়যোগ্য নয়। A("12345-12345") \ A("67890-67890") এবং A("67890-67890") \ A("12345-12345") একই নয়।

getPushHistory অবচিত

Anchor link to

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

পুশ বিস্তারিত বিবরণ সহ মেসেজ হিস্ট্রি পায়।

অনুরোধের বডি

Anchor link to
নামটাইপবিবরণ
auth*stringPushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন।
limitMessagesintegerএকটি প্রতিক্রিয়ায় মেসেজের সংখ্যা সীমিত করে। সম্ভাব্য মান 10 থেকে 1000।
sourcestringপুশ হিস্ট্রির উৎস। null বা: “CP”, “API”, “GeoZone”, “RSS”, “AutoPush”, “A/B Test” হতে পারে।
searchBystringঅনুসন্ধানের জন্য সম্ভাব্য মান। null বা: “notificationID”, “notificationCode”, “applicationCode”, “campaignCode” হতে পারে।
valuestring”searchBy” ফিল্ড অনুযায়ী অনুসন্ধান মান সেট করা হয়েছে।
lastNotificationIDstringপেজিনেশনের জন্য ব্যবহৃত। পূর্ববর্তী /getPushHistory কল থেকে শেষ messageId। নিচে বিস্তারিত দেখুন।
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "rows": [{
      "id": 10191611434,
      "code": "8071-07AD1171-77238AD1",
      "createDate": "2020-09-14 12:26:21",
      "sendDate": "2020-09-14 12:26:21",
      "content": {
        "en": "Hello!"
      },
      "url": null,
      "ios_title": null,
      "ios_subtitle": null,
      "ios_root_params": null,
      "android_header": null,
      "android_root_params": null,
      "conditions": null,
      "conditions_operator": "AND",
      "filter_code": "E3A64-A5F3C",
      "filter_conditions": "#In-app Purchase(≠0)",
      "filter_name": "Purchased something",
      "geozone": null,
      "campaignId": "",
      "campaignName": "",
      "subscription_segments": null,
      "open": {
        "C90C0-0E786": {
          "IOS": 0
        }
      },
      "sent": {
        "C90C0-0E786": {
          "IOS": 1
        }
      },
      "ctr": {
        "C90C0-0E786": 0
      }
    }, {
      "id": 10191609202,
      "code": "41CA-83F8E0D7-7A63822B",
      "createDate": "2020-09-14 12:25:55",
      "sendDate": "2020-09-14 12:25:55",
      "content": {
        "en": "Hi!"
      },
      "url": null,
      "ios_title": null,
      "ios_subtitle": null,
      "ios_root_params": null,
      "android_header": null,
      "android_root_params": null,
      "conditions": null,
      "conditions_operator": "AND",
      "filter_code": null,
      "filter_conditions": null,
      "filter_name": null,
      "geozone": null,
      "campaignId": "",
      "campaignName": "",
      "subscription_segments": {
        "2D732-BB981": "News"
      },
      "open": {
        "C90C0-0E786": {
          "CHROME": 0,
          "IOS": 0
        }
      },
      "sent": {
        "C90C0-0E786": {
          "CHROME": 1,
          "IOS": 2
        }
      },
      "ctr": {
        "C90C0-0E786": 0
      }
    }]
  }
}
উদাহরণ
{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H",  // required. API access token from Pushwoosh Control Panel
    "source": null,                  // optional. Possible values are null, "CP", "API", "GeoZone",
                                     //           "RSS", "AutoPush", "A/B Test"
    "searchBy": "applicationCode",   // optional. Possible values are "", "notificationID",
                                     //           "notificationCode", "applicationCode", "campaignCode"
    "value": "C8717-703F2",          // optional. Search value set according to the "searchBy" field.
    "lastNotificationID": 0,         // optional. Used for pagination. Last messageId from the
                                     //           previous /getPushHistory call. See details below.
    "limitMessages": 1000            // optional. Possible value from 10 to 1000.
  }
}

এই পদ্ধতিটি অ্যাকাউন্ট থেকে 1000টি মেসেজ ফেরত দেবে যা মেসেজ আইডি দ্বারা সাজানো হয়েছে। দ্বিতীয় পৃষ্ঠা পেতে, lastNotificationId প্যারামিটারে পূর্ববর্তী প্রতিক্রিয়ার শেষ মেসেজ আইডি নির্দিষ্ট করুন।

প্রতিক্রিয়া ডেটা প্রকার

Anchor link to
id -- int | 0
code -- string
createDate -- string  (date: %Y-%m-%d %H:%M:%S)
sendDate -- string  (date: %Y-%m-%d %H:%M:%S)
content -- array ( dict {lang: value} | list [])
title -- array ( dict {lang: value} | list [])
subtitle -- array ( dict {lang: value} | list [])
url -- string
ios_title -- string | array ( dict {lang: value} ) | null
ios_subtitle -- string | array ( dict {lang: value} ) | null
ios_root_params -- dict (JSON) | null
android_header -- string | array ( dict {lang: value} ) | null
android_root_params -- dict (JSON) | null
conditions -- list (JSON) | null
conditions_operator -- string | null
filter_code -- string | null
filter_name -- string | null
filter_conditions -- string | null
geozone -- string | null
campaignId -- string | ""
campaignName -- string | ""
subscription_segments (obsolete) -- list (JSON) | null
data -- dict (JSON) | null
open -- dict [dict [string: int]]  | ""   Example: 'open': {'AAAAA-BBBBB': {'IOS': 1, 'ANDROID': 1}}
sent -- dict [dict [string: int]]  | ""   Example: 'sent': {'AAAAA-BBBBB': {'IOS': 10, 'ANDROID': 10}}
ctr -- dict [string: int] | ""  Example: {'AAAAA-BBBBB': 1}
errors -- dict [string: int] | ""  Example: {'ANDROID': 1, 'IOS': 1}

cancelMessage

Anchor link to

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

একটি নির্ধারিত মেসেজ পাঠানো বাতিল করে। মেসেজটি মেসেজ হিস্ট্রিতে canceled স্ট্যাটাস সহ থাকে। রিসেন্ড টু নন-ওপেনার্স দিয়ে এটি থেকে তৈরি ফলো-আপ সেন্ডগুলিও বাতিল করা হয়।

আপনি যদি মেসেজটি মেসেজ হিস্ট্রি থেকে মুছে ফেলতে চান তবে এর পরিবর্তে /deleteMessage ব্যবহার করুন (ইতিমধ্যে পাঠানো মেসেজ সম্পর্কে সেখানে সতর্কতা দেখুন)।

অনুরোধের বডি

Anchor link to
নামটাইপবিবরণ
auth*stringPushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন।
message*string/createMessage প্রতিক্রিয়ায় প্রাপ্ত মেসেজ কোড।
{
   "status_code":200,
   "status_message":"OK"
}
উদাহরণ
{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H",  // required. API access token from Pushwoosh Control Panel
    "message": "xxxx-xxxxxxx-xxxxxx" // required. The message code obtained in /createMessage response
  }
}

স্ট্যাটাস কোড:

HTTP স্ট্যাটাস কোডstatus_codeবিবরণ
200200মেসেজ সফলভাবে বাতিল করা হয়েছে
200210আর্গুমেন্ট ত্রুটি। আরও তথ্যের জন্য status_message দেখুন।
400N/Aত্রুটিপূর্ণ অনুরোধ স্ট্রিং
500500অভ্যন্তরীণ ত্রুটি