- 开始使用 — 访问您的 OneSignal 应用并查找 API 密钥
- 设置消息渠道 — 安装 SDK 并配置渠道
- SDK 和 API 参考 — 详细的方法、类和端点文档
- 用户和身份 — 识别用户、管理订阅并保护访问安全
- 测试和调试 — 在上线前验证您的集成
- Webhook 和事件 — 在服务器端接收消息事件
开始使用
如果您的团队已有 OneSignal 账户，请让管理员邀请您加入组织。否则，请创建账户开始使用。 您的 OneSignal 应用是用户和消息数据存储的地方。每个应用都有其自己的应用 ID、API 密钥和消息渠道。您可以在单个组织中拥有多个应用，用于不同的项目或环境。应用、组织和账户
应用、组织和账户之间的关系。
密钥和 ID
查找用于身份验证的应用 ID、REST API 密钥和组织 ID。
添加团队成员
邀请开发者并在您的组织中分配角色。
使用情况和计费
计费、发票和使用详情。
设置消息渠道
安装 OneSignal SDK 以创建并追踪各平台的用户参与度。每个消息渠道都有自己的设置指南，涵盖凭据、SDK 初始化和教程。移动 SDK 设置
iOS、Android、华为和亚马逊的 SDK 设置。支持推送通知、应用内消息和 Live Activities。
网页推送
Web SDK 安装和浏览器推送通知设置。
电子邮件
电子邮件渠道配置和发件人域名验证。
应用内消息
在您的移动应用内显示丰富的交互式消息。
短信
SMS 渠道设置和运营商注册。
RCS
带有品牌内容和已读回执的富媒体消息。
Live Activities
iOS 动态锁屏更新。Android 有类似功能可用。
移动推送权限提示
配置选择加入提示以在移动端收集推送订阅。
网页推送权限提示
配置选择加入提示以在网页端收集推送订阅。
SDK 和 API 参考
客户端 SDK、服务器 SDK 和 REST API 的详细文档。移动 SDK 参考
iOS、Android 和跨平台 SDK 的方法、类和事件钩子。
Web SDK 参考
初始化、用户管理、订阅方法和自定义触发器。
服务器 SDK 参考
安装和配置适用于 Node.js、Python、Java、Go、PHP、Ruby、C# 和 Rust 的服务器 SDK。
REST API 概览
端点、身份验证、速率限制和请求/响应格式。
交易性消息
通过 API 发送带有个性化数据的 OTP、收据和时效性警报。
GitHub 上的服务器 SDK
所有服务器 SDK 库的源代码和示例。
用户和身份
OneSignal 为每个人分配一个 OneSignal ID，并将其设备、电子邮件地址和电话号码作为订阅进行追踪。用户在匿名状态下，直到您使用外部 ID 调用login 进行识别。识别用户可跨渠道和设备统一其订阅。
用户
用户模型、外部 ID、匿名用户与已识别用户、登录/登出。
订阅
接收您消息的设备、电子邮件地址和电话号码。
身份验证
需要服务器生成的 JWT 以防止用户冒充。
别名
将自定义标识符映射到用户，用于跨平台追踪和集成。
标签
在用户上设置键值数据，用于个性化和分段。
自定义事件
追踪用户行为以触发 Journey 或支持分析。
测试和调试
在向全体受众发送之前，验证您的集成是否正常工作。测试订阅
查找和配置推送、电子邮件和 SMS 的测试订阅。
调试日志
从移动应用捕获详细的 SDK 日志以进行故障排除。
移动端故障排除
解决常见的推送送达、APNS 和应用内消息问题。
网页端故障排除
修复 Service Worker、浏览器兼容性和网页推送问题。
Webhook 和事件
在服务器端接收消息事件，用于分析、自动化或与外部系统同步。事件流
实时将点击、打开、接收等消息事件流传输到您的数据仓库。
Journey Webhook
从 Journey 步骤向您的服务器发送 HTTP 请求。
网页推送 Webhook
网页推送显示、点击和关闭事件的 HTTP 回调。
常见问题
如何验证 REST API 请求？
在Authorization 标头中以 Bearer Token 形式包含您的 REST API 密钥：Authorization: Key YOUR_REST_API_KEY。在 OneSignal 仪表板的设置 > 密钥和 ID 中查找您的密钥。详情请参阅密钥和 ID。
客户端 SDK 和服务器 SDK 有什么区别？
客户端 SDK（移动和 Web）在用户设备上的应用中运行。它们处理订阅注册、权限提示、应用内消息以及通过login 进行用户识别。服务器 SDK 在您的后端运行，调用 REST API 发送消息、管理用户和导出数据。
如何跨设备识别用户？
在用户登录后，在每台设备上调用OneSignal.login("your_external_id")。OneSignal 会将所有具有相同外部 ID 的订阅合并到单个用户下。实现详情请参阅用户。
我需要设置身份验证吗？
身份验证是可选的，但强烈建议在生产应用中启用。如果不启用，任何客户端都可以使用任意外部 ID 调用login。启用身份验证需要更新 OneSignal SDK 以使用服务器生成的 JWT，从而防止冒充。
需要帮助？与我们的支持团队聊天或发送邮件至
support@onesignal.com请包含以下信息：- 您遇到的问题详情以及复现步骤（如有）
- 您的 OneSignal 应用 ID
- 外部 ID 或订阅 ID（如适用）
- 您在 OneSignal 控制台中测试的消息 URL（如适用）
- 任何相关的日志或错误信息