推送模板

推送模板

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

1.1 模板说明

pushType 说明 描述值
Notification 点击通知启动应用 在通知栏显示一条含图标、标题等的通知,用户点击后激活您的应用

1.2 模板参数说明

结构体 成员 长度 必填 说明
NotificationTemplate t.appId 设定接收的应用
t.appKey 用于鉴定身份是否合法
t.duration_start 消息展示开始时间
t.duration_end 消息展示结束时间
title 40中/英字符 通知标题
text 600中/英字符 通知内容
logo 40中/英字符 通知的图标名称,包含后缀名(需要在客户端开发时嵌入),如“push.png”
logoUrl 100中/英字符 通知图标URL地址
isRing 收到通知是否响铃:GT_ON响铃,GT_OFF不响铃。默认响铃。
isVibrate 收到通知是否振动:GT_ON振动,GT_OFF不振动。默认振动。
isClearable 通知是否可清除:GT_ON可清除,GT_OFF不可清除。默认可清除。
transmissionType 4Byte 收到消息是否立即启动应用:1为立即启动,2则广播等待客户端自启动
transmissionContent 2048中/英字符 透传内容,不支持转义字符

1.3 NotificationTemplate代码实例

void NotificationTemplateDemo(NotificationTemplate* templ)
{
templ->t.appId = APPID;
templ->t.appKey = APPKEY;
//通知栏标题
templ->title = "请填写通知标题";
//通知栏内容
templ->text = "请填写通知内容";
//通知栏显示本地图片
templ->logo = "";
//通知栏显示网络图标
templ->logoUrl = "";
//应用启动类型,1:强制应用启动 2:等待应用启动
templ->transmissionType = 1;
//透传内容
templ->transmissionContent = "请填写透传内容";
//templ->t.duration_start="2015-07-10 18:00:00";
//templ->t.duration_end="2015-07-10 19:00:00";
//接收到消息是否响铃,GT_ON:响铃 GT_OFF:不响铃
templ->isRing = GT_ON;
//接收到消息是否震动,GT_ON:震动 GT_OFF:不震动
templ->isVibrate = GT_ON;
//接收到消息是否可清除,GT_ON:可清除 GT_OFF:不可清除
templ->isClearable = GT_ON;
}

int pushtest(){
NotificationTemplate tmpl = {0};
NotificationTemplateDemo(& tmpl);
}

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

2.1 模板说明

pushType 说明 描述值
Link 点击通知打开网页 在通知栏显示一条含图标、标题等的通知,用户点击后可打开您指定的网页

2.2 模板参数说明

结构体 成员 长度 必填 说明
LinkTemplate t.appId 设定接收的应用
t.appKey 用于鉴定身份是否合法
t.duration_start 消息展示开始时间
t.duration_end 消息展示结束时间
title 40中/英字符 通知标题
text 600中/英字符 通知内容
logo 40中/英字符 通知的图标名称,包含后缀名(需要在客户端开发时嵌入),如“push.png”
logoUrl 100中/英字符 通知图标URL地址
isRing 收到通知是否响铃:GT_ON响铃,GT_OFF不响铃。默认响铃。
isVibrate 收到通知是否振动:GT_ON振动,GT_OFF不振动。默认振动。
isClearable 通知是否可清除:GT_ON可清除,GT_OFF不可清除。默认可清除。

2.3 LinkTemplate代码实例

void LinkTemplateDemo(LinkTemplate* templ)
{
templ->t.appId = APPID;
templ->t.appKey = APPKEY;
//通知栏标题
templ->title = "请填写通知标题";
//通知栏内容
templ->text = "请填写通知内容";
//通知栏显示本地图片
templ->logo = "";
//通知栏显示网络图标,如无法读取,则显示本地默认图标,可为空
templ->logoUrl = "";
//打开的链接地址
templ->url="http://www.baidu.com";
//templ->t.duration_start="2015-07-10 18:00:00";
//templ->t.duration_end="2015-07-10 19:00:00";
//接收到消息是否响铃,GT_ON:响铃 GT_OFF:不响铃
templ->isRing = GT_ON;
//接收到消息是否震动,GT_ON:震动 GT_OFF:不震动
templ->isVibrate = GT_ON;
//接收到消息是否可清除,GT_ON:可清除 GT_OFF:不可清除
templ->isClearable = GT_ON;
}

