进阶功能说明

进阶功能说明

消息撤回

功能描述

消息撤回是指对已经发送消息进行撤回。客户端接收到消息撤回的指令,会将通知栏中展示的消息进行删除,不再展示。Android支持撤回指定消息,iOS则清空所有消息。

接口名称

详见消息撤回模板

限制说明

  • SDK要求

    客户端sdk:2.12.5.0以上
    服务端os-sdk:php 4.1.2.0以上

  • 支持任务类型:撤回模板支持撤回单推、群推、toApp任务。

  • 支持模板:仅支持通知模板。

消息覆盖

功能描述

实现消息覆盖,可以通过os-sdk重新发一条消息实现。需要被覆盖的消息已经增加了notifyId字段,用于实现下发消息的覆盖。新的消息使用相同的notifyId下发。
如果希望被覆盖的消息之前没有设置notifyid,后台会根据随机的taskid通过算法生成notifyid,则无法对已经下发的消息进行覆盖。

Android与iOS都支持覆盖指定消息。

接口名称

在支持的模板中设置

$template->set_notifyId($notifyId); //设定notifyId,覆盖使用的唯一id

限制说明

  • SDK要求

    客户端sdk:2.12.5.0以上
    服务端os-sdk:php 4.1.2.0以上

  • 支持的模板:仅支持通知模板。

  • 支持任务类型,os-sdk支持单推、toList、toApp。

短信补量

功能描述

针对推送,在消息有效时间内,对未收到推送消息的用户进行短信补发,既提升消息触达又节省成本。短信补发服务,补发对象仍是APP注册用户(账户未注销)。

个推推送消息下发时,对于在线用户,直接通过sdk通道下发,对于离线用户消息将存储在离线空间,等到用户设定的短信补发时间,将开始对已绑定pn的用户进行短信补发。 对于在补发前,经过个推通道成功下发消息的用户,将不再进行短信补发。

接口名称

在支持的模板中设置

$template->setSmsInfo($smsMessage);

限制说明

  • 进行短信补量推送前,必须在个推申请开通短信补量并报备短信模板。短信模板审核通过后,才能进行短信补量推送。短信模板报备审核的日期为1-2个工作日。

  • 事前要通过接口绑定cid和pn的关系,点击查看相关API

  • 支持的模板:通知模板和透传模板

  • 短信参数填错,将不会进行短信补量,但是通过个推的sdk推送的消息会正常下发

  • 短信补量的开始时间必须在个推通道的消息有效离线时间内,且不大于服务端限制值(目前设置是3天)。

请求参数

成员名或方法名 类型 是否必填 描述 示例值
setSmsTemplateId() String 推送的短信模板ID(短信模板说明) $smsMessage->setSmsTemplateId("xxxx");
setSmsContent() map 推送的短信模板中占位符的内容。 $smsContent = array(); $smsContent["name"] = "zhangsan"; $smsContent["money"] = "0000"; $smsMessage->smsContent($smsContent);
setOfflineSendtime() long 推送后多久进行短信补发(单位:ms) $smsMessage->setOfflineSendtime(100000L);
setIsApplink() boolean 推送的短信模板中是否选用APPLink进行推送。 $smsMessage->setIsApplink(true);
setUrl() String 推送的短信模板中的APPLink链接地址。 $smsMessage->setUrl("www.baidu.com");
setPayload() String 推送的短信模板中的APPLink自定义字段。 $smsMessage->setPayload("自定义");

返回值

参数 类型 是否必填 描述 示例值
result String 响应码 result=ok
contentId String 任务ID contentId=xxxxxxx
smsResult String 短信提交结果 smsResult=accept
smsResultMsg String 短信提交失败结果 smsResultMsg=模板不存在

结果示例

结果 示例 说明
短信补量提交成功 {result=ok, contentId=xxxxx, smsResult=accept} 消息推送成功,短信提交成功。
短信补量提交失败 {result=ok, smsResultMsg=模板不存在, contentId=xxxxxxx, smsResult=error} 消息推送成功,短信提交失败。

角标设置(仅支持iOS)

功能描述

用来设置未读消息条数,仅支持iOS。

根据cid设置角标

功能描述

通过cid和deviceToken通知个推服务器当前iOS设备的角标情况。
Badge即ios用户应用icon上显示的数字,该接口提供了三种设置badge的方式:

1.在原有badge上+N;

2.在原有badge上-N;

3.直接设置badge(数字,会覆盖原有的badge值)

接口名称

// 根据 DeviceToken 设置 Badge
function setBadgeForDeviceToken($badge,$appid,$deviceTokenList)

// 根据 clientid 设置 Badge
function setBadgeForCID($badge,$appid,$cidList)

请求参数

参数名 类型 必需 默认值 参数描述
$badge String 用户应用icon上显示的数字
$appid String 用户所属应用id
$cidList Array 目标用户clientid列表
$deviceTokenList Array iOS用户DeviceToken列表

返回参数

名称 类型 描述
result String 请求结果,其他返回结果详见错误返回值

返回示例

{
    "result":"Success"
}

厂商推送

个推支持多厂商推送,开通请联系邮箱:lieg@getui.com

开发者中心 SDK 下载

文档中心搜索