其他接口

其他接口

1. 别名接口

1.1 别名说明

个推使用clientid来标识每个独立的用户,但clientid不等于开发者应用上的用户名,如果希望将消息发给应用上指定用户名的用户,则需要将用户名指定一个用户别名。

为一个或者一批clientid用户定义一个用户别名,通过这个用户别名对一个或一批用户进行推送。目前一个别名最多允许绑定10个clientid。

别名规则说明:

  1. 有效的别名组成:字母(区分大小写)、数字、下划线、汉字
  2. 任务备注名长度限制为 40 字节。( UTF-8 )
  3. 一个别名最多允许绑定10个clientid。

1.2 对应接口

1.2.1 bindAlias-单个clientid绑定别名

一个clientid只能绑定一个别名,若已绑定过别名的clientid再次绑定新别名,则认为与前一个别名自动解绑,绑定新别名。

函数说明:

bindAlias(APPID,ALIAS,CID)

参数说明:
参数名 类型 必需 默认值 参数描述
APPID String 用户所属应用id
ALIAS String 用户别名
CID String 用户id
代码实例
<?php
//更新时间为2014年11月11日
//增加ClientId可自定义别名功能
header("Content-Type: text/html; charset=utf-8");

require_once(dirname(__FILE__) . '/' . 'IGt.Push.php');

//采用"PHP SDK 快速入门", "第二步 获取访问凭证 "中获得的应用配置
define('APPKEY','');
define('APPID','');
define('MASTERSECRET','');
define('CID','用户id');
define('ALIAS','请输入别名');
define('HOST','http://sdk.open.api.igexin.com/apiex.htm');

aliasBind();    //clientid与别名绑定

function aliasBind(){

    $igt = new IGeTui(HOST,APPKEY,MASTERSECRET);
    $rep = $igt->bindAlias(APPID,ALIAS,CID);
    var_dump($rep);
    echo("<br><br>");

}
?>

1.2.2 bindAliasBatch-多个clientid绑定别名

允许将多个clientid和一个别名绑定,如用户使用多终端,则可将多终端对应的clientid绑定为一个别名,目前一个别名最多支持绑定10个clientid。

函数说明:
 bindAliasBatch(APPID,$targetList)
参数说明:
参数名 类型 必需 默认值 参数描述
APPID String 用户所属应用id
targetList Array cid列表
代码实例
<?php
//更新时间为2014年11月11日
//增加ClientId可自定义别名功能
header("Content-Type: text/html; charset=utf-8");

require_once(dirname(__FILE__) . '/' . 'IGt.Push.php');

//采用"PHP SDK 快速入门", "第二步 获取访问凭证 "中获得的应用配置
define('APPKEY','');
define('APPID','');
define('MASTERSECRET','');
define('CID','用户id');
define('ALIAS','请输入别名');
define('HOST','http://sdk.open.api.igexin.com/apiex.htm');
//define('CID2','请输入clientid');

aliasBatch();    //多个clientid,使用同一别名绑定

function aliasBatch(){

        $igt = new IGeTui(HOST,APPKEY,MASTERSECRET);

        $target = new IGtTarget();
        $target->set_clientId(CID);
        $target->set_alias(ALIAS);
        $targetList[] = $target;

//        $target1 = new IGtTarget();
//        $target1->set_clientId(CID2);
//        $target1->set_alias(ALIAS);
//        $targetList[] = $target1;

        $rep = $igt->bindAliasBatch(APPID,$targetList);
        var_dump($rep);
        echo("<br><br>");
}
// 注:只要有一个cid绑定成功,返回结果就为true
?>

1.2.3 queryClientId-根据别名获取clientid信息

函数说明:
queryClientId(APPID,ALIAS)
参数说明:
参数名 类型 必需 默认值 参数描述
APPID String 用户所属应用id
ALIAS String 用户别名
代码实例
<?php
//更新时间为2014年11月11日
//增加ClientId可自定义别名功能
header("Content-Type: text/html; charset=utf-8");

require_once(dirname(__FILE__) . '/' . 'IGt.Push.php');

//采用"PHP SDK 快速入门", "第二步 获取访问凭证 "中获得的应用配置
define('APPKEY','');
define('APPID','');
define('MASTERSECRET','');
define('CID','用户id');
define('ALIAS','请输入别名');
define('HOST','http://sdk.open.api.igexin.com/apiex.htm');
//define('CID2','请输入clientid');