int main(){
 LinkTemplate tmpl = {0};
 LinkTemplateDemo(& tmpl);
return 0;
}

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

3.1 模板说明

pushType 说明 描述
NotyPopLoad 通知栏弹框下载模板 在通知栏显示一条含图标、标题等的通知,用户点击后弹出框,用户可以选择直接下载应用或者取消下载应用。(iOS不支持使用该模板)

3.2 模板参数说明

结构体 成员 长度 必填 说明
NotyPopLoadTemplate t.appId 设定接收的应用
t.appKey 用于鉴定身份是否合法
t.duration_start 消息展示开始时间
t.duration_end 消息展示结束时间
notyIcon 40中/英字符 通知栏图标
logoUrl 100中/英字符 通知图标URL地址
notyTitle 40中/英字符 通知栏标题
notyContent 600中/英字符 通知栏内容
isCleared 通知栏是否可以清除(默认是) GT_ON可清除 GT_OFF不可清除
isBelled 是否响铃(默认是) GT_ON响铃 GT_OFF不响铃
isVibrational 是否震动(默认是) GT_ON震动 GT_OFF不震动
popTitle 40中/英字符 弹出框标题
popContent 600中/英字符 弹出框内容
popImage 200中/英字符 弹出框图标
popButton1 4中/英字符 弹出框左边按钮名称
popButton2 4中/英字符 弹出框右边按钮名称
loadIcon 40中/英字符 下载图标,如果是本地图标,需要添加file://前缀;如果是网络图标,则填写网络图标地址
loadTitle 40中/英字符 下载标题
loadUrl 200中/英字符 下载地址
isAutoInstall 是否自动安装(默认否)
isActived 安装完成后是否自动启动应用程序(默认否)
androidMark 40中/英字符 安卓标识
symbianMark 40中/英字符 塞班标识
iphoneMark 40中/英字符 苹果标识

NotyPopLoadTemplate代码实例

void NotyPopLoadTemplateDemo(NotyPopLoadTemplate* templ)
{
templ->t.appId = APPID;
templ->t.appKey = APPKEY;
//通知栏标题
templ->notyTitle = "请填写通知标题";
//通知栏内容
templ->notyContent = "请填写通知内容";
//通知栏显示本地图片
templ->notyIcon = "icon.png";
//通知栏显示网络图标
templ->logoUrl = "http://www-igexin.qiniudn.com/wp-content/uploads/2013/08/logo_getui1.png";
//弹框显示标题
templ->popTitle = "弹框标题";
//弹框显示内容
templ->popContent = "弹框内容";
//弹框显示图片
templ->popImage = "";
//弹框左边按钮显示文本
templ->popButton1 = "下载";
//弹框右边按钮显示文本
templ->popButton2 = "取消";
//通知栏显示下载标题
templ->loadTitle = "下载标题";
//通知栏显示下载图标,可为空
templ->loadIcon = "file://push.png";
//下载地址,不可为空
templ->loadUrl = "http://www.appchina.com/market/d/425201/cop.baidu_0/com.gexin.im.apk";
//应用安装完成后,是否自动启动
templ->isActived = true;
//下载应用完成后,是否弹出安装界面,true:弹出安装界面,false:手动点击弹出安装界面
templ->isAutoInstall = true;
//templ->t.duration_start="2015-07-10 18:00:00";
//templ->t.duration_end="2015-07-10 19:00:00";
//接收到消息是否响铃,GT_ON:响铃 GT_OFF:不响铃
templ->isBelled = GT_ON ;
//接收到消息是否震动,GT_ON:震动 GT_OFF:不震动
templ->isVibrationed = GT_ON;
//接收到消息是否可清除,GT_ON:可清除 GT_OFF:不可清除
templ->isCleared = GT_ON;
}

 int main(){
  NotyPopLoadTemplate tmpl = {0};
  NotyPopLoadTemplateDemo(& tmpl);
 return 0;
}

4. 透传消息模版

4.1 模板说明

pushType 说明 描述
Transmission 透传(payload) 数据经SDK传给您的客户端,由您写代码决定如何处理展现给用户

4.2 模板参数说明

