OPPO开放平台 推送通知栏消息 参数说明
通知栏消息
名称 | 类型 | 是否必填 | 默认 | 描述 | 是否支持单推 |
---|---|---|---|---|---|
app_message_id | String | 否 | 无 | App开发者自定义消息Id,主要用于消息去重。 对于广播消息,相同app_message_id只会保存一条; 对于单推消息,相同app_message_id的消息只会对同一个目标推送一次。 | 是 |
style | Int | 否 | 1 | 通知栏样式 1. 标准样式 2. 长文本样式 (ColorOS版本>5.0可用,通知栏第一条消息可展示全部内容,非第一条消息只展示一行内容)3. 大图样式 (ColorOS版本>5.0可用,通知栏第一条消息展示大图,非第一条消息不显示大图,推送方式仅支持广播,且不支持定速功能)。 | 是 |
big_picture_id | String | 否 | 无 | 大图id【style为3时,必填】,通过上传大图接口获得大图id后可使用。 上传大图接口请参考服务端API介绍章节 | 否 |
small_picture_id | String | 否 | 无 | 通知图标id,通过上传小图接口获得小图id后可使用。 上传小图接口请参考服务端API介绍章节。 | 否 |
title | String | 是 | 无 | 设置在通知栏展示的通知栏标题, 【字数串长度限制在50个字符内,中英文字符及特殊符号(如emoji)均视为一个字符】 | 是 |
sub_title | String | 否 | 无 | 子标题,设置在通知栏展示的通知栏标题, 【字符串长度限制在10个字符以内,中英文字符及特殊符号(如emoji)均视为一个字符计算】 | 是 |
content | String | 是 | 无 | 设置在通知栏展示的通知的正文内容 1)当选择标准样式(style 设置为 1)时,内容字符串长度限制在200以内; 2)当选择长文本样式(style设置 为 2)时,内容字符串长度限制在128以内; 3)当选择大图样式(style 设置为 3)时,内容字符串长度限制在50以内。 【字符串长度计算说明:中英文字符及特殊符号(如emoji)均视作一个字符计算】 | 是 |
click_action_type | Int | 否 | 0 | 点击通知栏后触发的动作类型。 点击动作类型值的定义和含义如下: 0.启动应用; 1.跳转指定应用内页(action标签名); 2.跳转网页; 4.跳转指定应用内页(全路径类名);【非必填,默认值为0】; 5.跳转Intent scheme URL | 是 |
click_action_activity | String | 否 | Null | 当设置click_action_type为1或者4时,需要配置本参数。 应用内页地址【click_action_type为1/4/时必填,长度500】 示例: 假设应用注册了类名为InternalActivity的activity,应用内页的xml配置如下 ![]() 当开发者期望消息被点击后跳转到这个应用内页,可以有两种方法传递参数: 指定click_action_type为1时,click_action_activity传入com.coloros.push.demo.internal 指定click_action_type为4时,click_action_activity传入com.coloros.push.demo.component.InternalActivity | 是 |
click_action_url | String | 否 | Null | 跳转URL,当跳转的形式为URL时,click_action_type参数需要设置为2或5,同事设置本参数。本参数接受最大长度2000以内的URL。 示例: click_action_type为2时,本参数可设置为http://oppo.com?key1=val1&key2=val2click_action_type为5时,本参数可设置为command://test?key1=val1&key2=val2 | 是 |
action_parameters | String | 否 | Null | 跳转动作参数。 打开应用内页或网页时传递给应用或网页的附加参数【JSON格式】,字符串长度不超过4000。当跳转类型是URL类型时,参数会以URL参数直接拼接在URL后面。 示例:{“key1”:“value1”,“key2”:“value2”} | 是 |
show_time_type | Int | 否 | 0 | 通知栏展示类型。展示类型如下 0:即时展示 1:定时展示 | 否 |
show_start_time | Long | 否 | 0 | 定时展示的开始时间。 选择定时展示后,消息将于设定的开始时间到结束时间之内展示。 本参数接受13位的unix时间戳。 | 否 |
show_end_time | Long | 否 | 0 | 定时展示的结束时间。 选择定时展示后,消息将于设定的开始时间到结束时间之内展示。 本参数接受13位的unix时间戳。 | 否 |
off_line | Boolean | 否 | TRUE | 是否是离线消息。 如果是离线消息,OPPO PUSH在设备离线期间缓存消息一段时间,等待设备上线接收。 | 是 |
off_line_ttl | Int | 否 | 3600 | 离线消息的存活时间,单位是秒。存活时间最大允许设置为10天,参数超过10天以10天传入。 | 是 |
push_time_type | Int | 否 | 0 | 定时推送 (0, “即时”),(1, “定时”), 【只对全部用户推送生效】 | 否 |
push_start_time | Long | 否 | 0 | 定时推送开始时间(根据time_zone转换成当地时间), 【push_time_type 为1必填】,时间的毫秒数 | 否 |
time_zone | String | 否 | GMT+08:00 | 时区,默认值:(GMT+08:00)北京,香港,新加坡 | 是 |
fix_speed | Boolean | 否 | FALSE | 是否定速推送。广播类型消息专用,如果设置定速推送,消息将会以给定的速度均匀下发。 | 否 |
fix_speed_rate | Long | 否 | 1000 | 定速推送的速率,单位为条每秒。 指定消息为定速推送消息时,需要指定本参数。 定速推送速率范围在[1000, 10000]。 | 否 |
network_type | Int | 否 | 0 | 推送的网络环境类型。 本参数将影响用户设备仅在指定类型的网络环境下接收消息。 参数定义如下: 0:不限联网方式; 1:仅wifi推送,设置后,消息只会在用户处于WiFi环境下才下发。 | 否 |
call_back_url | String | 否 | 无 | 回执功能详见回执一章仅支持registrationId推送方式开发者接收消息送达的回执消息的URL地址。 OPPO PUSH提供消息回执的功能,消息回执的功能是指消息送达后,OPPO PUSH基于HTTP/HTTPS请求的方式告知开发者对应消息的送达情况。 要使用回执功能,开发者需要配置回执目标地址的URL参数,URL长度限制在限制200以内。 以下是一个使用回执的示例: 1.开发者配置本参数 2.消息到达设备后,OPPO PUSH根据本参数,向这个URL以Content-Type为application/json的方式发送一个HTTP/HTTPS请求。 请求内容的示例如下JSON 数据示例: [ { “messageId”: “msgId1”, // 到达的消息ID “appId”: “appid”, // 对应的应用ID “taskId”: “taskId1”, // 如果是广播消息,对应taskID;如果是单推消息,该字段为消息ID “registrationIds”: “regId1, regid2”, // 消息的推送目标注册ID “eventTime”: “timestamp”, // 回执事件产生时间 “param”: “call_back_parameter”, // 开发者指定的回执参数 “eventType”: “push_arrive” // 到达事件,消息到达的事件被定义为push_arrive }, // 对于完全一致的URL地址,OPPO PUSH可能会将相同URL地址回执信息在一个HTTP/HTTPS请求中发送,因此body里是一个长度大于等于1的JSON数组 { “messageId”: “msgId1”, “appId”: “appid”, “taskId”: “taskId1”, “registrationIds”: “regId1,regid2”, “eventTime”: “timestamp”, “param”: “call_back_parameter”, “eventType”: “push_arrive” } ] | 是 |
call_back_parameter | String | 否 | 无 | 开发者指定的自定义回执参数。 参数字符串长度限制在100以内,OPPO PUSH将这个参数设置在回执请求体单个JSON结构的param字段中。 | 是 |
channel_id | String | 否 | OPPO PUSH 提供的默认通道ID | 指定下发的通道ID。 通知栏通道(NotificationChannel),从Android9开始,Android设备发送通知栏消息必须要指定通道ID,(如果是快应用,必须带置顶的通道Id:OPPO PUSH推送) | 是 |
show_ttl | Int | 否 | 86400 | 限时展示时间(单位:秒)。 消息在通知栏展示后开始计时,展示时长超过展示事件后,消息会从通知栏中消失。 显示展示的时间范围在6小时到48小时之间,默认24小时。 | 是 |
notify_id | Int | 否 | 由OPPO PUSH生成 | 每条消息在通知显示时的唯一标识,主要用于新旧消息的覆盖。不设置本参数时,PUSH自动为给每条消息生成一个唯一标识; 当不同的消息设置为同一个notify_id,到达设备的新消息将覆盖旧消息展示在设备通知栏中。 | 是 |
auditResponse | JSON | 否 | null | 推必安信息审核api响应内容,详见《基于第三方审核结果的消息推送》 | 支持 |
编辑:yimen,如若转载,请注明出处:https://www.yimenapp.com/kb-yimen/11080/
部分内容来自网络投稿,如有侵权联系立删