queryCID();    //根据别名查询ClientId

function queryCID(){
    $igt = new IGeTui(HOST,APPKEY,MASTERSECRET);
        $rep = $igt->queryClientId(APPID,ALIAS);
        var_dump($rep);
        echo("<br><br>");
}
?>

1.2.4 queryAlias-通过clientid获取别名信息

函数说明:
queryAlias(APPID,CID)
参数说明:
参数名 类型 必需 默认值 参数描述
APPID String 用户所属应用id
CID String 用户id
代码实例
<?php
//更新时间为2014年11月11日
//增加ClientId可自定义别名功能
header("Content-Type: text/html; charset=utf-8");

require_once(dirname(__FILE__) . '/' . 'IGt.Push.php');

//采用"PHP SDK 快速入门", "第二步 获取访问凭证 "中获得的应用配置
define('APPKEY','');
define('APPID','');
define('MASTERSECRET','');
define('CID','用户id');
define('ALIAS','请输入别名');
define('HOST','http://sdk.open.api.igexin.com/apiex.htm');
//define('CID2','请输入clientid');

queryAlias();    //根据CID查询别名

function queryAlias(){
    $igt = new IGeTui(HOST,APPKEY,MASTERSECRET);
        $rep = $igt->queryAlias(APPID,CID);
        var_dump($rep);
        echo("<br><br>");
}
?>

1.2.5 unBindAlias-单个clientid和别名解绑

函数说明:
 unBindAlias(APPID,ALIAS,CID)
参数说明:
参数名 类型 必需 默认值 参数描述
APPID String 用户所属应用id
ALIAS String 用户别名
CID String 用户id(clientid)
代码实例
<?php
//更新时间为2014年11月11日
//增加ClientId可自定义别名功能
header("Content-Type: text/html; charset=utf-8");

require_once(dirname(__FILE__) . '/' . 'IGt.Push.php');

//采用"PHP SDK 快速入门", "第二步 获取访问凭证 "中获得的应用配置
define('APPKEY','');
define('APPID','');
define('MASTERSECRET','');
define('CID','用户id');
define('ALIAS','请输入别名');
define('HOST','http://sdk.open.api.igexin.com/apiex.htm');
//define('CID2','请输入clientid');

aliasUnBind();    //解除ClientId别名绑定

function aliasUnBind(){
    $igt = new IGeTui(HOST,APPKEY,MASTERSECRET);
        $rep = $igt->unBindAlias(APPID,ALIAS,CID);
        var_dump($rep);
        echo("<br><br>");
}
?>

1.2.6 unBindAliasAll-绑定别名的所有clientid解绑

函数说明:
 unBindAliasAll(APPID,ALIAS);
参数说明
参数名 类型 必需 默认值 参数描述
APPID String 用户所属应用id
ALIAS String 用户别名
代码实例:
<?php
//更新时间为2014年11月11日
//增加ClientId可自定义别名功能
header("Content-Type: text/html; charset=utf-8");

require_once(dirname(__FILE__) . '/' . 'IGt.Push.php');

//采用"PHP SDK 快速入门", "第二步 获取访问凭证 "中获得的应用配置
define('APPKEY','');
define('APPID','');
define('MASTERSECRET','');
define('CID','用户id');
define('ALIAS','请输入别名');
define('HOST','http://sdk.open.api.igexin.com/apiex.htm');
//define('CID2','请输入clientid');

aliasUnBindAll();    //解除所有ClientId别名绑定

function aliasUnBindAll(){
        $igt = new IGeTui(HOST,APPKEY,MASTERSECRET);
        $rep = $igt->unBindAliasAll(APPID,ALIAS);
        var_dump($rep);
        echo("<br><br>");
}
?>

2. 标签

2.1 描述

tag即为用户标签,个推提供了服务端和客户端接口,允许app针对每个clientid设置标签。用户的喜好、习惯、性别、年龄段等信息,这些信息均可以做为用户分组的标签。

通过标签(tag)方式实现用户分组,将消息发给指定标签用户,更进一步筛选了用户,实现精细化运营。

2.2 应用场景

