README

Ghasedak PHP SDK

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

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

英文文档 | 波斯语文档

目录

• 安装
• 使用
  • 参数
  • 示例
• 一次性密码（OTP）
  • 参数
  • 示例
• 许可证

安装

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

composer require ghasedak/php  

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

或者您可以从这里下载Ghasedak SDK，将其解压到您的项目中，并按照下面的其他说明进行操作。此外，包中还有一个示例文件夹，您可以用来了解过程。

使用

要使用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）。
您可以向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许可证的条款下自由分发。

目录

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

安装

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

composer require ghasedak/php  

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

如果您不想使用Composr，可以从此处下载Ghasedak PHP包：这里，并将解压后的文件内容添加到您的项目中。此外，包中包含一个名为Example的文件夹，您可以使用它来学习如何正确使用该包。

使用方法

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

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

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）

一次性密码用于通过手机进行验证或用于双因素认证（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许可证下发布。