Presets API

พรีเซ็ตพุช คือเทมเพลตการแจ้งเตือนแบบพุชที่สามารถนำกลับมาใช้ใหม่ได้ ซึ่งเป็นอ็อบเจกต์เดียวกับที่คุณสร้างในตัวแก้ไขพุชของ Control Panel API นี้จัดการเฉพาะพรีเซ็ตพุชเท่านั้น พรีเซ็ตสำหรับ SMS, WhatsApp, Kakao, LINE และ Viber แต่ละรายการมีบริการพรีเซ็ตเฉพาะของตนเอง ซึ่งไม่ครอบคลุมในที่นี้

ใช้ code ของพรีเซ็ตเพื่อส่งผ่าน Notify (payload preset) หรือ Customer Journey Send push point

URL พื้นฐาน

https://rpc-api.svc-nue.pushwoosh.com

endpoint ทั้งหมดให้บริการผ่าน HTTPS คำขอและการตอบกลับใช้ application/json เว้นแต่จะระบุไว้เป็นอย่างอื่น

การยืนยันตัวตน

ทุกคำขอต้องมีส่วนหัว Authorization พร้อมกับ Server API token ของคุณ:

Authorization: Api YOUR_API_TOKEN

ข้อตกลงทั่วไป

การตั้งชื่อฟิลด์: ส่วนเนื้อหาของคำขอและพารามิเตอร์ query/path ยอมรับ lowerCamelCase (ตัวอย่างเช่น sendType, localizedProperties, searchByName) — เซิร์ฟเวอร์จะ unmarshal ทั้งสองรูปแบบ การตอบกลับจะถูก marshal โดยใช้ชื่อฟิลด์ proto ในรูปแบบ snake_case (localized_properties, platform_properties, per_page และอื่นๆ) เสมอ ตัวอย่างการตอบกลับและข้อมูลอ้างอิง อ็อบเจกต์ Preset ด้านล่างใช้รูปแบบนั้น
code: ทุกการตอบกลับของพรีเซ็ตจะมีโค้ดของตัวเอง ซึ่งสร้างขึ้นเมื่อ Create ส่งโค้ดนี้ไปยัง Get, Update, UpdatePartial, Delete, Clone และไปยัง API การส่งข้อความ/journey ที่กล่าวถึงข้างต้น
คีย์แพลตฟอร์ม: แมป platforms และ open_actions จะใช้ รหัสประเภทอุปกรณ์ ที่เป็นตัวเลขเป็นคีย์ (1 สำหรับ iOS, 3 สำหรับ Android และอื่นๆ) platform_properties จะใช้ชื่อ enum ของแพลตฟอร์มเป็นคีย์แทน (IOS, ANDROID, HUAWEI_ANDROID, OSX — ซึ่งเป็นเพียงสี่แพลตฟอร์มที่ครอบคลุม)
ฟิลด์ที่ไม่ได้กรอกข้อมูล: การตอบกลับของ Get, Create และ Clone จะรวมทุกฟิลด์ของ อ็อบเจกต์ Preset แม้ว่าจะว่างเปล่าหรือมีค่าเป็นศูนย์ก็ตาม List จะส่งคืนชุดฟิลด์ที่ลดลง — ดู List ด้านล่าง Update และ UpdatePartial จะไม่ส่งคืนฟิลด์พรีเซ็ตใดๆ เลย — ดู ข้อควรระวัง ในส่วนของฟังก์ชันเหล่านั้น

การตอบกลับข้อผิดพลาด

สถานะ HTTP	ความหมาย
`400 Bad Request`	อาร์กิวเมนต์ไม่ถูกต้อง — ฟิลด์ที่จำเป็นขาดหายไปหรือมีรูปแบบไม่ถูกต้อง หรือเงื่อนไขเบื้องต้นล้มเหลว (ตัวอย่างเช่น การโคลนโดยไม่มี `name`)
`401 Unauthorized`	ส่วนหัว `Authorization` ขาดหายไปหรือไม่ถูกต้อง
`403 Forbidden`	แอปพลิเคชันหรือพรีเซ็ตไม่ได้เป็นของบัญชีของผู้เรียก
`404 Not Found`	ไม่พบพรีเซ็ตหรือแอปพลิเคชัน
`500 Internal Server Error`	ความล้มเหลวที่ไม่คาดคิดฝั่งเซิร์ฟเวอร์

