a3dmorteza/kavenegar-php

为 Kavenegar API 提供的 PHP 封装

dev-master 2024-05-01 05:20 UTC

This package is auto-updated.

Last update: 2024-10-01 00:25:58 UTC


README

Latest Stable Version Total Downloads

Kavenegar RESTful API 文档

如需有关 API 文档的更多信息,请访问 RESTful 文档

安装

首先,您需要在 Kavenegar 上创建账户,请从 此处 开始

之后,您只需从 我的账户 部分获取 API 密钥。

使用以下方式

composer require kavenegar/php

或者添加

"kavenegar/php": "*"

然后运行以下命令使用 composer 下载扩展

$ composer update

使用方法

以下是一个使用 PHP 发送短信的示例。

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

try{
	$api = new \Kavenegar\KavenegarApi( "API Key" );
	$sender = "10004346";
	$message = "خدمات پیام کوتاه کاوه نگار";
	$receptor = array("09123456789","09367891011");
	$result = $api->Send($sender,$receptor,$message);
	if($result){
		foreach($result as $r){
			echo "messageid = $r->messageid";
			echo "message = $r->message";
			echo "status = $r->status";
			echo "statustext = $r->statustext";
			echo "sender = $r->sender";
			echo "receptor = $r->receptor";
			echo "date = $r->date";
			echo "cost = $r->cost";
		}		
	}
}
catch(\Kavenegar\Exceptions\ApiException $e){
	// در صورتی که خروجی وب سرویس 200 نباشد این خطا رخ می دهد
	echo $e->errorMessage();
}
catch(\Kavenegar\Exceptions\HttpException $e){
	// در زمانی که مشکلی در برقرای ارتباط با وب سرویس وجود داشته باشد این خطا رخ می دهد
	echo $e->errorMessage();
}

/*
sample output
{
    "return":
    {
        "status":200,
        "message":"تایید شد"
    },
    "entries": 
    [
        {
            "messageid":8792343,
            "message":"خدمات پیام کوتاه کاوه نگار",
            "status":1,
            "statustext":"در صف ارسال",
            "sender":"10004346",
            "receptor":"09123456789",
            "date":1356619709,
            "cost":120
        },
        {
            "messageid":8792344,
            "message":"خدمات پیام کوتاه کاوه نگار",
            "status":1,
            "statustext":"در صف ارسال",
            "sender":"10004346",
            "receptor":"09367891011",
            "date":1356619709,
            "cost":120
        }
    ]
}
*/

贡献

欢迎修复错误、编写文档和增强功能!请告知我们 support@kavenegar.com

指南

介绍 Kavenegar 服务

Kavenegar 是一种发送和接收短信及语音通话的 Web 服务,您可以轻松使用。

创建账户

如果您还不是 Kavenegar Web 服务的成员,您可以从 会员注册链接 注册并获取用于测试 API 的试用账户。

文档

要查看完整文档信息,请访问 短信 Web 服务 页面,或访问 Web 服务文档 页面。

波斯语指南

如果您想阅读 Kavenegar SDK 的波斯语指南,请访问 发送短信代码 页面。

更多信息

要了解更多信息,请访问 Kavenegar SMS Web 服务 的介绍页面。

如果您在使用 Kavenegar SDK 时遇到问题或有建议,请通过 Pull Request 或发送电子邮件到 support@kavenegar.com 来让我们知道。

http://kavenegar.com

http://kavenegar.com