README

SignalAds RESTful API 文档

如需获取 API 文档的更多信息，请访问 RESTful 文档

安装

之后，您只需从 我的账户 部分获取 API-KEY。

使用方法

composer require signalads-co/php

或添加

"signalads/php": "*"

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

$ composer update

用法

• 必需的自动加载

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

• 异常处理

try{
	// call SignalAdsApi function
}
catch(\SignalAds\Exceptions\ApiException $e){
	// در صورتی که خروجی وب سرویس 200 نباشد این خطا رخ می دهد
	echo $e->errorMessage();
}
catch(\SignalAds\Exceptions\HttpException $e){
	// در زمانی که مشکلی در برقرای ارتباط با وب سرویس وجود داشته باشد این خطا رخ می دهد
	echo $e->errorMessage();
}

• 发送单条短信

$api = new \SignalAds\SignalAdsApi( "API Key" );
$sender = "10004346";
$message = "خدمات پیام کوتاه سیگنال";
$receptor = "09123456789";
$api->Send($sender,$receptor,$message);

示例输出

{
  "data": {
    "message_id": "28561b88-8403-45b8-a114-508abdb9c436",
    "price": 120
  },
  "message": "پیام شما با موفقیت در صف ارسال قرار گرفت",
  "error": {
    "message": null,
    "errors": null
  }
}

• 发送多条相同文本的短信

$api = new \SignalAds\SignalAdsApi( "API Key" );
$sender = "10004346";
$message = "خدمات پیام کوتاه سیگنال";
$receptors = array("09123456789","09367891011");
$api->SendGroup($sender,$receptors,$message);

示例输出

{
  "data": {
    "message_id": "55800454-fe52-44b3-9c44-43c87d6f29b2",
    "price": 240
  },
  "message": "پیام شما با موفقیت در صف ارسال قرار گرفت",
  "error": {
    "message": null,
    "errors": null
  }
}

• 按模式发送短信

$api = new \SignalAds\SignalAdsApi( "API Key" );
$sender = "10004346";
$pattern_id = "10004346";
$pattern_params = ["param 1", "param 2"];
$receptors = array("09123456789","09367891011");
$api->SendPattern($sender,$pattern_id,$pattern_params,$receptors);

示例输出

{
  "data": {
    "message_id": "28561b88-8403-45b8-a114-508abdb9c436"
  },
  "message": "پیام شما با موفقیت در صف ارسال قرار گرفت",
  "error": {
    "message": null,
    "errors": null
  }
}

• 获取消息状态

$api = new \SignalAds\SignalAdsApi( "API Key" );
$messageid=123;
$api->Status($messageid);

• 通过筛选获取消息状态

$api = new \SignalAds\SignalAdsApi( "API Key" );
$messageid=123;
$limit=10;
$offset=0;
$status=1;
$receptor="09xxxxxxxxx";
$api->Status($messageid, $limit, $offset, $status, $receptor);

状态

PENDING = 1
SENDING = 2
BLACKLIST = 3
DELIVERED = 4
NOT_DELIVERED = 5
NOT_SENDING = 6
ERROR = 7

示例输出

{
  "data": {
    "items": [
      {
        "number": "09xxxxxxxxx",
        "status": 1
      },
      {
        "number": "09xxxxxxxxx",
        "status": 2
      },
      {
        "number": "09xxxxxxxxx",
        "status": 3
      },
      {
        "number": "09xxxxxxxxx",
        "status": 4
      },
      {
        "number": "09xxxxxxxxx",
        "status": 5
      },
      {
        "number": "09xxxxxxxxx",
        "status": 6
      },
      {
        "number": "09xxxxxxxxx",
        "status": 7
      }
    ],
    "count": 7,
    "sum": 0
  },
  "message": null,
  "error": {
    "message": null,
    "errors": null
  }
}

• 获取账户余额

$api = new \SignalAds\SignalAdsApi( "API Key" );
$api->GetCredit();

示例输出

{
  "data": {
    "credit": 12345
  },
  "message": null,
  "error": {
    "message": null,
    "errors": null
  }
}

• 获取套餐价格

$api = new \SignalAds\SignalAdsApi( "API Key" );
$api->GetPackagePrice();

示例输出

{
  "data": {
    "id": 415,
    "gift_charge": "123",
    "price": "123",
    "name": "testsdf",
    "package_prices": [
      {
        "id": 156,
        "english_price": "210",
        "persian_price": "180",
        "operator": {
          "id": 1,
          "title": "همراه اول"
        }
      }
    ]
  },
  "message": null,
  "error": {
    "message": null,
    "errors": null
  }
}