Delete บนพรีเซ็ตที่ยังคงถูกใช้โดย Send push point ของ journey ที่กำลังทำงานหรือหยุดชั่วคราวอยู่ จะส่งคืน 400 Bad Request (a FailedPrecondition on the wire) — ไม่ใช่ 409 ให้ลบพรีเซ็ตออกจาก journey ก่อน

Create, Update และ UpdatePartial จะส่งคืน 400 Bad Request สำหรับ โทเค็นการปรับแต่งส่วนบุคคล ที่ไม่สามารถแก้ไขได้ — ดูด้านล่าง

โทเค็นการปรับแต่งส่วนบุคคล

Create, Update และ UpdatePartial จะตรวจสอบทุก โทเค็นการปรับแต่งส่วนบุคคล ({name|modifier|default}) ใน localizedTitle, localizedSubtitle และ localizedContent (สำหรับทุกภาษาในคำขอ) และในฟิลด์เนื้อหา rich per-platform ที่ผู้ส่งใช้แทนที่ (title, content, banner, icon, URL, deep-link params และอื่นๆ สำหรับแต่ละแพลตฟอร์ม) ฟิลด์นอกเหนือจากชุดนั้น เช่น richmedia, campaignCode, deeplink หรือ filterCode จะเก็บโทเค็นไว้ตามที่เขียน — Pushwoosh จะไม่แยกวิเคราะห์ไวยากรณ์การปรับแต่งส่วนบุคคลที่นั่น

โทเค็นต้องการ modifier ที่ Pushwoosh รู้จัก เพราะโทเค็นที่ไม่มีการแก้ไขหรือสะกดผิดจะไม่สามารถจัดรูปแบบได้และจะไปถึงผู้ใช้เป็นวงเล็บปีกกาตามตัวอักษร โทเค็นที่ไม่มี modifier หรือ modifier ที่ไม่รู้จัก ({Tag|}, {Tag|typo}) จะทำให้การเรียกใช้ล้มเหลวด้วย InvalidArgument:

{
  "code": 3,
  "message": "personalization token {Tag|} has no known modifier, so it would be delivered as text; expected one of [capitalizefirst capitalizeallfirst uppercase lowercase regular base64 cent dollar comma euro jpy lira M-d-y m-d-y M d y M d Y l M d H:i m-d-y H:i]"
}

ใน UpdatePartial การตรวจสอบนี้จะทำงานกับชุดฟิลด์เนื้อหาที่ถูกแทนที่ทั้งหมดที่บันทึกไว้ของพรีเซ็ต ไม่ใช่แค่ฟิลด์ในคำขอปัจจุบัน — พรีเซ็ตที่มีโทเค็นที่เสียหายอยู่แล้วในฟิลด์ที่ไม่ได้แตะต้อง จะทำให้การเรียก UpdatePartial ครั้งต่อๆ ไปล้มเหลวทุกครั้งจนกว่าโทเค็นนั้นจะได้รับการแก้ไข localizedTitle, localizedSubtitle และ localizedContent เป็นข้อยกเว้น: จะถูกตรวจสอบก็ต่อเมื่อการเรียกเดียวกันนั้นรวมฟิลด์เหล่านี้อยู่ด้วย

Modifiers ที่ยอมรับ

ตัวเลือกการปรับแต่งส่วนบุคคลของ Control Panel มี modifier ทุกตัวด้านล่างสำหรับแท็ก INTEGER/PRICE (รวมถึงรูปแบบวันที่) และแท็กสตริง ยกเว้น base64 — ซึ่งสามารถเข้าถึงได้ผ่าน API เท่านั้น gitlab.corp.pushwoosh.com/channels/sdk/pkg/dynamiccontent คือแหล่งข้อมูลจริงที่ทั้ง Control Panel และ API นี้ใช้ในการตรวจสอบ

