justpush/justpush-php-sdk

通过 PHP 发送推送消息的 SDK

1.0.16 2024-08-19 10:34 UTC

This package is not auto-updated.

Last update: 2024-09-18 10:17:18 UTC


README

JustPush - PHP SDK

欢迎使用 JustPush 的官方 PHP SDK!此 SDK 允许您轻松集成我们的强大消息平台,提供创建消息、检索消息、创建主题和更新主题的功能。

功能

  • 创建消息:使用我们简化的 API 无缝发送消息。
  • 检索消息:轻松检索消息,实现无缝集成和处理。
  • 创建主题:通过创建特定主题来组织您的消息。
  • 更新主题:修改现有主题,以保持消息结构的灵活性和时效性。

在应用商店中下载应用

安装

通过 Composer 安装 SDK

composer require justpush/justpush-php-sdk

基本推送消息

这是发送通知的基本示例。

$response = JustPushMessage::token('REPLACE_WITH_USER_TOKEN')
    ->message('Here is a sample Message')
    ->title('Test Title')
    ->create();

echo json_encode($response->result(), JSON_PRETTY_PRINT); //Result
echo json_encode($response->responseHeaders(), JSON_PRETTY_PRINT); //Response Headers

JustPush 消息

定义主题

我们的目标是使 API 尽可能简单。因此,您可以发送以下内容之一

  • 主题标题 - 当标题存在多次时,将使用最旧的标题。如果该名称不在您的主题列表中,将创建一个新主题。
  • 主题 UUID - 使用主题的精确匹配

发送多张图片

当消息包含多张图片时,将使用第一张图片作为推送消息横幅。

设置过期时间

设置过期时间后,消息将有一个以秒为单位的 TTL。在过期时间过后,消息将自动隐藏。

JustPush 主题

POST / 创建主题

这是创建主题的基本示例

$response = JustPushTopic::token('REPLACE_WITH_USER_TOKEN')
    ->title('New Topic')
    ->create();
    
echo json_encode($response->result(), JSON_PRETTY_PRINT); //Result
echo json_encode($response->responseHeaders(), JSON_PRETTY_PRINT); //Response Headers

PUT / 更新主题

这是更新主题的基本示例

$response = JustPushTopic::token('REPLACE_WITH_USER_TOKEN')
    ->topic('REPLACE_WITH_TOPIC_UUID')
    ->title('New Topic Title')
    ->update();
    
echo json_encode($response->result(), JSON_PRETTY_PRINT); //Result
echo json_encode($response->responseHeaders(), JSON_PRETTY_PRINT); //Response Headers

GET / 获取主题

这是创建主题的基本示例

$response = JustPushTopic::token('REPLACE_WITH_USER_TOKEN')
    ->topic('REPLACE_WITH_TOPIC_UUID')
    ->get();

echo json_encode($response->result(), JSON_PRETTY_PRINT); //Result
echo json_encode($response->responseHeaders(), JSON_PRETTY_PRINT); //Response Headers

响应头

OpenApi 规范

此包附带 OpenAPI 规范。可以在 docs 文件夹中找到。 点击此处

变更日志

  • 1.0.15 - 为 acknowledgements 添加了重试机制