推送模板

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

本章介绍了PYTHON2 API的推送模板实例，推送模板结合推送方式即可完成整套推送方案。

1. 点击通知打开应用模板

1.1 描述

在通知栏显示一条含图标、标题等的通知，用户点击后激活您的应用。（激活后，打开应用的首页，如果只要求点击通知唤起应用，不要求到哪个指定页面就可以用此功能。

1.2 应用场景

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

1.3 对应接口(Notification Template)

接口定义

在通知栏显示一条含图标、标题等的通知，用户点击后激活您的应用

参数说明

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

Style0系统样式

Style6展开式通知样式,setBigStyle1/setBigStyle2/setBigStyle3 三种方式选一种

1.4 NotificationTemplate实例

# 通知透传模板动作内容
def NotificationTemplateDemo():
    template = NotificationTemplate()
    template.appId = APPID
    template.appKey = APPKEY
    # begin = "2015-03-04 17:40:22"
    # end = "2015-03-04 17:47:24"
    # template.setDuration(begin, end)
    style0 = Style0()
    style0.title = "style0"
    style0.text = "style0"
    # style0.isClearable = False
    # style0.isRing = False
    # style0.isVibrate = False
    template.style = style0    
    return template

2. 点击通知打开网页模板

2.1 模板说明

2.2 模板参数说明

LinkTemplate代码实例

def LinkTemplateDemo():
    template = LinkTemplate()
    template.appId = APPID
    template.appKey = APPKEY
    # begin = "2015-03-04 17:40:22";
    # end = "2015-03-04 17:47:24";
    # template.setDuration(begin, end)
    #详细通知栏消息布局样式
    style0 = Style0()
    style0.title = "style0"
    style0.text = "style0"
    # style0.isClearable = False
    # style0.isRing = False
    # style0.isVibrate = False
    template.style = style0    
    return template

3. 点击通知栏弹框下载模板

3.1 模板说明

3.2 模板参数说明

3.3 NotyPopLoadTemplate代码实例

def NotyPopLoadTemplateDemo():
    template = NotyPopLoadTemplate()
    template.appId = APPID
    template.appKey = APPKEY
    style0 = Style0()
    style0.title = "style0"
    style0.text = "style0"
    style0.logo = "push.png"
    style0.logoUrl = "http://s1.hao123img.com/res/images/search_logo/image.png"
    style0.isClearable = True
    style0.isRing = True
    style0.isVibrate = True

    template.notyIcon = "icon.png"
    template.logoUrl = ""
    template.notyTitle = u"通知弹框下载功能标题"
    template.notyContent= u"通知弹框下载功能内容"
    template.isRing = True
    template.isVibrate = True
    template.isClearable = True
    template.popTitle = u"弹框标题"
    template.popContent = u"弹框内容"
    template.popImage = ""
    template.popButton1 = u"下载"
    template.popButton2 = u"取消"
    template.loadIcon = "file://icon.png"
    template.loadTitle = u"下载内容"
    template.loadUrl = "http://gdown.baidu.com/data/wisegame/c95836e06c224f51/weixinxinqing_5.apk"
    template.isAutoInstall = True
    template.isActive = False
    # begin = "2015-03-04 17:40:22";
    # end = "2015-03-04 17:47:24";
    # template.setDuration(begin, end)
    return template

4. 透传消息模板

4.1 模板说明

4.2 模板参数说明

4.3 TransmissionTemplate代码实例

def TransmissionTemplateDemo():
    template = TransmissionTemplate()
    template.transmissionType = 1
    template.appId = APPID
    template.appKey = APPKEY
    template.transmissionContent = '请填入透传内容'
    alertMsg = SimpleAlertMsg()
    alertMsg.alertMsg = ""
    apn = APNPayload();
    apn.alertMsg = alertMsg
    apn.badge = 2
    apn.sound = ""
    apn.addCustomMsg("payload", "payload")
    #apn.contentAvailable=1
    #apn.category="ACTIONABLE"
    # begin = "2015-03-04 17:40:22";
    # end = "2015-03-04 17:47:24";
    # template.setDuration(begin, end)
    #template.setApnInfo(apn)
    /*iOS 推送需要对该字段进行设置具体参数详见iOS模板说明(PYTHON)*/
    return template

4.4 iOS推送说明

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

4.4.1 对应接口

def setApnInfo(payload):

4.4.2 参数描述

setAPNInfo具体参数含义详见苹果APNs文档：
https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/PayloadKeyReference.html

4.4.3 参数说明

• VoIP推送

4.4.4 代码示例：

def TransmissionTemplateDemo():
    template = TransmissionTemplate()
    template.transmissionType = 1
    template.appId = APPID
    template.appKey = APPKEY
    template.transmissionContent = '请填入透传内容'
    template = TransmissionTemplate()
    #设置APNs信息
    apnpayload = APNPayload()
    apnpayload.badge = 4
    apnpayload.sound = "test1.wav"
    apnpayload.contentAvailable = 1
    apnpayload.category = "ACTIONABLE"
    apnpayload.addCustomMsg("payload", "payload")
    #设置语音播报类型，int类型，0.不可用 1.播放body 2.播放自定义文本
    apnpayload.voicePlayType = 2
    #设置语音播报内容，String类型，非必须参数，用户自定义播放内容，仅在voicePlayMessage=2时生效
    #注：当"定义类型"=2, "定义内容"为空时则忽略不播放
    apnpayload.voicePlayMessage = "支付宝到账一千万元整"

    #简单类型如下设置
    alertMsg = SimpleAlertMsg()
    alertMsg.alertMsg = "alertMsg";
    #字典类型如下设置
    #alertMsg = DictionaryAlertMsg()
    #alertMsg.body = 'body'
    #alertMsg.actionLocKey = 'actionLockey'
    #alertMsg.locKey = 'lockey'
    #alertMsg.locArgs=['loc-args']
    #alertMsg.launchImage = 'launchImage'
    # iOS8.2以上版本支持
    #alertMsg.title = 'Title'
    #alertMsg.titleLocArgs = ['TitleLocArg']
    #alertMsg.titleLocKey = 'TitleLocKey'

    #可以设置字典类型AlertMsg和简单类型AlertMsg其中之一
    apnpayload.alertMsg=alertMsg

    #需要使用IOS语音推送，请使用VoIPPayload代替APNPayload
    # voIPPayload = VoIPPayload()
    # voIPPayload.setVoIPPayload("啦啦啦啦啦啦")
    # template.setApnInfo(voIPPayload)
    template.setApnInfo(apnpayload)

    return template