ข้ามไปยังเนื้อหา

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

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

Messages API

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

Presets API

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

Device API

Anchor link to
registerDeviceลงทะเบียนอุปกรณ์สำหรับแอปพลิเคชัน
unregisterDeviceลบ push token ของอุปกรณ์
setTagsตั้งค่าแท็กสำหรับอุปกรณ์
getTagsดึงแท็กพร้อมค่าที่สอดคล้องกันสำหรับอุปกรณ์ที่ระบุ
setBadgeส่งค่าป้ายสถานะ (badge) ปัจจุบันสำหรับอุปกรณ์ไปยัง Pushwoosh
applicationOpenลงทะเบียนอีเวนต์การเปิดแอป
pushStatลงทะเบียนอีเวนต์การเปิดพุช
messageDeliveryEventลงทะเบียนอีเวนต์การส่งพุชสำหรับอุปกรณ์

Audience API

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

Segmentation (Filters) API

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

User-centric API

Anchor link to
registerUserเชื่อมโยง User ID ภายนอกกับอุปกรณ์ที่ระบุ
postEventเรียกใช้อีเวนต์ภายในแอป

Events API

Anchor link to
createEventสร้างอีเวนต์สำหรับแอป

Applications API

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

Campaigns API

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

App configuration API

Anchor link to
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 สำหรับแอป
createEmailMessageสร้างข้อความอีเมล
registerEmailลงทะเบียนที่อยู่อีเมลสำหรับแอป
deleteEmailลบที่อยู่อีเมลออกจากฐานข้อมูลของคุณ
setEmailTagsตั้งค่าแท็กสำหรับที่อยู่อีเมลที่ระบุ
registerEmailUserเชื่อมโยง User ID ภายนอกกับที่อยู่อีเมลที่ระบุ

Test devices API

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

Message inbox API

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

Statistics API

Anchor link to

Message statistics

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

Application and subscriber statistics

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

Campaign statistics

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

Events and tags statistics

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

iOS Live Activities API

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

Customer Journey API

Anchor link to
Get Journey statsรับสถิติสำหรับ Journey ที่ระบุโดยใช้ ID
Remove users from journeysลบผู้ใช้หนึ่งคนหรือมากกว่าออกจาก Journey ที่ใช้งานอยู่ทั้งหมดหรือที่เลือก

Scheduled requests API

Anchor link to
getResultsดึงผลลัพธ์ของคำขอที่ตั้งเวลาไว้
createSMSMessageสร้างข้อความ SMS ใหม่

WhatsApp API

Anchor link to
createWhatsAppMessageสร้างข้อความ WhatsApp ใหม่
createLineMessageสร้างข้อความ LINE ใหม่
createKakaoMessageส่งข้อความ Kakao โดยใช้เทมเพลตที่ได้รับอนุมัติ

Geozones API

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