← 资料库索引 ← 官方文档 原始链接 ↗ 🔍
官方文档

腾讯云移动推送 推送接口(Push API) 原文标题:移动推送 推送接口_腾讯云

发表时间:2026-09-24采集时间:2026-10-09 10:34:55来源:cloud.tencent.com原文语言:zh状态:完整

内容概要总结

本文是腾讯云移动推送(TPNS)的推送接口(Push API)API 文档,定义所有推送请求的参数结构与示例。Push API 的请求参数通过 JSON 封装上传后台,由参数区分推送目标。核心围绕 audience_type(推送目标)与 message_type(消息类型)展开:推送目标支持全量、标签、单设备、设备列表、单账号、账号列表,以及号码包推送、token 文件包推送;单设备/单账号推送使用 token、account 字段,设备列表/账号列表使用 token_list、account_list(均不得超过 1000 个,否则推送失败)。

消息体按平台区分:Android/HarmonyOS 有普通消息与透传消息(因厂商限制,Android 和 HarmonyOS 透传消息只通过自建通道下发),iOS 有通知消息、静默消息与 LiveActivity 更新/远程启动。文档详列各厂商字段(华为 hw_category、荣耀 honor_importance、OPPO oppo_category、vivo vivo_category、小米 xm_ch_id、魅族 notification_type)及消息覆盖 collapse_id、定时推送、循环推送 loop_param、通道策略 channel_rules 等高级参数;并给出推送限频(全量/标签/号码包推送 1 条/秒,超频返回错误码 1008028)、expire_time 过期时间(默认 86400 秒、最长 72 小时、最大不得超过 259200)等约束。

原文内容(原文即中文)

⚠ 说明:抓取正文由页面文本抽取,原页面的部分参数表格被压平为纯文本行(如参数名与说明分行),未作补充或改写;数值与字段名均保持与原文一致。

文档中心>移动推送>API 文档>推送相关接口>推送接口

推送接口

最近更新时间:2026-09-24 16:34:06

本页目录:

  • iOS LiveActivity PushToStart

接口说明

接口服务地址与服务接入点一一对应,请选择与您的应用服务接入点对应的 服务地址。

接口功能:Push API 是所有推送接口的统称。Push API 有多种推送目标,推送目标见下文。
所有请求参数通过 JSON 封装上传给后台,后台通过请求参数区分不同的推送目标。如有疑问请参见 服务端错误码。

腾讯云移动推送结合业务优化的需求,对全量推送、标签推送和号码包推送进行限频(1条/秒),官网控制台将与 API 同步调整。

如果超过此频率会返回错误码:1008028,请您自行调整推送频率,否则可能会引起推送异常。

必要参数

package_account_push:号码包推送

package_token_push:token 文件包推送

注册打包的环境与推送环境需要保持一致,请参见 推送环境选择说明

是(仅号码包推送\\ token 文件包推送时使用)

audience_type:推送目标

推送目标,表示一条推送可以被推送到哪些设备。
Push API 提供了多种推送目标,例如全量、标签、单设备、设备列表、单账号、账号列表。

标签组合推送,可设置'与'、'或'、'非'组合规则

注意:当与 tag_list 二者共存时,tag_list 字段自动无效,参数说明请查看 tag_rules 参数说明tag_list(后续不再更新):

推送 tag1 和 tag2 的设备{"tags":["tag1","tag2"],"op":"AND"}

推送 tag1 或 tag2 的设备{"tags":["tag1","tag2"],"op":"OR"}

如果该参数包含多个 token 只会推送第一个 token

格式 eg:["token1","token2"]

注意:若列表超过1000个 token,推送会失败,如需推送更大批量 token,建议您使用 上传 Token 包推送

格式 eg:["account1","account2"]

注意: 若列表超过1000个 account,推送会失败,如需推送更大批量 account,建议您使用 号码包推送

标签推送(tag_rules 方式):广东和湖南,并且是20200408当天活跃过的男性用户。

"tag_type": "xg_auto_province"

"tag_type": "xg_auto_active"

"tag_type": "xg_user_define"

单设备推送:推送给 token 为 token1 的设备。

"audience_type": "token",

