README

Ghasedak PHP SDK

用于在您的 PHP 项目中实现 Ghasedak SMS API 的易于使用的 SDK。
探索文档

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

英文文档 | 波斯语文档

目录

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

安装

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

composer require ghasedak/php  

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

或者您可以从 这里 下载 Ghasedak SDK，并在您的项目中解压缩它，然后按照下面的说明进行操作。此外，包内还有一个 Example 文件夹，您可以使用它来了解流程。

使用

要使用 API，您需要一个 API 密钥。为了获取它，您应该有一个 Ghasedak 账户。注册并获取您的 API 密钥。

然后需要包含文件 autoload.php 以加载所有类和依赖项。

require __DIR__ . '/vendor/autoload.php';

使用您的 API 密钥从 Ghasedak 类创建一个实例

$api = new \Ghasedak\GhasedakApi( 'your_api_key');  

别忘了将 your_api_key 替换为您从 Ghasedak 账户获得的密钥。

发送短信

$api->SendSimple(  
 "09xxxxxxxxx", // receptor
 "Hello World!", // message
 "3000xxxxx" // choose a line number from your account
);  

参数

示例

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

require __DIR__ . '/vendor/autoload.php';
 
try{  
 $message = "Hello, World!";
 $lineNumber = null; // If you do not have a dedicated line, you must specify the line number  
 $receptor = "09xxxxxxxxx";
 $api = new \Ghasedak\GhasedakApi('api_key');
 $api->SendSimple($receptor,$message,$lineNumber);  
}
catch(\Ghasedak\Exceptions\ApiException $e){  
 echo $e->errorMessage();  
}  
catch(\Ghasedak\Exceptions\HttpException $e){  
 echo $e->errorMessage();  
}  

一次性密码 (OTP)

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

$api->setVerifyType(GhasedakApi::VERIFY_TEXT_TYPE)->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");

参数

示例

require __DIR__ . '/vendor/autoload.php';  

try{  
 $receptor = "09xxxxxxxxx";
 $type = 1;
 $template = "my-template";
 $param1 = '123456';
 $api = new \Ghasedak\GhasedakApi('api_key');
 $api->Verify($receptor, $type, $template, $param1);
}  
catch(\Ghasedak\Exceptions\ApiException $e){  
 echo $e->errorMessage();  
}  
catch(\Ghasedak\Exceptions\HttpException $e){  
 echo $e->errorMessage();  
}  

:)

许可

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

目录

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

安装

最简单的安装方法是通过 Composer

composer require ghasedak/php  

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

如果您不想使用 Composer，您可以从 这里 下载 Ghasedak PHP 包，将其内容解压到您的项目中，然后按照下面的说明进行操作。此外，包中还有一个名为 Example 的文件夹，您可以使用它来了解如何正确使用此包。

使用方法

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

然后，需要将autoload文件添加到您的项目中。

require __DIR__ . '/vendor/autoload.php';

使用您的API密钥创建一个Ghasedak类的实例。

$api = new \Ghasedak\GhasedakApi( 'your_api_key');  

请注意，将your_api_key替换为您从信使账户获取的密钥。

发送您的自定义短信。

$api->SendSimple(  
	"09xxxxxxxxx",  // receptor 
	"Hello World!", // message 
	"3000xxxxx" 	// choose a line number from your account
 );

参数

示例代码

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

require __DIR__ . '/vendor/autoload.php';  
try{  
 $message = "Hello, World!";
 $lineNumber = null; // If you do not have a dedicated line, you must specify the line number  
 $receptor = "09xxxxxxxxx";
 $api = new \Ghasedak\GhasedakApi('api_key');
 $api->SendSimple($receptor,$message,$lineNumber);  
}  
catch(\Ghasedak\Exceptions\ApiException $e){  
 echo $e->errorMessage();  
}  
catch(\Ghasedak\Exceptions\HttpException $e){  
 echo $e->errorMessage();  
}  

一次性密码（OTP）

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

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

$api->setVerifyType(GhasedakApi::VERIFY_TEXT_TYPE)->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");

参数

示例代码

require __DIR__ . '/vendor/autoload.php';  
try{  
 $receptor = "09xxxxxxxxx";
 $type = 1;
 $template = "my-template";
 $param1 = '123456';
 $api = new \Ghasedak\GhasedakApi('api_key');
 $api->Verify($receptor, $type, $template, $param1);  
}  
catch(\Ghasedak\Exceptions\ApiException $e){  
 echo $e->errorMessage();  
}  
catch(\Ghasedak\Exceptions\HttpException $e){  
 echo $e->errorMessage();  
}  

许可

此包在MIT许可下发布。