热门标签 | HotTags
当前位置:  开发笔记 > 编程语言 > 正文

JPush相关概念

JPush相关概念连接极光服务器前提在连接极光服务器之前需要先将APP进行注册,连接Server时需要用到下发的两个字段:AppKey:应
JPush相关概念

连接极光服务器前提

在连接极光服务器之前需要先将APP进行注册,连接Server时需要用到下发的两个字段:
AppKey:应用唯一标识。
Master Secret:服务器秘钥,用于服务器端调用API请求时对发送内容做签名。客户端调用时传输这两个字段进行验证
HTTP Header(头)里加一个字段(Key/Value对): Authorization: Basic base64authstring 其中 base64authstring 的生成算法为:base64(appKey:masterSecret) 即,对 appKey 加上冒号,加上 masterSecret 拼装起来的字符串,再做 base64 转换。

消息形式

JPush提供四种消息形式:通知,自定义消息,富媒体和本地通知。通知
或者说 Push Notification,即指在手机的通知栏(状态栏)上会显示的一条通知信息。 通知主要用于提示用户的目的,应用于新闻内容、促销活动、产品信息、版本更新提醒、订单状态提醒等多种场景 自定义消息
自定义消息不是通知,所以不会被SDK展示到通知栏上。其内容完全由开发者自己定义。 自定义消息主要用于应用的内部业务逻辑。一条自定义消息推送过来,有可能没有任何界面显示。富媒体
JPush支持开发者发送图文并茂的通知,从而更好的传达信息,带来更丰富的用户互动。 JPush提供了5种模板,开发者可以通过填充模板的内容,发送landing page、弹窗、信息流形式的富媒体通知。 开发者还可以直接通过URL发送预先编辑好的页面。 富媒体当前支持Android平台,为更好的使用富媒体的功能,建议更新当前SDK版本至v2.1.8及以上。 暂时只能通过极光推送的控制台发送,不支持API形式。本地通知
本地通知API不依赖于网络,无网条件下依旧可以触发;本地通知的定时时间是自发送时算起的,不受中间关机等操作的影响。 本地通知与网络推送的通知是相互独立的,不受保留最近通知条数上限的限制。 本地通知适用于在特定时间发出的通知,如一些Todo和闹钟类的应用,在每周、每月固定时间提醒用户回到应用查看任务。

名词解释

设备标识 Registration ID
集成了 JPush SDK 的应用程序在第一次 App 启动后,成功注册到 JPush 服务器时,JPush 服务器会给客户端返回唯一的该设备的标识 – RegistrationID。JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。 有了这个标识,App 编程可以把这个 RegistrationID 保存到自己的应用服务器上,然后就可以根据 RegistrationID 来向设备推送消息或者通知。 RegistrationID在卸载重装后是否可变:http://blog.jiguang.cn/registrationid/

别名 alias
为安装了应用程序的用户,取个别名来标识。以后给该用户 Push 消息时,就可以用此别名来指定。每个用户只能指定一个别名。 同一个应用程序内,对不同的用户,建议取不同的别名。这样,尽可能根据别名来唯一确定用户。 系统不限定一个别名只能指定一个用户。如果一个别名被指定到了多个用户,当给指定这个别名发消息时,服务器端API会同时给这多个用户发送消息。 举例:在一个用户要登录的游戏中,可能设置别名为 userid。游戏运营时,发现该用户 3 天没有玩游戏了,则根据 userid 调用服务器端API发通知到客户端提醒用户。标签 tag
为安装了应用程序的用户,打上标签。其目的主要是方便开发者根据标签,来批量下发 Push 消息。 可为每个用户打多个标签。 举例: game, old_page, women用户分群
用户分群的筛选条件有:标签、地理位置、系统版本、注册时间、活跃用户和在线用户。 开发者可以通过在控制台(官网)设置好用户分群之后,在控制台推送时指定该分群的名称或使用API调用该分群的id发送。 比如,开发者可以设置这样的用户分群:位于北京、上海、广州和深圳,并且最近7天在线的用户。

推送对象

一个推送对象,以 JSON 格式表达,表示一条推送相关的所有信息。
关键字 选项 含义 platform 必填 推送平台设置 audience 必填 推送设备指定 notification 可选 通知内容体。是被推送到客户端的内容。与 message 一起二者必须有其一,可以二者并存 message 可选 消息内容体。是被推送到客户端的内容。与 notification 一起二者必须有其一,可以二者并存 sms_message 可选 短信渠道补充送达内容体 options 可选 推送参数 cid 可选 用于防止 api 调用端重试造成服务端的重复推送而定义的一个标识符。

