munafio/oursms-laravel

Laravel OurSMS API 集成

v0.1.0 2021-06-08 23:12 UTC

This package is auto-updated.

Last update: 2024-08-30 01:43:50 UTC


README

The Service Has STOPPED!

Laravel OurSMS API 集成

Latest Stable Version Total Downloads License

安装

  1. 将此包添加到您的 Laravel 应用程序中
$ composer require munafio/oursms-laravel
  1. 使用以下 artisan 命令安装 OurSMS
$ php artisan oursms:install

这将发布配置,并在您应用程序的 .env 文件中创建 oursms 环境变量,并为您设置一切。

  1. 使用您的 OurSMS 账户凭据修改应用程序的 .env 文件中的以下变量
...
OURSMS_USER_ID=
OURSMS_SECRET_KEY=

这就完成了,祝您使用愉快 :)

快速开始

您可以在应用程序中轻松使用此包,您只需要在应用程序的任何位置导入包的 facade(例如在控制器中)如下所示

use Munafio\OurSMS\Facades\OurSMS;

或者,您可以直接使用它而不导入 facade,如下所示

...
public function example(Request $request){
	...
	OurSMS::sendOSM(...,...);
	...
}
...

可用方法

发送单条消息(OSM)

OurSMS::sendOSM($phoneNumber, $message);

发送一次性密码(OTP)

OurSMS::sendOTP($phoneNumber, $message);

获取短信状态

OurSMS::getStatus($messageId);

配置

您可以在应用程序的 config/oursms.php 文件中找到配置文件,其中包含以下属性

/*
|-------------------------------------
| OurSMS service credentials
|-------------------------------------
*/
'user_id'  =>  env('OURSMS_USER_ID',  null),
'secret_key'  =>  env('OURSMS_SECRET_KEY',  null),
  • user_id 您在网站上的用户 ID。
  • secret_key 您自己的密钥,您可以在网站上的 user id 旁边找到。
/*
|-------------------------------------
| OurSMS service API base_uri
|-------------------------------------
*/
'base_uri'  =>  'https://oursms.app/api/v1/SMS'
  • base_uriOurSMS 服务端点的基准 URL。

变更日志

CHANGELOG.md

作者

Munaf A. Mahdi

许可

MIT