ดัชนีอ้างอิงเมธอด API

Pushwoosh มีไลบรารีขนาดใหญ่ของเมธอด API กว่า 100 รายการ ซึ่งจัดหมวดหมู่ตามฟังก์ชันต่างๆ เช่น การส่งการแจ้งเตือน การจัดการผู้ใช้ และการติดตามการวิเคราะห์

Messaging API v2

API แบบครบวงจรที่มาแทนที่กลุ่มเมธอด /create*Message ทั้งหมด (push, email, SMS, Kakao) ดู ภาพรวม และ คู่มือการย้ายระบบ

Notify	สร้างและส่งข้อความเดียวผ่านช่องทางใดก็ได้ แทนที่ /createMessage, /createTargetedMessage, /createEmailMessage, /createSMSMessage, /createKakaoMessage
Cancel	ยกเลิกข้อความที่สร้างไว้ก่อนหน้านี้ก่อนที่จะถูกส่ง ใช้กับ message_code จาก Notify
Update	แทนที่ข้อความที่ยังคงตั้งเวลาไว้ด้วยคำจำกัดความใหม่ (แทนที่ทั้งหมด) ใช้กับ message_code จาก Notify

SMTP gateway

ส่งอีเมลธุรกรรมผ่าน SMTP มาตรฐานแทนการเรียก API โดยตรง เกตเวย์จะตรวจสอบสิทธิ์ด้วยรหัสแอปพลิเคชันและโทเค็น API ของคุณ จากนั้นจะส่งต่อแต่ละข้อความไปยัง Notify ดู ข้อมูลอ้างอิง SMTP gateway

Messages API

createMessage เลิกใช้งานแล้ว	สร้างการแจ้งเตือนแบบพุชใหม่ ใช้ Notify แทน
deleteMessage	ลบข้อความที่ตั้งเวลาไว้
getMessageDetails	ดึงรายละเอียดข้อความ
createTargetedMessage เลิกใช้งานแล้ว	สร้างการแจ้งเตือนแบบพุชที่กำหนดเป้าหมายใหม่ ใช้ Notify กับชนิด transactional แทน
getPushHistory เลิกใช้งานแล้ว	ใช้ /messages:list เพื่อดึงประวัติข้อความพร้อมข้อมูลโดยละเอียด
cancelMessage	ยกเลิกข้อความที่ตั้งเวลาไว้

Presets API

createPreset	สร้าง Preset ใหม่
getPreset	ดึงพารามิเตอร์ของ Preset ที่ระบุ
listPresets	ดึงรายการ Preset ที่สร้างขึ้นสำหรับแอป
deletePreset	ลบ Preset ออกจากบัญชีของคุณ

Device API

registerDevice	ลงทะเบียนอุปกรณ์สำหรับแอปพลิเคชัน
unregisterDevice	ลบโทเค็นพุชของอุปกรณ์
deleteDevice	ลบอุปกรณ์และข้อมูลที่เกี่ยวข้องทั้งหมดในแอปพลิเคชันที่ระบุ
setTags	ตั้งค่าแท็กสำหรับอุปกรณ์
getTags	ดึงแท็กพร้อมค่าที่สอดคล้องกันสำหรับอุปกรณ์ที่ระบุ
setBadge	ส่งค่า badge ปัจจุบันสำหรับอุปกรณ์ไปยัง Pushwoosh
applicationOpen	ลงทะเบียนเหตุการณ์การเปิดแอป
pushStat	ลงทะเบียนเหตุการณ์การเปิดพุช
messageDeliveryEvent	ลงทะเบียนเหตุการณ์การส่งพุชสำหรับอุปกรณ์

Audience API

bulkSetTags	ตั้งค่าแท็กสำหรับอุปกรณ์หลายเครื่อง
bulkSetTags Status	ส่งคืนสถานะของการดำเนินการ bulkSetTags
bulkRegisterDevice	ลงทะเบียนอุปกรณ์หลายเครื่องในคำขอเดียว รวมถึงค่าแท็กที่เป็นตัวเลือกสำหรับแต่ละอุปกรณ์
bulkRegisterDevice Status	ดึงสถานะและผลลัพธ์ของคำขอลงทะเบียนอุปกรณ์จำนวนมากโดยใช้ ID คำขอ
bulkUnregisterDevice	ยกเลิกการลงทะเบียนอุปกรณ์หลายเครื่องในคำขอเดียว
bulkUnregisterDevice Status	ดึงสถานะและผลลัพธ์ของคำขอยกเลิกการลงทะเบียนอุปกรณ์จำนวนมากโดยใช้ ID คำขอ

Tags API

addTag	สร้างแท็กในบัญชีของคุณ
deleteTag	ลบแท็กพร้อมข้อมูลที่เกี่ยวข้องทั้งหมด
listTags	ดึงรายการแท็กในบัญชี

