API 方法参考索引

Pushwoosh 提供了包含 100 多种 API 方法的庞大库，这些方法按发送通知、管理用户和跟踪分析等各种功能进行了分类。

消息传递 API v2

统一的 API，取代了整个 /create*Message 系列（推送、电子邮件、SMS、Kakao）。请参阅概述和迁移指南。

Notify	通过任何渠道创建并发送单条消息。取代 /createMessage、/createTargetedMessage、/createEmailMessage、/createSMSMessage、/createKakaoMessage。
Cancel	在消息送达前取消先前创建的消息。与来自 Notify 的 message_code 一起使用。
Update	用新的定义（完全替换）替换仍在计划中的消息。与来自 Notify 的 message_code 一起使用。

SMTP 网关

通过标准 SMTP 提交事务性电子邮件，而不是直接调用 API。网关使用您的应用程序代码和 API 令牌进行身份验证，然后将每条消息转发到 Notify。请参阅 SMTP 网关参考。

消息 API

createMessage 已弃用	创建新的推送通知。请改用 Notify。
deleteMessage	删除已计划的消息。
getMessageDetails	检索消息详情。
createTargetedMessage 已弃用	创建新的定向推送通知。请改用带有 transactional 类型的 Notify。
getPushHistory 已弃用	使用 /messages:list 检索包含详细数据的消息历史记录。
cancelMessage	取消已计划的消息。

预设 API

createPreset	创建新的预设。
getPreset	检索指定推送预设的参数。
listPresets	检索为应用创建的预设列表。
deletePreset	从您的账户中删除预设。

设备 API

registerDevice	为应用程序注册设备。
unregisterDevice	移除设备的推送令牌。
deleteDevice	删除指定应用程序中的设备及其所有相关数据。
setTags	为设备设置标签值。
getTags	检索特定设备的标签及其对应值。
setBadge	将设备的当前角标值发送到 Pushwoosh。
applicationOpen	注册应用打开事件。
pushStat	注册推送打开事件。
messageDeliveryEvent	为设备注册推送送达事件。

受众 API

bulkSetTags	为多个设备设置标签值。
bulkSetTags Status	返回 bulkSetTags 操作的状态。
bulkRegisterDevice	在单个请求中注册多个设备，包括每个设备的可选标签值。
bulkRegisterDevice Status	使用请求 ID 检索批量设备注册请求的状态和结果。
bulkUnregisterDevice	在单个请求中注销多个设备。
bulkUnregisterDevice Status	使用请求 ID 检索批量设备注销请求的状态和结果。

标签 API

addTag	在您的账户中创建标签。
deleteTag	移除标签及其所有相关信息。
listTags	检索账户上的标签列表。

分段 (筛选器) API

createFilter	创建新的分段。
listFilters	返回可用分段及其条件的列表。
deleteFilter	删除现有分段。
exportSegment	计划一个请求以导出与分段条件匹配的订阅者。
exportSegment Results	检索 exportSegment 结果的 CSV 链接。

以用户为中心的 API

registerUser	将外部 User ID 与指定设备关联。
deleteUser	删除用户以及与指定 User ID 关联的所有设备。
postEvent	在应用内调用事件。

事件 API

createEvent	为应用创建事件。

应用程序 API

createApplication	在账户上创建新的应用程序。
updateApplication	更新应用程序设置。
deleteApplication	从账户中删除应用。
getApplication	获取有关应用的详细信息。
getApplications	检索账户上的应用程序列表。
getApplicationFile	检索与应用相关的配置文件。
setApplicationPlatformStatus	更改应用的平台状态。

营销活动 API

createCampaign	创建新的推送营销活动。
deleteCampaign	删除特定的营销活动。
getCampaigns	检索应用的营销活动列表。

应用配置 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 平台。

电子邮件 API