示例与说明

关键字选项含义
platform必填推送平台设置
audience必填推送设备指定
notification可选通知内容体。是被推送到客户端的内容。与 message 一起二者必须有其一,可以二者并存
message可选消息内容体。是被推送到客户端的内容。与 notification 一起二者必须有其一,可以二者并存
sms_message可选短信渠道补充送达内容体
options可选推送参数
cid可选用于防止 api 调用端重试造成服务端的重复推送而定义的一个标识符。

{"cid": "8103a4c628a0b98974ec1949-711261d4-5f17-4d2f-a855-5e5a8909b26e","platform": "all","audience": {"tag": ["深圳","北京"]},"notification": {"android": {"alert": "Hi, JPush!","title": "Send to Android","builder_id": 1,"extras": {"newsid": 321}},"ios": {"alert": "Hi, JPush!","sound": "default","badge": "+1","extras": {"newsid": 321}}},"message": {"msg_content": "Hi,JPush","content_type": "text","title": "msg","extras": {"key": "value"}},"sms_message":{"content":"sms msg content","delay_time":3600},"options": {"time_to_live": 60,"apns_production": false,"apns_collapse_id":"jiguang_test_201706011100"}
}

View Code

platform

JPush 当前支持 Android, iOS, Windows Phone 三个平台的推送。其关键字分别为:"android", "ios", "winphone"。
推送到所有平台:
{ "platform" : "all" }
指定特定推送平台:
{ "platform" : ["android", "ios"] }

audience

推送设备对象,表示一条推送可以被推送到哪些设备列表。确认推送设备对象,JPush 提供了多种方式,比如:别名、标签、注册ID、分群、广播等。
all 如果要发广播(全部设备),则直接填写 “all”。

推送形式

单播(unicast) 向指定的设备发送消息,包括向单个devicetoken或者单个alias发消息。列播(listcast) 向指定的一批设备发送消息,包括向多个devicetoken或者多个alias发消息。广播(broadcast) 向安装该App的所有设备发送消息(对 app_key 下的所有用户推送消息。)

推送目标(即设备)

广播外的设备选择方式,有如下几种:

关键字类型含义说明备注
tagJSON Array标签OR数组。多个标签之间是 OR 的关系,即取并集。用标签来进行大规模的设备属性、用户属性分群。 一次推送最多 20 个。
  • 有效的 tag 组成:字母(区分大小写)、数字、下划线、汉字、特殊字符@!#$&*+=.|¥。
  • 限制:每一个 tag 的长度限制为 40 字节。(判断长度需采用UTF-8编码)
tag_andJSON Array标签AND数组。多个标签之间是 AND 关系,即取交集。注意与 tag 区分。一次推送最多 20 个。
tag_notJSON Array标签NOT数组。多个标签之间,先取多标签的并集,再对该结果取补集。一次推送最多 20 个。
aliasJSON Array别名数组。多个别名之间是 OR 关系,即取并集。用别名来标识一个用户。一个设备只能绑定一个别名,但多个设备可以绑定同一个别名。一次推送最多 1000 个。
  • 有效的 alias 组成:字母(区分大小写)、数字、下划线、汉字、特殊字符@!#$&*+=.|¥。
  • 限制:每一个 alias 的长度限制为 40 字节。(判断长度需采用UTF-8编码)
registration_idJSON Array注册ID数组。多个注册ID之间是 OR 关系,即取并集。设备标识。一次推送最多 1000 个。
segmentJSON Array用户分群ID在页面创建的用户分群的 ID。定义为数组,但目前限制一次只能推送一个。目前限制是一次只能推送一个。
abtestJSON ArrayA/B Test ID在页面创建的 A/B 测试的 ID。定义为数组,但目前限制是一次只能推送一个。目前限制一次只能推送一个。


示例

推送给全部(广播):

{"platform": "all","audience" : "all","notification" : {"alert" : "Hi, JPush!","android" : {}, "ios" : {"extras" : { "newsid" : 321}}}
}

推送给多个标签(只要在任何一个标签范围内都满足):在深圳、广州、或者北京

{"audience" : {"tag" : [ "深圳", "广州", "北京" ]}
}

推送给多个标签(需要同时在多个标签范围内):在深圳并且是“女”

{"audience" : {"tag_and" : [ "深圳", "女" ]}
}

