patricpoba/mnotify

使用mnotify.com作为服务提供商发送短信的API

v0.1.5 2023-06-06 17:02 UTC

This package is auto-updated.

Last update: 2024-09-06 19:45:24 UTC


README

此包允许您使用mNotify.com(作为一个服务提供商)从Laravel应用程序发送短信。语音功能将在未来的版本中添加。

安装

如果您还没有安装composer,请从http://www.getcomposer.org/download下载并安装它。

方法1:使用composer要求此包

composer require patricpoba/mnotify

方法2:将以下内容添加到您的项目composer.json文件中

{
    "require": {
       "patricpoba/mnotify": "0.1.*"
    }
}

并运行此命令

composer update

在更新composer后,将ServiceProvider添加到config/app.php中的providers数组

Laravel <= 5.4

如果您正在使用laravel 5.5,您可以跳过此步骤。

PatricPoba\Mnotify\MnotifyServiceProvider::class, 

将此包的外观添加到$aliases数组中。

'Sms'  => PatricPoba\Mnotify\Facades\Sms::class,

配置

在您开始发送短信之前,您需要在您的/.env文件中设置您的API密钥和默认发送者ID。您可以在https://apps.mnotify.net/api/api找到您的API密钥。这些配置文件可以从Laravel应用程序中更改。请参阅示例

<!-- /.env file -->
MNOTIFY_SMS_API_KEY=YourKeyGoesHere
MNOTIFY_SENDER_ID=MyApp

用法

以下是发送短信和检查mnotify账户短信余额的基本用法指南。

发送短信

可以使用外观或类文件发送短信。在此示例中,我们将使用mnotify.com的短信API从我们的Laravel应用程序发送短信。

 
# Basic sending(uses api_key set in .env file)
Sms::send('02XXXXXXXXX', 'Testing test');

# To use a different api key,
Sms::setApiKey('API_KEY_GOES_HERE')->send('0275799028', 'Testing App');

# To customise sender Id,
# NB: sender Id must not be more than 11 characters
Sms::from('CompanyName')->send('02XXXXXXXX', 'Testing App');

调度

日期和时间格式为Y-m-d H:i:s。只有当您想稍后安排消息时,才应添加此日期时间。

$dateTime = \Carbon\Carbon::now()->addMinutes(30); // format: 2017-05-02 00:59:00

Smd::schedule($dateTime, '0275799028', 'Testing Application')

检查短信余额

这返回您的mnotify.com短信余额。

Sms::balance();

# To check the balance using an api key different from the one set in the .env file,
Sms::setApiKey('API_KEY_GOES_HERE')->balance();

贡献

感谢您考虑为此包做出贡献!要做出贡献,请分叉此存储库,编写一些代码,然后向develop分支提交pull request。:-)

许可证

此包是开源软件,许可协议为MIT许可证