พารามิเตอร์ของ /createMessage

ที่นี่คุณจะพบคำอธิบายของพารามิเตอร์ API /createMessage พารามิเตอร์ที่จำเป็น ช่วยให้การโพสต์คำขอ API /createMessage สำเร็จและการส่งการแจ้งเตือนแบบพุช (broadcast push notification) ในเวลาที่กำหนด พารามิเตอร์ทางเลือก ช่วยให้คุณสามารถปรับแต่งคุณสมบัติของการแจ้งเตือนแบบพุชได้อย่างล้ำลึก

พารามิเตอร์ที่จำเป็นนั้นต้องใช้ในคำขอ /createMessage มิฉะนั้น คำขอจะไม่ถูกส่ง

โค้ดเฉพาะของแอปที่สร้างขึ้นในบัญชี Pushwoosh ของคุณ สามารถพบโค้ดแอปได้ที่มุมบนซ้ายของ Control Panel หรือในการตอบกลับของคำขอ /createApplication โค้ดแอปคือชุดอักขระ 10 ตัว (ทั้งตัวอักษรและตัวเลข) ที่คั่นด้วยยัติภังค์

เมื่อสร้างแอปผ่าน API คุณจะได้รับโค้ดแอปในการตอบกลับของคำขอ /createApplication ของคุณ

หากต้องการรับโค้ดของแอปที่สร้างไว้ก่อนหน้านี้ผ่าน API ให้เรียกใช้ /getApplications ในการตอบกลับของคำขอ /getApplications คุณจะได้รับรายการแอปทั้งหมดที่สร้างขึ้นในบัญชี Pushwoosh ของคุณพร้อมกับชื่อและโค้ด

โทเค็นการเข้าถึง API จาก Pushwoosh Control Panel ไปที่ Settings → API Access และคัดลอกโทเค็นที่คุณต้องการใช้หรือสร้างโทเค็นใหม่

เมื่อสร้างโทเค็นการเข้าถึง ให้ระบุสิทธิ์การใช้งาน เลือกช่องทำเครื่องหมายสำหรับประเภทของกิจกรรมที่คุณจะใช้โทเค็น API ด้วย คุณสามารถสร้างโทเค็น API เฉพาะแอปได้โดยการเลือกช่องทำเครื่องหมายของ Applications

สตริงหรืออ็อบเจกต์เพื่อกำหนดเนื้อหาของข้อความ พารามิเตอร์ “content” ที่ส่งด้วยค่าประเภทสตริงจะส่งข้อความเดียวกันไปยังผู้รับทุกคน

"content": "Hello world!",

อ็อบเจกต์ JSON ใช้สำหรับระบุเนื้อหาโดยใช้ Dynamic Content ตัวอย่างเช่น สำหรับข้อความหลายภาษา

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

อาร์เรย์ 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
• platforms
• preset
• rich_media
• send_rate
• timezone
• template_bindings
• transactionId
• users

วันที่และเวลาที่จะส่งข้อความ อาจเป็นวันที่และเวลาใดก็ได้ในรูปแบบ YYYY-MM-DD HH:mm หรือ ‘now’ หากตั้งค่าเป็น ‘now’ ข้อความจะถูกส่งทันทีหลังจากส่งคำขอ

โค้ดของแคมเปญ (Campaign) หากต้องการรับโค้ดแคมเปญ ให้ไปที่ Channels → Statistics และเลือกแคมเปญที่คุณจะใช้ คุณสามารถค้นหาโค้ดแคมเปญได้ที่ท้าย URL ของหน้าเว็บหลัง campaigns-statistic ซึ่งเป็นชุดอักขระ 10 ตัว (ทั้งตัวอักษรและตัวเลข) ที่คั่นด้วยยัติภังค์

