README

这个PHP库允许您与Nexah API进行通信。您可以发送短信消息并检查您的短信余额。该库为开发者提供了管理其与API交互的灵活性。要使用API，您需要一个账户。访问官方网站 https://nexah.net/ 以获取一个账户。

要求

• 从 https://nexah.net/ 获取的用户名和密码
• PHP 7.4及以上版本
• Composer

安装

通过composer

$ composer require gladdle/nexah-sms

基本用法

<?php

require "./vendor/autoload.php";

use Gladdle\NexahSms\Configuration;
use Gladdle\NexahSms\SmsClient;

$client = new SmsClient(
    new Configuration(
        "username",
        "password",
        "senderId"
    )
);

// Multiple numbers
// formats: 6xxxxxxxx or 2376xxxxxxxx
$client->send("6xxxxxxxx, 2376xxxxxxxx", "Message to be sent"); // returns true

// One number
$client->send("6xxxxxxxx", "Message to be sent"); // returns true

// Get SMS balance
$client->getBalance() // returns number, eg 10000

捕获错误

当您尝试与API通信时，可能会发生错误

• 用户名和/或密码不正确
• 无效的手机号码

您可以根据遇到错误来调整您的代码

use Gladdle\NexahSms\Exception\AuthException;
use Gladdle\NexahSms\Exception\SendingFailureException;

try {

    $client->send("6xxxxxxxx, 2376xxxxxxxx", "Message to be sent");
    $client->getBalance();

} catch (AuthException $e) {
    // Wrong username and/or password 
    // do stoff...
} catch (SendingFailureException $e) {
    // Incorrect numbers. Message not sent
    // Retrieve them
    $numbers = $client->getInvalidNumbers(); // ['6xxxxxxxxx', 'xxxxxxxxx'];
}

测试

安装后，您可以在不编写任何代码的情况下立即测试库。请确保您有一个有效的用户名和密码。

$ NX_BAD_USER=username NX_GOOD_USER=username NX_PWD=password NX_GOOD_NUM=677777777 NX_BAD_NUM=6777777771 NX_SENDERID=senderId  php vendor/bin/phpunit tests/

NX_BAD_USER 以及其他都是环境变量。您可以根据您的操作系统来定义它们

• NX_BAD_USER 无效的用户名
• NX_GOOD_USER 有效的用户名
• NX_PWD 有效的密码
• NX_GOOD_NUM 有效的号码
• NX_BAD_NUM 无效的号码，例如10位数字

日志

您可以通过定义文件路径来流日志消息

$client = new SmsClient(
    new Configuration(
        "username",
        "password",
        "senderId"
        __DIR__ . '/var/logs.log'
    )
);

作者

Koumé KOUMGANG - https://www.linkedin.com/in/etiennekoumgang/