设备列表推送,推送给 token 为 token1 和 token2 的设备。

"audience_type": "token_list",

单账号推送:推送给账号为 account1 的设备。

"audience_type": "account",

账号列表推送:推送账号为 account1 和 account2 的设备。

"audience_type": "account_list",

message_type:消息类型

Android & iOS & HarmonyOS

注意:该字段与 content-available: 1 互斥,请勿同时使用。

注意:因厂商限制,Android 和 HarmonyOS 透传消息只通过移动推送自建通道下发,无法通过厂商通道下发

message:消息体

消息体,即下发到客户端的消息。
Push API 对 iOS 、Android 和 HarmonyOS 三个平台的消息有不同处理,需要分开来实现对应平台的推送消息,推送的消息体是 JSON 格式。

Android /Harmony 普通消息

Android 和 HarmonyOS 平台具体字段如下表:

安卓和鸿蒙字段部分共用,请开发者注意支持平台相关字段的使用。

单个元素由 "start" 和 "end" 组成的起止时间对组成

"start" 和 "end" 由 hour (小时)和 min(分钟)描述对应时刻,详细参考具体示例。

注意:支持通道有:自建通道、FCM、华为、荣耀和 OPPO 通道,其中华为、荣耀和 OPPO 通道需要加白名单,分组折叠能力才生效。

通知分组折叠后显示的摘要,thread_id 非空时有效

通知栏大图片 url 地址,仅对移动推送自建通道和小米通道生效;

注意:如需使用小米通道大图通知功能,需先调用小米图片上传接口上传图片文件,获取小米指定的图片地址 pic_url ,再填入移动推送推送对应的参数 xg_media_resources 中。

注意:仅移动推送自建通道支持该参数下发,其他通道不下发该参数

安卓/鸿蒙通知高级设置结构体,请参见 Android/Harmony 结构体说明

Android 和 Harmony 结构体说明

通知渠道 ID(仅移动推送自建通道生效),请参见 创建通知渠道。

通知渠道名称(仅移动推送自建通道生效) ,请参见 创建通知渠道。

通知分类(仅移动推送自建通道且 Android SDK1.4.3.1及以上版本生效),请参见 移动推送自建通道通知分类说明。

注意:适配华为本地通知自分类可使用此字段,详细请参见 华为本地通知适配说明。

通知渠道优先级(仅移动推送自建通道且 Android SDK1.4.3.1及以上版本生效),请参见 移动推送自建通道通知渠道优先级说明。

1: 对应 Android 系统的 IMPORTANCE_MIN

2: 对应 Android 系统的 IMPORTANCE_LOW

3: 对应 Android 系统的 IMPORTANCE_DEFAULT

4: 对应 Android 系统的 IMPORTANCE_HEIGHT

注意:仅在首次创建通知的 Channel 时生效,如本地已有相同的通知渠道此字段不生效。

注意:7月1日后创建的私信和订阅类型消息需要与 xm_template_id 配套使用。

下发小米通道时 ChannelId 必填,否则请求小米报错:27001。

使用私信和订阅类型消息时必填,与 xm_ch_id 同时携带。

当推送请求体中携带 模板 ID 时,系统将强制启用所有设备通过厂商通道下发,无论 App 在线还是离线补推,均不会经过 自建通道,因此 channel_rules 参数 中严禁强制关闭厂商通道。若厂商通道被禁用,将导致消息因无可用下发通道而失败。

xm_template_param_json_str

模版变量参数的 JSON 字符串,键为模版占位符名,值为消息模板参数的 JSON 字符串。

iii.不支持 emoji 及特殊符号(Unicode Other Symbol 类,即 \\p{So});

华为下发的消息紧急程度,取值 HIGH、NORMAL(默认)。

oppo_top_notification_bar_show

注意:仅 OPPO 通道有效,其需要 联系 OPPO 商务 开通

vivo vpush 商业化字段,仅 vivo 通道有效,包含广告模板 ID、消息样式等,详情参见 vivo_marketing 参数说明,其需要 联系 vivo 商务 开通。

说明:如果您应用的数据处理位置为中国区时通知渠道无效,详细说明请您参见 华为自定义渠道 文档。

