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

เลิกใช้งานแล้ว

/createMessage เลิกใช้งานแล้ว การผสานรวมใหม่ควรใช้ Messaging API v2 — ดู คู่มือการย้าย สำหรับการจับคู่พารามิเตอร์ด้านล่างแบบฟิลด์ต่อฟิลด์

ที่นี่คุณจะพบคำอธิบายของพารามิเตอร์ API /createMessage

• พารามิเตอร์ที่จำเป็น ต้องรวมอยู่ในการส่งคำขอ API /createMessage และการส่ง push notification ในเวลาที่กำหนดให้สำเร็จ

• พารามิเตอร์ที่ไม่จำเป็น ช่วยให้คุณสามารถปรับแต่งคุณสมบัติของ push notification ได้

หมายเหตุ

หากคุณกำลังใช้ /createMessage เพื่อส่ง SMS โปรดดูที่ พารามิเตอร์สำหรับการส่ง SMS พารามิเตอร์อื่นๆ จะไม่ถูกส่งผ่าน

พารามิเตอร์ที่จำเป็น

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

application

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

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

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

auth

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

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

content

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

String

"content": "Hello world!",

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

Object

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

notifications

อาร์เรย์ JSON ของคุณสมบัติ push ต้องมีพารามิเตอร์ที่จำเป็นอย่างน้อยคือ 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
• message_type
• platforms
• preset
• rich_media
• send_rate
• timezone
• template_bindings
• transactionId
• users

send_date

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

พารามิเตอร์ที่ไม่จำเป็น

campaign

รหัสของ Campaign หากต้องการรับรหัส Campaign ให้ไปที่ Statistics → Aggregated statistics และเลือก Campaign ที่คุณจะใช้ รหัส campaign จะปรากฏที่ส่วนท้ายของ URL ของหน้าในรูปแบบ XXXXX-XXXXX

ตัวอย่าง:

URL: https://app.pushwoosh.com/applications/AAAAA-AAAAA/statistics/aggregated-message?campaignCode=XXXXX-XXXXX

รหัส Campaign: XXXXX-XXXXX

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

capping_days

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

Frequency capping จะไม่ถูกนำไปใช้กับข้อความที่มี message_type: transactional ในกรณีอื่นๆ ทั้งหมด frequency capping จะถูกนำไปใช้ รวมถึงคำขอที่ละเว้น message_type

capping_count

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

conditions

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

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

คำอธิบาย Operator

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

String tags

Valid operators: EQ, IN, NOTEQ, NOTIN, NOTSET, ANY

Valid operands:

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

Integer tags

Valid operators: EQ, IN, NOTEQ, NOTIN, BETWEEN, GTE, LTE, NOTSET, ANY

Valid operands:

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

Date tags

Valid operators: EQ, IN, NOTEQ, NOTIN, BETWEEN, GTE, LTE, NOTSET, ANY

Valid operands:

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

Boolean tags

Valid operators: EQ, NOTSET, ANY

Valid operands: 0, 1, true, false

List tags

Valid operators: IN, NOTIN, NOTSET, ANY

Valid operands: operand ต้องเป็นอาร์เรย์ของสตริงเช่น ["value 1", "value 2", "value N"]

สำคัญ

โปรดจำไว้ว่าพารามิเตอร์ “filter” และ “conditions” ไม่ควรใช้ร่วมกัน
นอกจากนี้ ทั้งสองพารามิเตอร์ จะถูกละเว้น หากใช้พารามิเตอร์ “devices” ในคำขอเดียวกัน

Country และ Language tags

ค่า Language tag เป็นรหัสสองตัวอักษรตัวพิมพ์เล็กตาม ISO-639-1 ค่า Country tag เป็นรหัสสองตัวอักษรตัวพิมพ์ใหญ่ตาม ISO_3166-2

ตัวอย่างเช่น หากต้องการส่ง push notification ไปยังผู้สมัครสมาชิกที่พูดภาษาโปรตุเกสในบราซิล คุณจะต้องระบุเงื่อนไขต่อไปนี้: "conditions": [["Country", "EQ", "BR"],["Language", "EQ", "pt"]]

conditions_operator

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

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

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

data

สตริง JSON หรืออ็อบเจกต์ JSON ที่ใช้ในการส่ง custom data ใดๆ ใน push payload; จะถูกส่งเป็นพารามิเตอร์ “u” ใน payload (แปลงเป็นสตริง JSON)

devices

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

dynamic_content

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

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

filter

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

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

ignore_user_timezone

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

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

inbox_date

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

หมายเหตุ

หากต้องการบันทึกข้อความไปยัง Inbox ให้ใช้อย่างน้อยหนึ่งในพารามิเตอร์ ‘inbox’: “inbox_date” หรือ “inbox_image”

ข้อควรระวัง

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

inbox_image

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

หมายเหตุ

หากต้องการบันทึกข้อความไปยัง Inbox ให้ใช้อย่างน้อยหนึ่งในพารามิเตอร์ ‘inbox’: “inbox_date” หรือ “inbox_image”

inbox_days

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

link

URL ที่จะเปิดเมื่อผู้ใช้เปิด push notification

message_type

ระบุประเภทของข้อความ push ค่าที่ใช้ได้คือ marketing และ transactional ดู Marketing vs transactional messages สำหรับรายละเอียด

พารามิเตอร์นี้เป็นทางเลือก หากละเว้น ข้อความจะถือว่าเป็น transactional และส่งถึงทุกคน รวมถึง control group ข้อความ Marketing จะไม่ถูกส่งไปยังสมาชิก control group

minimize_link

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

platforms

อาร์เรย์ของรหัสแพลตฟอร์มเพื่อส่งข้อความไปยังแพลตฟอร์มเฉพาะเท่านั้น

รหัสแพลตฟอร์มที่ใช้ได้ ได้แก่: 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

preset

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

rich_media

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

send_rate

การควบคุมความเร็วในการส่ง push ค่าที่ถูกต้องคือตั้งแต่ 100 ถึง 1000 pushes/วินาที

timezone

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

template_bindings

Template placeholders ที่จะใช้ในเทมเพลตเนื้อหาของคุณ ดูคู่มือ Liquid Templates สำหรับรายละเอียด

transactionId

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

use_latest_user_device

หากตั้งค่าเป็น true จะส่ง push หนึ่งครั้งต่อผู้ใช้แทนที่จะเป็นหนึ่งครั้งต่ออุปกรณ์: เฉพาะอุปกรณ์ที่มี Last Application Open ล่าสุดในบรรดาแพลตฟอร์มใน platforms เท่านั้นที่จะได้รับ หากไม่มีอุปกรณ์ใดของผู้ใช้บนแพลตฟอร์มเหล่านั้นที่มีข้อมูลดังกล่าว อุปกรณ์ที่ตรงกันเครื่องแรกจะได้รับแทน ดังนั้นการส่งจะไม่ถูกทิ้ง อุปกรณ์ที่ไม่มี user ID จะไม่ได้รับผลกระทบ ใช้ได้ไม่ว่ากลุ่มเป้าหมายจะถูกกำหนดเป้าหมายอย่างไร — โดย users, filter, หรือ conditions ทำงานเหมือนกับ use_latest_user_device ใน Messaging API v2 ค่าเริ่มต้นคือ false (ส่งไปยังทุกอุปกรณ์)

users

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