场景1:一个用户经常看电影,给该用户打一个“movie”标签,当有最新电影更新了,可给tag为movie的这一群用户推送消息。

场景2:音频播放器应用。对不同音乐类型喜好的人群推送不同类别的新音乐通知。

2.3 对应接口

2.3.1 setClientTag-对指定用户设置tag属性

函数说明
setClientTag(APPID,CID,$tagList)
参数说明
参数名 类型 必需 默认值 参数描述
APPID String 用户所属应用id
CID String 目标用户id(clientid)
$tagList Array 用户tag列表

注:此接口有频次控制,tag的长度、个数、总长度也有限制,申请修改请联系邮箱:kegf@getui.com

代码实例
<?php
//更新时间为2014年11月11日
//增加ClientId可自定义别名功能
header("Content-Type: text/html; charset=utf-8");

require_once(dirname(__FILE__) . '/' . 'IGt.Push.php');

//采用"PHP SDK 快速入门", "第二步 获取访问凭证 "中获得的应用配置
define('APPKEY','');
define('APPID','');
define('MASTERSECRET','');
define('CID','用户id');
define('HOST','http://sdk.open.api.igexin.com/apiex.htm');


setTag();    //通过服务端设置ClientId的标签

function setTag(){
    $igt = new IGeTui(HOST,APPKEY,MASTERSECRET);
    $tagList = array('','中文','English');
    $rep = $igt->setClientTag(APPID,CID,$tagList);
    var_dump($rep);
    echo ("<br><br>");
}
?>

2.3.2 getUserTags-获取指定用户的tag属性

函数说明
getUserTags(appId, cid)
参数说明
参数名 类型 必需 默认值 参数描述
appId String 用户所属应用id
cid String 目标用户id(clientid)
代码实例
<?php
//更新时间为2014年11月11日
//增加ClientId可自定义别名功能
header("Content-Type: text/html; charset=utf-8");

require_once(dirname(__FILE__) . '/' . 'IGt.Push.php');

//采用"PHP SDK 快速入门", "第二步 获取访问凭证 "中获得的应用配置
define('APPKEY','');
define('APPID','');
define('MASTERSECRET','');
define('CID','用户id');
define('HOST','http://sdk.open.api.igexin.com/apiex.htm');


getUserTags();    //获取用户标签

function getUserTags() {
    $igt = new IGeTui(HOST,APPKEY,MASTERSECRET);
    $rep = $igt->getUserTags(APPID,CID);
    //$rep.connect();
    var_dump($rep);
    echo ("<br><br>");
}
?>

3. 停止任务接口

3.1 接口名称

stop(taskId)

3.2 参数描述

参数名 类型 必需 默认值 参数描述
taskId String 任务id

3.3 stop代码实例

<?php
//更新时间为2014年11月11日
//增加ClientId可自定义别名功能
header("Content-Type: text/html; charset=utf-8");

require_once(dirname(__FILE__) . '/' . 'IGt.Push.php');

//采用"PHP SDK 快速入门", "第二步 获取访问凭证 "中获得的应用配置
define('APPKEY','');
define('APPID','');
define('MASTERSECRET','');
define('CID','用户id');
define('HOST','http://sdk.open.api.igexin.com/apiex.htm');

stoptask();    //停止任务

function stoptask(){
    $igt = new IGeTui(HOST,APPKEY,MASTERSECRET);
    $rep = $igt->stop("OSA-0225_d5GB1otdWLAsTb3gckDXY7");
    var_dump($rep);
}
?>

4. 查询用户状态

4.1 接口名称

getClientIdStatus(APPID,CID)

4.2 参数描述

参数 类型 说明
APPID String 设置推送的appid
CLIENTID String 用户唯一标识符

4.3 getClientIdStatus代码实例

<?php
//更新时间为2014年11月11日
//增加ClientId可自定义别名功能
header("Content-Type: text/html; charset=utf-8");

require_once(dirname(__FILE__) . '/' . 'IGt.Push.php');

//采用"PHP SDK 快速入门", "第二步 获取访问凭证 "中获得的应用配置
define('APPKEY','');
define('APPID','');
define('MASTERSECRET','');
define('CID','用户id');
define('HOST','http://sdk.open.api.igexin.com/apiex.htm');

getUserStatus();    //获取用户状态

