Presets API

createPreset

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

สร้างพรีเซ็ตใหม่

Request Body

ชื่อ	ประเภท	คำอธิบาย
auth*	string	โทเค็นการเข้าถึง API จาก Pushwoosh Control Panel
name*	string	ชื่อพรีเซ็ต
applicationCode*	string	รหัสแอปพลิเคชัน Pushwoosh
campaignCode	string	รหัสของแคมเปญที่คุณต้องการกำหนดพรีเซ็ตนี้ไป
content*	object	พารามิเตอร์เนื้อหาข้อความ
content.message*	string	สตริงหรืออาร์เรย์ เนื้อหาข้อความ ในกรณีที่เป็นสตริง จะใช้ภาษา “Default”
content.action	object	พารามิเตอร์การดำเนินการแบบกำหนดเอง ดูตัวอย่างด้านล่าง
content.userData	array	ข้อมูลผู้ใช้แบบกำหนดเอง จะถูกส่งเป็นพารามิเตอร์ “u” ในเพย์โหลด (แปลงเป็นสตริง JSON)
content.properties	array	เนื้อหาเฉพาะสำหรับแพลตฟอร์มต่างๆ ดูตัวอย่างด้านล่าง
scheduling.sendRate	integer	การควบคุมปริมาณการส่ง (Throttling) ค่าที่ใช้ได้คือตั้งแต่ 100 ถึง 1000 pushes/วินาที
segmentation	object	พารามิเตอร์การแบ่งกลุ่ม (Segmentation)
segmentation.filter	string	ชื่อฟิลเตอร์
segmentation.platforms*	array	อาร์เรย์ของจำนวนเต็ม รายการ ID ของแพลตฟอร์ม 1 - iOS, 3 - Android, 7 - Mac OS X, 8 - Windows, 9 - Amazon, 10 - Safari, 11 - Chrome, 12 - Firefox

