Skip to main content
安装 OneSignal SDK 并让您的首次集成正常运行。首次设置请按顺序完成各节,或直接跳到所需部分。
  1. 开始使用:查找您的应用 ID 和 API 密钥
  2. 安装 SDK:安装移动或 Web SDK
  3. 用户和身份:识别用户、管理订阅并保护访问安全
  4. 测试您的集成:在上线前验证送达
  5. 故障排除:调试送达问题

开始使用

如果您的团队已有 OneSignal 账户,请让管理员邀请您加入组织。否则,请创建账户开始使用。 您的 OneSignal 应用保存用户和消息数据,包括 SDK 设置所需的应用 ID 和 API 密钥。如果您管理多个项目或环境,请了解应用、组织和账户之间的关系。

密钥和 ID

查找用于身份验证的应用 ID、REST API 密钥和组织 ID。

安装 SDK

为您的平台安装 OneSignal SDK。

移动 SDK 设置

iOS、Android、华为和亚马逊的 SDK 设置。支持推送通知、应用内消息和 Live Activities。

Web SDK 设置

Web SDK 安装和浏览器推送通知设置。
以下平台也可通过我们的 REST API 获得支持:

用户和身份

OneSignal 为每个人分配一个 OneSignal ID,并将其设备、电子邮件地址和电话号码作为订阅进行追踪。用户在匿名状态下,直到您使用外部 ID 调用 login 进行识别。识别用户可跨渠道和设备统一其订阅。

用户

用户模型、外部 ID、匿名用户与已识别用户、登录/登出。

订阅

接收您消息的设备、电子邮件地址和电话号码。

标签

为用户添加自定义属性,用于个性化和细分。

自定义事件

追踪用户行为以触发 Journey 或支持分析。

测试您的集成

在向全体受众发送之前,使用测试用户验证送达、渲染和深度链接。

测试用户

查找和配置推送、电子邮件和 SMS 的测试用户。

故障排除

先捕获调试日志,然后使用与您的集成匹配的平台指南。

移动端故障排除

解决常见的推送送达、APNs 和应用内消息问题。

Web SDK 故障排除

修复 service worker 错误、来源不匹配以及通知不显示的问题。

调试日志

启用详细日志记录,重现问题,并与支持团队共享日志。

重置网页推送权限

清除浏览器缓存、service worker 和通知权限,以进行干净的测试。

设置完成后

探索常见使用场景,并在构建过程中查阅 SDK 方法或 REST API 端点。

教程和使用案例

浏览废弃购物车、入门流程、重新参与活动等的实施指南。

标签

为用户添加自定义属性,用于个性化和细分。

自定义事件

追踪用户行为以触发 Journey 或支持分析。

移动 SDK 参考

iOS、Android 和跨平台 SDK 的方法、类和事件钩子。

Web SDK 参考

初始化、用户管理、订阅方法和自定义触发器。

服务器 SDK 参考

安装和配置适用于 Node.js、Python、Java、Go、PHP、Ruby、C# 和 Rust 的服务器 SDK。

REST API 概览

端点、身份验证、速率限制和请求/响应格式。

常见问题

如何跨设备识别用户?

在用户登录后,在每台设备上调用 OneSignal.login("your_external_id")。OneSignal 会将所有具有相同外部 ID 的订阅合并到单个用户下。实现详情请参阅用户

我需要设置身份验证吗?

身份验证是可选的,但强烈建议在生产应用中启用。如果不启用,任何客户端都可以使用任意外部 ID 调用 login。启用身份验证需要更新 OneSignal SDK 以使用服务器生成的 JWT,从而防止冒充。

我可以在不使用移动或 Web SDK 的情况下使用 OneSignal 吗?

可以。您可以使用 REST API服务器 SDK 发送电子邮件和短信、管理用户以及触发消息。推送通知、应用内消息和客户端用户识别需要移动和 Web SDK。

如何从我的服务器发送消息?

使用 REST API服务器 SDK。使用来自密钥和 ID 的 REST API 密钥进行身份验证。切勿将 REST API 密钥嵌入移动或 Web 客户端。