หากต้องการรับรายการแคมเปญพร้อมโค้ด ให้เรียกใช้ /getCampaigns ในการตอบกลับของคำขอ /getCampaigns คุณจะได้รับรายการแคมเปญทั้งหมดที่สร้างขึ้นสำหรับแอปนั้นๆ ในบัญชี Pushwoosh ของคุณ พร้อมด้วยโค้ด ชื่อ และคำอธิบาย

ระยะเวลาที่จะใช้สำหรับการจำกัดความถี่ (frequency capping) เป็นวัน (สูงสุด 30 วัน)

จำนวนพุชสูงสุดที่สามารถส่งจากแอปที่ระบุไปยังอุปกรณ์หนึ่งๆ ภายในระยะเวลา “capping_days” ในกรณีที่ข้อความที่สร้างขึ้นเกินขีดจำกัด “capping_count” สำหรับอุปกรณ์ใดอุปกรณ์หนึ่ง ข้อความนั้นจะไม่ถูกส่งไปยังอุปกรณ์ดังกล่าว

เงื่อนไข (Conditions) คืออาร์เรย์เช่น [tagName, operator, operand] ที่ใช้สำหรับส่งข้อความที่กำหนดเป้าหมายตาม Tags และค่าของแท็ก โดยที่:

• tagName — ชื่อของแท็กที่จะใช้
• operator — ตัวดำเนินการเปรียบเทียบค่า (“EQ” | “IN” | “NOTEQ” | “NOTIN” | “LTE” | “GTE” | “BETWEEN” | “NOTSET” | “ANY”)
• operand — ค่าของแท็ก (Tag values) ประเภทใดประเภทหนึ่งต่อไปนี้: string | integer | array | date | boolean | list

• EQ: ค่าแท็กเท่ากับ operand
• IN: ค่าแท็กมีค่าใดค่าหนึ่งใน operand (operand ต้องเป็นอาร์เรย์เสมอ)
• NOTEQ: ค่าแท็กไม่เท่ากับ operand
• NOTIN: ค่าแท็กไม่มีค่าใดๆ ใน operand (operand ต้องเป็นอาร์เรย์เสมอ)
• GTE: ค่าแท็กมากกว่าหรือเท่ากับ operand
• LTE: ค่าแท็กน้อยกว่าหรือเท่ากับ operand
• BETWEEN: ค่าแท็กมากกว่าหรือเท่ากับค่าต่ำสุดของ operand แต่น้อยกว่าหรือเท่ากับค่าสูงสุดของ operand (operand ต้องเป็นอาร์เรย์เสมอ)
• NOTSET: ไม่มีการตั้งค่าแท็ก ไม่พิจารณา Operand
• ANY: แท็กมีค่าใดๆ ไม่พิจารณา Operand

ตัวดำเนินการที่ใช้ได้: EQ, IN, NOTEQ, NOTIN, NOTSET, ANY
Operand ที่ใช้ได้:

• EQ, NOTEQ: operand ต้องเป็นสตริง
• IN, NOTIN: operand ต้องเป็นอาร์เรย์ของสตริงเช่น ["value 1", "value 2", "value N"]
• NOTSET: ไม่มีการตั้งค่าแท็ก ไม่พิจารณา Operand
• ANY: แท็กมีค่าใดๆ ไม่พิจารณา Operand

ตัวดำเนินการที่ใช้ได้: EQ, IN, NOTEQ, NOTIN, BETWEEN, GTE, LTE, NOTSET, ANY
Operand ที่ใช้ได้:

• EQ, NOTEQ, GTE, LTE: operand ต้องเป็นจำนวนเต็ม
• IN, NOTIN: operand ต้องเป็นอาร์เรย์ของจำนวนเต็มเช่น [value 1, value 2, value N]
• BETWEEN: operand ต้องเป็นอาร์เรย์ของจำนวนเต็มเช่น [min_value, max_value]
• NOTSET: ไม่มีการตั้งค่าแท็ก ไม่พิจารณา Operand
• ANY: แท็กมีค่าใดๆ ไม่พิจารณา Operand