Modifier	ประเภทแท็ก	หมายเหตุ
`capitalizefirst`	string	ไม่คำนึงถึงตัวพิมพ์เล็ก-ใหญ่
`capitalizeallfirst`	string	ไม่คำนึงถึงตัวพิมพ์เล็ก-ใหญ่
`uppercase`	string	ไม่คำนึงถึงตัวพิมพ์เล็ก-ใหญ่
`lowercase`	string	ไม่คำนึงถึงตัวพิมพ์เล็ก-ใหญ่
`regular`	string หรือ integer	ไม่คำนึงถึงตัวพิมพ์เล็ก-ใหญ่ ไม่มีการจัดรูปแบบ
`base64`	string	ไม่คำนึงถึงตัวพิมพ์เล็ก-ใหญ่, API เท่านั้น — ไม่มีในตัวเลือกของ CP
`cent` / `dollar` / `comma` / `euro` / `jpy` / `lira`	integer	ไม่คำนึงถึงตัวพิมพ์เล็ก-ใหญ่
`M-d-y`, `m-d-y`, `M d y`, `M d Y`, `l`, `M d`, `H:i`, `m-d-y H:i`	integer	Modifiers รูปแบบวันที่, จับคู่ตรงตามที่เขียน, รวมถึงตัวพิมพ์เล็ก-ใหญ่

Endpoints

เมธอด	เส้นทาง	คำอธิบาย
`POST`	`/api/presets`	สร้างพรีเซ็ตพุชใหม่
`GET`	`/api/presets`	แสดงรายการพรีเซ็ตพุชของแอปพลิเคชัน
`GET`	`/api/presets/{code}`	รับพรีเซ็ตพุชเดียว
`PUT`	`/api/presets/{code}`	อัปเดตพรีเซ็ตพุช (เขียนทับทั้งหมด)
`PUT`	`/api/presets/{code}:partial`	อัปเดตพรีเซ็ตพุช (บางส่วน)
`POST`	`/api/presets/{code}:clone`	โคลนพรีเซ็ตพุช
`DELETE`	`/api/presets/{code}`	ลบพรีเซ็ตพุช

สร้าง

สร้างพรีเซ็ตพุชใหม่ในแอปพลิเคชันและส่งคืนพร้อมกับโค้ดที่สร้างขึ้น

POST /api/presets

เนื้อหาคำขอ

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
`application`	string	ใช่	โค้ดแอปพลิเคชัน ที่จะสร้างพรีเซ็ต
`name`	string	ใช่	ชื่อพรีเซ็ต
`sendType`	string	ไม่	ช่องทางของพรีเซ็ต (เช่น `push`)
`isV2`	boolean	ไม่	ปักหมุดแฟล็กต้นทางของพรีเซ็ต ละเว้นเพื่อตั้งค่าเริ่มต้นเป็น `true` (v2); ตั้งค่า `false` เฉพาะเมื่อต้องการสร้างพรีเซ็ต v1 แบบดั้งเดิม

ฟิลด์อื่นๆ ทั้งหมด — เนื้อหาที่แปลเป็นภาษาท้องถิ่น, แพลตฟอร์ม, deep link, inbox, หมวดหมู่ และอื่นๆ — จะใช้ร่วมกับ Update และมีเอกสารอธิบายไว้ครั้งเดียวในข้อมูลอ้างอิง อ็อบเจกต์ Preset ด้านล่าง

ตัวอย่างคำขอ

{
  "application": "XXXXX-XXXXX",
  "name": "20% discount",
  "platforms": { "1": true, "3": true },
  "localizedContent": {
    "default": "Get your 20% discount right now",
    "es": "Consigue tu 20% de descuento ahora mismo"
  },
  "localizedTitle": { "default": "Hi there" },
  "openAction": { "link": { "url": "https://example.com" } },
  "categories": ["promo"]
}

การตอบกลับ

ส่งคืน { "preset": { ... } } ซึ่งเป็น อ็อบเจกต์ Preset ที่สร้างขึ้น

รายการ

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

GET /api/presets

