README

此仓库包含用于 ippanel api 的开源 PHP 客户端。文档可以在以下地址找到：[http://docs.ippanel.com](http://docs.ippanel.com)。

安装

使用 composer

composer require amidesfahani/php-rest-sdk

示例

要使用 SDK，您需要创建一个客户端实例，该实例为您提供 API 上的可用方法

require 'autoload.php';

// you api key that generated from panel
$apiKey = "api-key";

$client = new \IPPanel\Client($apiKey);

...

信用检查

# return float64 type credit amount
$credit = $client->getCredit();

一对多发送

对于发送短信，显然您需要 originator 号码、recipients 和 message。

$bulkID = $client->send(
    "+9810001",          // originator
    ["98912xxxxxxx"],    // recipients
    "ippanel is awesome" // message
);

如果发送成功，将返回一个唯一的跟踪码，您可以使用该码跟踪您的消息状态。

获取消息摘要

$bulkID = "message-tracking-code";

$message = $client->get_message($bulkID);

echo $message->status;   // get message status
echo $message->cost;     // get message cost
echo $message->payback;  // get message payback

获取消息投递状态

$bulkID = "message-tracking-code"

list($statuses, $paginationInfo) = $client->fetchStatuses($bulkID, 0, 10)

// you can loop in messages statuses list
foreach($statuses as status) {
    echo sprintf("Recipient: %s, Status: %s", $status->recipient, $status->status);
}

echo sprintf("Total: ", $paginationInfo->total);

收件箱获取

获取收件箱消息

list($messages, $paginationInfo) = $client->fetchInbox(0, 10);

foreach($messages as $message) {
    echo sprintf("Received message %s from number %s in line %s", $message->message, $message->sender, $message->number);
}

模式创建

对于发送预定义模式的消息（例如验证码等），您必须创建一个模式。一个模式至少有一个参数。参数用 %param_name% 定义。

$pattern = $client->createPattern("%name% is awesome", False);

echo $pattern->code;

使用模式发送

$patternValues = [
    "name" => "IPPANEL",
];

$bulkID = $client->sendPattern(
    "t2cfmnyo0c",    // pattern code
    "+9810001",      // originator
    "98912xxxxxxx",  // recipient
    $patternValues,  // pattern values
);

错误检查

use IPPanel\Errors\Error;
use IPPanel\Errors\HttpException;

try{
    $bulkID = $client->send("9810001", ["98912xxxxx"], "ippanel is awesome");
} catch (Error $e) { // ippanel error
    var_dump($e->unwrap()); // get real content of error
    echo $e->getCode();

    // error codes checking
    if ($e->code() == ResponseCodes::ErrUnprocessableEntity) {
        echo "Unprocessable entity";
    }
} catch (HttpException $e) { // http error
    var_dump($e->getMessage()); // get stringified error
    echo $e->getCode();
}