华为消息类型标识,确定消息提醒方式,对特定类型消息加快发送,参数详情请参见 华为的请求参数说明 的 category 参数。

1:表示通知栏消息预期的提醒方式为静默提醒,消息到达手机后,无铃声震动。

2:表示通知栏消息预期的提醒方式为强提醒,消息到达手机后,以铃声、震动提醒用户。终端设备实际消息提醒方式将根据 hw_category 字段取值或者 智能分类 结果进行调整。

新版本荣耀分类可以不复用该字段,可以使用 honor_importance 字段。

如果没传 honor_importance 则还是会复用

1:LOW 表示消息为资讯营销类,默认展示方式为静默通知,仅在下拉通知栏展示。

2:NORMAL 表示消息为服务通讯类,默认展示方式为锁屏展示+下拉通知栏展示。

当honor_importance为0或者无此字段时,取原hw_importance字段。

OPPO 渠道 ID(仅 OPPO 推送通道生效)

注意:该参数仅支持 OPPO 旧通道,旧通道即将下线,请使参数 oppo_category 新通道分类。

OPPO 消息类型标识,详细场景请参见《OPPO 新消息分类场景说明》

使用 oppo_notify_level 参数时,oppo_category 参数必传。请参见 OPPO 提醒申请使用。

oppo_priv_msg_template_id

注意:当推送请求体中携带 模板 ID 时,系统将强制启用所有设备通过厂商通道下发,无论 App 在线还是离线补推,均不会经过 自建通道,因此 channel_rules 参数 中严禁强制关闭厂商通道。若厂商通道被禁用,将导致消息因无可用下发通道而失败。

oppo_priv_title_param_json_str

oppo_priv_content_param_json_str

vivo 消息类型标识,根据 vivo 推送消息分类规范,自行对消息进行分类,请在发送消息时携带 vivo_category 字段并正确赋值,参数值详情请参见 vivo 消息分类。

自2026年10月19日起新接入 vivo 推送服务的应用,vivo_category 字段必填。

自2026年10月19日前已完成接入的存量应用,vivo_category 字段非必填,不填默认为公信消息。

vivo 渠道 ID:“0”代表运营消息,“1”代表系统消息(仅 vivo 推送通道生效)。

说明:该字段即将下线,请6月30号之前申请 vivo_category 参数传值,否则被判为运营消息(推送受限)。

notification_type 字段值为“1”时,表示公信消息,限制每日每设备推送数量。

notification_type 字段值为“2”时,表示私信消息,推送无限制。

本地通知样式标识,指定成您在终端预设的样式 id, 不传则不指定。

[0, 100):直接设置,支持华为、vivo 和鸿蒙设备

注意:不同厂商设备的角标适配能力不同,各参数值实现效果请参见 角标适配指南。

指定 Android 工程里 raw 目录中的铃声文件名,不需要后缀名。

说明:自定义铃声仅华为、小米、FCM 和移动推送自建通道支持,需配合n_ch_id字段使用,配置步骤可参考 如何设置自定义铃声。

指定通知栏缩略图显示的是应用内图标还是网络资源图标 :

1:网络资源图标,仅移动推送自建通道、FCM、华为、荣耀和鸿蒙通道支持

当 icon_type = 0:填写 Android 应用内的图片资源文件名称(不带文件后缀),仅对移动推送自建通道有效

当前 icon_type = 1:填写缩略图 url 地址,缩略图格式要求可参见 富媒体通知文档,仅移动推送自建通道、FCM、华为、荣耀和鸿蒙通道支持

需要使用 RGB 颜色的十进制值,例如 RGB 颜色 #01e240,请填入123456,

设置点击通知栏之后的行为,默认为打开 App,详情参考 action 参数说明

用户自定义的参数(需要序列化为 JSON String)获取方式详见 通知点击跳转-客户端获取参数

华为官方通知:「2021年9月30日起停用 V2协议」。移动推送已将华为推送协议升级到 V5,V5协议不支持通过【附加参数】字段携带自定义参数。如果您集成了华为厂商通道,建议您改用 Intent 方式携带自定义参数,否则将导致自定义参数不能成功通过华为推送通道下发。