พารามิเตอร์ Query

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
`application`	string	ใช่	โค้ดแอปพลิเคชันที่จะแสดงรายการพรีเซ็ต
`orderBy`	string	ไม่	`NAME` (ค่าเริ่มต้น), `CREATED` หรือ `UPDATED`
`orderDirection`	string	ไม่	`ASC` (ค่าเริ่มต้น) หรือ `DESC`
`page`	integer	ไม่	ดัชนีหน้าแบบศูนย์
`perPage`	integer	ไม่	ขนาดหน้า ค่าเริ่มต้นคือ `100` เมื่อละเว้นหรือเป็น `0`
`searchByName`	string	ไม่	การจับคู่สตริงย่อยที่ไม่คำนึงถึงตัวพิมพ์เล็ก-ใหญ่บนชื่อพรีเซ็ต หรือ โค้ด (`ILIKE %value%`)
`searchByCategory`	array of strings	ไม่	ทำซ้ำพารามิเตอร์เพื่อกรองตามหมวดหมู่หลายรายการ เช่น `?searchByCategory=promo&searchByCategory=lifecycle`
`showHidden`	boolean	ไม่	รวมพรีเซ็ตที่ทำเครื่องหมายว่า `hidden`

การตอบกลับ

แต่ละรายการมีเพียง: name, code, platforms, localized_content (ข้อความธรรมดาต่อภาษา — ไม่ใช่ localized_properties), localized_title, localized_subtitle, banner, icon, categories, journey_uuid, custom_data, is_v2, created, updated ฟิลด์อื่นๆ ทั้งหมดของ อ็อบเจกต์ Preset — localized_properties, platform_properties, deeplink, richmedia, url และอื่นๆ — จะถูกละเว้น แม้ว่าจะตั้งค่าไว้ในพรีเซ็ตก็ตาม

ฟิลด์	ประเภท	คำอธิบาย
`presets`	array of objects	หน้าปัจจุบันของพรีเซ็ต ในรูปแบบที่ลดลงตามที่อธิบายไว้ข้างต้น
`page`	integer	ดัชนีหน้าที่ส่งคืน
`per_page`	integer	ขนาดหน้าที่ใช้สำหรับการตอบกลับนี้
`total`	integer	จำนวนพรีเซ็ตทั้งหมดที่ตรงกับตัวกรองในทุกหน้า

ตัวอย่างการตอบกลับ

{
  "presets": [
    { "name": "20% discount", "code": "AAAAA-BBBBB", "platforms": { "1": true, "3": true }, "categories": ["promo"] }
  ],
  "page": 0,
  "per_page": 100,
  "total": 1
}

รับ

ส่งคืนพรีเซ็ตพุชเดียวตามโค้ด พร้อมกับทุกฟิลด์ของ อ็อบเจกต์ Preset ที่กรอกข้อมูลแล้ว

GET /api/presets/{code}

พารามิเตอร์ Path

พารามิเตอร์	ประเภท	คำอธิบาย
`code`	string	โค้ดของพรีเซ็ต

การตอบกลับ

ส่งคืน { "preset": { ... } } ซึ่งเป็น อ็อบเจกต์ Preset ฉบับเต็ม

อัปเดต

เขียนทับพรีเซ็ตพุชที่มีอยู่ตามโค้ดด้วยฟิลด์ที่ให้มา

PUT /api/presets/{code}

พารามิเตอร์ Path

พารามิเตอร์	ประเภท	คำอธิบาย
`code`	string	โค้ดของพรีเซ็ตที่จะเขียนทับ

เนื้อหาคำขอ

ฟิลด์เดียวกับ สร้าง (ลบ application) บวกกับฟิลด์ที่เหลือของ อ็อบเจกต์ Preset sendType ได้รับการยอมรับแต่จะถูกละเว้น — ไม่สามารถเปลี่ยนช่องทางของพรีเซ็ตได้หลังจากการสร้าง

Update จะสร้างคุณสมบัติเนื้อหาของพรีเซ็ตใหม่ทั้งหมดในทุกการเรียก: localizedProperties, platformProperties, openAction/openActions, deeplink, deeplinkParams, richmedia, url, campaignCode, filterCode, geoZones, sendRate, cappingCount/cappingDays, ฟิลด์ notification*Url ทั้งสาม, remotePage, wnsContent, originalUrl, แฟล็ก *Silent ทั้งสี่, inboxImage/inboxIcon/inboxDays/inboxDate, banner, icon, customData และ isV2 — หากละเว้นฟิลด์ใดๆ เหล่านี้ จะถูกล้างค่า (หรือสำหรับ isV2 จะถูกรีเซ็ตเป็น true)

