README

Ghasedak Laravel SDK

实现 Ghasedak SMS API 的 Laravel 项目易于使用的 SDK。
查看文档 »

Web Service 文档 · REST API . 报告错误 · 请求功能

英文文档 | 波斯语文档

目录

• 安装
• 更新
• 使用
  • 参数
  • 示例
• 一次性密码 (OTP)
  • 参数
  • 示例
• 许可

安装

最简单的安装方法是使用 Composer

composer require ghasedak/laravel

Composer 是 PHP 的依赖管理器，允许您声明项目所依赖的库，它将为您管理（安装/更新）它们。如果您不熟悉 Composer，可以阅读其文档并通过 getcomposer.org 下载。

更新

将此行设置到您的项目中的 composer.json 文件

"ghasedak/laravel": "*"

然后运行以下命令使用 Composer 更新

composer update 

Composer 会更新您本地机器上的所需包。

使用

要使用此包，您需要一个 API 密钥。为此，您应该拥有一个 Ghasedak 账户。注册并获取您的 API 密钥。
将以下变量复制到您项目的 .env 文件中，并将 your_api_key 替换为您从 Ghasedak 账户获得的密钥。

GHASEDAKAPI_KEY=your_api_key

在控制器顶部或您想要使用的地方使用 GhasedakFacade

use Ghasedak\Laravel\GhasedakFacade;

然后您可以使用 GhasedakApi 的方法静态地使用 SendSimple

$response = GhasedakFacade::SendSimple($receptor, $message, $lineNumber = null, $sendDate = null, $checkId = null);

####或者

$response = Ghasedak\Laravel\GhasedakFacade::SendSimple($receptor, $message, $lineNumber = null, $sendDate = null, $checkId = null);

参数

示例

以下是发送短信的示例代码。请注意，如果您没有专用线路，则必须指定 行号。

$receptor = '09xxxxxxxxx';
$message = 'Hello, World!';
$lineNumber = '3000xxxxx'; 

$response = Ghasedak\Laravel\GhasedakFacade::SendSimple($receptor, $message, $lineNumber);

一次性密码 (OTP)

一次性密码 (OTP) 接口用于执行手机认证或实现双因素认证 (2FA)。
您可以向 Verify 方法传递最多 10 个 param

$response = Ghasedak\Laravel\GhasedakFacade::setVerifyType(Ghasedak\Laravel\GhasedakFacade::VERIFY_MESSAGE_TEXT)
->Verify(
    "09xxxxxxxxx",  // receptor  
    "my-template",  // name of the template which you've created in you account  
    "param1",       // parameters (supporting up to 10 parameters)   
    "param2",   
    "param3"
);  

参数

示例

$receptor = "09xxxxxxxxx";
$type = Ghasedak\Laravel\GhasedakFacade::VERIFY_MESSAGE_TEXT;
$template = "my-template";
$param1 = '123456';

$response = Ghasedak\Laravel\GhasedakFacade::setVerifyType($type)->Verify($receptor, $template, $param1);

:)

许可

在 MIT 许可证条款下自由分发。

目录

• 安装
• 更新
• 使用
• 参数
• 示例代码
• 一次性密码
• 参数
• 示例代码
• 许可

安装

最简单的安装方法是使用 Composer

composer require ghasedak/laravel

Composer 是一个用于管理 PHP 包的系统，它允许您管理（安装/更新）项目所依赖的包。如果您不熟悉 Composer，可以访问 getcomposer.org 了解其文档并下载安装。

更新

请将以下行添加到您的 composer.json 文件中

"ghasedak/laravel": "*"

然后运行以下命令

composer update 

Composer 会更新您的项目中的包和依赖项。

使用方法

使用此包需要API密钥。首先在网站Qasdek注册并从您的用户面板获取API密钥。

将以下变量复制到您的项目.env文件中，并用从Qasdek账户获得的密钥替换your_api_key。

GHASEDAKAPI_KEY=your_api_key

use Ghasedak\Laravel\GhasedakFacade;

$response = GhasedakFacade::SendSimple($receptor, $message, $lineNumber = null, $sendDate = null, $checkId = null);

####或者

$response = Ghasedak\Laravel\GhasedakFacade::SendSimple($receptor, $message, $lineNumber = null, $sendDate = null, $checkId = null);

:))

参数

示例代码

以下代码是发送单条短信方法的示例。请注意，如果没有专用的行号，您必须输入line number。

$receptor = '09xxxxxxxxx';
$message = 'Hello, World!';
$lineNumber = '3000xxxxx';

$response = Ghasedak\Laravel\GhasedakFacade::SendSimple($receptor, $message, $lineNumber);

一次性密码（OTP）

一次性密码用于通过手机验证或用于双重验证（2FA）。

您可以使用Verify方法发送最多10个param。

$response = Ghasedak\Laravel\GhasedakFacade::setVerifyType(Ghasedak\Laravel\GhasedakFacade::VERIFY_MESSAGE_TEXT)
->Verify(   
    "09xxxxxxxxx", // receptor 
    "my-template", // name of the template which you've created in you account   
    "param1",      // parameters (supporting up to 10 parameters)   
    "param2",   
    "param3"
);  

参数

示例代码

$receptor = "09xxxxxxxxx";
$type = Ghasedak\Laravel\GhasedakFacade::VERIFY_MESSAGE_TEXT;
$template = "my-template";
$param1 = '123456';

$response = Ghasedak\Laravel\GhasedakFacade::setVerifyType($type)->Verify($receptor, $template, $param1);

许可

此包按照MIT许可证发布。