应用前台时,是否展示通知 。 默认展示,仅对移动推送自建通道、FCM 通道有效

若取值为1且应用在前台,终端用户对该条推送无感知,但有抵达数据上报。

鸿蒙通知高级设置结构体,请参见 harmony 结构体说明

vivo 广告模板 ID,开发者可前往 vivo 营销平台创建通知广告模板,详情请参见 vivo 付费服务接口文档,其需要 联系 vivo 商务开通。 非 vivo 付费服务请忽略。

标题+内容+大图+小图(可选):id=3,类型大图

标题+内容+组图/三图+小图(可选):id=4,类型组图/三图

详情请参见 vivo 付费服务接口文档,其需要 联系 vivo 商务开通。 非 vivo 付费服务请忽略。

出价,系统以此价格为准进行实时 cpc 计费,该价格不得低于与 vivo 商务商定价格,其需要 联系 vivo 商务开通。 非 vivo 付费服务请忽略。

vivo 付费通道样式,详情请参见 vivo 付费服务接口文档,其需要联系 vivo 商务开通。 非 vivo 付费服务请忽略。

小图,请填写上传图片后所获得图片 ID(需要在 vivo 侧上传),详情请参见 vivo 付费服务接口文档,其需要联系 vivo 商务开通。非 vivo 付费服务请忽略。

大图,请填写上传图片后所获得图片 ID(需要在 vivo 侧上传),详情请参见 vivo 付费服务接口文档,其需要联系 vivo 商务开通。非 vivo 付费服务请忽略。

最多可填写 3 个按钮,单个按钮长度不超过 12 个字符(6 个汉字或 12 个英文字母) 支持每个按钮单独配置 deeplink 链接,详情请参见 vivo 付费服务接口文档,其需要联系 vivo 商务开通。非 vivo 付费服务请忽略。

按钮名字,详情请参见 vivo 付费服务接口文档,其需要联系 vivo 商务开通。非 vivo 付费服务请忽略。

详情请参见 vivo 付费服务接口文档,其需要联系 vivo 商务开通。非 vivo 付费服务请忽略。

跳转内容,跳转类型为 2 时,跳转内容最大 1000 个字符,跳转类型为 4 时,跳转内容最大 1024 个字符。关于 skipContent 的内容可 以参考【vivo 推送常见问题】,其需要联系 vivo 商务 开通。非 vivo 付费服务请忽略。

3:打开 App 自定义页面(推荐使用,参考 使用 Intent 方式跳转指引)

action_type 为1,且需要打开 activity 时必选

activity 完整名称,例如 com.x.y.PushActivity

action_type 为1,且需要打开 activity 时可选

if:Intent 的 Flag 属性,类型为 Integer

pf:PendingIntent 的 Flag 属性,类型为 Integer

url:网页地址,仅支持 http、https,类型为 String

confirm:是否需要用户确认,类型为 Integer

自定义 scheme,例如 xgscheme://com.tpns.push/notify_detail

harmony_message 结构体说明

注意:目前仅支持0(通知消息),暂时不支持其他消息,待后续更新。

通知消息类型,完成申请通知消息自分类权益并激活后,用于标识消息类型,不用的通知消息和提醒方式,取值如下:

MARKETING:内容推荐、新闻、财经动态、生活资讯、调研、社交动态、产品促销、功能推荐、运营活动(仅对内容进行标识,不会加快消息发送),统称为营销类消息,该营销消息类型无需申请自分类权益,消息携带 category 取值后即生效。

MARKETING 消息与其他分类的通知消息存在不同的频控策略,详情请参见通知消息推送数量管理规则。

"inbox_content": ["1.content1","2.content2","3.content3"]

点击消息动作,详情请参见 click_action 结构体

1 - SOCIAL_COMMUNICATION 社交通信

2 - SERVICE_INFORMATION 服务提醒

3 - CONTENT_INFORMATION 内容资讯

4 - LIVE_VIEW 实况窗。(预留能力,暂未支持)

5 - CUSTOMER_SERVICE 客服消息

该类型用于用户与商家之间的客服消息,需由用户主动发起。

用户自定义的参数(需要序列化为 JSON String)