name, platforms, categories, localizedTitle, localizedSubtitle และ localizedContent เป็นข้อยกเว้น: แต่ละฟิลด์จะถูกแตะต้องก็ต่อเมื่อคุณส่งมัน และจะถูกปล่อยไว้ไม่เปลี่ยนแปลงเมื่อละเว้น

ใช้ UpdatePartial หากคุณต้องการให้กลุ่มแรกถูกปล่อยไว้ไม่เปลี่ยนแปลงเมื่อละเว้นเช่นกัน

การตอบกลับ

อ็อบเจกต์ว่างเปล่าเมื่อสำเร็จ: {}

UpdatePartial

อัปเดตเฉพาะฟิลด์ที่ให้มาของพรีเซ็ตพุชที่มีอยู่ตามโค้ด โดยปล่อยฟิลด์ที่ไม่ได้ตั้งค่าไว้ไม่เปลี่ยนแปลง

PUT /api/presets/{code}:partial

พารามิเตอร์ Path

พารามิเตอร์	ประเภท	คำอธิบาย
`code`	string	โค้ดของพรีเซ็ตที่จะแพตช์

เนื้อหาคำขอ

ฟิลด์เดียวกับ อัปเดต ลบ application ซึ่งแตกต่างจาก Update ทุกฟิลด์ที่นี่ — รวมถึง localizedProperties, platformProperties, categories และส่วนที่เหลือของกลุ่มคุณสมบัติเนื้อหาที่ระบุไว้ใน ข้อควรระวังของ Update — จะถูกปล่อยไว้ไม่เปลี่ยนแปลงเมื่อละเว้น และจะถูกแตะต้องก็ต่อเมื่อคุณส่งมัน (ฟิลด์ map/array ที่คุณส่งจะยังคงแทนที่ค่าที่มีอยู่สำหรับฟิลด์นั้นทั้งหมด แต่จะไม่ส่งผลกระทบต่อสิ่งที่คุณไม่ได้รวมไว้) sendType ก็ได้รับการยอมรับแต่จะถูกละเว้นเช่นกัน

ตัวอย่างคำขอ

{
  "sendRate": 500,
  "cappingCount": 3,
  "cappingDays": 7
}

การตอบกลับ

เป็นอ็อบเจกต์ว่างเปล่าเช่นกัน — ดู ข้อควรระวังข้างต้น

โคลน

ทำซ้ำพรีเซ็ตพุชที่มีอยู่ภายใต้ชื่อใหม่ในแอปพลิเคชันเดียวกัน

POST /api/presets/{code}:clone

เนื้อหาคำขอ

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
`code`	string	ใช่	โค้ดของพรีเซ็ตต้นทางที่จะทำซ้ำ
`name`	string	ใช่	ชื่อสำหรับพรีเซ็ตใหม่

ตัวอย่างคำขอ

{ "code": "AAAAA-BBBBB", "name": "20% discount (copy)" }

การตอบกลับ

ส่งคืน { "preset": { ... } } ซึ่งเป็น อ็อบเจกต์ Preset ใหม่

ลบ

ลบพรีเซ็ตพุชอย่างถาวรตามโค้ด

DELETE /api/presets/{code}

พารามิเตอร์ Path

พารามิเตอร์	ประเภท	คำอธิบาย
`code`	string	โค้ดของพรีเซ็ตที่จะลบ

การตอบกลับ

อ็อบเจกต์ว่างเปล่าเมื่อสำเร็จ: {}

การอ้างอิงอ็อบเจกต์

ชื่อฟิลด์ด้านล่างตรงกับสิ่งที่ Get, Create, Update และ Clone ส่งคืนจริง — ชื่อฟิลด์ proto แบบ snake_case (ดู ข้อตกลงทั่วไป) รูปแบบ lowerCamelCase ที่ใช้ในตัวอย่างคำขอด้านบนทำงานในลักษณะเดียวกันกับอินพุต

อ็อบเจกต์ Preset

ข้อมูลระบุตัวตน