Segmentation (Filters) API

createFilter	สร้าง Segment ใหม่
listFilters	ส่งคืนรายการ Segment ที่มีอยู่พร้อมเงื่อนไข
deleteFilter	ลบ Segment ที่มีอยู่
exportSegment	กำหนดเวลาคำขอเพื่อส่งออกผู้สมัครสมาชิกที่ตรงกับเงื่อนไขของ Segment
exportSegment Results	ดึงลิงก์ CSV สำหรับผลลัพธ์ exportSegment

User-centric API

registerUser	เชื่อมโยง User ID ภายนอกกับอุปกรณ์ที่ระบุ
deleteUser	ลบผู้ใช้และอุปกรณ์ทั้งหมดที่เกี่ยวข้องกับ User ID ที่ระบุ
postEvent	เรียกเหตุการณ์ภายในแอป

Events API

createEvent	สร้างเหตุการณ์สำหรับแอป

Applications API

createApplication	สร้างแอปพลิเคชันใหม่ในบัญชี
updateApplication	อัปเดตการตั้งค่าแอปพลิเคชัน
deleteApplication	ลบแอปออกจากบัญชี
getApplication	รับรายละเอียดเกี่ยวกับแอป
getApplications	ดึงรายการแอปพลิเคชันในบัญชี
getApplicationFile	ดึงไฟล์การกำหนดค่าที่เกี่ยวข้องกับแอป
setApplicationPlatformStatus	เปลี่ยนสถานะแพลตฟอร์มของแอป

Campaigns API

createCampaign	สร้างแคมเปญพุชใหม่
deleteCampaign	ลบแคมเปญที่ระบุ
getCampaigns	ดึงรายการแคมเปญสำหรับแอป

App configuration API

configureApplication for iOS	กำหนดค่าแพลตฟอร์ม iOS สำหรับแอป
configureApplication for Android	กำหนดค่าแพลตฟอร์ม Android สำหรับแอป
configureApplication for Mac OS X	กำหนดค่าแพลตฟอร์ม macOS สำหรับแอป
configureApplication for Windows	กำหนดค่าแพลตฟอร์ม Windows สำหรับแอป
configureApplication for Amazon	กำหนดค่าแพลตฟอร์ม Amazon สำหรับแอป
configureApplication for Chrome	กำหนดค่าแพลตฟอร์ม Chrome สำหรับแอป
configureApplication for Safari	กำหนดค่าแพลตฟอร์ม Safari สำหรับแอป
configureApplication for Firefox	กำหนดค่าแพลตฟอร์ม Firefox สำหรับแอป
configureApplication for Email	กำหนดค่าแพลตฟอร์ม Email สำหรับแอป

Email API

createEmailMessage เลิกใช้งานแล้ว	สร้างข้อความอีเมล ใช้ Notify กับ platforms: ["EMAIL"] และ email_payload แทน
registerEmail	ลงทะเบียนที่อยู่อีเมลสำหรับแอป
deleteEmail	ลบที่อยู่อีเมลออกจากฐานข้อมูลของคุณ
setEmailTags	ตั้งค่าแท็กสำหรับที่อยู่อีเมลที่ระบุ
registerEmailUser	เชื่อมโยง User ID ภายนอกกับที่อยู่อีเมลที่ระบุ

Test devices API

createTestDevice	ลงทะเบียนอุปกรณ์ทดสอบสำหรับแอปพลิเคชัน
listTestDevices	ดึงอุปกรณ์ทดสอบทั้งหมดที่ลงทะเบียนสำหรับแอปพลิเคชัน

Message inbox API

getInboxMessages	ดึงรายการข้อความใน Inbox สำหรับ HWID ที่ระบุ
inboxStatus	อัปเดตสถานะของข้อความใน Inbox ที่ระบุ

Statistics API

Message statistics

messages:list	ดึงรายการข้อความที่ส่งแล้ว
totalsByIntervals	ให้ข้อมูลเมตริกและข้อมูล Conversion ที่รวบรวมตามชั่วโมง
getMessageLog	ดึงข้อมูลโดยละเอียดเกี่ยวกับข้อความที่ส่งแล้ว
linksInteractions	ให้สถิติเกี่ยวกับการคลิกลิงก์ในอีเมล
linksInteractionsDevices	แสดงรายชื่อผู้ใช้ที่คลิกลิงก์ในอีเมล
bouncedEmails	ให้ข้อมูลเกี่ยวกับอีเมลที่ตีกลับ การร้องเรียน และเหตุผลการตีกลับ

Application and subscriber statistics

getApplicationSubscribersStats	ดึงสถิติผู้สมัครสมาชิกของแอป โดยจัดกลุ่มตามประเภทอุปกรณ์
getAppStats	ดึงสถิติแอปสำหรับช่วงเวลาที่ระบุ
getSubscribersStatistics	ดึงสถิติผู้สมัครสมาชิกสำหรับช่วงเวลาที่ระบุ

