此SDK已停止维护，请开发者对接 RestApi V2

推送模板说明

简述

开发者可设置推送展示效果，分为通知样式和后续操作。

推送效果：

• 通知消息：

通知展示时效果：响铃、震动、通知是否可清除，下拉大图、长文本。

通知点击后效果：打开应用首页、打开应用内指定页面、打开浏览器指定网页。

• 透传消息：

即自定义消息，效果由开发者自行管理，个推只负责消息传递，不做任何处理，默认不会在通知栏中展示，开发者需自行处理展示方式或后续动作。

设置步骤

STEP1：选择合适的推送模板，决定后续操作。

STEP2：（仅通知模板）添加模板中的style属性，设置通知样式。

STEP3：设置推送其他参数

STEP4：执行推送

示例说明

# STEP1：选择模板
template = NotificationTemplate()
# 设置APPID与APPKEY
template.appId = APPID
template.appKey = APPKEY


# STEP2：设置通知样式
style = Style0()
# 设置通知栏标题与内容
style.title = "请输入通知栏标题"
style.text = "请输入通知栏内容"
# 配置通知栏图标
style.logo = "icon.png"
# 配置通知栏网络图标
style.logoUrl = ""
# 设置通知是否响铃，震动，或者可清除
style.isRing = True
style.isVibrate = True
style.isClearable = True
style.channel = "通知渠道id"
style.channelName = "通知渠道名称"
style.channelLevel = 3  # 设置通知渠道重要性
template.style = style


# STEP3：设置推送其他参数
message = IGtSingleMessage()
message.data = template
# STEP4：执行推送
push.pushMessageToSingle(message, target)

【透传模板】自定义消息

描述

透传消息是指消息传递到客户端只有消息内容，展现形式由客户端自行定义。客户端可自定义通知的展现形式，也可自定义通知到达之后的动作，或者不做任何展现。

对应模板（TransmissionTemplate）

参数说明

代码示例

def transmissionTemplateDemo():
    template = TransmissionTemplate()
    template.appId = APPID
    template.appKey = APPKEY
    template.transmissionType = 2
    template.transmissionContent = "请输入需要透传的内容"
    return template

【通知模板】打开应用首页

描述

在通知栏显示一条通知，用户点击后打开应用的首页。

应用场景

针对沉默用户，发送推送消息，点击消息栏的通知可直接激活启动应用，提升应用的转化率。

对应模板（NotificationTemplate）

参数说明

代码示例

def notificationTemplateDemo():
    template = NotificationTemplate()
    template.appId = APPID
    template.appKey = APPKEY
    template.transmissionType = 1
    template.transmissionContent = "请输入您要透传的内容"

    style = new Style0();
    # 设置通知栏标题与内容
    style.title = "请输入通知栏标题"
    style.text = "请输入通知栏内容"
    # 配置通知栏图标
    style.logo = "icon.png"
    # 配置通知栏网络图标
    style.logoUrl = ""
    # 设置通知是否响铃，震动，或者可清除
    style.isRing = True
    style.isVibrate = True
    style.isClearable = True
    style.channel = "自定义channel"
    style.channelName = "自定义channelName"
    style.channelLevel = 3
    template.style = style

    # 设置定时展示时间，安卓机型可用
    # template.setDuration("2019-08-16 11:40:00", "2019-08-16 12:24:00")

    # 消息覆盖
    # template.notifyid = 123 # 在消息推送的时候设置自定义的notifyid。如果需要覆盖此条消息，则下次使用相同的notifyid发一条新的消息。客户端sdk会根据notifyid进行覆盖。
    return template

【通知模板】打开应用内页面

描述

在通知栏显示一条通知，用户点击后打开应用内指定的页面。

应用场景

推广促销活动，用户点击通知栏信息，直接打开到应用内指定的促销活动页面。

对应模板（StartActivityTemplate）

参数说明

代码示例

def startActivityTemplateDemo():
    template = StartActivityTemplate()
    template.appId = APPID
    template.appKey = APPKEY

    style = Style0()
    # 设置通知栏标题与内容
    style.title = "请输入通知栏标题"
    style.text = "请输入通知栏内容"
    # 配置通知栏图标
    style.logo = "icon.png"
    # 配置通知栏网络图标
    style.logoUrl = ""
    # 设置通知是否响铃，震动，或者可清除
    style.isRing = True
    style.isVibrate = True
    style.isClearable = True
    style.channel = "自定义channel"
    style.channelName = "自定义channelName"
    style.channelLevel = 3
    template.style = style

    intent = "intent://Intent;component=com.yourpackage/.NewsActivity;end"
    template.intent = intent #最大长度限制为1000
    # 设置定时展示时间，安卓机型可用
    # template.setDuration("2019-08-16 11:40:00", "2019-08-16 12:24:00")

    # 消息覆盖
    # template.notifyid = 123 # 在消息推送的时候设置自定义的notifyid。如果需要覆盖此条消息，则下次使用相同的notifyid发一条新的消息。客户端sdk会根据notifyid进行覆盖。
    return template;

【通知模板】打开浏览器网页

描述

在通知栏显示一条通知，用户点击可打开浏览器的指定网页。

应用场景

推广促销活动，用户点击通知栏信息，直接打开到指定的促销活动页面，推送直接到达指定页面，免去了中间过程的用户流失。

对应模板（LinkTemplate）

参数说明

代码示例