click_action 参数说明(harmony)

应用内置页面 ability 对应的 action

当 action_type 为1时,字段 uri 和 action 至少填写一个

当 action_type 为1时,字段 uri 和 action 至少填写一个

"xg_media_resources": "xxx" , //此处填富媒体元素地址,例如https://www.xx.com/img/bd_logo1.png?qua=high

"xg_media_audio_resources":"xxx", //此处填音频富媒体元素地址,例如http://sc1.111ttt.cn/2018/1/03/13/396131227447.mp3

"hour": "13",//起始时间 小时值, 取值 [0:24)

"min": "00"// 起始时间 分钟值, 取值[0:60)

"hour": "14",//结束时间 小时值, 取值 [0:24)

"min": "00" //结束时间 分钟值,取值[0:60)

"n_ch_id": "default_message",

"oppo_category": "IM", //oppo分类

"oppo_priv_msg_template_id": "hellooppo",

"oppo_priv_title_param_json_str": "{\\"name\\": \\"duoduo\\"}",

"oppo_priv_content_param_json_str":"{\\"name\\": \\"duoduo\\",\\"country\\":\\"cn\\"}",

"xm_ch_id": "156023", //小米分类

"xm_template_id": "P12545",//注意:若推送请求体中传了模版ID,所有设备都不会走自建通道下发(包括app在线和离线补推)。

"xm_template_param_json_str": "{\\"keywords1\\":\\"duoduo\\",\\"keywords2\\": \\"guangdong\\"}",

"vivo_category": "IM", //vivo分类

"hw_category":"IM", //华为分类

"hw_ch_id": "华为通知消息的channel_id",

"notification_type": 2 , //魅族分类

"honor_importance":2, //荣耀分类

"icon_res": "xxx",//仅支持https

"custom_content":"{\\"key\\":\\"value\\"}", //Android下的自定义参数

"action_type": 1,// 动作类型,1,打开activity或app本身;2,打开浏览器;3,打开Intent

"activity": "com.x.y.PushActivity",