Campaign statistics

getCampaignStats	ดึงสถิติแคมเปญสำหรับช่วงเวลาที่ระบุ

Events and tags statistics

getEventStatistics	ดึงจำนวนครั้งที่เหตุการณ์ถูกทริกเกอร์ในช่วงเวลาที่ระบุ
getTagStats	ดึงสถิติสำหรับแท็กที่ระบุ

iOS Live Activities API

startLiveActivity	สร้าง iOS Live Activity ใหม่
updateLiveActivity	อัปเดต iOS Live Activity ที่มีอยู่

Apple Wallet PassKit API

Apple Wallet PassKit API	ข้อมูลอ้างอิงสำหรับการจัดการ Apple Wallet pass และการกำหนดค่าที่เกี่ยวข้องใน Pushwoosh

Google Wallet API

Create a pass	สร้าง pass ใน Google Wallet และส่งคืนลิงก์สำหรับบันทึก
Validate a pass	ตรวจสอบการกำหนดค่า pass โดยไม่ต้องสร้าง
Update a pass	อัปเดต pass ที่มีอยู่ Google จะส่งการเปลี่ยนแปลงไปยังอุปกรณ์ที่บันทึกไว้
Get a save link	ส่งคืนลิงก์สำหรับบันทึก “Add to Google Wallet” สำหรับ pass ที่มีอยู่
Get a pass	ส่งคืน pass ที่จัดเก็บไว้เพียงรายการเดียว
List passes	ส่งคืนรายการ pass แบบแบ่งหน้าสำหรับแอปพลิเคชัน
Set pass state	เปิดใช้งานหรือทำให้ pass เป็นโมฆะ
Delete a pass	ทำให้ pass ใน Google เป็นโมฆะและลบบันทึก Pushwoosh ของมัน
Get configuration	ส่งคืนสถานะการกำหนดค่า Google Wallet สำหรับแอปพลิเคชัน
Templates	แสดงรายการเทมเพลต pass หรือดึงเทมเพลตหนึ่งรายการเพื่อใช้เป็นจุดเริ่มต้น

Customer Journey API

Lifecycle	เริ่ม หยุดชั่วคราว สิ้นสุด ร่าง หรือจัดเก็บ journey ตาม UUID ของมัน
Create and update	สร้างคำจำกัดความ journey ใหม่หรือแทนที่อันที่มีอยู่
Start by API	นำผู้ใช้เข้าสู่จุดเริ่มต้น API ของ journey ที่กำลังทำงานอยู่
Get Journey stats	รับสถิติสำหรับ journey ที่ระบุตาม ID ของมัน
Remove users from journeys	ลบผู้ใช้หนึ่งคนหรือมากกว่าออกจาก journey ที่ใช้งานอยู่ทั้งหมดหรือที่เลือก

Scheduled requests API

getResults	ดึงผลลัพธ์ของคำขอที่ตั้งเวลาไว้

SMS API

createSMSMessage เลิกใช้งานแล้ว	สร้างข้อความ SMS ใหม่ ใช้ Notify กับ platforms: ["SMS"] แทน

WhatsApp API

createWhatsAppMessage เลิกใช้งานแล้ว	สร้างข้อความ WhatsApp ใหม่ ใช้ Notify กับ platforms: ["WHATS_APP"] แทน

LINE API

createLineMessage เลิกใช้งานแล้ว	สร้างข้อความ LINE ใหม่ ใช้ Notify กับ platforms: ["LINE"] แทน

Kakao API

createKakaoMessage เลิกใช้งานแล้ว	ส่งข้อความ Kakao โดยใช้เทมเพลตที่ได้รับอนุมัติ ใช้ Notify กับ platforms: ["KAKAO"] แทน

Geozones API

getNearestZone	ดึงพารามิเตอร์ของ Geozone ที่ใกล้ที่สุดและระยะทางไปยังโซนนั้น นอกจากนี้ยังบันทึกตำแหน่งของอุปกรณ์สำหรับการแจ้งเตือนแบบ geo push
addGeoZone	เพิ่ม Geozone ไปยังแอปที่ระบุ
updateGeoZone	อัปเดตคุณสมบัติของ Geozone เช่น ชื่อ สถานะ เนื้อหา และช่วง
deleteGeoZone	ลบ Geozone ออกจากแอป
addGeoZoneCluster	เพิ่ม Geozone Cluster ไปยังแอป
deleteGeoZoneCluster	ลบ Geozone Cluster ออกจากแอป
listGeoZones	ดึงรายการ Geozone สำหรับแอป
listGeoZoneClusters	ดึงรายการ Geozone cluster สำหรับแอป