PHPackages                             xufei56789/getui - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. xufei56789/getui

ActiveLibrary[Utility & Helpers](/categories/utility)

xufei56789/getui
================

Laravel 5 Getui Package

075PHP

Since Sep 13Pushed 7y agoCompare

[ Source](https://github.com/xufei56789/laravel-getui-s)[ Packagist](https://packagist.org/packages/xufei56789/getui)[ RSS](/packages/xufei56789-getui/feed)WikiDiscussions master Synced today

READMEChangelogDependenciesVersions (1)Used By (0)

个推是国内领先的推送技术服务商,提供安卓(Android)和iOS推送SDK,为APP开发者提供高效稳定推送技术服务; 每个APP都需要推送，在做后端的时候，我们肯定是需要个推来实现对APP推送消息，个推的使用功能特别多，如果自己单独去开发，一定浪费大量的时间，所以我集成了Laravel个推拓展，方便大家学习使用

开发前的准备
======

[](#开发前的准备)

1. 安装Laravel
2. 申请个推APPKEY，APPID，MASTERSECRET等
3. 有一个自己的测试CID，问APP开发人员要吧

安装拓展
====

[](#安装拓展)

1、运行如下代码安装拓展包：

```
composer require "xufei56789/getui:dev-master"

```

3.等待下载安装完成，需要在`config/app.php`中注册服务提供者同时注册下相应门面：

```
'providers' => [
    //........
    Xufei\Getui\GetuiServiceprovider::class,
],

'aliases' => [
     //..........
    'Getui'     => Xufei\Getui\Facades\Getui::class,
],
```

服务注入以后，如果要使用自定义的配置，还可以发布配置文件到config目录：

```
php artisan vendor:publish
```

其他接口
====

[](#其他接口)

### 获取单日用户数据

[](#获取单日用户数据)

```
Getui::getUserDataByDate($date);
```

请求参数`date`,查询的日期（格式：yyyyMMdd）,比如：20170525
返回参数：

```
[
  "result" => "Success",
  "data" => [
  // 新注册用户数
  "newRegistCount" => 512,
  // 累计注册用户数
  "registTotalCount" => 14349,
  // 活跃用户数
  "activeCount" => 1544,
  // 在线用户数
  "onlineCount" => 55,
  "appId" => "",
  "date" => "20170726",
  ]
]
```

### 获取单日推送数据

[](#获取单日推送数据)

```
Getui::getPushDataByDate($date);
```

请求参数`date`,查询的日期（格式：yyyyMMdd）,比如：20170525

返回参数：

```
[
  "result" => "ok",
  "data" => [
    "appId" => "",
    "date" => "20170726",
    // 发送总数
    "sendCount" => 255,
    // 在线发送数
    "sendOnlineCount" => 140,
    // 接收数
    "receiveCount" => 138,
    // 展示数
    "showCount" => 25,
    // 点击数
    "clickCount" => 12,
  ],
  "GT" => "{"sent":140,"feedback":138,"displayed":25,"clicked":12}"
]
```

### 停止任务接口

[](#停止任务接口)

```
Getui::stopPushTask($taskId);
```

请求参数`taskId`,发送任务的taskId，在Push返回中获取
返回参数：`true`,`false`

### 查询用户状态

[](#查询用户状态)

```
Getui::getUserStatus($CID);
```

请求参数`CID`,用户唯一标识符,默认查询的是`config/getui.php`文件中的`CID`

```
[
  // 是否在线，Offline代表不在线，Online代表在线
  "result" => "Offline",
  // 最后登陆时间
  "lastLogin" => 1501142220930,
  "isblack" => false,
]
```

### 获取推送状态

[](#获取推送状态)

```
Getui::getPushMessageResult($taskId);
```

请求参数`taskId`,发送任务的taskId，在Push返回中获取
返回参数：

```
[
  "result" => "ok",
  "taskId" => "OSS-0728_071043065bcecc3a129937763b2309cd"
]
```

### 通过标签获取用户总数

[](#通过标签获取用户总数)

```
Getui::getUserCountByTags($tagList);
```

请求参数`tagList`,标签列表`Array`,比如：`array("laravel","php")`

返回参数：

```
[
  "result" => "Success",
  "appId" => "",
  "tagCount" => [],
]
```

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

[](#大数据综合分析用户得到的标签即用户画像)

```
Getui::getPersonaTags();
```

返回参数：

```
[
  "result" => "Success",
  "tags" => []
]
```

消息模板
====

[](#消息模板)

### 点击通知打开应用模板，可传递参数

[](#点击通知打开应用模板可传递参数)

IGtNotificationTemplate
$config配置信息如下

参数类型说明typestrHIGH/SIMPLE SIMPLE代表简单模版，HIGH代表高级模版titlestrHIGH模版使用，消息标题bodystr消息内容logostrlogologourlstrlogo地址### 点击通知打开网页模板

[](#点击通知打开网页模板)

IGtLinkTemplate

$config配置信息如下：

参数类型说明titlestr消息标题bodystr消息内容logostrlogologourlstrlogo地址urlstrurl代表当点击弹窗跳转到的网址### 点击通知弹窗下载模板(iOS 不支持使用该模板)

[](#点击通知弹窗下载模板ios-不支持使用该模板)

IGtNotyPopLoadTemplate
$config配置信息如下：

参数类型说明typestrnotice/bomb/download notice代表通知栏，bomb代表弹框，download代表下载titlestr消息标题bodystr消息内容logostrlogoloadurlstrloadurl代表当使用download模版时的下载地址### 透传消息模版，可传递参数

[](#透传消息模版可传递参数)

IGtTransmissionTemplate
$config配置信息如下

参数类型说明typestrHIGH/SIMPLE SIMPLE代表简单模版，HIGH代表高级模版titlestrHIGH模版使用，消息标题bodystr消息内容logostrlogologourlstrlogo地址消息推送方式
======

[](#消息推送方式)

### 对单个用户推送消息

[](#对单个用户推送消息)

```
$template = "IGtTransmissionTemplate";
$data = "a";
$config = array("type" => "HIGH", "title" => "你有一条新消息", "body" => "你有一个3000元的订单需要申请","logo"=>"","logourl"=>"");
$CID = "";
$test = Getui::pushMessageToSingle($template,$config,$data,$CID);
```

参数说明：
$template代表上一步的消息模板
$data代表您推送的内容，具体询问APP开发人员，一般为JSON格式，如果只是普通的发送消息随意填写
$config参考模版所需内容，这里使用透传为例
$CID为发送给某人具体CID，默认为config/getui.php中的测试CID

返回参数:

```
[
  "result" => "ok",
  "taskId" => "OSS-0728_071043065bcecc3a129937763b2309cd",
  "status" => "successed_offline",
]
```

### 对指定列表用户推送消息

[](#对指定列表用户推送消息)

```
$template = "IGtTransmissionTemplate";
$data = "a";
$config = array("type" => "HIGH", "title" => "你有一条新消息", "body" => "你有一个3000元的订单需要申请","logo"=>"","logourl"=>"");
$CID = "";
$test = Getui::pushMessageToList($template,$config,$data,$CID);
```

参数说明：
$template代表上一步的消息模板
$data代表您推送的内容，具体询问APP开发人员，一般为JSON格式，如果只是普通的发送消息随意填写
$config参考模版所需内容，这里使用透传为例
$CID为发送给用户组的CID（列表模式），默认为config/getui.php中的测试CID

返回参数:

```
[
  "result" => "ok"
  "contentId" => "OSL-0728_hLKYR4tmkC7S0lI7QnSTT"
]
```

应用场景：
场景1，对于抽奖活动的应用，需要对已知的某些用户推送中奖消息，就可以通过ClientID列表方式推送消息。
场景2，向新客用户发放抵用券，提升新客的转化率，就可以事先提取新客列表，将消息指定发送给这部分指定CID用户。

### 对指定应用群推消息

[](#对指定应用群推消息)

```
// 模版选择
$template = "IGtTransmissionTemplate";
// 发送内容
$data = "IGtTransmissionTemplate";
// 条件选择
$choice = array(
        // 发送手机类型
        "phoneTypeList"=>["ANDROID","IPHONE","IPAD"],
        // 发送城市
        "provinceList"=>["北京","上海"],
        // 标签选择，为空即可
        "tagList"=>["标签"],
        // 年龄选择
        "age"=>["10","11"]
    );
$config = array("type" => "HIGH", "title" => "你有一条新消息", "body" => "APP更新了哦，快去看看吧","logo"=>"","logourl"=>"");
$test = Getui::pushMessageToApp($template,$config,$data,$choice);
```

参数说明：
$template代表上一步的消息模板
$data代表您推送的内容，具体询问APP开发人员，一般为JSON格式，如果只是普通的发送消息随意填写
$config参考模版所需内容，这里使用透传为例
$choice为发送给用户组的条件筛选

返回参数:

```
[
  "result" => "ok"
  "contentId" => "OSL-0728_hLKYR4tmkC7S0lI7QnSTT"
]
```

应用场景：
1、对全部APP的用户推送消息
2、对某个城市的人推送消息
3、对某个年龄的人推送消息

推送接口模式
======

[](#推送接口模式)

推送接口包括https模式和http模式 更改只需要修改`config/getui.php`中的`HTTPS`参数，`true`代表为Https推送接口，`false`代表为Http推送接口，默认为Http请求

###  Health Score

20

—

LowBetter than 14% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity9

Limited adoption so far

Community3

Small or concentrated contributor base

Maturity39

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/b813c95b45464edd3c30837609ce59137ae1ae7fd8420729170c5147c002e6a8?d=identicon)[xufei56789](/maintainers/xufei56789)

---

Top Contributors

[![xufei56789](https://avatars.githubusercontent.com/u/22664500?v=4)](https://github.com/xufei56789 "xufei56789 (7 commits)")

### Embed Badge

![Health badge](/badges/xufei56789-getui/health.svg)

```
[![Health](https://phpackages.com/badges/xufei56789-getui/health.svg)](https://phpackages.com/packages/xufei56789-getui)
```

###  Alternatives

[t3docs/examples

This extension packages a number of code examples from the Core Documentation.

3120.2k](/packages/t3docs-examples)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)