结构体 成员 长度 必填 说明
TransmissionTemplate t.appId 设定接收的应用
t.appKey 用于鉴定身份是否合法
t.pushInfo iOS推送使用该字段
t.duration_start 消息展示开始时间
t.duration_end 消息展示结束时间
transmissionContent 2048中/英字符 透传内容,不支持转义字符
transmissionType 4byte 收到消息是否立即启动应用,1为立即启动,2则广播等待客户端自启动

4.3 TransmissionTemplate代码实例

void TransmissionTemplateDemo(TransmissionTemplate* templ)
{
templ->t.appId = APPID;
templ->t.appKey = APPKEY;
 //应用启动类型,1:强制应用启动 2:等待应用启动
templ->transmissionType = 1;
 //透传内容
templ->transmissionContent = "透传内容";
//templ->t.duration_start="2015-07-10 18:00:00";
//templ->t.duration_end="2015-07-10 19:00:00";
}

 int main(){
  TransmissionTemplate tmpl = {0};
  TransmissionTemplateDemo(& tmpl);
 return 0;
}

4.4 iOS推送说明

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

4.4.1 参数描述

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

4.4.2 参数说明

结构体 成员 说明
PushInfo badge 应用icon上显示的数字
contentAvailable 推送直接带有透传数据
sound 通知铃声文件名
category 在客户端通知栏触发特定的action和button显示
cmsg 增加自定义的数据
body 通知文本消息字符串
actionLocKey (用于多语言支持)指定执行按钮所使用的Localizable.strings
locKey (用于多语言支持)指定Localizable.strings文件中相应的key
locArgs 如果loc-key中使用的占位符,则在loc-args中指定各参数
launchImage 指定启动界面图片名
title 通知标题
titleLocArgs (用于多语言支持)对于标题指定执行按钮所使用的Localizable.strings,仅支持iOS8.2以上版本
titleLocArgs 对于标题, 如果loc-key中使用的占位符,则在loc-args中指定各参数,仅支持iOS8.2以上版本

4.4.3 代码实例:

void TransmissionTemplateDemo(TransmissionTemplate* templ)
{
templ->t.appId = APPID;
templ->t.appKey = APPKEY;
templ->transmissionType = 1; //应用启动类型,1:强制应用启动 2:等待应用启动
templ->transmissionContent = ""; //透传内容

//APN推送,加入pushinfo参数
templ->t.pushInfo.body = "body";
templ->t.pushInfo.actionLocKey = "actionLocKey";
templ->t.pushInfo.locKey = "locKey";
templ->t.pushInfo.launchImage = "launchImage";
templ->t.pushInfo.title = "title";
templ->t.pushInfo.titleLocKey = "titleLocKey";
templ->t.pushInfo.badge = 10;
templ->t.pushInfo.contentAvailable = 1;
templ->t.pushInfo.sound = "test1.wav";
ListInfo locargslist = {0};
locargslist.size = 1;
ListItem argitem = {0};
strcpy(argitem.item,"argitem");
locargslist.item = &argitem;
templ->t.pushInfo.locArgs = locargslist;
ListInfo titleargslist = {0};
titleargslist.size = 1;
ListItem titlelist = {0};
strcpy(titlelist.item,"titleargitem");
titleargslist.item = &titlelist;
templ->t.pushInfo.titleLocArgs = titleargslist;
}

int main(){
 TransmissionTemplate tmpl = {0};
 TransmissionTemplateDemo(& tmpl);
return 0;
}
通知
2017.12.18 iOS SDK 2.1.0.0

新增 SDK 离线状态返回。 优化 SDK 解决已知问题。

......
2017.08.17 Android SDK 2.11.1.0

增加 "绑定、解绑别名" 结果回调 修复 "设置标签" 在某些情况下失败问题 修复若干其他 bug【感谢快看小说的反馈及大力支持~】

......
2017.08.10 iOS SDK 2.0.0.0

新增支持一键解绑该别名下对应的所有用户。 优化 SDK 解决已知问题,以 Framework 形式提供 SDK 库。 扩展 SDK(GtExtensionSdk)新增资源释放接口,防止超时处理导致的问题。

......
2017.08.03 Android SDK 2.10.3.5

调整代码符合google审核规则 针对海外用户进行联网优化 bug修复

......
2017.07.13 PYTHON SDK 4.0.1.4

修改获取用户状态接口的返回值无法识别的问题

......

文档中心搜索