function getUserStatus() {
    $igt = new IGeTui(HOST,APPKEY,MASTERSECRET);
    $rep = $igt->getClientIdStatus(APPID,CID);
    var_dump($rep);
    echo ("");
}
?>

5. Badge设置

5.1 描述

Badge即ios用户应用icon上显示的数字,该接口提供了三种设置badge的方式:

1.在原有badge上+N;

2.在原有badge上-N;

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

5.2 接口函数说明

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

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

5.3 参数说明

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

5.4 代码实例-根据 deviceToken 设置 Badge

<?php
//更新时间为2014年11月11日
//增加ClientId可自定义别名功能
header("Content-Type: text/html; charset=utf-8");

require_once(dirname(__FILE__) . '/' . 'IGt.Push.php');

//采用"PHP SDK 快速入门", "第二步 获取访问凭证 "中获得的应用配置
define('APPKEY','');
define('APPID','');
define('MASTERSECRET','');
define('CID1','用户id1');
define('CID2','用户id2');
define('ALIAS','请输入别名');
define('HOST','http://sdk.open.api.igexin.com/apiex.htm');
//"+1"即在原有badge上加1,"-1"即在原有badge上减1,直接设置badge数值,会覆盖原有数值
define('Badge','+1');

setBadgeForDeviceTokenDemo();

function setBadgeForDeviceTokenDemo(){
    $igt = new IGeTui(HOST,APPKEY,MASTERSECRET);
    $cidList=array("CID1","CID2");
    $ret = $igt->setBadgeForDeviceToken(Badge,APPID,$cidList);
    var_dump($ret);
}
?>

5.6 代码实例-根据 clientid 设置 Badge

<?php
//增加ClientId可自定义别名功能
header("Content-Type: text/html; charset=utf-8");

require_once(dirname(__FILE__) . '/' . 'IGt.Push.php');

//采用"PHP SDK 快速入门", "第二步 获取访问凭证 "中获得的应用配置
define('APPKEY','');
define('APPID','');
define('MASTERSECRET','');
define('CID1','用户id1');
define('CID2','用户id2');
define('ALIAS','请输入别名');
define('HOST','http://sdk.open.api.igexin.com/apiex.htm');
//"+1"即在原有badge上加1,"-1"即在原有badge上减1,直接设置badge数值,会覆盖原有数值
define('Badge','+1');

setBadgeForCIDDemo();

function setBadgeForCIDDemo(){
    $igt = new IGeTui(HOST,APPKEY,MASTERSECRET);
    $cidList=array("CID1","CID2");
    $ret = $igt->setBadgeForCID(Badge,APPID,$cidList);
    var_dump($ret);
}
?>

6. 黑名单用户管理

6.1 描述

将指定cid列表中的用户加入/移除黑名单

6.2 接口函数说明

// 添加黑名单用户
function  addCidListToBlk($appId,$cidList)
// 移除黑名单用户
function  restoreCidListFromBlk($appId,$cidList)

6.3 参数说明

参数名 类型 必需 默认值 参数描述
appId String appId
cidList Array 该appId下的用户cid列表

6.4 代码实例-添加用户到黑名单

<?php
header("Content-Type: text/html; charset=utf-8");

require_once(dirname(__FILE__) . '/' . 'IGt.Push.php');

//采用"PHP SDK 快速入门", "第二步 获取访问凭证 "中获得的应用配置
define('APPKEY','');
define('APPID','');
define('MASTERSECRET','');
define('CID1','用户id1');
define('CID2','用户id2');
define('ALIAS','请输入别名');
define('HOST','http://sdk.open.api.igexin.com/apiex.htm');

addCidListToBlkDemo();

function addCidListToBlkDemo(){
    $igt = new IGeTui(HOST,APPKEY,MASTERSECRET);
    $cidList=array("CID1","CID2");
    $ret = $igt->addCidListToBlk(APPID,$cidList);
    var_dump($ret);
}
?>

6.6 代码实例-将用户从黑名单移除

<?php
header("Content-Type: text/html; charset=utf-8");

require_once(dirname(__FILE__) . '/' . 'IGt.Push.php');

//采用"PHP SDK 快速入门", "第二步 获取访问凭证 "中获得的应用配置
define('APPKEY','');
define('APPID','');
define('MASTERSECRET','');
define('CID1','用户id1');
define('CID2','用户id2');
define('ALIAS','请输入别名');
define('HOST','http://sdk.open.api.igexin.com/apiex.htm');