"aty_attr": {// activity属性,只针对action_type=1的情况

"if": 0, // Intent的Flag属性

"pf": 0 // PendingIntent的Flag属性

"url": "https://cloud.tencent.com ", // 仅支持http、https

"intent": "xgscheme://com.tpns.push/notify_detail" //SDK版本需要大于等于1.0.9,然后在客户端的intent配置data标签,并设置scheme属性

"uri": "tpns://com.tpns.push/notify_detail"

"custom_content":"{\\"key\\":\\"value\\"}" //Harmony下的自定义参数

iOS 通知消息

消息标题,此字段会覆盖 alert 下的 title 中的内容。

消息内容,此字段会覆盖 alert 下的 body 中的内容。

说明:若取值为1且应用在前台,终端用户对该条推送无感知,但有抵达数据上报。

图片、音视频富媒体元素 url 地址,详情请参见 富媒体通知

iOS 字段说明

苹果推送服务(APNs)特有的消息体字段,请参见 aps 参数说明,其他详细介绍请参见官网 Payload。

说明:对于 iOS 推送,aps 消息体内透传给 Apple 的参数,其命名与 apple 推送接口保持一致, 使用中划线分割(例如 content-state)。其他非苹果官方参数使用 TPNS 统一的下划线分割。

自定义下发的参数,需要序列化为 json string

推送的时候携带 "mutable-content":1,说明是支持 iOS 10 的 Service Extension

开启后,推送详情中会有抵达数据上报,使用该功能前请按照 通知服务扩展的使用说明 实现 Service Extension 接口,如果不携带此字段则没有抵达数据上报

如果消息有富媒体信息(xg_media_resources 字段)此字段强制取值为1

播放系统默认提示音,"sound":"default"

播放本地自定义铃声,"sound":"chime.aiff"

静音效果,"sound":"" 或者是去除 sound 字段。

自定义铃声说明:格式必须是 Linear PCM、MA4(IMA/ADPCM)、alaw,μLaw 的一种,将声频文件放到项目 bundle 目录中,且时长要求30s 以下,否则就是系统默认的铃声。

仅对 iOS 15 以后的设备生效,需要在Capability 中打开Time Sensitive Notifications选项,有4个值可以选择设置:

passive:被动通知,即并不需要及时关注的通知。

time-sensitive:时效性通知,需要人们立刻注意的通知。

仅对 iOS 15 以后的设备生效,取值范围0~1之间,开启专注模式后此字段生效,系统会根据字段分数从高到低对通知进行排序,分数最高的会展示在通知摘要中。

"xg_media_resources":"https://www.xx.com/img/bd_logo1.png";,

"subtitle": "my subtitle"

"category": "INVITE_CATEGORY",

"interruption-level":"time-sensitive",

"custom_content":"{\\"key\\":\\"value\\"}"

Android/Harmony 透传消息

透传消息,Android/Harmony 平台特有,即不显示在手机通知栏中的消息,可以用来实现让用户无感知的向 App 下发带有控制性质的消息。

因厂商限制,Android/Harmony 透传消息只通过移动推送自建通道下发,无法通过厂商通道下发。

Android 和 Harmony 平台具体字段如下表:

单个元素由 "start" 和 "end" 组成的起止时间对组成。

"start" 和 "end" 由 hour (小时)和 min(分钟)描述对应时刻,详细参考具体示例。

"title": "this is title",

"content": "this is content",

"custom_content":"{\\"key\\":\\"value\\"}", //Android下的自定义参数

"custom_content":"{\\"key\\":\\"value\\"}" //Harmony下的自定义参数

iOS 静默消息

静默消息,iOS 平台特有,类似 Android 中的透传消息,消息不展示,当静默消息到达终端时,iOS 会在后台唤醒 App 一段时间(小于30s),让 App 来处理消息逻辑。

  1. 如果需要唤醒关闭的 App,应用需开启 Background fetch 能力(Xcode 里面配置)。
  1. 手机频繁推送静默消息后可能会限频(只影响关闭 App 状态下的拉起,此时只有当用户打开 App 后才会触达,后台和前台无影响)

点击 app->application:didFinishLaunchingWithOptions:>didReceiveRemoteNotification:fetchCompletionHandler:

苹果推送服务(APNs)特有的,其中最重要的键值对如下:

不能包含 alert、sound 字段,详细介绍请参见 Payload

注意:content-available: 1与 message_type:"notify" 字段互斥,请勿同时使用

"custom_content":"{\\"key\\":\\"value\\"}"

iOS LiveActivity Update

用户可以通过 ActivityKit 开发锁屏状态下的实时活动界面或开发基于灵动岛的动画效果,可以通过 APNs 发送远程通知来更新或结束实时活动。

事件类型,更新实时活动取值 update ,结束实时活动取值 end

实时活动内容更新,KV 格式,用户配合终端所需内容自行定义及解析

当结束实时活动, event 为 end 时生效,不填则默认4小时后消失,若取值为过去时间则立马消失,若取值4小时以内的时间则按指定时间消失

当使用实时活动时,message_type 取 notify 值。

"audience_type": "activity",

"activity": "6F21C4FC-5FB0-4310-AA13-C7B12FD6FAEF",

"message_type": "notify",

"dismissal-date":1684310548,

"describe": "Delivery Update756"

"custom_content": "{\\"key\\":\\"value\\"}"

iOS LiveActivity PushToStart

远程启动实时活动,用户可以通过某类活动 AClassActivity 请求 pushToStartToken 并调用 SDK 的绑定活动接口将活动类别和对应用户关联,在将来的某个时刻,下发给此类活动下的所有绑定用户。

远程启动实时活动类别,固定值 activity_attributes

业务侧定义的实时活动类别,值为类名,如订单类参考取值 OrderActivity

实时活动类别如 OrderActivity 里面除 content-state 之外的静态值

业务自定义内容,可变,实时活动动态更新数据,远程启动可不传

当使用实时活动时,message_type 取 notify 值。

"audience_type": "activity_attributes",

"message_type": "notify",

"attributes-type": "OrderActivity",

"attributes-sub-type": "OrderActivity_A"

"custom_content": "{\\"key\\":\\"value\\"}"

可选参数

Push API 可选参数是除了audience_type、message_type、message以外,可选的高级参数。

若 expire_time <= 0,系统将采用默认过期时间 86400 秒(即 24 小时)

若 expire_time > 0,且小于800s,则系统会重置为800s

若 expire_time >= 800s,按实际设置时间存储,最长72小时

设置的最大值不得超过259200,否则会导致推送失败

Array[{"channel":string,"expire_time":int}]

在推送接口中填写 channel_expires 字段后, 在推送流程中,会区分此类型消息和普通消息,单独使用通道的特殊离线消息时长,其他通道则使用默认值 expire_time 过期时间,消息离线存储时间(单位为秒),最长72小时

若 expire_time > 0,且小于800s,则系统会重置为800s

若 expire_time >= 800s,按实际设置时间存储,最长72小时

设置的最大值不得超过259200,否则会导致推送失败

定时推送任务,指定推送时间,可选择未来90天内的时间:

多包名推送:当 App 存在多个渠道包(例如应用宝、豌豆荚等),并期望推送时所有渠道的 App 都能收到消息,可将该值设置为 true。

注意:该参数默认控制移动推送自建通道的多包名推送,需要实现厂商通道多包名推送详见 厂商通道多包名配置 文档

仅全量推送、号码包推送和标签推送支持此字段,详情见下文 loop_param 参数说明

推送计划 ID,推送计划创建及使用方式可 参考文档

标签组合推送,可设置'与'、'或'、'非'组合规则

注意:当与 tag_list 二者共存时,tag_list 字段自动无效,参数说明请查看 tag_rules 参数说明

要求 audience_type = account

参数格式:["account1","account2"]

1:往账号关联的所有 device 设备上推送信息

账号类型,需要与推送的账号所属类型一致,取值可参考 账号类型取值表

参数格式:[ "token1","token2" ]

0:代表如果有无效的 token 则这个接口调用失败

注意:仅对 token 列表推送和单 token 推送有效

推送限速设置每秒 X 条,X 取值参数范围1000 - 50000

消息覆盖参数,在前一条推送任务已经调度下发后,如果第二条推送任务携带相同的 collapse_id 则会停止前一条推送中尚未下发的移动推送自建通道数据,同时会覆盖展示第一条推送任务的消息。

已完成任务的 collapse_id 可以通过 单个任务推送信息查询接口 获取。

可自定义该条推送允许通过哪些通道下发,默认允许通过所有通道下发,详细推送策略参考 通道策略

channel_rules 数组单元素数据结构见下 channel_rules 参数说明

对于不支持消息覆盖的 OPPO 、vivo 通道的设备,是否进行消息下发。

暂不支持用户自定义此参数,需要移动推送生成的 collapse_id。

目前仅支持移动推送自建通道、APNs 通道、小米通道、魅族通道以及华为系统版本 EMUI10 及以上的设备。

对于华为通道,覆盖消息时携带自定义参数需要使用 intent 方式,如使用 custom_content 方式携带自定义参数,接口层会进行拦截。

目前 OPPO 通道 vivo 通道不支持覆盖消息。当新创建覆盖消息时可通过 force_collapse 字段设置为 false 来关闭 vivo、OPPO 通道的下发。

tag_rules 参数说明

tag_rules 数组内各元素的运算符,第一个 tag_rules 元素的 operator 为无效数据,第二个 tag_rules 元素的 operator 作为第一个和第二个 tag_rules 元素之间的运算符。

是否对 tag_items 数组的运算结果进行非运算。

tag_items 说明

具体标签值,类型:string,如 tag1,guangdong 等。

tag_items 数组内各元素的运算符,第一个 tag_items 元素的 items_operator 为无效数据,第二个 tag_items 元素的 items_operator 作为第一个和第二个 tag_items 元素之间的运算符。

注意:不同规则之间运算符逻辑优先级「AND」>「OR」

tag_type 取值表

channel_rules 参数说明

是否关闭 channel 中对应的通道, 默认打开通道。

loop_param 参数说明

循环区间开始日期,可选择未来90天内的时间。格式 YYYY-MM-DD,例如2019-07-01

循环区间截止日期,可选择未来90天内的时间。格式 YYYY-MM-DD,例如2019-07-07

按天循环:填写[0],表示每天的任务,按周循环:填周几[0-6],如[0, 1, 2]表示每周的星期天,周一,周二进行推送,按月循环:填写日期,如[1,10,20],每个月1,10,20号

具体推送时间,格式 HH:MM:SS,例如["19:00:00", "20:00:00"],表示每天的19点,20点进行推送

应答参数

与请求包一致(如果请求包无该字段,则该字段返回为0)

注意:如果您是循环推送类型,则会返回多个 pushid 放在一个数组类型里

仅对 token 列表推送和单 token 推送 且 ignore_invalid_token 值为1时返回,该字段会存储被过滤的无效 token ,有效 token 会正常下发

若有额外数据要返回,则结果封装在该字段的 json 中

示例说明

Android/Harmony 账号推送请求消息

"audience_type": "account",

"message_type": "notify",

"xg_media_resources": "xxx1" , //此处填富媒体元素地址,例如https://www.xx.com/img/bd_logo1.png?qua=high

"xg_media_audio_resources":"xxx", //此处填音频富媒体元素地址,例如http://sc1.111ttt.cn/2018/1/03/13/396131227447.mp3

"hour": "13",//起始时间 小时值, 取值 [0:24)

"min": "00"// 起始时间 分钟值, 取值[0:60)

"hour": "14",//结束时间 小时值, 取值 [0:24)

"min": "00" //结束时间 分钟值,取值[0:60)

"n_ch_id": "default_message",

"icon_res": "xxx",//仅支持https

"action_type": 1,// 动作类型,1,打开 activity 或 app 本身;2,打开浏览器;3,打开 Intent

"aty_attr": {// activity属性,只针对action_type=1的情况

"if": 0, // Intent的Flag属性

"pf": 0 // PendingIntent的Flag属性

"url": "xxxx ", // 仅支持http、https

"intent": "xxx" //SDK版本需要大于等于1.0.9,然后在客户端的intent配置data标签,并设置scheme属性

"uri": "tpns://com.tpns.push/notify_detail"

"custom_content":"{\\"key\\":\\"value\\"}"

账号推送应答消息

"environment": "product",

"invalid_targe_list": [],

iOS 单设备推送请求消息

"audience_type": "token",

"token_list": [ "05da87c0ae****fa9e08d884aada5bb2"],

"category": "INVITE_CATEGORY"

"custom_content":"{\\"key\\":\\"value\\"}"

单设备推送应答消息

"invalid_targe_list": [],

标签推送场景(tag_rules 方式)

场景一:广东和湖南,并且是20200408当天活跃过的男性用户
表达式:(xg_auto_province.guangdong 或 xg_auto_province.hunan)与 xg_auto_active.20200408 与 xg_user_define.male

"is_not": false, //是否对tags内标签计算的结果进行非运算,true-进行非运算,false-不进行非运算

"tags_operator": "OR", //tags内标签对应的运算符

"items_operator": "OR", //tag_items内各元素的运算符,第一个元素的items_operator为无效数据,第二个元素的items_operator作为第一个和第二个元素之前的运算符,以此类推

"tag_type": "xg_auto_province" //tags内标签对应的标签类型

"tag_type": "xg_auto_active"

"tag_type": "xg_user_define"

场景二:近3天活跃,并且 App 版本不为1.0.2的华为用户
表达式:(xg_auto_active.20200406 或 xg_auto_active.20200407 或 xg_auto_active.20200408)与 (非 xg_auto_version.1.0.2) 与 xg_auto_devicebrand.huawei

"is_not": false, //是否对tags内标签计算的结果进行非运算,true-进行非运算,false-不进行非运算

"tags_operator": "OR", //tags内标签对应的运算符

"items_operator": "OR", //tag_items内各元素的运算符,第一个元素的items_operator为无效数据,第二个元素的items_operator作为第一个和第二个元素之前的运算符,以此类推

"tag_type": "xg_auto_active" //tags内标签对应的标签类型

"tag_type": "xg_auto_verison"

"tag_type": "xg_auto_devicebrand"

文档“捉虫”活动

API专项"捉虫"

文档建议,你提了吗

放大预览