概述
推送服务(Push)面向应用提供稳定、高效的消息推送能力,支持在线通道以及华为、荣耀、OPPO、vivo、小米、魅族、APNs、 FCM 等厂商通道。
术语表
推送服务服务端 API 的常见术语如下表所示:
术语 | 描述 |
SDKAppID | 腾讯云后台用于区分不同应用的唯一标识,在即时通信 IM 控制台创建应用时生成。不同 SDKAppID 之间的数据相互隔离。 |
App 管理员 | 具备调用服务端 REST API 权限的应用管理员账号。调用推送服务服务端 API 时,URL 参数 identifier 必须填写 App 管理员账号。 |
UserSig | 腾讯云用于用户登录鉴权的安全签名。服务端调用 API 时,需要使用 App 管理员账号生成的 UserSig。 |
UserID | 业务侧定义的用户账号,用于在应用内唯一标识用户。 |
RegistrationID | 终端成功注册推送服务后生成的设备推送标识,可用于单发推送以及用户属性、用户标签管理。 |
在线推送 | 用户在线且 Push SDK 与服务端保持连接时,通过在线通道下发消息。 |
离线推送 | 用户不在线或应用在后台时,通过 APNs、Android 厂商通道或 Google FCM 等通道发送通知。 |
全员/标签推送 | 向全部用户,或根据用户属性、用户标签筛选出的目标人群发送推送。 |
单发推送 | 向指定 UserID 或 RegistrationID 列表发送推送,单次最多可指定 500 个接收账号。 |
用户属性 | 以键值对形式描述用户特征的数据,例如城市、会员等级,可用于属性人群筛选和推送。 |
用户标签 | 用于标识用户兴趣或业务分组的字符串,例如“黄金会员”“活跃用户”,可用于标签人群筛选和推送。 |
OfflinePushInfo | 推送信息公共配置对象,用于设置通知标题、通知内容、透传字段、角标、铃声、多语言内容及厂商通道参数。 |
TaskId | 全员/标签推送或单发推送成功后返回的推送任务 ID,可用于任务追踪;全员/标签推送的 TaskId 还可用于推送撤回。 |
API 快速入门
您可以使用腾讯云即时通信 IM 的 REST API 在线调试工具调用推送服务服务端 API。下面以“单发推送”为例说明调用步骤:
1. 登录腾讯云控制台,创建或选择已开通推送服务的应用,并获取应用的 SDKAppID。
2. 准备 App 管理员账号,并使用该管理员账号生成 UserSig。
3. 进入 REST API 在线调试工具。
4. 选择推送服务下的“单发推送”接口。
5. 填写 SDKAppID、App 管理员账号、UserSig 和随机数等公共参数。
6. 填写发送方账号、接收方账号列表及
OfflinePushInfo。接收方账号可以是 UserID 或 RegistrationID。7. 发起调用,根据应答中的
ActionStatus、ErrorCode 和 ErrorInfo 判断处理结果;批量推送还需要检查 ErrorList 中是否存在失败账号。