推送给多个别名:

{"audience" : {"alias" : [ "4314", "892", "4531" ]}
}

推送给多个注册ID:

{"audience" : {"registration_id" : [ "4312kjklfds2", "8914afd2", "45fdsa31" ]}
}

可同时推送指定多类推送目标:在深圳或者广州,并且是 “女” “会员”

{"audience" : {"tag" : [ "深圳", "广州" ]"tag_and" : [ "女", "会员"]}
}

notification

推送实体内容对象=通知(notification)+消息(message)
notification对象:下属属性包含 4 种(alert+3个平台属性)
alert
通知的内容在各个平台上,都可能只有这一个最基本的属性 "alert"。
这个位置的 "alert" 属性(直接在 notification 对象下),是一个快捷定义,各平台的 alert 信息如果都一样,则可不定义。如果各平台有定义,则覆盖这里的定义。

{"notification" : {"alert" : "Hello, JPush!"}
}


上面定义的 notification 对象,将被推送到 "platform" 指定的多个平台,并且其通知 alert 信息都一样。

android Android 平台上的通知,JPush SDK 按照一定的通知栏样式展示。

关键字类型选项含义说明
alertstring必填通知内容这里指定了,则会覆盖上级统一指定的 alert 信息;内容可以为空字符串,则表示不展示到通知栏。
titlestring可选通知标题如果指定了,则通知里原来展示 App名称的地方,将展示成这个字段。
builder_idint可选通知栏样式IDAndroid SDK 可设置通知栏样式,这里根据样式 ID 来指定该使用哪套样式。
priorityint可选通知栏展示优先级默认为0,范围为 -2~2 ,其他值将会被忽略而采用默认。
categorystring可选通知栏条目过滤或排序完全依赖 rom 厂商对 category 的处理策略
styleint可选通知栏样式类型默认为0,还有1,2,3可选,用来指定选择哪种通知栏样式,其他值无效。有三种可选分别为bigText=1,Inbox=2,bigPicture=3。
alert_typeint可选通知提醒方式可选范围为 -1 ~ 7 ,对应 Notification.DEFAULT_ALL = -1 或者 Notification.DEFAULT_SOUND = 1, Notification.DEFAULT_VIBRATE = 2, Notification.DEFAULT_LIGHTS = 4 的任意 “or” 组合。默认按照 -1 处理。
big_textstring可选大文本通知栏样式当 style = 1 时可用,内容会被通知栏以大文本的形式展示出来。支持 api 16以上的rom。
inboxJSONObject可选文本条目通知栏样式当 style = 2 时可用, json 的每个 key 对应的 value 会被当作文本条目逐条展示。支持 api 16以上的rom。
big_pic_pathstring可选大图片通知栏样式当 style = 3 时可用,可以是网络图片 url,或本地图片的 path,目前支持.jpg和.png后缀的图片。图片内容会被通知栏以大图片的形式展示出来。如果是 http/https 的url,会自动下载;如果要指定开发者准备的本地图片就填sdcard 的相对路径。支持 api 16以上的rom。
extrasJSON Object可选扩展字段这里自定义 JSON 格式的 Key/Value 信息,以供业务使用。

