关键 API 标识符
本文列出了 Pushwoosh API 请求中使用的基本标识符。这些标识符是进行身份验证、创建消息、定位、分段、跟踪和管理您应用中用户的必需项。
通用标识符
Anchor link to应用代码
Anchor link to分配给您 Pushwoosh 账户中每个应用的唯一标识符。在大多数 API 调用中都需要它来指定目标应用。
查找位置
Pushwoosh 控制面板 → 应用名称下方。
API 访问令牌
Anchor link to分配给 Pushwoosh 账户的唯一令牌，用于验证 API 请求。它允许访问管理项目、发送消息、修改设置和检索数据。每个账户默认至少创建一个令牌。了解更多
查找位置
Pushwoosh 控制面板 → API Access。
设备标识符
Anchor link to硬件 ID
Anchor link to由 Pushwoosh SDK 分配给设备的唯一标识符。由 SDK 自动设置或在设备注册时传递。了解更多
查找位置
-
在设备日志中。了解更多
-
在 User Explorer 中按 User ID 搜索时
-
从 Segments 列表 下载的 CSV 文件中
推送令牌
Anchor link to由平台提供商颁发的令牌，用于识别应用-设备对以传递推送通知。当授予推送权限时，由 SDK 自动收集。了解更多
查找位置
-
在设备日志中。了解更多
-
在 User Explorer 中，在搜索字段中输入 HWID 以找到关联的设备，然后打开设备详情以查看推送令牌。
设备类型
Anchor link to使用数字代码指示目标设备的平台。由 SDK 自动设置。
支持的值：
1 – iOS3 – Android7 – macOS8 – Windows9 – Amazon10 – Safari11 – Chrome12 – Firefox13 – Internet Explorer14 – Email17 – Huawei18 – SMS20 – Web21 – WhatsApp22 – Line23 – Kakao Talk24 – Telegram25 – Apple Wallet26 – Google Wallet27 – Viber用户标识符
Anchor link to用户 ID
Anchor link to分配给用户的自定义标识符，可实现跨设备和个性化定位。了解更多
查找位置
Pushwoosh 控制面板 → Audience → User Explorer
消息标识符
Anchor link to消息代码
Anchor link to创建每条消息时分配的唯一标识符。它遵循特定格式：XXXX-XXXXXXXX-XXXXXXXX。
此代码对于以下操作至关重要：
- 跟踪特定消息的状态和传递情况
- 取消（或删除）先前发送的消息
- 获取消息统计信息
查找位置
- Pushwoosh 控制面板： 导航至 Campaigns → One-time messages，然后打开所需消息的 properties。消息代码将显示在那里。
/createMessageAPI 响应： 通过 API 创建新消息时，消息代码会包含在响应中。
请求 ID
Anchor link to将消息与创建它的 HTTP 请求关联起来，让您可以端到端地跟踪单次发送——从 HTTP 调用通过 Pushwoosh 的路由层到最终的消息。
存在于通过 HTTP 调用 /createMessage 或 Messaging API v2 创建的任何消息上，包括从控制面板发送的消息。由 Journeys、cron 发送或其他非 HTTP 内部触发器创建的消息没有请求 ID。
设置您自己的值
随请求传递一个 X-Request-ID 标头。如果该值的长度在 8-128 个字符之间，并且只包含拉丁字母、数字、点、下划线和连字符，Pushwoosh 会重用它；否则——或者如果省略了该标头——Pushwoosh 会为您生成一个。无效值会被静默替换，因此请求永远不会因此失败。不强制要求唯一性，因此如果您依赖它进行跟踪，请为每个请求使用一个实际唯一的值。
查找位置
Pushwoosh 控制面板 → 打开一条消息 → Message Details → Show all properties → Message settings → Request ID（带有一个复制按钮）。
示例：a1b2c3d4e5f64a7b8c9d0e1f2a3b4c5d
应用内代码
Anchor link to识别一个即时应用内消息活动的唯一代码。 查找位置
Pushwoosh 控制面板 → Campaigns → Instant in-apps。在列表中，代码显示在活动名称下方。
示例：AAAAA-BBBBB
内容标识符
Anchor link to预设代码
Anchor link to已保存消息预设（例如，推送或 SMS）的标识符。了解更多
查找位置
Pushwoosh 控制面板 → Content → Presets。
您可以在两个地方找到预设代码：
-
在列表视图中，显示在预设名称下方。
-
在编辑或创建预设时的 URL 中（它是 URL 的最后一部分）。
示例：
URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/sms-presets/edit/AAAAA-BBBBB
预设代码：AAAAA-BBBBB
富媒体代码
Anchor link to应用内消息模板的标识符。了解更多
查找位置
Pushwoosh 控制面板 → Content → Rich media。
示例：
URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/rich-media/AAAAA-BBBBB/statistics
富媒体代码：AAAAA-BBBBB
邮件内容代码
Anchor link to邮件内容代码是已保存邮件内容的唯一标识符。了解更多
查找位置
Pushwoosh 控制面板 → Content → Email content。
代码是 URL 的最后一部分。
示例：
URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/email-content/edit/AAAAA-BBBBB
邮件内容代码：AAAAA-BBBBB
活动标识符
Anchor link to活动代码
Anchor link to用于引用特定活动以进行跟踪和分析的唯一标识符。
查找位置
在 Pushwoosh 控制面板中查看与活动相关的统计信息时，活动代码会出现在 URL 中。 要找到它，请转到 Statistics → Aggregated statistics，点击所需的活动，并复制 URL 末尾的代码。
示例：
URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/statistics/aggregated-message?campaignCode=YYYYY-YYYYY
活动代码： YYYYY-YYYYY
Journey ID
Anchor link to用于将消息与特定营销活动关联以进行跟踪和性能分析的唯一标识符。
查找位置
- 在 Pushwoosh 控制面板的活动画布 URL 中。
- 在画布上选择一个点，然后按 Ctrl+I (Cmd+I)——会将
<journey UUID>/<point UUID>复制到剪贴板；Journey ID 是斜杠之前的部分。
示例：
URL: https://app.pushwoosh.com/journeys/XXXXX-XXXXX/1/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
Journey ID: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
分段和定位标识符
Anchor link to分段 / 筛选器名称
Anchor link to在 Pushwoosh 中为受众定位创建的预定义用户分段的名称。了解更多
查找位置
Pushwoosh 控制面板 → Segments。
分段 / 筛选器代码
Anchor link to格式为 XXXXX-XXXXX 的唯一代码，用于识别 Pushwoosh 中的一个分段（也称为筛选器）。此代码用于 API 调用、自动化逻辑和动态分段规则。
查找位置
-
通过
/listFiltersAPI 方法。 -
在 Pushwoosh 控制面板中查看分段时，在地址栏中：
示例：
URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/segments/XXXE9-XXX49/detail
分段代码： XXXE9-XXX49
分配给用户或设备的自定义属性。用于动态分段和个性化。了解更多
查找位置
Pushwoosh 控制面板 → Tags 或通过 /getTags API。
事件标识符
Anchor link to事件名称
Anchor link to被跟踪事件的名称（例如，purchase、login、subscription）。用于触发自动化工作流或进行分析。了解更多
查找位置
Pushwoosh 控制面板 → Audience → Events。
地理位置标识符
Anchor link to地理区域 ID
Anchor link to识别用于触发基于位置的通知的地理围栏区域。了解更多
查找位置
Pushwoosh 控制面板 → Geozones。