restoreCidListFromBlkDemo();

function restoreCidListFromBlkDemo(){
    $igt = new IGeTui(HOST,APPKEY,MASTERSECRET);
    $cidList=array("CID1","CID12");
    $ret = $igt->restoreCidListFromBlk(APPID,$cidList);
    var_dump($ret);
}
?>

7. 获取推送结果

7.1 接口名称

getPushResult(taskId)

7.2 参数说明

参数 类型 参数说明
taskId String 任务唯一识别号(格式OSL-yyMM_XXXXXX)

7.3 返回值

回执 参数说明
“{“taskId”:”OSA-0820_uQ7gevLuGS7Odz8FS2ZSB9”,”result”:”ok”,”msgTotal”:59,”msgProcess”:0}”
taskID:任务ID
msgTotal:表示有效可下发总数
result:OK执行成功
result:sign_error 表示校验失败
msgProcess:收到消息回执总数

7.4 getPushResult代码实例

<?php

header("Content-Type: text/html; charset=utf-8");

require_once(dirname(__FILE__) . '/' . 'IGt.Push.php');

//http的域名
define('HOST','http://sdk.open.api.igexin.com/apiex.htm');

//https的域名
//define('HOST','https://api.getui.com/apiex.htm');

//采用"PHP SDK 快速入门", "第二步 获取访问凭证 "中获得的应用配置          
define('APPKEY','');
define('APPID','');
define('MASTERSECRET','');
define('CID','用户id');



getPushMessageResultDemo();

function getPushMessageResultDemo(){


//    putenv("gexin_default_domainurl=http://183.129.161.174:8006/apiex.htm");

    $igt = new IGeTui(HOST,APPKEY,MASTERSECRET);

    $ret = $igt->getPushResult("OSA-0522_QZ7nHpBlxF6vrxGaLb1FA3");
    var_dump($ret);

}

?>

8. 获取单日用户数据

8.1 接口描述

调用此接口可以获取某个应用单日的用户数据(用户数据包括:新增用户数,累计注册用户总数,在线峰值,日联网用户数)(目前只支持查询1天前的数据)

8.2 接口名称:

queryAppUserDataByDate(APPID , DATE)

8.3 接口参数:

字段 类型 说明
APPID String 应用ID
DATE String 查询的日期(格式:yyyyMMdd)

8.4 返回值:

字段 上级 含义
result - 成功:ok
data - 查询数据对象
appId data 请求的AppId
date data 查询的日期(格式:yyyyMMdd)
newRegistCount data 新注册用户数
registTotalCount data 新注册用户数
activeCount data 活跃用户数
onlineCount data 在线用户数

8.5 queryAppUserDataByDate代码示例:

<?php

header("Content-Type: text/html; charset=utf-8");

require_once(dirname(__FILE__) . '/' . 'IGt.Push.php');

//http的域名
define('HOST','http://sdk.open.api.igexin.com/apiex.htm');

//https的域名
//define('HOST','https://api.getui.com/apiex.htm');

//采用"PHP SDK 快速入门", "第二步 获取访问凭证 "中获得的应用配置             
define('APPKEY','');
define('APPID','');
define('MASTERSECRET','');


getPushMessageResultDemo();

function getPushMessageResultDemo(){


//    putenv("gexin_default_domainurl=http://183.129.161.174:8006/apiex.htm");

        $igt = new IGeTui(HOST,APPKEY,MASTERSECRET);

       $ret = $igt->queryAppUserDataByDate(APPID,"20140807");
        var_dump($ret);

}

?>

9. 获取单日推送数据

9.1 描述

调用此接口可以获取某个应用单日的推送数据(推送数据包括:发送总数,在线发送数,接收数,展示数,点击数)(目前只支持查询1天前的数据)

9.2 接口名称:

queryAppPushDataByDate(APPID,DATE)

9.3 接口参数:

字段 类型 说明
APPID String 应用ID
DATE String 查询的日期(格式:yyyyMMdd)

9.4 返回值:

字段 上级 含义
result - 成功:ok
data - 查询数据对象
appId data 请求的AppId
date data 查询的日期(格式:yyyyMMdd)
sendCount data 发送总数
sendOnlineCount data 在线发送数
receiveCount data 接收数
showCount data 展示数
clickCount data 点击数

9.5 queryAppPushDataByDate代码示例:

<?php

header("Content-Type: text/html; charset=utf-8");

require_once(dirname(__FILE__) . '/' . 'IGt.Push.php');

//http的域名
define('HOST','http://sdk.open.api.igexin.com/apiex.htm');

//https的域名
//define('HOST','https://api.getui.com/apiex.htm');

//采用"PHP SDK 快速入门", "第二步 获取访问凭证 "中获得的应用配置             
define('APPKEY','');
define('APPID','');
define('MASTERSECRET','');


getPushMessageResultDemo();

function getPushMessageResultDemo(){


//    putenv("gexin_default_domainurl=http://183.129.161.174:8006/apiex.htm");

        $igt = new IGeTui(HOST,APPKEY,MASTERSECRET);

      $ret = $igt->queryAppPushDataByDate(APPID,"20140807");
    var_dump($ret);

}

?>

10. 获取24小时在线用户数

10.1 描述

通过接口查询当前时间一天内的在线数(十分钟一个点,一小时六个点)

10.2 接口

10.3 函数说明

function getLast24HoursOnlineUserStatistics($appId)

10.4 参数说明

参数名 类型 必需 默认值 参数描述
appId String appId

10.5返回值

IQueryResult具体返回值详情查询,请点击IpushResult接口返回值

字段 取值 说明
appId String 用户appId
onlineStatics Array 24小时用户在线数统计

10.6 代码实例

<?php
header("Content-Type: text/html; charset=utf-8");

require_once(dirname(__FILE__) . '/' . 'IGt.Push.php');
//采用"PHP SDK 快速入门", "第二步 获取访问凭证 "中获得的应用配置
define('APPKEY','');
define('APPID','');
define('MASTERSECRET','');
define('CID','用户id1');
define('ALIAS','请输入别名');
define('HOST','http://sdk.open.api.igexin.com/apiex.htm');

getLast24HoursOnlineUserStatisticsDemo();

function getLast24HoursOnlineUserStatisticsDemo(){
    $igt = new IGeTui(HOST,APPKEY,MASTERSECRET);
    $ret = $igt->getLast24HoursOnlineUserStatistics(APPID);
    var_dump($ret);
}
?>

11. 通过标签获取用户总数

11.1 描述

调用此接口可以获取该标签下的用户总数

11.2 接口名称:

getUserCountByTags(APPID, $tagList)

11.3 接口参数:

字段 类型 说明
APPID String 应用ID
$tagList Array 标签列表

11.4 getUserCountByTags代码示例:

<?php

header("Content-Type: text/html; charset=utf-8");

require_once(dirname(__FILE__) . '/' . 'IGt.Push.php');

//http的域名
define('HOST','http://sdk.open.api.igexin.com/apiex.htm');

//https的域名
//define('HOST','https://api.getui.com/apiex.htm');

//采用"PHP SDK 快速入门", "第二步 获取访问凭证 "中获得的应用配置         
define('APPKEY','');
define('APPID','');
define('MASTERSECRET','');


getUserCountByTagsDemo();

function getUserCountByTagsDemo() {
    $igt = new IGeTui(HOST, APPKEY, MASTERSECRET);
    $tagList = array("金在中","龙卷风");
    $ret = $igt->getUserCountByTags(APPID, $tagList);
    var_dump($ret);
}

?>

12. 查询符合条件的用户数

12.1 描述

通过接口查询符合当前查询条件的用户数

12.2 函数说明

function queryUserCount($appId, $appConditions)

12.3 参数说明

参数名 类型 必需 默认值 参数描述
appId String appId
conditions AppConditions conditions

12.5 代码实例

<?php

header("Content-Type: text/html; charset=utf-8");

require_once(dirname(__FILE__) . '/' . 'IGt.Push.php');
//http的域名
define('HOST','http://sdk.open.api.igexin.com/apiex.htm');

//https的域名
//define('HOST','https://api.getui.com/apiex.htm');

