ดัชนีอ้างอิงเมธอด 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

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

Messages API

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

Presets API

Create	สร้างพรีเซ็ตพุชใหม่
List	แสดงรายการพรีเซ็ตพุชของแอปพลิเคชัน
Get	ดึงพรีเซ็ตพุชเดียวตามรหัส
Update	เขียนทับพรีเซ็ตพุชตามรหัส
UpdatePartial	อัปเดตเฉพาะฟิลด์ที่ให้มาของพรีเซ็ตพุชตามรหัส
Clone	ทำซ้ำพรีเซ็ตพุชภายในแอปพลิเคชันเดียวกัน
Delete	ลบพรีเซ็ตพุชตามรหัส

Device API

registerDevice	ลงทะเบียนอุปกรณ์สำหรับแอปพลิเคชัน
unregisterDevice	ลบโทเค็นพุชของอุปกรณ์
deleteDevice	ลบอุปกรณ์และข้อมูลที่เกี่ยวข้องทั้งหมดในแอปพลิเคชันที่ระบุ
setTags	ตั้งค่าแท็กสำหรับอุปกรณ์
getTags	ดึงแท็กพร้อมค่าที่สอดคล้องกันสำหรับอุปกรณ์เฉพาะ
setBadge	ส่งค่าป้ายสถานะปัจจุบันสำหรับอุปกรณ์ไปยัง 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	สร้างเซกเมนต์ใหม่
listFilters	ส่งคืนรายการเซกเมนต์ที่มีอยู่พร้อมเงื่อนไข
deleteFilter	ลบเซกเมนต์ที่มีอยู่
exportSegment	กำหนดเวลาคำขอเพื่อส่งออกผู้ติดตามที่ตรงกับเงื่อนไขของเซกเมนต์
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	เปลี่ยนสถานะแพลตฟอร์มของแอป

Control Groups API

List	แสดงรายการกลุ่มควบคุมของแอปพลิเคชัน
Create	สร้างกลุ่มควบคุม
Get	ดึงกลุ่มควบคุมเดียวตามรหัส
UpdatePercentage	ปรับขนาดเปอร์เซ็นต์การกันออกของกลุ่มควบคุม
UpdateCountries	กำหนดขอบเขตกลุ่มควบคุมใหม่เป็นชุดของประเทศ
Disable	ปิดกลุ่มควบคุม
Reshuffle	สุ่มตัวอย่างการกันออกของกลุ่มควบคุมใหม่
ForceUpdateCalculation	เริ่มนับขนาดของกลุ่มควบคุมใหม่
GetCalculationStatus	สำรวจการคำนวณขนาดที่กำลังทำงานอยู่
GetAnalytics	ดึงข้อมูลการวิเคราะห์ Control-vs-Treatment สำหรับกลุ่มควบคุม
CheckControlGroupMembership	รายงานว่า User ID แต่ละรายการในชุดถูกกันออกโดยกลุ่มควบคุมหรือไม่
Delete	ลบกลุ่มควบคุม

Data Erasure API

Create	เริ่มการลบ (หรือการนับแบบทดลอง) ข้อมูลส่วนบุคคลของบุคคลหนึ่ง
Upload	สร้างงานลบข้อมูลจากไฟล์ CSV ของตัวระบุที่อัปโหลด
ListTasks	แสดงรายการงานลบข้อมูลของบัญชี
GetTask	ดึงสถานะและตัวนับของงานลบข้อมูลหนึ่งงาน
ListTaskRows	แสดงผลลัพธ์รายตัวระบุของงานหนึ่งงาน
GetTaskReport	ดาวน์โหลดรายงานของงานหนึ่งงานเป็น CSV
GetJournalReport	ดาวน์โหลดงานทั้งหมดในช่วงเวลาหนึ่งเป็นไฟล์ CSV เดียว

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 ภายนอกกับที่อยู่อีเมลที่ระบุ

Email Templates API

Create	สร้างเทมเพลตอีเมลใหม่ในแอปพลิเคชัน
List	แสดงรายการเทมเพลตอีเมลของแอปพลิเคชัน
Get	ส่งคืนเทมเพลตอีเมลเดียวตามรหัส
Update	อัปเดตเทมเพลตอีเมลที่มีอยู่ตามรหัส
Delete	ลบเทมเพลตอีเมลและพรีเซ็ตที่เชื่อมต่ออยู่ตามรหัส
Clone	โคลนเทมเพลตอีเมลไปยังแอปพลิเคชันปลายทาง

Test devices API

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

Message inbox API

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

Statistics API

สถิติข้อความ

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

การส่งออกสถิติข้อความแบบอะซิงโครนัส

exportMessagesStatistics/export	จัดคิวการส่งออกประวัติข้อความเป็นไฟล์ CSV โดยไม่มีการจำกัดแถวของ messages:list
exportMessagesStatistics/status	ส่งคืนความคืบหน้าของงานส่งออก
exportMessagesStatistics/result	ส่งคืนชื่อไฟล์ที่สร้างขึ้นเมื่อทำงานเสร็จสิ้น
exportMessagesStatistics/lastTasks	แสดงรายการงานส่งออกล่าสุดสำหรับแอปพลิเคชัน
exportMessagesStatistics/delete	ลบงานและไฟล์ของงานก่อนที่ระยะเวลาการเก็บรักษาจะหมดอายุ
exportMessagesStatistics/download	ดาวน์โหลดไฟล์ CSV ที่สร้างขึ้นตามชื่อ

สถิติแอปพลิเคชันและผู้ติดตาม

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

สถิติแคมเปญ

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

สถิติเหตุการณ์และแท็ก

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

สถิติในแอป

inapps:totals	ดึงข้อมูลยอดรวมของการแสดงผล การโต้ตอบ และการจำกัดความถี่สำหรับแคมเปญในแอปหนึ่งแคมเปญหรือมากกว่าในช่วงเวลาหนึ่ง
inapps:timeline	ดึงข้อมูลยอดรวมของช่วงเวลาและอนุกรมเวลาของเมตริกในแอปสำหรับแคมเปญเดียว

iOS Live Activities API

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

Apple Wallet PassKit API

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

Google Wallet API

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

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 ที่ใกล้ที่สุดและระยะทางไปยังโซนนั้น และยังบันทึกตำแหน่งของอุปกรณ์สำหรับการแจ้งเตือนแบบพุชตามตำแหน่งทางภูมิศาสตร์
addGeoZone	เพิ่ม Geozone ไปยังแอปที่ระบุ
updateGeoZone	อัปเดตคุณสมบัติของ Geozone เช่น ชื่อ สถานะ เนื้อหา และช่วง
deleteGeoZone	ลบ Geozones ออกจากแอป
addGeoZoneCluster	เพิ่ม Geozone Cluster ไปยังแอป
deleteGeoZoneCluster	ลบ Geozone Cluster ออกจากแอป
listGeoZones	ดึงรายการ Geozones สำหรับแอป
listGeoZoneClusters	ดึงรายการคลัสเตอร์ Geozone สำหรับแอป