ตัวดำเนินการที่ใช้ได้: EQ, IN, NOTEQ, NOTIN, BETWEEN, GTE, LTE, NOTSET, ANY
Operand ที่ใช้ได้:

• "YYYY-MM-DD 00:00" (สตริง)
• unix timestamp 1234567890 (จำนวนเต็ม)
• "N days ago" (สตริง) สำหรับตัวดำเนินการ EQ, BETWEEN, GTE, LTE

ตัวดำเนินการที่ใช้ได้: EQ, NOTSET, ANY
Operand ที่ใช้ได้: 0, 1, true, false

ตัวดำเนินการที่ใช้ได้: IN, NOTIN, NOTSET, ANY
Operand ที่ใช้ได้: operand ต้องเป็นอาร์เรย์ของสตริงเช่น ["value 1", "value 2", "value N"]

ตัวดำเนินการตรรกะสำหรับอาร์เรย์เงื่อนไข (conditions arrays) ค่าที่เป็นไปได้: AND | OR โดยมี AND เป็นค่าเริ่มต้น

หากตัวดำเนินการที่ใช้คือ AND (เมื่อไม่ได้ระบุตัวดำเนินการ หรือพารามิเตอร์ ‘conditions_operator’ มีค่าเป็น ‘AND’) อุปกรณ์ที่ตรงตามเงื่อนไขทั้งหมดพร้อมกันจะได้รับการแจ้งเตือนแบบพุช

หากตัวดำเนินการเป็น OR อุปกรณ์ที่ตรงตามเงื่อนไขใดๆ ที่ระบุไว้จะได้รับข้อความ

สตริง JSON หรืออ็อบเจกต์ JSON ที่ใช้ในการส่ง ข้อมูลที่กำหนดเอง ใดๆ ในเพย์โหลดของพุช จะถูกส่งเป็นพารามิเตอร์ “u” ในเพย์โหลด (แปลงเป็นสตริง JSON)

อาร์เรย์ของ push tokens หรือ hwids เพื่อส่งการแจ้งเตือนแบบพุชที่กำหนดเป้าหมาย หากตั้งค่าไว้ ข้อความจะถูกส่งไปยังอุปกรณ์ในรายการเท่านั้น

ตัวยึดตำแหน่งสำหรับ Dynamic Content ที่จะใช้แทนค่าแท็กของอุปกรณ์ ตัวอย่างด้านล่างจะส่งข้อความ “Hello, John!” ไปยังผู้ใช้ทุกคนที่คุณกำหนดเป้าหมาย หากไม่ได้ตั้งค่าไว้ ค่า Dynamic Content จะถูกดึงมาจากแท็กของอุปกรณ์

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

ชื่อของ Segment ที่ตรงกับที่สร้างไว้ใน Pushwoosh Control Panel หรือผ่านคำขอ API /createFilter ไปที่ส่วน Audience → Segments (Filters) และตรวจสอบรายการ Segments ที่สร้างขึ้น

หากต้องการรับรายการ Segments ผ่าน API ให้เรียกใช้เมธอด API /listFilters ในการตอบกลับของคำขอ /listFilters คุณจะได้รับรายการ Segments ทั้งหมดที่สร้างขึ้นในบัญชี Pushwoosh ของคุณ พร้อมด้วยชื่อเงื่อนไข และวันหมดอายุของ Segments

หากตั้งค่าเป็น ‘true’ จะส่งข้อความในเวลาและวันที่ที่ระบุในพารามิเตอร์ “send_date” ตามเวลา UTC-0

หากตั้งค่าเป็น ‘false’ ผู้ใช้จะได้รับข้อความตามเวลาท้องถิ่นที่ระบุไว้ตามการตั้งค่าของอุปกรณ์

วันที่ที่ข้อความควรถูกเก็บไว้ใน Inbox ของผู้ใช้ หากไม่ระบุ ข้อความจะถูกลบออกจาก Inbox ในวันถัดไปหลังจากวันที่ส่ง

URL ของรูปภาพที่กำหนดเองที่จะแสดงใกล้กับข้อความใน Inbox

