wenpeng/aliyun-push

Aliyun OpenAPI Push SDK

This package's canonical repository appears to be gone and the package has been frozen as a result.

v1.0.0 2016-07-20 05:07 UTC

Requires

• php: >=5.4.0
• wenpeng/aliyun-core: ^1.0.0

MIT

• wenpeng

• php
• sdk
• push
• openapi
• aliyun

README

Aliyun OpenAPI Push SDK

Install

$ composer require wenpeng/aliyun-push

Usage

/**
 * 初始配置
 */
$config = [
	'access_key_id' => 'xxx',
	'access_key_secret' => 'xxx',
];
$region = EndpointConfig::getRegionIds();
$domain = EndpointConfig::getProductDomains();
$endpoint = new Endpoint('cn-hangzhou', $region, $domain);
EndpointProvider::setEndpoints([$endpoint]);

$profile = DefaultProfile::getProfile('cn-hangzhou', $config['access_key_id'], $config['access_key_secret']);

/**
 * 请求对象
 */
$request = new \Aliyun\Push\Request\PushRequest();

/**
 * 推送目标
 */
$request->setAppKey($appKey);
$request->setTarget("all");                     //推送目标: device:推送给设备; account:推送给指定帐号,tag:推送给自定义标签; all: 推送给全部
$request->setTargetValue("all");                //根据Target来设定，如Target=device, 则对应的值为 设备id1,设备id2. 多个值使用逗号分隔.(帐号与设备有一次最多100个的限制)
$request->setDeviceType(3);                     // 设备类型deviceType 取值范围为:0~3. iOS设备: 0; Android设备: 1; 全部: 3, 这是默认值.

/**
 * 推送配置
 */
$request->setType(1);                           // 0:表示消息(默认为0), 1:表示通知
$request->setTitle("Hello OpenAPI!");           // 消息的标题
$request->setBody("PushRequest body");          // 消息的内容
$request->setSummary("PushRequest summary");    // 通知的摘要

/**
 * 推送配置: iOS
 */
$request->setiOSBadge("5");                     // iOS应用图标右上角角标
$request->setiOSMusic("default");               // iOS通知声音
$json = json_encode(['key' => 'value']);
$request->setiOSExtParameters($json);           //自定义的kv结构,开发者扩展用 针对iOS设备
$request->setApnsEnv("DEV");
$request->setRemind("false");                   // 当APP不在线时候，是否通过通知提醒

/**
 *  推送配置: Android
 */
$request->setAndroidOpenType("3");              // 点击通知后动作,1:打开应用 2: 打开应用Activity 3:打开 url
$url = "http://www.baidu.com";
$request->setAndroidOpenUrl($url);              // Android收到推送后打开对应的url,仅仅当androidOpenType=3有效
$json = json_encode(['key' => 'value']);
$request->setAndroidExtParameters($json);       // 设定android类型设备通知的扩展属性

/**
 * 推送控制
 */
$now = time();
$pushTime = gmdate('Y-m-d\TH:i:s\Z', $now + 30);
$expireTime = gmdate('Y-m-d\TH:i:s\Z', $now + 12 * 3600);
$request->setPushTime($pushTime);               // 30秒之后的时间点, 也可以设置成你指定固定时间, 延后推送。可选，如果不设置表示立即推送
$request->setStoreOffline("false");             // 离线消息是否保存,若保存, 在推送时候，用户即使不在线，下一次上线则会收到
$request->setExpireTime($expireTime);           // 12小时后消息失效, 不会再发送
$request->setBatchNumber("100010");             // 批次编号,用于活动效果统计. 设置成业务可以记录的字符串

$client   = new DefaultAcsClient($profile);
$response = $client->getAcsResponse($request);

var_dump($response);

官网文档

License

The MIT License (MIT). Please see License File for more information.