{
  "status_code": 200,
  "status_message": "OK"
}

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",        // จำเป็น โทเค็นการเข้าถึง API จาก Pushwoosh Control Panel
    "name": "PRESET_NAME",                 // จำเป็น
    "applicationCode": "XXXXX-XXXXX",      // จำเป็น รหัสแอปพลิเคชัน Pushwoosh
    "applicationGroupCode": "AAAAA-BBBBB", // ไม่จำเป็น สามารถใช้แทน "applicationCode" ได้
    "campaignCode": "CCCCC-DDDDD",         // ไม่จำเป็น รหัสแคมเปญ
    "content": {                           // จำเป็น ประกอบด้วยข้อมูลข้อความ
      "message": {                         // จำเป็น สตริงหรืออ็อบเจกต์ เนื้อหาข้อความ ในกรณีที่เป็น
        "en": "English message",           //          สตริง จะใช้ภาษาเริ่มต้น
        "fr": "French message"             //          เนื้อหาข้อความที่แปลสำหรับภาษาต่างๆ
      },                                   //          ใช้เฉพาะ ISO 639-1:2002 สำหรับรหัสภาษา
      "title": {                           // ไม่จำเป็น สตริงหรืออ็อบเจกต์ สำหรับหลายภาษา ให้ตั้งค่าหัวข้อ
        "en": "English title",             //          สำหรับแต่ละภาษาในอ็อบเจกต์ จะถูกละเว้นหาก
        "fr": "French title"               //          มีการระบุหัวข้อเฉพาะแพลตฟอร์ม (เช่น
      },                                   //          'ios_title', 'android_header' ฯลฯ ดูตัวอย่าง
                                           //          พารามิเตอร์เฉพาะแพลตฟอร์มใน
                                           //          /createMessage API)
      "subtitle": {                        // ไม่จำเป็น สตริงหรืออ็อบเจกต์ สำหรับหลายภาษา ให้ตั้งค่าหัวข้อ
        "en": "English subtitle",          //          สำหรับแต่ละภาษาในอ็อบเจกต์ จะถูกละเว้นหาก
        "fr": "French subtitle"            //          มีการระบุหัวข้อย่อยเฉพาะแพลตฟอร์ม (เช่น
      },                                   //          'ios_subtitle' ฯลฯ ดูตัวอย่างพารามิเตอร์
                                           //          เฉพาะแพลตฟอร์มใน /createMessage API)
      "action": {                          // ไม่จำเป็น การกระทำที่จะเกิดขึ้นเมื่อผู้ใช้เปิดข้อความ
        "type": "url",                     // ไม่จำเป็น ประเภทของการกระทำ ประเภทที่มี: "url", "deepLink",
                                           //            "richMedia", "openApp"(ค่าเริ่มต้น)
        "options": {                       // ไม่จำเป็น ตัวเลือกสำหรับประเภทการกระทำ จำเป็นสำหรับทุกประเภท
                                           //          การกระทำ ยกเว้น "openApp"
          "url": "https://example.com",    // จำเป็นสำหรับประเภทการกระทำ "url", สตริง จะถูกย่อ
                                           //          หากมีการกำหนดตัวย่อ
          "shortener": 2,                  // ไม่จำเป็น ค่าที่มี: 0 - ไม่ย่อ, 2 - bit.ly
                                           //          หากไม่ได้ระบุตัวย่อ จะใช้ bit.ly เป็นค่าเริ่มต้น
          "richMediaCode": "BBBBB-AAAAA",  // จำเป็นสำหรับประเภทการกระทำ "richMedia", สตริง
                                           //          รหัส Rich Media จาก Pushwoosh Control Panel
          "id": 123,                       // จำเป็นสำหรับประเภทการกระทำ "deepLink", จำนวนเต็ม Deep Link ID
          "params": {                      // ไม่จำเป็น, พารามิเตอร์ที่กำหนดเอง, จำเป็นสำหรับประเภทการกระทำ "deepLink", อาร์เรย์
            "param1": "value1",
            "param2": "value2"
          }
        }
      },
      "userData": {                        // ไม่จำเป็น ข้อมูลผู้ใช้แบบกำหนดเอง จะถูกส่งเป็นพารามิเตอร์ "u"
        "CustomData": "value"              //          ในเพย์โหลด (แปลงเป็นสตริง JSON)
      },
      "platforms": {
        "ios": {
          "sound": "default",
          "silent": 1,
          "ttl": 604800,
          "rootParams": {
            "rule_id": "12345",
            "screen_id": "34567"
          },
          "interruptionLevel": "active"
        },
        "android": {
          "rootParams": {
            "rule_id": "12345",
            "screen_id": "34567"
          }
        }
      }
    },
    "scheduling": {            // ไม่จำเป็น ตัวเลือกการตั้งเวลา
      "sendRate": 1000         // ไม่จำเป็น การควบคุมปริมาณการส่ง (Throttling) ค่าที่ใช้ได้คือตั้งแต่ 100 ถึง 1000 pushes/วินาที
    },
    "segmentation": {          // จำเป็น ตัวเลือกการแบ่งกลุ่ม
      "filter": "FILTER NAME", // ไม่จำเป็น ชื่อฟิลเตอร์จาก Pushwoosh Control Panel ของคุณ
      "platforms": [1, 3]      // จำเป็น รายการ ID ของแพลตฟอร์ม: 1 — iOS; 3 — Android;
                               //          7 — Mac OS X; 8 — Windows; 9 — Amazon; 10 — Safari;
                               //          11 — Chrome; 12 — Firefox;
    }
  }
}

getPreset

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

ดึงข้อมูลพารามิเตอร์ของพุชพรีเซ็ตที่ระบุ

Request Body