def linkTemplateDemo():
    template = LinkTemplate()
    template.appId = APPID
    template.appKey = APPKEY

    style = Style0()
    # 设置通知栏标题与内容
    style.title = "请输入通知栏标题"
    style.text = "请输入通知栏内容"
    # 配置通知栏图标
    style.logo = "icon.png"
    # 配置通知栏网络图标
    style.logoUrl = ""
    # 设置通知是否响铃，震动，或者可清除
    style.isRing = True
    style.isVibrate = True
    style.isClearable = True
    style.channel = "自定义channel"
    style.channelName = "自定义channelName"
    style.channelLevel = 3
    template.style = style

    # 设置打开的网址地址
    template.url = "http://www.getui.com"
    # 设置定时展示时间，安卓机型可用
    # template.setDuration("2019-08-16 11:40:00", "2019-08-16 12:24:00")

    # 消息覆盖
    # template.notifyid = 123 # 在消息推送的时候设置自定义的notifyid。如果需要覆盖此条消息，则下次使用相同的notifyid发一条新的消息。客户端sdk会根据notifyid进行覆盖。
    return template

【通知模板】通知消息撤回

描述

消息撤回是指对已经发送的个推通道消息进行撤回。客户端接收到消息撤回的指令，会将通知栏中展示的消息进行删除，不再展示。

sdk版本要求

客户端sdk：2.12.5.0以上

服务端os-sdk：python3 4.1.1.0以上

撤回使用限制

1. 支持任务类型：os-sdk撤回模板支持撤回单推、群推、toApp任务。
2. 支持模板：只支持撤回通知、不支持透传
3. Android只支持撤回个推通道下发的通知，通过手机厂商通道下发的通知不支持撤回
4. iOS撤回会将应用当前所有的通知都清空。

对应模板 （RevokeTemplate）

参数说明

代码示例

def RevokeTemplateDemo():
    template = RevokeTemplate()
    template.appId = APPID
    template.appKey = APPKEY
    # 指定需要撤回消息对应的taskId
    template.oldTaskId = TASKID
    # 当客户端没有找到对应的taskid，是否把对应appid下所有的通知都撤回
    template.force = False

    return template

【通知样式】iOS通知样式设置

iOS推送需要在代码中通过相应模板的setAPNInfo接口设置相应的APNs通知参数。
透传模板传输的数据最大为是3KB，APNs传输数据最大支持3KB。

对应方法

    template.setApnInfo(payload)

参数描述

setAPNInfo具体参数含义详见苹果APNs文档。

注：setAutoBadge、setAlertMsg、setSound(不设置无声)必须至少设置一项

参数说明

• 普通消息推送

• VoIP推送

代码示例

def TransmissionTemplateDemo():
    template = TransmissionTemplate()
    template.transmissionType = 2
    template.appId = APPID
    template.appKey = APPKEY
    template.transmissionContent = '这是个透传'

    # ios消息推送
    payload = APNPayload()
    payload.badge = 4
    # apnpayload.sound_str = "com.gexin.ios.silence"
    # ios 12.0 以上可以使用 Dictionary 类型的 sound
    payload.sound_d = Sound_Dictionary()
    payload.sound_d.name = "default"
    payload.sound_d.volume = 1.0
    payload.sound_d.critical = 1
    payload.addCustomMsg("由客户自定义消息key", "由客户自定义消息value")  # apnpayload.customMsg[key] = value
    payload.contentAvailable = 1
    payload.category = "$由客户端定义"
    # 设置语音播报类型，int类型，0.不可用 1.播放body 2.播放自定义文本
    payload.voicePlayType = 2
    # 设置语音播报内容，String类型，非必须参数，用户自定义播放内容，仅在voicePlayType = 2时生效
    # 注：当"定义类型"=2, "定义内容"为空时则忽略不播放
    payload.voicePlayMessage = "定义内容"
    # 添加多媒体资源
    multidia1 = MultiMedia()
    multidia1.resUrl = "资源文件地址"
    multidia1.setResType(MediaType.pic)
    multidia1.setOnlyWifi(True)
    payload.multiMedia = [multidia1]
    # APN简单推送
    # alertMsg = SimpleAlertMsg()
    # alertMsg.alertMsg = "hello"
    # APN高级推送（字典模式）
    alertMsg = DictionaryAlertMsg()
    alertMsg.body = "body"
    alertMsg.actionLocKey = "显示关闭和查看两个按钮的消息"
    alertMsg.locKey = "loc-key1"
    alertMsg.locArgs = ['loc-ary1']
    alertMsg.launchImage = "调用已经在应用程序中绑定的图形文件名"
    # IOS8.2以上版本支持
    alertMsg.title = '通知标题'
    alertMsg.titleLocArgs = ['自定义通知标题组']
    alertMsg.titleLocKey = '自定义通知标题'
    payload.alertMsg = alertMsg
    # 需要使用iOS语音传输，请使用VoIPPayload代替APNPayload
    # payload = VoIPPayload()
    # jo = dict()
    # jo['key1'] = "value1"
    # payload.setVoIPPayload(json.dumps(jo))
    template.setApnInfo(payload)

    return template

【通知样式】Android通知样式设置

对应接口

template.style = Style0()

接口说明

AbstractNotifyStyle是父类，Style0、Style6是其子类

• Style0：系统样式
• Style6-1：大图+文本样式
• Style6-2：长文本样式

参数说明

Style0 系统样式

Style6 展开式通知样式，BigStyle1/BigStyle2 两种方式选一种