karix/karix-sms-notification

允许您在 Laravel 通知中使用 karix 短信作为自定义通道

0.1.0 2020-06-30 07:28 UTC

This package is auto-updated.

Last update: 2024-09-29 05:48:49 UTC


README

Build Status StyleCI GitHub license GitHub stars

此包使您能够通过 Karix.io(karix.io)轻松发送短信,适用于 Laravel 7+。

安装

您可以通过 composer 安装此包

composer require bitfumes/karix-notification-channel

设置 Karix ID 和 Token

登录 Karix.io 获取您的 ID 和 Token,将其放在您的 .env 文件中,并将您的 Karix ID 和 Token 添加到 config/services.php

// config/services.php
...
    'karix' => [
        'id' => env('KARIX_ID'),
        'token' => env('KARIX_TOKEN'),
    ],
...

用法

现在您可以在通知的 via() 方法中使用该通道

use Bitfumes\KarixNotificationChannel\KarixChannel;
use Bitfumes\KarixNotificationChannel\KarixMessage;
use Illuminate\Notifications\Notification;

class YourNotification extends Notification
{
    public function via($notifiable)
    {
        return [KarixChannel::class];
    }

    public function toKarix($notifiable)
    {
        return KarixMessage::create()
                        ->from('+1XXXXXXXXXX')
                        ->content('Your message comes here');
    }
}

为了让通知知道有一个名为 KarixSmsChannel 的新通道,请将 routeNotificationForKarix 方法添加到您的 Notifiable 模型中(可能是您的 user.php 文件)。

此方法需要返回用户的电子邮件(如果是私密板)和要添加卡片的 Trello 列表 ID。

注意事项:确保您的表中有一个 '电话' 字段,以及您正在使用的国家代码,例如 +91xxxxxxxxxx。

public function routeNotificationForKarix()
{
    return $this->phone;
}

可用方法

  • version(''):接受一个字符串值作为 Karix API 版本。
  • timezone(''):接受一个字符串值作为您要设置的短信时区。

测试

$ composer test

安全

如果您发现任何与安全相关的问题,请通过电子邮件 sarthak@bitfumes.com 反馈,而不是使用问题跟踪器。

贡献

有关详细信息,请参阅 CONTRIBUTING

致谢

许可

MIT 许可证(MIT)。有关更多信息,请参阅 许可文件