{"notification" : {"android" : {"alert" : "hello, JPush!", "title" : "JPush test", "builder_id" : 3, "style":1 // 1,2,3"alert_type":1 // -1 ~ 7"big_text":"big text content","inbox":JSONObject,"big_pic_path":"picture url","priority":0, // -2~2"category":"category str","extras" : {"news_id" : 134, "my_key" : "a value"}}}
}

iOS iOS 平台上 APNs 通知结构。该通知内容会由 JPush 代理发往 Apple APNs 服务器,并在 iOS 设备上在系统通知的方式呈现。 该通知内容满足 APNs 的规范,支持的字段如下:

关键字类型选项含义说明
alertstring或JSON Object必填通知内容这里指定内容将会覆盖上级统一指定的 alert 信息;内容为空则不展示到通知栏。支持字符串形式也支持官方定义的alert payload 结构
soundstring可选通知提示声音如果无此字段,则此消息无声音提示;有此字段,如果找到了指定的声音就播放该声音,否则播放默认声音,如果此字段为空字符串,iOS 7 为默认声音,iOS 8及以上系统为无声音。(消息) 说明:JPush 官方 API Library (SDK) 会默认填充声音字段。提供另外的方法关闭声音。
badgeint可选应用角标如果不填,表示不改变角标数字;否则把角标数字改为指定的数字;为 0 表示清除。JPush 官方 API Library(SDK) 会默认填充badge值为"+1",详情参考:badge +1
content-availableboolean可选推送唤醒推送的时候携带"content-available":true 说明是 Background Remote Notification,如果不携带此字段则是普通的Remote Notification。详情参考:Background Remote Notification
mutable-contentboolean可选通知扩展推送的时候携带”mutable-content":true 说明是支持iOS10的UNNotificationServiceExtension,如果不携带此字段则是普通的Remote Notification。详情参考:UNNotificationServiceExtension
categorystring可选 IOS8才支持。设置APNs payload中的"category"字段值
extrasJSON Object可选附加字段这里自定义 Key/value 信息,以供业务使用。

iOS 通知 JPush 要转发给 APNs 服务器。APNs 协议定义通知长度为 2048 字节。

JPush 因为需要重新组包,并且考虑一点安全冗余,要求"iOS":{ } 及大括号内的总体长度不超过:2000 个字节。JPush 使用 utf-8 编码,所以一个汉字占用 3 个字节长度。

服务端发送消息串:

{"notification" : {"ios" : {"alert" : "hello, JPush!", "sound" : "sound.caf", "badge" : 1, "extras" : {"news_id" : 134, "my_key" : "a value"}}}
}

客户端收到apns:

{"_j_msgid" = 813843507;aps = {alert = "hello,JPush!";badge = 1;sound = "sound.caf";};"my_key" = "a value";"news_id" = 134;
}

winphone
Windows Phone 平台上的通知。该通知由 JPush 服务器代理向微软的 MPNs 服务器发送,并在 Windows Phone 客户端的系统通知栏上展示。

该通知满足 MPNs 的相关规范。当前 JPush 仅支持 toast 类型:

关键字类型选项含义说明
alertstring必填通知内容会填充到 toast 类型 text2 字段上。这里指定了,将会覆盖上级统一指定的 alert 信息;内容为空则不展示到通知栏。
titlestring可选通知标题会填充到 toast 类型 text1 字段上。
_open_pagestring可选点击打开的页面名称点击打开的页面。会填充到推送信息的 param 字段上,表示由哪个 App 页面打开该通知。可不填,则由默认的首页打开。
extrasJSON Object可选扩展字段作为参数附加到上述打开页面的后边。

{"notification" : {"winphone" : {"alert" : "hello, JPush!", "title" : "Push Test", "_open_page" : "/friends.xaml", "extras" : {"news_id" : 134, "my_key" : "a value"}}}}

message

message:自定义消息
应用内消息。或者称作:自定义消息,透传消息。 此部分内容不会展示到通知栏上,JPush SDK 收到消息内容后透传给 App。需要 App 自行处理。 iOS 平台上,此部分内容在推送应用内消息通道(非APNS)获取。Windows Phone 暂时不支持应用内消息。

sms_message

用于设置短信推送内容以及短信发送的延迟时间。手机接收号码,开发者需要先把用户的手机号码与设备的registration id匹配。

options

cid

cid 是用于防止 api 调用端重试造成服务端的重复推送而定义的一个推送参数。 用户使用一个 cid 推送后,再次使用相同的 cid 进行推送,则会直接返回第一次成功推送的结果,不会再次进行推送。 CID的有效期为1天。CID的格式为:{appkey}-{uuid} 在使用cid之前,必须通过接口获取你的 cid 池。获取时type=push或者不传递type值。


推荐阅读
  • Android Studio Bumblebee | 2021.1.1(大黄蜂版本使用介绍)
    本文介绍了Android Studio Bumblebee | 2021.1.1(大黄蜂版本)的使用方法和相关知识,包括Gradle的介绍、设备管理器的配置、无线调试、新版本问题等内容。同时还提供了更新版本的下载地址和启动页面截图。 ... [详细]
  • 如何搭建Java开发环境并开发WinCE项目
    本文介绍了如何搭建Java开发环境并开发WinCE项目,包括搭建开发环境的步骤和获取SDK的几种方式。同时还解答了一些关于WinCE开发的常见问题。通过阅读本文,您将了解如何使用Java进行嵌入式开发,并能够顺利开发WinCE应用程序。 ... [详细]
  • 快递100企业版物流快递接口使用流程
    varis_mobinavigator.userAgent.toLowerCase().match((ipod|iphone|android|coolpad|mmp|smartph ... [详细]
  • 我认为我的PHPintall可能有问题.当我尝试这样做时,我得到了Warning:mcrypt_decrypt()[function.mcrypt-decrypt]:Modulei ... [详细]
  • Python实现变声器功能(萝莉音御姐音)的方法及步骤
    本文介绍了使用Python实现变声器功能(萝莉音御姐音)的方法及步骤。首先登录百度AL开发平台,选择语音合成,创建应用并填写应用信息,获取Appid、API Key和Secret Key。然后安装pythonsdk,可以通过pip install baidu-aip或python setup.py install进行安装。最后,书写代码实现变声器功能,使用AipSpeech库进行语音合成,可以设置音量等参数。 ... [详细]
  • 本文介绍了Hyperledger Fabric外部链码构建与运行的相关知识,包括在Hyperledger Fabric 2.0版本之前链码构建和运行的困难性,外部构建模式的实现原理以及外部构建和运行API的使用方法。通过本文的介绍,读者可以了解到如何利用外部构建和运行的方式来实现链码的构建和运行,并且不再受限于特定的语言和部署环境。 ... [详细]
  • 本文介绍了Web学习历程记录中关于Tomcat的基本概念和配置。首先解释了Web静态Web资源和动态Web资源的概念,以及C/S架构和B/S架构的区别。然后介绍了常见的Web服务器,包括Weblogic、WebSphere和Tomcat。接着详细讲解了Tomcat的虚拟主机、web应用和虚拟路径映射的概念和配置过程。最后简要介绍了http协议的作用。本文内容详实,适合初学者了解Tomcat的基础知识。 ... [详细]
  • 利用Visual Basic开发SAP接口程序初探的方法与原理
    本文介绍了利用Visual Basic开发SAP接口程序的方法与原理,以及SAP R/3系统的特点和二次开发平台ABAP的使用。通过程序接口自动读取SAP R/3的数据表或视图,在外部进行处理和利用水晶报表等工具生成符合中国人习惯的报表样式。具体介绍了RFC调用的原理和模型,并强调本文主要不讨论SAP R/3函数的开发,而是针对使用SAP的公司的非ABAP开发人员提供了初步的接口程序开发指导。 ... [详细]
  • 在Xamarin XAML语言中如何在页面级别构建ControlTemplate控件模板
    本文介绍了在Xamarin XAML语言中如何在页面级别构建ControlTemplate控件模板的方法和步骤,包括将ResourceDictionary添加到页面中以及在ResourceDictionary中实现模板的构建。通过本文的阅读,读者可以了解到在Xamarin XAML语言中构建控件模板的具体操作步骤和语法形式。 ... [详细]
  • 本文介绍了Python爬虫技术基础篇面向对象高级编程(中)中的多重继承概念。通过继承,子类可以扩展父类的功能。文章以动物类层次的设计为例,讨论了按照不同分类方式设计类层次的复杂性和多重继承的优势。最后给出了哺乳动物和鸟类的设计示例,以及能跑、能飞、宠物类和非宠物类的增加对类数量的影响。 ... [详细]
  • Imtryingtofigureoutawaytogeneratetorrentfilesfromabucket,usingtheAWSSDKforGo.我正 ... [详细]
  • Android自定义控件绘图篇之Paint函数大汇总
    本文介绍了Android自定义控件绘图篇中的Paint函数大汇总,包括重置画笔、设置颜色、设置透明度、设置样式、设置宽度、设置抗锯齿等功能。通过学习这些函数,可以更好地掌握Paint的用法。 ... [详细]
  • ShiftLeft:将静态防护与运行时防护结合的持续性安全防护解决方案
    ShiftLeft公司是一家致力于将应用的静态防护和运行时防护与应用开发自动化工作流相结合以提升软件开发生命周期中的安全性的公司。传统的安全防护方式存在误报率高、人工成本高、耗时长等问题,而ShiftLeft提供的持续性安全防护解决方案能够解决这些问题。通过将下一代静态代码分析与应用开发自动化工作流中涉及的安全工具相结合,ShiftLeft帮助企业实现DevSecOps的安全部分,提供高效、准确的安全能力。 ... [详细]
  • Android图形架构学习笔记(待修改)
    以下简单总结来自Android官网,稍作总结:https:source.android.google.cndevicesgraphics概览Andr ... [详细]
  • 一、常用加密情况有三种:1.资源加密,如图片,音乐(防盗版)2.网络传输过程中的加密,避免被人拦 ... [详细]
author-avatar
王怡君3018
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有