README

波斯语指南

内容

安装
- 设置 IPPanel 服务
用法
- 可用的消息方法
变更日志
安全
贡献
鸣谢
许可

安装

此包是 laravel 的官方包 ippanel/php-rest-sdk 的适配器

您可以通过 composer 安装此包

$ composer require mirvan/ippanel

设置 IPPanel 服务

您需要在 config/services.php 中设置您的 API 密钥

"ippanel"   => [
    'api_key'  =>  'API_KEY_SECRET',
],

用法

官方 IPPanel PHP 客户端

您可以直接访问官方 IPPanel PHP 客户端，如下所示

use Mirvan\IPPanel\IPPanel;

$client = new IPPanel();

# return float64 type credit amount
$credit = $client->getCredit();

$bulkID = $client->send(
    "+9810001",          // originator
    ["98912xxxxxxx"],    // recipients
    "ippanel is awesome" // message
);

或使用类外观

# return float64 type credit amount
$credit = \IPPanel::getCredit();

$bulkID = \IPPanel::send(
    "+9810001",          // originator
    ["98912xxxxxxx"],    // recipients
    "ippanel is awesome" // message
);

查看完整文档

通知通道

您可以在模型中设置参考

public function routeNotificationForIPPanel()
{
    return '09121234567';
}

您可以在模型中设置发起者

public function ippanelOriginator()
{
    return '+983000505';
}

在通知类中设置通道

use Mirvan\IPPanel\IPPanelChannel;

public function via($notifiable)
{
    return [IPPanelChannel::class];
}

用于发送普通消息

use Mirvan\IPPanel\IPPanelMessage;

 public function toIPPanel($notifiable)
{
    return (new IPPanelMessage)
        ->reference('09121231212')
        ->originator('+983000505')
        ->body('message');
}

用于模式消息

use Mirvan\IPPanel\IPPanelMessage;

 public function toIPPanel($notifiable)
{
    return (new IPPanelMessage)
        ->reference('09121231212')
        ->originator('+983000505')
        ->pattern('pattern_code')
        ->variable('variable-name','1234');
}

请注意：reference() 和 originator() 会覆盖 routeNotificationForIPPanel() 和 ippanelOriginator()

return (new IPPanelMessage)
    ->originator('+983000505')
    ->reference('09121231212')
    ->body('message');

可用的通知消息方法

originator('')：接受一个 1 到 11 个字符的字符串值，用作消息发送者名称。这将覆盖 ippanelOriginator()
reference('')：接受一个用于消息参考的字符串值。此信息将在状态报告中返回，以便您匹配消息及其状态。限制：1-32 个字母数字字符。这将覆盖 routeNotificationForIPPanel()

普通消息 的可用选项

body('')：接受一个用于消息主体的字符串值。

模式消息 的可用选项

pattern('')：接受一个用于模式代码的字符串值。
variable('name','value')：接受一个字符串作为变量名称，另一个字符串作为变量值
variables([])：接受一个用于变量的数组

变更日志

有关最近更改的更多信息，请参阅 CHANGELOG

安全

如果您发现任何与安全相关的问题，请通过电子邮件 me@mirvan.ir 联系，而不是使用问题跟踪器。

mirvan / ippanel

维护者

详情