createEmailMessage 已弃用	创建电子邮件消息。请改用带有 platforms: ["EMAIL"] 和 email_payload 的 Notify。
registerEmail	为应用注册电子邮件地址。
deleteEmail	从您的数据库中删除电子邮件地址。
setEmailTags	为指定的电子邮件地址设置标签值。
registerEmailUser	将外部 User ID 与指定的电子邮件地址关联。

测试设备 API

createTestDevice	为应用程序注册测试设备。
listTestDevices	检索为应用程序注册的所有测试设备。

消息收件箱 API

getInboxMessages	检索指定 HWID 的收件箱消息列表。
inboxStatus	更新特定收件箱消息的状态。

统计 API

消息统计

messages:list	检索已发送消息的列表。
totalsByIntervals	提供按小时汇总的指标和转化数据。
getMessageLog	检索有关已发送消息的详细信息。
linksInteractions	提供有关电子邮件链接点击的统计信息。
linksInteractionsDevices	列出点击电子邮件中链接的用户。
bouncedEmails	提供有关电子邮件退回、投诉和退回原因的信息。

应用程序和订阅者统计

getApplicationSubscribersStats	检索应用的订阅者统计信息，按设备类型分组。
getAppStats	检索特定时间段的应用统计信息。
getSubscribersStatistics	检索特定时间段的订阅者统计信息。

营销活动统计

getCampaignStats	检索特定时间段的营销活动统计信息。

事件和标签统计

getEventStatistics	检索在特定时间段内事件被触发的次数。
getTagStats	检索特定标签的统计信息。

iOS 实时活动 API

startLiveActivity	创建新的 iOS 实时活动。
updateLiveActivity	更新现有的 iOS 实时活动。

Apple Wallet PassKit API

Apple Wallet PassKit API	用于在 Pushwoosh 中管理 Apple Wallet 通行证和相关配置的参考。

Google Wallet API

Create a pass	在 Google Wallet 中创建通行证并返回一个保存链接。
Validate a pass	检查通行证配置而不创建它。
Update a pass	更新现有通行证。Google 会将更改发送到已保存的设备。
Get a save link	为现有通行证返回一个“添加到 Google Wallet”的保存链接。
Get a pass	返回单个存储的通行证。
List passes	返回应用程序的分页通行证列表。
Set pass state	激活或使通行证失效。
Delete a pass	使 Google 中的通行证失效并删除其 Pushwoosh 记录。
Get configuration	返回应用程序的 Google Wallet 配置状态。
Templates	列出通行证模板或获取一个作为起点。

Customer Journey API

Lifecycle	通过其 UUID 启动、暂停、完成、草稿或归档一个 Journey。
Create and update	创建新的 Journey 定义或替换现有定义。
Start by API	将用户注入正在运行的 Journey 的 API 入口点。
Get Journey stats	通过其 ID 获取特定 Journey 的统计数据。
Remove users from journeys	从所有或选定的活动 Journey 中移除一个或多个用户。

计划请求 API

getResults	检索计划请求的结果。

SMS API

createSMSMessage 已弃用	创建新的 SMS 消息。请改用带有 platforms: ["SMS"] 的 Notify。

WhatsApp API

createWhatsAppMessage 已弃用	创建新的 WhatsApp 消息。请改用带有 platforms: ["WHATS_APP"] 的 Notify。

LINE API

createLineMessage 已弃用	创建新的 LINE 消息。请改用带有 platforms: ["LINE"] 的 Notify。

Kakao API

createKakaoMessage 已弃用	使用经批准的模板发送 Kakao 消息。请改用带有 platforms: ["KAKAO"] 的 Notify。

地理区域 API

getNearestZone	检索最近的地理区域的参数及其距离。还记录设备位置以用于地理推送通知。
addGeoZone	将地理区域添加到特定应用。
updateGeoZone	更新地理区域属性，如名称、状态、内容和范围。
deleteGeoZone	从应用中删除地理区域。
addGeoZoneCluster	将地理区域集群添加到应用。
deleteGeoZoneCluster	从应用中删除地理区域集群。
listGeoZones	检索应用的地理区域列表。
listGeoZoneClusters	检索应用的地理区域集群列表。