README

SaralSMS SDK for PHP 让开发者能够轻松地在 PHP 代码中访问 SaralSMS API 服务，并构建健壮的基于 SMS 的应用程序和软件。

入门指南

1. 注册 SaralSMS – 在开始之前，您需要注册一个 SaralSMS 账户并获取您的 凭证。
2. 最低要求 – 运行 SDK，您的系统需要满足最低要求，包括具有 PHP >= 7.2。我们强烈建议使用支持 cURL 扩展和带有 TLS 后端的 cURL（例如，NSS 或 OpenSSL）进行编译。

安装

安装 SDK – 使用 Composer 是安装 PHP SaralSMS SDK 的推荐方式。SDK 通过 Packagist 提供，在 saralsms/sdk-for-php 包下。

composer require saralsms/sdk-for-php

获取帮助

我们使用 GitHub 的问题跟踪错误和功能请求，并尽快解决它们。

• 联系 SaralSMS 支持 或在仪表板上打开工单。
• 如果您发现可能存在错误，请 打开问题。

快速示例

创建 SaralSMS 客户端

// require the composer autoloader.
require 'vendor/autoload.php';

use SaralSMS\Client;

// instantiate a SaralSMS client.
$client = new Client('f9c6......55c1');

发送消息

这将向数组中的一或多个号码发送消息。

$client->send(['9851xxx123', '9801xxx456'], 'This is test message from API.');

示例响应

{
    "message": "2 messages queued for delivery."
}

致谢

这将返回可用的信用额和已发送的总消息数。

$client->getCredits();

示例响应

{
  "credits": 6584,
  "total_sent": 3416
}

报告

这将返回包括网络、费用和状态在内的历史消息报告。

$pageNumber = 1;
$client->getReports($pageNumber);

示例响应

{
  "pages": 126,
  "data": [
    {
      "id": 56480058,
      "receiver": "9779851xxx123",
      "network": "ntc",
      "message": "Fruits are an excellent source of essential vitamins and minerals.",
      "api_credit": "1",
      "delivery_at": "2020-07-09 01:45:09"
    },
    {
      "id": 56480057,
      "receiver": "9779801xxx456",
      "network": "ncell",
      "message": "Vegetables are important sources of many nutrients, including potassium, dietary fiber.",
      "api_credit": "1",
      "delivery_at": "2020-07-08 07:25:31"
    }
  ]
}