ฟิลด์	ประเภท	คำอธิบาย
`code`	string	สร้างขึ้นเมื่อ `Create` ใช้ระบุพรีเซ็ตนี้ในที่อื่นๆ ทั้งหมดใน API
`name`	string	ชื่อพรีเซ็ต
`send_type`	string	ช่องทางของพรีเซ็ต (เช่น `push`)
`is_v2`	boolean	`true` สำหรับพรีเซ็ตที่สร้างหรือย้ายไปยังโมเดลเนื้อหา v2
`system`	boolean	ทำเครื่องหมายพรีเซ็ตว่าเป็นพรีเซ็ตระบบ/ภายใน
`hidden`	boolean	ซ่อนพรีเซ็ตจากผลลัพธ์ `List` (ส่ง `showHidden: true` เพื่อรวม)
`created`	string (RFC 3339)	การประทับเวลาการสร้าง
`updated`	string (RFC 3339)	การประทับเวลาการอัปเดตล่าสุด

การกำหนดเป้าหมายและเนื้อหา

ฟิลด์	ประเภท	คำอธิบาย
`platforms`	map<string, boolean>	แพลตฟอร์มที่พรีเซ็ตกำหนดเป้าหมาย โดยใช้ รหัสประเภทอุปกรณ์ เป็นคีย์ (เช่น `"1"` สำหรับ iOS)
`localized_properties`	map<string, object>	ภาษา → เนื้อหา rich per-platform รูปแบบเดียวกับ `LocalizedContent` บน payload ของ `Notify` — หนึ่งรายการต่อบล็อกแพลตฟอร์ม (`ios`, `android` และอื่นๆ) นี่เป็นวิธีหลักในการตั้งค่าเนื้อหาพุชเฉพาะแพลตฟอร์ม
`localized_title` / `localized_subtitle` / `localized_content`	map<string, string>	ภาษา → ข้อความธรรมดา ทางเลือกที่ง่ายกว่า `localized_properties` สำหรับชื่อเรื่อง, คำบรรยาย และเนื้อหาเมื่อคุณไม่ต้องการการแทนที่เฉพาะแพลตฟอร์ม
`platform_properties`	map<string, object>	การแทนที่เฉพาะแพลตฟอร์มแบบดั้งเดิม โดยใช้ชื่อ enum ของแพลตฟอร์มเป็นคีย์ (`IOS`, `ANDROID`, `HUAWEI_ANDROID`, `OSX`) ดู อ็อบเจกต์ PlatformProperties ด้านล่าง
`open_action`	`OpenAction`	การกระทำที่เกิดขึ้นเมื่อผู้ใช้เปิดการแจ้งเตือน ใช้กับทุกแพลตฟอร์ม ไม่สามารถใช้ร่วมกับ `open_actions` ได้ — การตอบกลับจะตั้งค่าเพียงอย่างใดอย่างหนึ่ง
`open_actions`	map<string, `OpenAction`>	การแทนที่ `open_action` เฉพาะแพลตฟอร์ม โดยใช้ รหัสประเภทอุปกรณ์ เป็นคีย์
`deeplink`	string	โค้ด Deep Link
`deeplink_params`	map<string, string>	พารามิเตอร์ที่ส่งไปยัง deep link
`richmedia`	string	โค้ด Rich Media ที่เปิดโดยการแจ้งเตือน
`url`	string	URL ที่เปิดโดยการแจ้งเตือน หากไม่ได้ใช้ deep link หรือ Rich Media

Inbox

ฟิลด์	ประเภท	คำอธิบาย
`inbox_image`	string	URL รูปภาพที่แสดงในรายการ Message Inbox
`inbox_icon`	string	URL ไอคอนที่แสดงในรายการ Message Inbox
`inbox_days`	integer	จำนวนวันที่รายการจะอยู่ใน Message Inbox
`inbox_date`	string (RFC 3339)	วันหมดอายุที่ชัดเจนสำหรับรายการ Message Inbox เป็นทางเลือกแทน `inbox_days`

การจัดระเบียบและข้อมูลเมตา

