为46Elks提供的Laravel通知通道包。

v1.10 2023-09-12 08:48 UTC

This package is auto-updated.

Last update: 2024-09-08 14:10:43 UTC


README

Latest Version on Packagist Software License Build Status

Quality Score Code Coverage Total Downloads

此包使得使用Laravel通过46Elks发送通知变得简单。

46Elks提供了一系列针对手机的服务。此包负责

  • 短信

未来还将提供更多端点。欢迎贡献力量。

内容

安装

composer require laravel-notification-channels/46elks

设置46Elks服务

将以下内容添加到您的config/services.php文件中

	'46elks' => [
		'username' => env('FORTY_SIX_ELKS_USERNAME'),
		'password' => env('FORTY_SIX_ELKS_PASSWORD'),
	],

同时请记得更新您的.env文件,使用正确的信息

FORTY_SIX_ELKS_USERNAME=
FORTY_SIX_ELKS_PASSWORD=

您可以在https://46elks.se/account找到您的用户名和密码

使用方法

要使用此通道,只需创建以下内容的通知

    use NotificationChannels\FortySixElks\FortySixElksChannel;
    use NotificationChannels\FortySixElks\FortySixElksSMS;

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

 
    public function to46Elks($notifiable)
    {
        return (new FortySixElksSMS())
	        ->line('Testsms')
	        ->line('Olle')
	        ->to('+46762216234')
	        ->from('Emil')
            	// -dry()
    }

可用媒介

短信

FortySixElksSMS具有以下方法,全部可链式调用。

短信的可用消息方法

from($mixed) 接受最多11个字符的字符串或号码。短信将以该名称发送。

to($number) 国际电话号码。

line($string) 每行中的字符串将单独一行。

flash() 将消息类型设置为闪存。不会出现在短信收件箱中。请参见此推文了解在iPhone上的外观。

dry() 当您想要验证API请求而不实际向手机发送短信时启用。启用此选项时,不会发送短信。要检查dry()请求,您需要将消息发送到+4670000000,然后您可以在https://46elks.com/logs上检查它。

whendelivered('http://localhost') 此webhook URL将在每次交付状态更改时接收POST请求。

dontlog() 启用以避免将消息文本存储在您的历史记录中。其他参数仍将存储。

MMS

要使用MMS,只需使用new FortySixElksMMS()代替new FortySixElksSMS()

FortySixElksMMS具有以下方法,全部可链式调用。

可用消息方法

from($mixed) 接受字符串“noreply”或MMS激活的号码。

to($number) 国际电话号码。

line($string) 每行中的字符串将单独一行。

image() 要发送在MMS中的图片的URL。

错误处理

如何处理通知发送错误

如果发送通知时发生任何错误,它将触发一个Illuminate\Notifications\Events\NotificationFailed事件。然后您可以监听该事件。

示例

Event::listen(NotificationFailed::class, function($event){
    info('Error while sending sms');
});

事件具有$event->notifiable$event->notification$event->channel$event->data(其中在$event->data['exception']中有异常)

变更日志

请参阅CHANGELOG以获取有关最近更改的更多信息。

测试

$ composer test

安全

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

贡献力量

请参阅CONTRIBUTING以获取详细信息。

致谢

许可证

MIT许可证(MIT)。请参阅许可证文件以获取更多信息。