ชื่อ	ประเภท	คำอธิบาย
auth*	string	โทเค็นการเข้าถึง API จาก Pushwoosh Control Panel
preset_code*	string	รหัสพุชพรีเซ็ตที่ต้องการดึงข้อมูล

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "preset": {
      "code": "XXXXX-XXXXX",
      "name": "Full preset",
      "page_id": 26,
      "url": null,
      "content": {
        "en": "Some message",
        "de": "Eine Nachricht"
      },
      "properties": {
        "ignore_user_timezone": 1,
        "ios_badges": "5",
        "ios_sound": "default",
        "ios_ttl": "43200",
        "android_sound": "Sound1.wav",
        "android_custom_icon": "icon.png",
        "android_header": "android_header",
        "android_gcm_ttl": "43200",
        "wns_type": "toast",
        "wns_content": {
          "template": "ToastImageAndText02",
          "lang-en": {
            "headlinetext": "Title",
            "bodytext": "super text"
          },
          "languages": ["en", "zh", "it", "sv", "de", "fr", "pt", "nl", "es"],
          "lang-zh": {
            "headlinetext": "",
            "bodytext": ""
          },
          "lang-it": {
            "headlinetext": "",
            "bodytext": ""
          },
          "lang-sv": {
            "headlinetext": "",
            "bodytext": ""
          },
          "lang-de": {
            "headlinetext": "",
            "bodytext": ""
          },
          "lang-fr": {
            "headlinetext": "",
            "bodytext": ""
          },
          "lang-pt": {
            "headlinetext": "",
            "bodytext": ""
          },
          "lang-nl": {
            "headlinetext": "",
            "bodytext": ""
          },
          "lang-es": {
            "headlinetext": "",
            "bodytext": ""
          },
          "imagesource": "https://image.com/jpg"
        },
        "adm_sound": "song",
        "adm_custom_icon": "i5.bmp",
        "adm_header": "Amazon Header",
        "adm_ttl": "7200",
        "safari_title": "Safari title",
        "safari_action": "OK",
        "safari_url_args": ["hello.com", ""],
        "safari_ttl": "43200",
        "userdata": "{\"custom\":\"data\"}",
        "created_via": "CP",
        "user_id": 2,
        "filter_id": "1"
      },
      "platforms": [1, 3, 7, 10, 11]
    }
  }
}

{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H", // จำเป็น โทเค็นการเข้าถึง API จาก Pushwoosh Control Panel
    "preset_code": "AAAAA-BBBBB"    // จำเป็น รหัสพุชพรีเซ็ตที่ต้องการดึงข้อมูล
  }
}

listPresets

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

ดึงข้อมูลรายการพรีเซ็ตที่สร้างขึ้นสำหรับแอป

Request Body

ชื่อ	ประเภท	คำอธิบาย
auth*	string	โทเค็นการเข้าถึง API จาก Pushwoosh Control Panel
application*	string	รหัสแอปพลิเคชัน Pushwoosh

ไม่มีพรีเซ็ต
รายการพรีเซ็ต

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "presets": []
  }
}

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "presets": [{
      "name": "test",
      "code": "AAAAA-BBBBB"
    }]
  }
}

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",  // จำเป็น โทเค็นการเข้าถึง API จาก Pushwoosh Control Panel
    "application": "XXXXX-XXXXX"     // จำเป็น รหัสแอปพลิเคชัน Pushwoosh
  }
}

deletePreset

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

ลบพรีเซ็ตออกจากบัญชีของคุณ

Request Body

ชื่อ	ประเภท	คำอธิบาย
auth*	string	โทเค็นการเข้าถึง API จาก Pushwoosh Control Panel
preset_code*	string	รหัสพรีเซ็ตที่ได้จาก Pushwoosh Control Panel หรือการตอบกลับจาก /listPresets API

{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // จำเป็น โทเค็นการเข้าถึง API จาก Pushwoosh Control Panel
    "preset_code": "AAAAA-BBBBB"    // จำเป็น รหัสของพรีเซ็ตที่ต้องการลบ
  }
}