ฟิลด์	ประเภท	คำอธิบาย
`categories`	array of strings	ชื่อหมวดหมู่ที่พรีเซ็ตถูกแท็กด้วย
`campaign_code`	string	โค้ดแคมเปญ ที่พรีเซ็ตนี้ถูกระบุแหล่งที่มา
`filter_code`	string	โค้ด Segment / Filter ที่พรีเซ็ตนี้กำหนดเป้าหมายโดยค่าเริ่มต้น
`geo_zones`	string	การกำหนดเป้าหมาย Geozone หากพรีเซ็ตถูกทริกเกอร์ตามตำแหน่งทางภูมิศาสตร์
`journey_uuid`	string	UUID ของ Customer Journey ที่เป็นเจ้าของพรีเซ็ตนี้ หากสร้างจาก Send push point ของ journey
`custom_data`	object	JSON รูปแบบอิสระที่ส่งต่อไปยัง client SDK เป็นพารามิเตอร์ `u`
`banner`	string	URL รูปภาพขนาดใหญ่ / ไฟล์แนบ
`icon`	string	URL ไอคอนการแจ้งเตือนที่กำหนดเอง

ขีดจำกัดการส่ง

ฟิลด์	ประเภท	คำอธิบาย
`send_rate`	integer	การควบคุมปริมาณการส่งที่ใช้พรีเซ็ตนี้ ในหน่วยข้อความ/วินาที — เทียบเท่าระดับพรีเซ็ตของ `SendRate` ของ `Notify`
`capping_count` / `capping_days`	integer	ขีดจำกัดความถี่ต่อผู้ใช้สำหรับพรีเซ็ตนี้ — เทียบเท่าระดับพรีเซ็ตของ `FrequencyCapping` `count` / `days` ของ `Notify`

Webhooks

ฟิลด์	ประเภท	คำอธิบาย
`notification_sent_url`	string	URL การเรียกกลับที่ร้องขอเมื่อมีการส่งการแจ้งเตือนที่ใช้พรีเซ็ตนี้
`notification_delivered_url`	string	URL การเรียกกลับที่ร้องขอเมื่อมีการส่งมอบการแจ้งเตือนที่ใช้พรีเซ็ตนี้
`notification_click_url`	string	URL การเรียกกลับที่ร้องขอเมื่อมีการคลิกการแจ้งเตือนที่ใช้พรีเซ็ตนี้

ฟิลด์ดั้งเดิม

สิ่งเหล่านี้สืบทอดมาจากโมเดลพรีเซ็ต v1 ซึ่งถูกกรอกข้อมูลเพื่อความเข้ากันได้กับ Control Panel มากกว่าสำหรับการผสานรวมใหม่

ฟิลด์	ประเภท	คำอธิบาย
`remote_page`	string	การอ้างอิงหน้าเว็บระยะไกลแบบดั้งเดิม
`wns_content`	string	JSON เทมเพลต Windows toast แบบดั้งเดิม ตามที่ยอมรับโดยเมธอด `createPreset`/`getPreset` ของ v1
`original_url`	string	ค่าของ `url` ก่อนการย่อ เมื่อ `url` ถูกแทนที่ด้วยลิงก์ที่ย่อแล้ว
`ios_silent` / `android_silent` / `huawei_android_silent`	boolean	แฟล็กพุชแบบเงียบ (เฉพาะข้อมูล) เฉพาะแพลตฟอร์ม

อ็อบเจกต์ PlatformProperties

ฟิลด์ที่มีในแต่ละรายการ platform_properties (IOS, ANDROID, HUAWEI_ANDROID, OSX):

ฟิลด์	ประเภท	คำอธิบาย
`badge`	string	การแทนที่จำนวนป้าย
`sound`	string	ชื่อไฟล์เสียง
`sound_off`	boolean	ปิดเสียงการแจ้งเตือน
`priority`	string	ลำดับความสำคัญในถาด (Android/Huawei เท่านั้น)
`delivery_priority`	string	ลำดับความสำคัญในการส่ง `NORMAL` หรือ `HIGH` (Android/Huawei เท่านั้น)
`ios_interruption_level`	string	`passive`, `active`, `time-sensitive` หรือ `critical` (iOS เท่านั้น)

เกี่ยวข้อง

Notify

การอ้างอิง Payload

การอ้างอิงพอยต์ Customer Journey