//采用"PHP SDK 快速入门", "第二步 获取访问凭证 "中获得的应用配置
define('APPKEY','');
define('APPID','');
define('MASTERSECRET','');
queryUserCountDemo();
function queryUserCountDemo(){
    $igt = new IGeTui(HOST,APPKEY,MASTERSECRET);
    $cdt = new AppConditions();
    $phoneTypeList=array('ANDROID');
    $provinceList=array('浙江');
    $tagList=array('haha');
    //新增机型
    $cdt->addCondition(AppConditions::PHONE_TYPE, $phoneTypeList);
    //新增地区
    $cdt->addCondition(AppConditions::REGION, $provinceList);
    //新增tag
    $cdt->addCondition(AppConditions::TAG, $tagList);
    //新增age
    //查询可推送的用户画像
    $rep = $igt->getPersonaTags(APPID);
    var_dump($rep);

    //新增用户画像
    //工作
    $jobs = array("0102","0110");
    $cdt->addCondition("jobs",$jobs);

    $age = array("0000");
    $cdt->addCondition("age",$age);

    $result = $igt->queryUserCount(APPID,$cdt);
    var_dump($result);

}
?>

13. 大数据综合分析用户得到的标签:即用户画像

13.1 接口名称:

getPersonaTags(APPID)

13.2 接口参数:

字段 类型 说明
APPID String 应用ID

13.3 getPersonaTags代码示例:

<?php

header("Content-Type: text/html; charset=utf-8");

require_once(dirname(__FILE__) . '/' . 'IGt.Push.php');

//http的域名
define('HOST','http://sdk.open.api.igexin.com/apiex.htm');

//https的域名
//define('HOST','https://api.getui.com/apiex.htm');

//采用"PHP SDK 快速入门", "第二步 获取访问凭证 "中获得的应用配置           
define('APPKEY','');
define('APPID','');
define('MASTERSECRET','');


getPersonaTagsDemo();

function getPersonaTagsDemo() {
    $igt = new IGeTui(HOST, APPKEY, MASTERSECRET);
    $ret = $igt->getPersonaTags(APPID);
    var_dump($ret);
}

?>

14. 批量获取推送结果

14.1 描述

调用此接口批量查询推送数据,可查询消息有效可下发总数,消息回执总数,用户点击数结果。

14.2 函数说明

function getPushResultByTaskidList($taskIdList)

14.3 参数说明

参数名 类型 必需 默认值 参数描述
taskIdList Array 任务Id列表

14.4 返回值

{
  "result": "",
  "resultList":[
      {
        "taskId":"",
        "GT": {//个推下发报表
            "sent": "",//成功下发数
            "displayed": "",//展示数
            "clicked": "",//点击
            "feedback": "",//到达
            "result": ""//成功(ok)或错误信息
        },
        "APN": {//ios apns下发
            "sent": "",//下发
            "displayed": "",//apns展示
            "clicked": "",//点击
            "result": ""//成功(ok)或错误信息
        }
      }
  ]
}

14.5 代码实例

<?php

header("Content-Type: text/html; charset=utf-8");

require_once(dirname(__FILE__) . '/' . 'IGt.Push.php');

//http的域名
define('HOST','http://sdk.open.api.igexin.com/apiex.htm');

//https的域名
//define('HOST','https://api.getui.com/apiex.htm');

//采用"PHP SDK 快速入门", "第二步 获取访问凭证 "中获得的应用配置
define('APPKEY','');
define('APPID','');
define('MASTERSECRET','');
getPushResultByTaskidListDemo();
function getPushResultByTaskidListDemo(){
    $igt = new IGeTui(HOST,APPKEY,MASTERSECRET);
    $taskIdList = array("123");
    $req = $igt->getPushResultByTaskidList($taskIdList);
    var_dump($req);

}
?>
通知
2018.08.09 PHP SDK 4.0.1.10

添加php新加接口功能文档说明

......
2018.07.19 Android SDK 4.3.1.0

增加Applink点击回执接口 修复若干其他bug以及性能优化

......
2018.06.19 iOS SDK 2.3.0.0

新增 AppLink 服务及统计支持。 新增短信补量推送服务。

......
2018.06.19 Android SDK 2.12.4.0

增加Applink点击回执接口 修复若干其他bug以及性能优化

......
2018.03.21 Android SDK 4.3.0.0

增加通知到达、点击回调 适配Android 8.0 修复若干其他bug

......

文档中心搜索