个推是商用级的移动应用消息推送云服务供应商，客户端 SDK 支持 Android、iOS、HarmonyOS NEXT 三大平台，开发者集成 SDK 后，可以通过个推强大的 web 端及丰富的 API 开放接口，发送推送消息、统计分析推送效果。可有效提高 App 活跃度，增加用户留存率。
| 名词 | 解释 |
|---|---|
| 通知消息 | 指定通知标题和内容后，由个推 SDK 自动处理在系统通知栏中展示通知栏消息，同时响铃或震动提醒用户(响铃和震动受手机系统的设置状态影响)。 |
| 透传消息 | 即自定义消息，消息体格式客户可以自己定义，如纯文本、json 串等。透传消息个推只传递数据，不做任何处理，客户端接收到透传消息后需要自己去做后续动作处理，如通知栏展示、弹框等。 |
| ClientId | 个推业务层中的对外用户标识，用于标识客户端身份，由第三方客户端获取并保存到第三方服务端，是个推 SDK 的唯一识别号，简称 CID、cid。 |
| 在线推送 | app 在前台打开运行时，cid 在线，通过个推渠道下发消息。 |
| 离线推送 | app 在后台、锁屏、进程关闭时，cid 离线，通过厂商渠道下发消息。若 Android、鸿蒙 未集成离线厂商， iOS 未配置推送证书，则该系统机型无法使用离线推送。 |
更多名词解释参考：个推名词解释
若您需要在手机设备上使用个推消息推送服务，必须先完成客户端 SDK 集成。
Android 个推主包：个推为 Android 应用提供的安全稳定的推送 SDK，集成主包后仅可以使用 “在线推送”。
Android 厂商开通 ：在各个安卓厂商平台开通消息推送服务，并在个推后台页面配置厂商参数。
注意：参考此文档，必须配置（华为、荣耀、vivo、魅族）渠道的回执，才能统计到这些渠道完整的到达、折损数据。
Android 多厂商包：个推与主流安卓厂商合作融合了厂商推送 SDK，在个推开发者中心后台配置多厂商参数、并集成多厂商包验证可以成功获取 token。则可以正常使用 “离线推送”。
目前华为、荣耀、魅族 不要求上架应用商店；vivo 、小米、oppo 必须上架应用商店后才可使用离线厂商推送。
厂商消息报表补全：由于个推透传无展示数返回，华为、oppo 、vivo 无完整离线点击数报表返回，为了方便您在个推后台可以看到更加完整的推送数据统计，建议您在客户端埋点上报补全。
使用上面最新版 Android 和 iOS 个推主包 SDK 默认集成了卓信 ID 。
个推消息推送全新升级，融入卓信 ID 服务。基于卓信 ID 的设备算法，升级后的消息推送服务可以有效帮助 APP 提升推送的设备覆盖率、设备聚合识别准确率、设备识别稳定性，安全完善推送底层设备 ID 体系。具体优势亮点可以看看：卓信 ID 详细讲解 。
卓信 ID 接口文档：建议您在 Android 和 iOS 客户端加上卓信 ID 初始化和 getZxid 调用。
个推除了提供 Android、iOS、HarmonyOS 原生SDK 之外，也提供主流的开发平台 插件和示例 。
开发者可通过调用 服务端 RestAPI V2 或者登陆 个推开发者中心 从页面下发消息。（若您想对单个 cid 用户进行推送，cid 必须先从客户端获取 ）
当 CID 在线(即 app 在前台打开运行)时：
消息通过个推通道下发到客户端。
具体到服务端 RestAPI-V2 代码中，即 push_message 中的 notification（通知） 或 transmission（透传） 内容传递给客户端。
注意：iOS 系统不展示个推在线通知消息，所以推送用户是 iOS 时，push_message 内只能使用 transmission，iOS 客户端在线接收时自己做通知栏展示。
当 CID 离线(即 app 在后台、锁屏、进程关闭)时：
有开启对应厂商离线功能的，消息将通过个推侧请求对应厂商侧的服务端。
具体到服务端 RestAPI-V2 代码中，即 push_channel 中的通知内容传递给厂商，实际的消息是经由厂商服务器下发至客户端；对于没有开启对应厂商功能的，消息将存在个推的离线库中，等待 CID 在线，再通过个推通道下发到客户端。
注意：若服务端 push_channel 不传值，则无法接收离线消息。
登陆 个推开发者中心，进入个推消息推送 dos 页面，可通过以下 2 个功能【创建推送】。
个推通知 + 厂商通知
个推透传 + 厂商通知
服务端 API 使用时首先需要获取 AppId、AppKey、MasterSecret 参数，获取来源如下图所示：
个推服务端提供了 SDK 帮助开发者提升集成推送服务端的效率， 开发者不需要进行复杂编程即可使用个推推送服务的各项常用功能，SDK 可以自动帮您满足调用过程中所需的鉴权、组装参数、发送 HTTP 请求等非功能性要求。
注意事项：
SDK 目前仅支持 Java 语言，若服务端是其它语言可以参考 服务端 RestAPI V2 文档 通过 Https 请求调用。
当您在使用过程中对接口字段有疑问时，可以通过 服务端 RestAPI V2 文档 查看具体字段描述。
安卓离线推送，营销类消息，各厂商都有额度限制，大部分厂商限制每天只能收到 2 条。
建议申请消息分类（包含 extra.channel_id 如何申请），详见： 厂商通道限额
非OPPO、VIVO软件商店官方渠道下载的应用，厂商不提供公信消息服务。只能发送 测试消息、或者私信消息。
本地集成测试可以推送 测试消息（支持：华为、荣耀、OPPO、VIVO）。
单推基础代码入参示例：为方便您测试，提供以下单推代码示例，更多接口及参数描述可查看 服务端 RestAPI V2 文档 。
{
"request_id": "请填写10到32位的id",
"audience": {
"cid": [
"请填写cid"
]
},
"settings": {
"ttl": 7200000,
//厂商推送策略strategy为 VIP 功能，需升级服务后方可使用。非VIP用户无法设置厂商策略，即使填写了也默认所有通道策略都是1
"strategy": {
"default": 1,
"ios": 4
}
},
//push_message是在线个推通道消息。若要发iOS在线，此处须使用transmission透传消息。或者vip可设置strategy策略"ios": 4
"push_message": {
"notification": {
"title": "安卓、鸿蒙在线通知标题",
"body": "安卓、鸿蒙在线通知内容",
"click_type": "startapp"
}
},
//push_channel是离线厂商通道消息
"push_channel": {
"android": {
"ups": {
"notification": {
"title": "安卓离线通知标题",
"body": "安卓离线通知内容",
"click_type": "startapp"
},
"options": {
"HW": {
// 值为int 类型。1 表示华为测试消息，华为每个应用每日可发送该测试消息500条。仅开发者测试使用，此参数请勿发布至线上。
"/message/android/target_user_type": 1
},
"HO": {
//值为int 类型。1 表示测试推送，不填默认为0。荣耀每个应用每日可发送该测试消息1000条。仅开发者测试使用，此参数请勿发布至线上。
"/android/targetUserType": 1
},
"VV": {
//值为int 类型。0 表示正式推送；1 表示测试推送，不填默认为0。仅开发者测试使用，此参数请勿发布至线上。
"/pushMode": 1
},
"XM": {
//新小米消息分类下，无论公信私信，/extra.channel_id 都必传，否则请求小米厂商接口会被拦截导致推送失败。
"/extra.channel_id": "填写小米平台申请的渠道id"
}
}
}
},
"ios": {
"type": "notify",
"payload": "附加自定义消息",
"aps": {
"alert": {
"title": "iOS离线通知标题",
"body": "iOS离线通知内容"
},
"content-available": 0
},
"auto_badge": "+1"
},
"harmony": {
"notification": {
"title": "鸿蒙离线通知标题",
"body": "鸿蒙离线通知内容",
"category": "MARKETING",
"click_type": "startapp"
},
"options": {
"HW": {
//鸿蒙测试消息，华为每个应用每日可发送该测试消息1000条。仅开发者测试使用，此参数请勿发布至线上。
"/pushOptions/testMessage": true
}
}
}
}
}
成功响应数据格式:
application/json;charset=utf-8{
"code": 0,
"msg": "",
"data": {
"$taskid": {
"$cid":"$status"
}
}
}
data说明| 名称 | 类型 | 描述 |
|---|---|---|
| $taskid | Json | 任务编号 |
| $cid | String | cid: App的用户唯一标识；status: 推送结果 successed_offline: 离线下发(包含厂商通道下发) successed_online: 在线下发 successed_ignore: 最近 90 天内不活跃的用户不下发 |
注意：服务端 api 返回成功仅表示接口请求调用成功，不能说明客户端是否收到了消息。
例如推送返回 successed_offline 则说明推送时客户端不在线，走离线推送。若安卓客户端未收到消息，即【安卓离线消息收不到】，可以按下方 七、帮助中心 排查。
消息推送SDK合规指南：您应确保在App首次运行时通过明显方式提示终端用户阅读您的《隐私政策》，并取得终端用户的合法授权后，再初始化SDK进行信息收集与处理。如果终端用户不同意您的隐私政策，则不能初始化个推的各项SDK，也无法使用相应SDK对应功能。
可以参考 合规指南 文档进行披露。
当您在集成推送服务遇到问题时：
示例：开发者在推送消息后，发现 Android 客户端并没有收到通知栏消息展示。
处理思路：
当官网文档无法解决您的问题时，可点击右侧的【技术咨询】扫码联系个推技术支持。
以上文档对您是否有帮助？
