短信通知通道 JSKSMS

2.1.0 2022-02-01 12:03 UTC

This package is not auto-updated.

Last update: 2024-09-25 00:29:06 UTC


README

Latest Version on Packagist Software License Build Status StyleCI Quality Score Code Coverage Total Downloads

本软件包使您能够使用 jsksms(jsksms.com)轻松发送通知,适用于Laravel 5.5+、6.x、7.x和8.x

内容

安装

您可以通过 composer 安装此软件包

composer require ramanandapanda/jsksms

设置 jsksms 服务

将您的 jsksms 令牌和默认发送者名称(或电话号码)添加到 config/services.php

// config/services.php
...
'jsksms' => [
    'endpoint' => env('jsksms_ENDPOINT', 'https://jsksms.com/api/v2/send'),
    'token' => env('jsksms_TOKEN', 'YOUR jsksms TOKEN HERE'),
    'sender' => env('jsksms_SENDER', 'YOUR jsksms SENDER HERE')
],
...

使用方法

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

use Illuminate\Notifications\Notification;
use NotificationChannels\jsksms\JsksmsMessage;

class AccountApproved extends Notification
{
    public function via($notifiable)
    {
        return ["jsksms"];
    }

    public function tojsksms($notifiable)
    {
        return (new JsksmsMessage)->content("Your account was approved!");       
    }
}

在您的可通知模型中,确保包含 routeNotificationForjsksms() 方法,该方法返回一个电话号码或电话号码数组。

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

按需通知

有时您可能需要向未存储为您的应用程序“用户”的人发送通知。使用 Notification::route 方法,您可以在发送通知之前指定临时的通知路由信息

Notification::route('jsksms', '5555555555')                      
            ->notify(new InvoicePaid($invoice));

可用的消息方法

sender():设置发送者的名称。 请确保在您的 jsksms 控制台中注册发送者名称。

content():设置通知消息的内容。此参数的长度不应超过 918 个字符(6 个消息部分)

test():是否向特定手机号码发送测试消息。此参数应为布尔值,默认值为 true

变更日志

有关最近更改的详细信息,请参阅 CHANGELOG

测试

$ composer test

安全性

如果您发现任何与安全性相关的问题,请使用问题跟踪器。

贡献

有关详细信息,请参阅 CONTRIBUTING

致谢

许可

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