อายุของข้อความในกล่องจดหมายเป็นวัน สูงสุด 30 วัน หลังจากช่วงเวลานี้ ข้อความจะถูกลบออกจากกล่องจดหมาย สามารถใช้แทนพารามิเตอร์ inbox_date ได้

URL ที่จะเปิดขึ้นเมื่อผู้ใช้เปิดการแจ้งเตือนแบบพุช

ตัวย่อ URL เพื่อย่อ URL ที่ส่งในพารามิเตอร์ “link” โปรดทราบว่าขนาดเพย์โหลดของการแจ้งเตือนแบบพุชมีจำกัด ดังนั้นควรพิจารณาสร้าง URL แบบสั้นเพื่อไม่ให้เกินขีดจำกัด ค่าที่ใช้ได้: 0 — ไม่ต้องย่อ, 2 — bitly ค่าเริ่มต้น = 2 ตัวย่อ URL ของ Google ถูกปิดใช้งานตั้งแต่วันที่ 30 มีนาคม 2019

อาร์เรย์ของโค้ดแพลตฟอร์มเพื่อส่งข้อความไปยังแพลตฟอร์มที่ระบุเท่านั้น รายการแพลตฟอร์มที่ใช้ได้: โค้ดแพลตฟอร์มที่ใช้ได้ ได้แก่: 1 — iOS, 3 — Android, 7 — Mac OS X, 8 — Windows, 9 — Amazon, 10 — Safari, 11 — Chrome, 12 — Firefox, 14 — Email, 17 — Huawei, 18 — SMS, and 21 — WhatsApp

โค้ดของ Preset ที่สร้างขึ้นใน Pushwoosh Control Panel หรือผ่าน API หากต้องการรับโค้ด Preset ให้ไปที่ Content → Presets ขยาย Preset ที่คุณจะใช้ และคัดลอก Preset Code จากรายละเอียดของ Preset

โค้ดของหน้า Rich Media ที่คุณจะแนบไปกับข้อความของคุณ หากต้องการรับโค้ด ให้ไปที่ Content → Rich Media เปิดหน้า Rich Media ที่คุณจะใช้ และคัดลอกโค้ดจากแถบ URL ของเบราว์เซอร์ของคุณ โค้ดคือชุดอักขระ 10 ตัว (ทั้งตัวอักษรและตัวเลข) ที่คั่นด้วยยัติภังค์

การควบคุมความเร็ว (Throttling) เพื่อจำกัดความเร็วในการส่งพุช ค่าที่ถูกต้องคือตั้งแต่ 100 ถึง 1000 พุช/วินาที

เขตเวลาที่จะนำมาพิจารณาเมื่อส่งข้อความในวันที่และเวลาที่ระบุ หากตั้งค่าไว้ เขตเวลาของอุปกรณ์จะถูกละเว้น หากละเว้น ข้อความจะถูกส่งในเขตเวลา UTC-0 ดูเขตเวลาที่รองรับได้ที่ https://php.net/manual/timezones.php

ตัวยึดตำแหน่งเทมเพลตเพื่อใช้ในเทมเพลตเนื้อหาของคุณ ดูรายละเอียดใน คู่มือ Liquid Templates

ตัวระบุข้อความที่ไม่ซ้ำกันเพื่อป้องกันข้อความซ้ำซ้อนในกรณีที่เกิดปัญหาเกี่ยวกับเครือข่าย คุณสามารถกำหนด ID ใดๆ ให้กับข้อความที่สร้างผ่านคำขอ /createMessage หรือ /createTargetedMessage ได้ โดยจะถูกเก็บไว้ที่ฝั่งของ Pushwoosh เป็นเวลา 5 นาที

อาร์เรย์ของ userIds User ID คือตัวระบุผู้ใช้ที่ไม่ซ้ำกันซึ่งตั้งค่าโดยคำขอ API /registerUser, /registerDevice หรือ /registerEmail