实例化JPush对象
_jpush = jpush.JPush(app_key, master_secret)
参数说明
app_key https://www.jpush.cn/ 控制台获取
master_secret https://www.jpush.cn/ 控制台获取
返回值
JPush 实例
push = _jpush.create_push()
参数说明 （无）
返回值
push 实例
tag(*tags)
参数说明
tags 例如：tag("tag1", "tag2")
返回值
payload 字典
tag_and(*tag_ands)
参数说明
tags 例如：tag_and("tag1", "tag2")
返回值
payload 字典
tag_not(*tag_nots)
参数说明
tags 例如：tag_not("tag1", "tag2")
返回值
payload 字典
alias(*alias)
参数说明
alias 例如：alias("alias1", "alias2")
返回值
payload 字典
registration_id(*reg_ids)
参数说明
registration_id 例如：tag("registration_id1", "registration_id2")
返回值
payload 字典
推送设备对象，表示一条推送可以被推送到哪些设备列表。确认推送设备对象，JPush 提供了多种方式，比如：别名、标签、注册ID、分群、广播等。
- all
如果要发广播（全部设备），则直接填写 “all”。
- 推送目标
广播外的设备选择方式，有如下几种：
notification(alert=None, ios=None, android=None, winphone=None)
参数说明
- alert
通知的内容在各个平台上，都可能只有这一个最基本的属性 "alert"。 这个位置的 "alert" 属性（直接在 notification 对象下），是一个快捷定义，各平台的 alert 信息如果都一样，则可不定义。如果各平台有定义，则覆盖这里的定义。
- ios
ios payload 字典 查看 ios payload
- android
android payload 字典 查看 android payload
返回值
notification payload
ios(alert=None, badge='+1', sound=None， content_available=False, mutable_content=False, category=None, extras=None, sound_disable=False, thread_id=None):
参数说明
| 关键字 | 类型 | 选项 | 含义 | 说明 |
|---|---|---|---|---|
| alert | string | 必填 | 通知内容 | 这里指定内容将会覆盖上级统一指定的 alert 信息；内容为空则不展示到通知栏。支持字符串形式也支持官方定义的 alert payload 结构，在该结构中包含 title 和 subtitle 等官方支持的 key |
| sound | string | 可选 | 通知提示声音 | 普通通知： string类型，如果无此字段，则此消息无声音提示；有此字段，如果找到了指定的声音就播放该声音，否则播放默认声音，如果此字段为空字符串，iOS 7 为默认声音，iOS 8 及以上系统为无声音。说明：JPush 官方 SDK 会默认填充声音字段，提供另外的方法关闭声音，详情查看各 SDK 的源码。 告警通知： JSON Object ,支持官方定义的 payload 结构，在该结构中包含 critical 、name 和 volume 等官方支持的 key |
| badge | int | 可选 | 应用角标 | 如果不填，表示不改变角标数字；否则把角标数字改为指定的数字；为 0 表示清除。JPush 官方 API Library(SDK) 会默认填充badge值为"+1",详情参考：badge +1 |
| content-available | boolean | 可选 | 推送唤醒 | 推送的时候携带"content-available":true 说明是 Background Remote Notification，如果不携带此字段则是普通的Remote Notification。详情参考：Background Remote Notification |
| mutable-content | boolean | 可选 | 通知扩展 | 推送的时候携带 ”mutable-content":true 说明是支持iOS10的UNNotificationServiceExtension，如果不携带此字段则是普通的 Remote Notification。详情参考：UNNotificationServiceExtension |
| category | string | 可选 | IOS8才支持。设置APNs payload中的"category"字段值 | |
| thread-id | string | 可选 | 通知分组 | ios 的远程通知通过该属性来对通知进行分组，同一个 thread-id 的通知归为一组。 |
| extras | JSON Object | 可选 | 扩展字段 | 这里自定义 Key/value 信息，以供业务使用。 |
返回值
android payload 字典
android(alert, title=None, builder_id=None, extras=None, priority=None, category=None, style=None, alert_type=None, big_text=None, inbox=None, big_pic_path=None, large_icon=None, intent=None)
参数说明
| 关键字 | 类型 | 选项 | 含义 | 说明 |
|---|---|---|---|---|
| alert | string | 必填 | 通知内容 | 这里指定了，则会覆盖上级统一指定的 alert 信息；内容可以为空字符串，则表示不展示到通知栏。 |
| title | string | 可选 | 通知标题 | 如果指定了，则通知里原来展示 App名称的地方，将展示成这个字段。 |
| builder_id | int | 可选 | 通知栏样式ID | Android SDK 可设置通知栏样式，这里根据样式 ID 来指定该使用哪套样式。 |
| extras | JSON Object | 可选 | 扩展字段 | 这里自定义 JSON 格式的 Key/Value 信息，以供业务使用。 |
返回值
android payload 字典
message(msg_content, title=None, content_type=None, extras=None)
参数说明
| 关键字 | 类型 | 选项 | 含义 |
|---|---|---|---|
| msg_content | string | 必填 | 消息内容本身 |
| title | string | 可选 | 消息标题 |
| content_type | string | 可选 | 消息内容类型 |
| extras | JSON Object | 可选 | JSON 格式的可选参数 |
返回值
message payload
smsmessage(content,delay_time)
- 参数说明
| 关键字 | 类型 | 选项 | 示例 |
|---|---|---|---|
| content | string | 必填 | 不能超过480个字符。"你好,JPush"为8个字符。超过67个字符的内容（含签名）会被拆分成多条短信下发。 |
| delay_time | int | 必填 | 单位为秒，不能超过24小时。设置为0，表示立即发送短信。该参数仅对android平台有效，iOS 和 Winphone平台则会立即发送短信 |
- 返回值
smsmessage payload
platform(*types)
- 参数说明
JPush 当前支持 Android, iOS, Windows Phone 三个平台的推送。其关键字分别为："android", "ios","winphone"。
- 返回值
platform tuple
options(options)
- 参数说明
- 返回值
options 字典