# OneSignal: Chinese > OneSignal is a platform for sending push notifications, emails, in-app messages, and SMS campaigns via a single API, Journey Builder, and a dashboard. ## Chinese - [Chinese / 用户指南 (177 pages)](https://documentation.onesignal.com/_llms/cn/tab-4ef7ed40.md): Documentation for Chinese / 用户指南. ### 主页 - [OneSignal 文档](https://documentation.onesignal.com/docs/cn/home.md): 使用 OneSignal 更快速地开始构建。探索快速入门、SDK、消息传递渠道、API 参考以及 Journeys 和 Live Activities 等高级功能。 ### 开发者指南 #### 开发者文档 - [开发者](https://documentation.onesignal.com/docs/cn/developers.md): 设置 OneSignal 移动和 Web SDK，查找您的应用 ID 和 API 密钥，识别用户，并在上线前测试您的集成。 - [身份验证](https://documentation.onesignal.com/docs/cn/identity-verification.md): 通过要求服务器生成的 JWT 来验证外部用户 ID、电子邮件和短信订阅，防止用户冒充。 ##### 用户模型 - [用户模型和迁移指南](https://documentation.onesignal.com/docs/cn/user-model-migration-guide.md): 了解如何从 OneSignal 的设备中心模型迁移到新的用户中心 API 和 SDK，以实现更个性化的多渠道参与。 - [移动 SDK 映射](https://documentation.onesignal.com/docs/cn/device-user-model-mobile-sdk-mapping.md): 比较 OneSignal 的传统播放器模型（v3 和 v4）与现代用户模型（v5+）之间的方法和属性名称，提供并排的 Swift 代码示例以简化迁移。 - [Web SDK 映射](https://documentation.onesignal.com/docs/cn/device-user-model-web-sdk-mapping.md): 比较旧版 Player 模型和新 User 模型之间的 OneSignal Web SDK 方法。通过基于 TypeScript 的代码示例和更新的方法参考，学习如何迁移您的实现。 #### 移动SDK ##### 移动SDK设置 - [移动 SDK 设置](https://documentation.onesignal.com/docs/cn/mobile-sdk-setup.md): 为 Android、iOS、Huawei 以及 React Native、Flutter、Unity 等跨平台框架设置 OneSignal SDK。 - [iOS SDK 设置](https://documentation.onesignal.com/docs/cn/ios-sdk-setup.md): 如何使用 OneSignal 向您的 iOS 应用添加推送通知和应用内消息。 - [Android SDK 设置](https://documentation.onesignal.com/docs/cn/android-sdk-setup.md): 在 Android Studio 中安装 OneSignal Android SDK，添加推送与应用内消息，涵盖 FCM 凭据、SDK 初始化与测试发送。 - [Unity SDK 设置](https://documentation.onesignal.com/docs/cn/unity-sdk-setup.md): 了解如何设置 OneSignal 的 Unity SDK，轻松为您的 iOS、Android、Amazon 和华为 Unity 应用添加推送通知。本指南涵盖 Unity 安装、平台配置和初始化。 - [React Native SDK 设置](https://documentation.onesignal.com/docs/cn/react-native-sdk-setup.md): 将 OneSignal React Native SDK 集成到 iOS、Android 和 Amazon 应用平台的综合指南。包括先决条件、配置步骤、特定平台设置和常见问题排除。 - [Expo SDK 设置](https://documentation.onesignal.com/docs/cn/react-native-expo-sdk-setup.md): 使用 Expo SDK 53+ 和 EAS Build 将 OneSignal Expo SDK 集成到您的 iOS 和 Android 应用，涵盖 expo 插件配置、react-native-onesignal 初始化、开发构建创建，以及推送通知与应用内消息的测试步骤和常见限制说明。 - [Flutter SDK 设置](https://documentation.onesignal.com/docs/cn/flutter-sdk-setup.md): 将 OneSignal Flutter SDK 添加到您的 iOS 和 Android Flutter 应用的说明 - [Flutterflow SDK 设置](https://documentation.onesignal.com/docs/cn/flutterflow-sdk-setup.md): 在您的 Flutterflow iOS 和 Android 应用程序中添加 OneSignal Flutter SDK 的说明 - [Cordova SDK 设置](https://documentation.onesignal.com/docs/cn/cordova-sdk-setup.md): 使用 OneSignal Cordova SDK 为 Cordova、Ionic 和 Capacitor 应用（iOS 和 Android）添加推送通知与应用内消息，涵盖插件安装、平台配置、SDK 初始化和测试步骤，并说明 Capacitor 项目何时应改用专用 SDK。 - [Capacitor SDK 设置](https://documentation.onesignal.com/docs/cn/capacitor-sdk-setup.md): 为您的 Capacitor 或 Ionic Capacitor 应用添加 OneSignal SDK 的说明，支持 iOS 和 Android。 - [.NET MAUI SDK 设置](https://documentation.onesignal.com/docs/cn/net-sdk-setup.md): 将 OneSignal .NET SDK 添加到您的跨平台 MAUI 应用（支持 iOS、Android 和桌面）的说明。 - [Amazon SDK 设置](https://documentation.onesignal.com/docs/cn/amazon-sdk-setup.md): 分步指南，将 OneSignal SDK 集成到您的 Amazon Fire OS 应用中，实现推送通知和应用内消息功能。 - [华为 SDK 设置](https://documentation.onesignal.com/docs/cn/huawei-sdk-setup.md): OneSignal 华为 SDK Android Studio 设置指南。 ###### 平台凭证设置 - [Android Firebase 凭据](https://documentation.onesignal.com/docs/cn/android-firebase-credentials.md): 在 OneSignal 中配置 Firebase Cloud Messaging (FCM) 服务账户凭据，为 Google Play Store 上的应用启用 Android 推送通知。 - [iOS p8 基于令牌的 APNs 连接](https://documentation.onesignal.com/docs/cn/ios-p8-token-based-connection-to-apns.md): 设置 .p8 身份验证密钥，通过 OneSignal 将您的 iOS 或 macOS 应用连接到 Apple Push Notification service (APNs)。 - [iOS：生成 p12 证书](https://documentation.onesignal.com/docs/cn/ios-p12-generate-certificates.md): 生成并上传 .p12 推送证书，通过 OneSignal 将您的 iOS 或 macOS 应用连接到 Apple 推送通知服务 (APNs)。 - [Amazon：生成 Amazon API 密钥](https://documentation.onesignal.com/docs/cn/generate-an-amazon-api-key.md): 分步指南 - [Huawei 授权](https://documentation.onesignal.com/docs/cn/authorize-onesignal-to-send-huawei-push.md): 将华为应用连接到 OneSignal 进行推送通知的分步指南，包括 PushKit 设置、API 密钥配置以及针对中国用户应用的华为可选消息自分类。 ##### 移动SDK参考 - [移动 SDK 参考](https://documentation.onesignal.com/docs/cn/mobile-sdk-reference.md): OneSignal 移动 SDK 的综合 API 参考，包括初始化、用户身份、订阅、标签、权限、应用内消息、Live Activities 等。支持 Android、iOS、Unity、React Native、Flutter 和 Cordova/Ionic 平台。 - [移动服务扩展](https://documentation.onesignal.com/docs/cn/service-extensions.md): 使用移动服务扩展在 iOS 和 Android 上于展示前拦截并修改推送通知，实现富媒体附件、确认送达、自定义通知样式、静默通知与后台数据处理，涵盖 iOS 通知服务扩展和 Android 扩展服务的设置方法，以及通过 OSNotification 类访问推送数据。 - [管理通知栏](https://documentation.onesignal.com/docs/cn/managing-the-notification-tray.md): OneSignal 移动推送通知在 Android 和 iOS 通知栏中的行为：点击和清除处理、恢复的通知、徽章、以编程方式清除通知以及服务扩展。 - [OSNotification 载荷](https://documentation.onesignal.com/docs/cn/osnotification-payload.md): OneSignal OSNotification 对象的参考，包括所有载荷字段、Android 和 iOS 特定属性、自定义数据和点击操作。 - [iOS: App Clip 支持](https://documentation.onesignal.com/docs/cn/app-clip-support.md): 了解如何在 iOS App Clips 中启用和配置 OneSignal 推送通知。涵盖设置步骤、限制以及对 Target-Content-ID 等高级体验的支持。 ##### 移动SDK故障排除 - [移动 SDK 故障排除](https://documentation.onesignal.com/docs/cn/mobile-troubleshooting.md): 解决常见的 OneSignal 移动 SDK 问题，包括 iOS、Android 和跨平台框架中的推送传递失败、APNS 错误和应用内消息问题。 - [获取调试日志](https://documentation.onesignal.com/docs/cn/capturing-a-debug-log.md): 学习如何使用 OneSignal SDK 从您的移动应用捕获详细的调试日志。本指南介绍如何启用详细日志记录、重现问题并共享日志以解决 Android 和 iOS 平台上的推送通知问题。 #### 网络 SDK - [Web SDK reference](https://documentation.onesignal.com/docs/en/web-sdk-reference.md): Complete OneSignal Web SDK v16 API reference covering initialization, login, user properties, push subscriptions, slidedown prompts, and event listeners. ##### 网络 SDK 设置 - [Web SDK 设置](https://documentation.onesignal.com/docs/cn/web-sdk-setup.md): 通过 JavaScript SDK 集成、Service Worker 文件上传和仪表板站点配置，将 OneSignal 网页推送通知添加到您的网站，支持 Chrome、Firefox、Edge 和 Safari 浏览器，涵盖权限提示、localhost 本地测试与欢迎通知设置步骤。 - [iOS 网页推送设置](https://documentation.onesignal.com/docs/cn/web-push-for-ios.md): 在 iOS 和 iPadOS 设备上启用网页推送通知的完整指南，包括清单文件设置、用户引导策略以及 Safari、Chrome 和 Edge 浏览器的实施最佳实践。 - [OneSignal service worker](https://documentation.onesignal.com/docs/cn/onesignal-service-worker.md): 设置和配置 OneSignalSDKWorker.js 文件，让您的网站能够通过 OneSignal 接收和显示网页推送通知。 - [使用 OneSignal Web SDK 的自定义代码 Web 推送设置](https://documentation.onesignal.com/docs/cn/web-push-custom-code-setup.md): 使用自定义代码在您的网站上设置 OneSignal Web 推送通知，适用于需要高级配置或程序化控制的场景，涵盖添加 JavaScript SDK、上传并配置 OneSignal Service Worker 文件、编写初始化代码以及 iOS 网页推送支持等步骤与注意事项。 - [Google Tag Manager 设置](https://documentation.onesignal.com/docs/cn/google-tag-manager.md): 使用 Google Tag Manager (GTM) 将 OneSignal Web Push 添加到您的网站，包括 service worker 设置、初始化和安全设置标签。 - [Angular Web SDK 设置](https://documentation.onesignal.com/docs/cn/angular-setup.md): 使用 onesignal-ngx 包将 OneSignal Web Push 通知集成到您的 Angular 应用程序中。学习如何安装、配置和解决 service worker 问题，以提供无缝的推送通知。 - [ReactJS 和 NextJS 设置](https://documentation.onesignal.com/docs/cn/react-js-setup.md): 了解如何将 OneSignal 推送通知集成到您的 ReactJS 或 NextJS Web 应用程序中，包括初始化、服务工作器设置和 TypeScript 支持。 - [Vue JS Web SDK 设置](https://documentation.onesignal.com/docs/cn/vue-js-setup.md): 使用 onesignal-vue 或 @onesignal/onesignal-vue3 插件将 OneSignal Web 推送通知集成到您的 Vue.js 应用中。了解如何安装、配置和自定义服务工作器以实现无缝推送投递。 ##### 网络 SDK 故障排除 - [Web SDK 故障排除](https://documentation.onesignal.com/docs/cn/troubleshooting-web-push.md): 排除 OneSignal Web Push 问题，包括 Service Worker 错误、源不匹配、MIME 类型以及通知未显示。 - [清理缓存和重置推送权限](https://documentation.onesignal.com/docs/cn/clearing-cache-and-resetting-push-permissions.md): 了解如何在Chrome、Firefox和Safari中重置浏览器推送权限、service worker和站点数据，以确保干净的测试环境并解决网络推送通知问题。 - [网页推送 Webhooks](https://documentation.onesignal.com/docs/cn/webhooks.md): 设置 HTTP webhooks 以在用户显示、点击或关闭网页推送通知时接收实时通知。包含 Chrome、Firefox 和 Safari 浏览器支持示例的完整指南。 #### 实时活动 - [Live Activities](https://documentation.onesignal.com/docs/cn/live-activities.md): 在 iOS 锁屏和 Dynamic Island 上为配送、行程和实时比分显示实时更新，涵盖设置、定位和分析。 - [Live Activities 开发者设置](https://documentation.onesignal.com/docs/cn/live-activities-developer-setup.md): 学习如何在您的 iOS 应用上使用 OneSignal 设置 Live Activities 以显示实时更新。 - [跨平台实时活动SDK设置](https://documentation.onesignal.com/docs/cn/cross-platform-live-activity-setup.md): 为 React Native、Flutter、Unity、Cordova、Capacitor 或 .NET MAUI 应用添加 iOS 实时活动。setupDefault 方法让 OneSignal SDK 管理 ActivityKit 生命周期，您只需编写小组件布局。 - [Android 实时更新通知](https://documentation.onesignal.com/docs/cn/android-live-notifications.md): 基于 OneSignal 推送构建 Android 实时更新通知：通过通知服务扩展传递结构化载荷，使用相同 collapse_id 的创建消息 API 就地更新单条常驻置顶通知，模拟 iOS 实时活动，适用于体育比分、下载进度和事件跟踪等场景，并提供载荷结构与配置步骤说明。 #### 桌面和手表设置 - [macOS 应用设置](https://documentation.onesignal.com/docs/cn/macos-app-setup.md): 学习如何将 OneSignal 集成到您的 macOS 应用中，无论是使用 Mac Catalyst 还是直接 API 访问。配置平台、安装 SDK 和发送推送通知的逐步指导。 - [Windows 应用程序设置](https://documentation.onesignal.com/docs/cn/windows-app-setup.md): 将 OneSignal 推送通知集成到您的通用 Windows 平台 (UWP) 应用程序中的完整指南，使用 Windows 推送通知服务 (WNS) 和 OneSignal 的 REST API - [watchOS 和 Wear OS 支持](https://documentation.onesignal.com/docs/cn/watchos-and-wear-os-support.md): 为独立的 Apple watchOS 和 Android Wear OS 应用实现 OneSignal 推送通知的完整指南，包括设置说明和 API 集成。 ### 教程 #### 教程 - [教程与用例](https://documentation.onesignal.com/docs/cn/tutorials.md): 浏览分步视频教程和最佳实践示例，学习如何设置和优化通知、与您的技术栈集成，并应用游戏、金融科技、新闻媒体等行业垂直领域顶级客户验证过的参与策略，帮助您成功实施 OneSignal 平台的关键功能，提升用户参与度、留存率和收入等业务成果，涵盖推送、邮件、应用内消息等渠道的实施技巧。 #### 🏢 按行业 - [游戏策略](https://documentation.onesignal.com/docs/cn/gaming-industry.md): 游戏行业消息实施中心：涵盖玩家 ID 设置、玩家生命周期标签、游戏行为自定义事件和受众细分策略，以及适用于移动游戏和实时服务游戏的 Journey 自动化方案，包括新玩家引导、每日奖励提醒、再互动和流失挽回等策略与视频教程，帮助提升玩家参与度、留存率和游戏收入。 - [金融与金融科技策略](https://documentation.onesignal.com/docs/cn/financial-fintech-industry.md): 金融与金融科技行业消息实施中心：涵盖用户 ID 设置、KYC 与安全状态标签、产品持有和交易自定义事件、受众细分，以及用于新用户验证、合规提醒、交叉销售和留存的 Journey 方案，帮助银行与金融科技应用在确保安全合规的同时有效触达并留住用户，提升转化与信任。 - [新闻和媒体策略](https://documentation.onesignal.com/docs/cn/news-and-media-industry.md): 新闻与媒体行业消息实施中心：涵盖用户 ID 设置、栏目兴趣标签、阅读行为自定义事件和受众细分，以及用于受众增长、突发新闻提醒、付费墙订阅转化和读者再互动的 Journey 方案，并附权限提示最佳实践视频，帮助媒体应用提升订阅量与参与度，覆盖读者从订阅到付费的完整生命周期。 #### 📈 提高参与度和留存 - [购物车放弃教程](https://documentation.onesignal.com/docs/cn/abandoned-cart.md): 使用 OneSignal 的购物车放弃通知挽回流失的销售。了解如何跟踪购物车活动、构建正确的细分，以及使用 Journeys 发送及时提醒。 - [创建活动动态](https://documentation.onesignal.com/docs/cn/create-an-activity-feed.md): 学习如何使用OneSignal的REST API、事件流或设备端逻辑构建应用内活动动态来跟踪和显示用户通知历史。 - [预订确认和放弃预订恢复](https://documentation.onesignal.com/docs/cn/booking-confirmations.md): 使用自定义事件、Journeys 和数据源根据实时预订状态发送预订确认或恢复邮件。 - [构建按钮驱动的引导轮播](https://documentation.onesignal.com/docs/cn/in-app-onboarding-carousel-tutorial.md): 使用带有按钮导航和自动关闭功能的 HTML 应用内消息创建多步骤引导流程。 - [社交活动](https://documentation.onesignal.com/docs/cn/social-activity.md): 为点赞、回复、关注、私信和竞技游戏事件等社交操作发送推送、邮件和短信通知，使用 Create message API 与 custom_data 实现个性化的后端触发提醒，限制点赞等高频操作的通知频率，并在用户离线或不活跃时作为实时聊天的回退方案推动应用再参与。 - [定位过时应用版本以鼓励应用更新](https://documentation.onesignal.com/docs/cn/app-version-update.md): 使用应用内消息检测过时的应用版本并提示用户更新，提供适用于 iOS 和 Android 的平台专属分段。 - [获得更多应用商店评价](https://documentation.onesignal.com/docs/cn/example-app-store-review.md): 使用 OneSignal 应用内消息以及 iOS 和 Android 原生评价提示，引导用户为您的应用评价，减少操作摩擦，提升评分。 - [使用横幅应用内消息引导用户](https://documentation.onesignal.com/docs/cn/example-create-a-tutorial.md): 使用不会阻塞应用界面的顶部和底部横幅应用内消息引导用户。 #### 🔔 交付关键或时间敏感消息 - [交易消息](https://documentation.onesignal.com/docs/cn/transactional-messages.md): 了解如何使用 OneSignal API 通过推送、电子邮件或 SMS 发送交易消息，如 OTP、账单更新和提醒，并使用个性化数据。 - [回退消息：推送不可用时的邮件或短信](https://documentation.onesignal.com/docs/cn/push-fallback-method.md): 使用 OneSignal 实施回退策略，确保在推送通知失败时通过邮件或短信传递关键消息。了解如何使用 Journey、API 和分段设置跨渠道消息以实现可靠的用户参与。 - [基于位置的消息](https://documentation.onesignal.com/docs/cn/location-triggered-event.md): 按国家、GPS 坐标或地理围栏细分用户，并使用 OneSignal 发送位置触发的推送通知。 #### 🧠 增强目标定位和个性化 - [按页面主题和订阅来源标记用户](https://documentation.onesignal.com/docs/cn/auto-segment-users-by-page-visit.md): 根据用户访问的页面和订阅推送通知的页面，在 OneSignal 中为用户添加标签，然后细分以进行有针对性的活动。 - [使用应用内消息请求位置权限](https://documentation.onesignal.com/docs/cn/location-opt-in-prompt.md): 在触发原生 Android 或 iOS 位置权限请求之前，使用 OneSignal 中的软预提示引导用户在您的移动应用中启用位置跟踪。 - [创建调查以征求反馈](https://documentation.onesignal.com/docs/cn/example-create-a-survey.md): 使用轮播、按钮点击操作、结果和标签构建多页面应用内调查，用于分析和用户细分。 - [定向特定的 Android 制造商和设备](https://documentation.onesignal.com/docs/cn/example-target-certain-android-manufacturers-and-devices.md): 识别并定向来自已知在应用被滑掉时会阻止推送通知的制造商的 Android 设备，并使用应用内消息教育用户启用正确的设置。 #### 🛠️ 改进用户体验和入职 - [为邮件设置确认选择加入](https://documentation.onesignal.com/docs/cn/double-opt-in-email.md): 学习如何在 OneSignal 中使用标签、细分和旅程实施双重选择加入（确认选择加入）流程，以提高参与度、合规性和列表质量。 - [偏好设置中心](https://documentation.onesignal.com/docs/cn/preference-center.md): 了解如何使用 OneSignal API 在您的应用程序或网站中实现自定义用户偏好设置中心，以管理通知主题、频率、渠道和数据隐私设置。 - [发送验证、魔术链接、OTP 和双重选择加入消息](https://documentation.onesignal.com/docs/cn/example-verification-magic-link-otp.md): 使用 OneSignal 的邮件和短信验证消息示例，包括一次性密码、魔术链接和带有模板和 API 示例的双重选择加入流程。 - [iOS：图像轮播推送通知](https://documentation.onesignal.com/docs/cn/ios-image-carousel-push-notifications.md): 如何使用 Swift 在 OneSignal iOS 推送通知中实现图像轮播。 ### API Reference #### Using REST APIs - [REST API overview](https://documentation.onesignal.com/reference/rest-api-overview.md): Programmatic access to OneSignal messaging, user management, segments, Journeys, and data exports over HTTPS with rate limiting and retry support. - [Rate limits and error handling](https://documentation.onesignal.com/reference/rate-limits.md): Understand OneSignal API and application rate limits, common errors, retry behavior, and how to safely recover from failures without sending duplicate messages or disabling your app. #### API Reference ##### Messages - [Sending messages with the OneSignal API](https://documentation.onesignal.com/reference/create-message.md): Send push notifications, emails, SMS, and Live Activities with the OneSignal API. Covers audience targeting, message composition, scheduling, and response handling. - [Idempotent API requests](https://documentation.onesignal.com/reference/idempotent-notification-requests.md): Prevent duplicate messages or custom events when retrying API requests. - [Push notification](https://documentation.onesignal.com/reference/push-notification.md): Send a message using the push notification channel. - [Email](https://documentation.onesignal.com/reference/email.md): Send a message using the email channel. - [SMS](https://documentation.onesignal.com/reference/sms.md): Send a message using the SMS channel. - [View message](https://documentation.onesignal.com/reference/view-message.md): View the details of a single message and the Outcomes associated with it. - [View messages](https://documentation.onesignal.com/reference/view-messages.md): View the details for a collection of messages. - [Cancel message](https://documentation.onesignal.com/reference/cancel-message.md): Stop a scheduled or currently outgoing message. - [Message history](https://documentation.onesignal.com/reference/message-history.md): View which subscriptions received a particular message - [Estimated recipients](https://documentation.onesignal.com/reference/count-unsaved.md): Returns the estimated number of recipients for a notification's targeting, without creating or sending anything. ##### Live Activities - [Start Live Activity](https://documentation.onesignal.com/reference/start-live-activity.md): Remotely start an iOS Live Activity with the OneSignal REST API, also known as push-to-start. Covers required body fields, choosing an activity_id, and audience targeting. - [Update Live Activity](https://documentation.onesignal.com/reference/update-live-activity-api.md): Update the content of a running iOS Live Activity or end it with the OneSignal REST API. Covers required body fields, update priority, and dismissal timing. ##### Custom Events - [Create custom events](https://documentation.onesignal.com/reference/create-custom-events.md): The Custom Events API allows you to record user events. Custom events can represent any action users take in your application, such as completing a purchase, viewing content, or achieving milestones. ##### Users - [Create user](https://documentation.onesignal.com/reference/create-user.md): Create a new user or modify the subscriptions associated with an existing User. - [View user](https://documentation.onesignal.com/reference/view-user.md): Retrieve a user including aliases, properties, and subscriptions. - [Update user](https://documentation.onesignal.com/reference/update-user.md): Modify a user's properties. - [Delete user](https://documentation.onesignal.com/reference/delete-user.md): Delete a user including all associated properties, subscriptions, and identity. - [View user identity](https://documentation.onesignal.com/reference/fetch-aliases.md): Retrieve all aliases associated with a user using a known alias, such as an `external_id`, `onesignal_id`, or a custom alias. This API helps you map back to a user's full identity from any one piece of identifying information. - [View user identity (by subscription)](https://documentation.onesignal.com/reference/fetch-identity-by-subscription.md): Retrieve all aliases linked to a user using a known `subscription_id`. This is useful when the user's identity is unknown but you have access to one of their push, email, or SMS subscriptions. - [Create or update alias](https://documentation.onesignal.com/reference/create-alias.md): Add or update aliases on an existing user when you already know one of that user's aliases, such as an external_id, onesignal_id, or custom alias. Updates the identity object only. - [Create alias (by subscription)](https://documentation.onesignal.com/reference/create-alias-by-subscription.md): Create or update an alias for a user using a known subscription ID. - [Delete alias](https://documentation.onesignal.com/reference/delete-alias.md): Remove a specific alias from a user. ##### Subscriptions - [Create Subscription by alias](https://documentation.onesignal.com/reference/create-subscription.md): Attach a new subscription (email, SMS, or push) to an existing OneSignal user identified by an alias. - [Update Subscription by ID](https://documentation.onesignal.com/reference/update-subscription.md): Update properties on an existing OneSignal subscription using its subscription_id. Commonly used to enable or disable a subscription when managing outside of the OneSignal SDK. - [Update Subscription by token](https://documentation.onesignal.com/reference/update-subscription-by-token.md): Update properties on an existing Subscription using its token. Commonly used to enable or disable subscription status when managing outside of the OneSignal SDK. - [Delete Subscription](https://documentation.onesignal.com/reference/delete-subscription.md): Delete a specific subscription by its subscription_id. This stops messages from being sent to that subscription but does not prevent future subscriptions with the same token. - [Transfer Subscription](https://documentation.onesignal.com/reference/transfer-subscription.md): Transfer a Subscription to a different user within the same OneSignal app. Useful for associating existing Subscriptions like push, email, or SMS with a new or updated user identity. - [Unsubscribe email with token](https://documentation.onesignal.com/reference/unsubscribe-with-token.md): Unsubscribe an email address from future messages by calling this API from your custom unsubscribe page. Automatically disables the associated email subscription using a token-based approach. ##### Templates - [Create template](https://documentation.onesignal.com/reference/create-template.md): Create reusable message templates for push, email, and SMS channels. Templates can be accessed through both the dashboard and API using a `template_id`. - [Update template](https://documentation.onesignal.com/reference/update-template.md): Update existing OneSignal message templates for push, email, or SMS. Changes apply immediately across dashboard and API usage via the `template_id` reference. - [View templates](https://documentation.onesignal.com/reference/view-templates.md): Retrieve a paginated list of message templates from your OneSignal app. This endpoint returns summary information for each template, including ID, name, creation, and update timestamps. - [View template](https://documentation.onesignal.com/reference/view-template.md): Retrieve the details of a specific message template in your OneSignal app using its template ID. This API returns the template content, target channel, and timestamps for creation and last update. - [Delete template](https://documentation.onesignal.com/reference/delete-template.md): Permanently delete a specific message template from your OneSignal app using its template ID. Templates used in Journeys must be removed from those Journeys before deletion. - [Copy template to another app](https://documentation.onesignal.com/reference/copy-template-to-another-app.md): Create a duplicate of a template in another app. The new template will be completely separate from the original (including having a new template_id) but will be created with all the same content. ##### Segments - [View segments](https://documentation.onesignal.com/reference/view-segments.md): Retrieve a list of segments associated with a specific OneSignal app. Useful for programmatically accessing segment metadata such as name, creation date, and status. - [View segment](https://documentation.onesignal.com/reference/view-segment.md): Retrieve details for a single segment by its ID, including subscriber count and optionally segment metadata and filters. - [Create segment](https://documentation.onesignal.com/reference/create-segments.md): Programmatically create segments in your OneSignal app using flexible filters and targeting rules. - [Update segment](https://documentation.onesignal.com/reference/update-segment.md): Update an existing segment's name and/or filters. The name parameter is always required. When filters are provided, all existing filters are replaced with the new ones. - [Delete segment](https://documentation.onesignal.com/reference/delete-segments.md): Delete segments from OneSignal. Does not delete users or subscriptions. ##### Journeys - [View journeys](https://documentation.onesignal.com/reference/view-journeys.md): Retrieve a paginated list of journeys for an app, with cursor-based pagination and a lightweight summary representation of each journey. - [View journey](https://documentation.onesignal.com/reference/view-journey.md): Retrieve the full configuration of a single journey by its UUID, including its audience, schedule, and node graph. - [View journey stats](https://documentation.onesignal.com/reference/view-journey-stats.md): Retrieve performance stats for a single journey, including journey-level counts, per-node counts, per-branch counts, and channel delivery stats. - [Create journey](https://documentation.onesignal.com/reference/create-journey.md): Create a new journey with an audience and a node graph. Journeys are always created in the draft state. - [Duplicate journey](https://documentation.onesignal.com/reference/duplicate-journey.md): Copy an existing journey into a new draft. You can apply overrides to the copy in the same request. - [Update journey](https://documentation.onesignal.com/reference/update-journey.md): Apply a partial update to a journey with JSON Merge Patch, and activate a draft journey by transitioning its state. - [Update journey node](https://documentation.onesignal.com/reference/update-journey-node.md): Apply a partial update to a single journey node, located by its server-assigned id, with JSON Merge Patch. - [Delete journey](https://documentation.onesignal.com/reference/delete-journey.md): Permanently delete a journey by its UUID. Deletion cannot be undone; archive a running journey instead if you need to keep its data. ##### Configuration - [View apps](https://documentation.onesignal.com/reference/view-apps.md): Retrieve a list of all OneSignal apps associated with your account, including key app details like name, App ID, subscription counts, and timestamps. Useful for managing multiple apps through the OneSignal API. - [View an app](https://documentation.onesignal.com/reference/view-an-app.md): View the details of a single OneSignal app - [Create an app](https://documentation.onesignal.com/reference/create-an-app.md): Programmatically create a new OneSignal app via the REST API. This guide explains required fields, supported platform configurations (Web, Android, iOS), and how to properly authenticate using your Organization API key. - [Update an app](https://documentation.onesignal.com/reference/update-an-app.md): Use to update the name or push platform configuration of an existing app. This guide explains required parameters and platform-specific update rules - [View API keys](https://documentation.onesignal.com/reference/view-api-keys.md): View the details of all of your current app API keys (Rich Authentication Token) for a single OneSignal app. - [Create API key](https://documentation.onesignal.com/reference/create-api-key.md): Use the OneSignal API to create a new Rich Authentication Token (App API Key) for a specific app. This guide explains how to authenticate with the Organization API key and configure optional IP allowlists using CIDR notation. - [Delete API key](https://documentation.onesignal.com/reference/delete-api-key.md): Delete a specific Rich Authentication Token (App API Key) for a OneSignal app. Requires your Organization API Key and the token's unique ID, not the token value itself. - [Update API key](https://documentation.onesignal.com/reference/update-api-key.md): Update a Rich Authentication Token (App API Key) for a OneSignal app. Modify the token's name or IP allowlist settings using your Organization API Key. - [Rotate API key](https://documentation.onesignal.com/reference/rotate-api-key.md): Rotate an existing App API Key (Rich Authentication Token) for a OneSignal app. Useful when a token is compromised or needs replacement without creating a new key from scratch. ##### Analytics - [Export subscriptions CSV](https://documentation.onesignal.com/reference/csv-export.md): Generate a GZip-compressed CSV export of your current subscription data using this API endpoint. - [Export audience activity CSV](https://documentation.onesignal.com/reference/export-csv-of-events.md): Export a compressed CSV report of audience-level delivery and engagement data for a specific message. This includes sent, delivered, clicked, failed, and unsubscribed events across Push, Email, and SMS channels. - [View outcomes](https://documentation.onesignal.com/reference/view-outcomes.md): View and export push notification outcome metrics such as clicks, conversions, and custom events. ##### Deprecated - [View players](https://documentation.onesignal.com/reference/view-devices.md): GET `https://onesignal.com/api/v1/players?app_id={app_id}&limit={limit}&offset={offset}` - [View player](https://documentation.onesignal.com/reference/view-device.md): GET https://onesignal.com/api/v1/players/{player_id} - [Add a player](https://documentation.onesignal.com/reference/add-a-device.md): POST `https://onesignal.com/api/v1/players` - [Edit player](https://documentation.onesignal.com/reference/edit-device.md): put https://onesignal.com/api/v1/players/{player_id} - [Edit tags with external user id](https://documentation.onesignal.com/reference/edit-tags-with-external-user-id.md): put https://onesignal.com/api/v1/apps/{app_id}/users/{external_user_id} - [Delete player record](https://documentation.onesignal.com/reference/delete-user-record.md): delete https://onesignal.com/api/v1/players/{player_id}?app_id={app_id} #### SDKs - [服务器 SDK 参考](https://documentation.onesignal.com/docs/cn/server-sdk-reference.md): 安装、配置和使用 OneSignal 服务器 SDK，从 Node.js、Python、Java、Go、PHP、Ruby、C# 和 Rust 后端发送推送通知、电子邮件和短信。 ### Release Notes #### Release Notes - [Changelog](https://documentation.onesignal.com/release-notes/changelog.md): Follow the OneSignal changelog for new features, product updates, and bug fixes across push, email, SMS, in-app messages, Journeys, and analytics. - [SDK Releases](https://documentation.onesignal.com/release-notes/sdk-releases.md): View the latest OneSignal SDK releases and updates. ## OpenAPI Specs - [openapi](/openapi.json) ## Optional - [Blog](https://onesignal.com/blog) - [GitHub](https://github.com/OneSignal) - [YouTube](https://www.youtube.com/@onesignalofficial/playlists)